Skip to content

tinker_cookbook.stores.LocalStorage

class tinker_cookbook.stores.LocalStorage(**)

File-based storage rooted at a local directory.

property root

The resolved local directory root.

url(path)

Return a file:/// URI for the given path.

Parameters:

  • path (str)

read(path)

See :meth:Storage.read.

Parameters:

  • path (str)

write(path, data)

See :meth:Storage.write.

Parameters:

  • path (str)
  • data (bytes)

append(path, data)

See :meth:Storage.append.

Parameters:

  • path (str)
  • data (bytes)

exists(path)

See :meth:Storage.exists.

Parameters:

  • path (str)

stat(path)

See :meth:Storage.stat.

Parameters:

  • path (str)

read_range(path, offset, length)

See :meth:Storage.read_range.

Parameters:

  • path (str)
  • offset (int)
  • length (int | None)

list_dir(prefix)

See :meth:Storage.list_dir. Returns sorted names.

Parameters:

  • prefix (str)

remove(path)

See :meth:Storage.remove.

Parameters:

  • path (str)

remove_dir(path)

See :meth:Storage.remove_dir.

Parameters:

  • path (str)

flush()

See :meth:Storage.flush. No-op for local filesystem.

aread(path)

Async version of :meth:read.

Parameters:

  • path (str)

awrite(path, data)

Async version of :meth:write.

Parameters:

  • path (str)
  • data (bytes)

aappend(path, data)

Async version of :meth:append.

Parameters:

  • path (str)
  • data (bytes)

aexists(path)

Async version of :meth:exists.

Parameters:

  • path (str)

astat(path)

Async version of :meth:stat.

Parameters:

  • path (str)

aread_range(path, offset, length)

Async version of :meth:read_range.

Parameters:

  • path (str)
  • offset (int)
  • length (int | None)

alist_dir(prefix)

Async version of :meth:list_dir.

Parameters:

  • prefix (str)

aremove(path)

Async version of :meth:remove.

Parameters:

  • path (str)

aremove_dir(path)

Async version of :meth:remove_dir.

Parameters:

  • path (str)