bandersnatch_storage_plugins package

Package contents

Submodules

bandersnatch_storage_plugins.filesystem module

class bandersnatch_storage_plugins.filesystem.FilesystemStorage(*args: Any, **kwargs: Any)

Bases: StoragePlugin

PATH_BACKEND

alias of Path

compare_files(file1: Path | str, file2: Path | str) → bool

Compare two files, returning true if they are the same and False if not.

copy_file(source: Path | str, dest: Path | str) → None

Copy a file from source to dest

delete_file(path: Path | str, dry_run: bool = False) → int

Delete the provided path, recursively if necessary.

delete_package_file(path: Path | str) → None

Remove a file and if the dir is empty remove it

exists(path: Path | str) → bool

Check whether the provided path exists

find(root: Path | str, dirs: bool = True) → str

A test helper simulating ‘find’.

Iterates over directories and filenames, given as relative paths to the root.

get_file_size(path: Path | str) → int

Return the file size of provided path.

get_hash(path: Path | str, function: str = 'sha256') → str

Get the sha256sum of a given path

get_lock(path: str | None = None) → UnixFileLock

Retrieve the appropriate FileLock backend for this storage plugin

Parameters:

path (str) – The path to use for locking

Returns:

A FileLock backend for obtaining locks

Return type:

filelock.FileLock

get_upload_time(path: Path | str) → datetime

Get the upload time of a given path

initialize_plugin() → None

Code to initialize the plugin

is_dir(path: Path | str) → bool

Check whether the provided path is a directory.

is_file(path: Path | str) → bool

Check whether the provided path is a file.

mkdir(path: Path | str, exist_ok: bool = False, parents: bool = False) → None

Create the provided directory

move_file(source: Path | str, dest: Path | str) → None

Move a file from source to dest

name = 'filesystem'

open_file(path: Path | str, text: bool = True, encoding: str = 'utf-8') → Generator[IO, None, None]

Yield a file context to iterate over. If text is true, open the file with ‘rb’ mode specified.

read_file(path: Path | str, text: bool = True, encoding: str = 'utf-8', errors: str | None = None) → str | bytes

Return the contents of the requested file, either a bytestring or a unicode string depending on whether text is True

rewrite(filepath: Path | str, mode: str = 'w', **kw: Any) → Generator[IO, None, None]

Rewrite an existing file atomically to avoid programs running in parallel to have race conditions while reading.

rmdir(path: Path | str, recurse: bool = False, force: bool = False, ignore_errors: bool = False, dry_run: bool = False) → int

Remove the directory. If recurse is True, allow removing empty children. If force is true, remove contents destructively.

scandir(path: Path | str) → Generator[DirEntry, None, None]

Read entries from the provided directory

set_upload_time(path: Path | str, time: datetime) → None

Set the upload time of a given path

update_safe(filename: Path | str, **kw: Any) → Generator[IO, None, None]

Rewrite a file atomically.

Clients are allowed to delete the tmpfile to signal that they don’t want to have it updated.

walk(root: Path | str, dirs: bool = True) → list[Path]

write_file(path: Path | str, contents: str | bytes) → None

Write data to the provided path. If contents is a string, the file will be opened and written in “r” + “utf-8” mode, if bytes are supplied it will be accessed using “rb” mode (i.e. binary write).