Lock util

Utils for handling: .in, .shared.in, .unlock, .shared.unlock, .lock, and .shared.lock

drain_swamp.lock_util.ENDING: tuple[str, str, str] = (".in", ".unlock", ".lock")

End suffix indicating one of the requirement lock file types

drain_swamp.lock_util.__all__: tuple[str, str] = ("is_shared", "replace_suffixes_last")

Module exports

drain_swamp.lock_util.is_shared(file_name: str) → bool

Determine if file name indicates requirements shared by more than one venv

Parameters:

file_name (str) – File name w/ or w/o (.in, .lock, or .unlock) ending

Returns:

True if file suffix indicates shared by more than one venv otherwise False

Return type:

bool

Raises:

  • ValueError – None, not str, or just whitespace or empty string

drain_swamp.lock_util.replace_suffixes_last(abspath_f: Any, suffix_last: str) → Path

Replace the last suffix of an absolute Path. Preserves .shared suffix

Parameters:

  • abspath_f (Any) – Absolute path. Should be a Path, not PurePath

  • suffix_last (str) – Suffix to replace existing last suffix. Preserves .shared

Returns:

Absolute path with last suffix replaced

Return type:

pathlib.Path

Raises: