bartender.web.api.job.archive#

Attributes#

ArchiveFormat

Functions#

create_archive(→ None)

Creates an archive of the specified directory.

_map_archive_format(→ Union[Type[fs.zipfs.ZipFS], ...)

Module Contents#

bartender.web.api.job.archive.ArchiveFormat#
async bartender.web.api.job.archive.create_archive(src_dir: pathlib.Path, exclude: list[str] | None, exclude_dirs: list[str] | None, archive_format: ArchiveFormat, archive_fn: str) → None#

Creates an archive of the specified directory.

Parameters:

  • src_dir (pathlib.Path) – The path to the source directory.

  • exclude (Optional[list[str]]) – A list of patterns to exclude from the archive.

  • exclude_dirs (Optional[list[str]]) – A list of directory names to exclude from the archive.

  • archive_format (ArchiveFormat) – Format to use for archive.

  • archive_fn (str) – The filename of the archive.

Return type:

None

bartender.web.api.job.archive._map_archive_format(archive_format: ArchiveFormat) → Type[fs.zipfs.ZipFS] | Type[fs.tarfs.TarFS]#
Parameters:

archive_format (ArchiveFormat) –

Return type:

Union[Type[fs.zipfs.ZipFS], Type[fs.tarfs.TarFS]]