gpf_entrepot_toolbelt.utils.directories_utils module

Utils for reading directories content

class gpf_entrepot_toolbelt.utils.directories_utils.PathType(value)

Bases : Enum

An enumeration.

DIR = 2
FILE = 1
gpf_entrepot_toolbelt.utils.directories_utils.list_directory(directory: Path, types: set[PathType] = (PathType.FILE, PathType.DIR, PathType.SYMLINK), ignored_templates: list[str] | None = ('^(.*/)?__.*$', '^.*[.]md5$'), included_templates: list[str] | None = None, recursive: bool = True) → set[Path]

Returns content of a directory, according to argument filters

Paramètres:

  • directory (Path) – directory to list

  • types (set[PathType]) – path items types to keep

  • ignored_templates (list[str] | None) – file name templates to ignore (ignore nothing if None)

  • included_templates (list[str] | None) – file name templates to keep (keep all if None)

  • recursive (bool) – True if folder must be scanned recursively

Renvoie:

set of files/directories/symlinks

Type renvoyé:

set[Path]