pep518 parser

pyproject.toml parsing. text –> dict

drain_swamp.parser_in.__all__: tuple[str] = ("TomlParser",)

Module exports

drain_swamp.parser_in._logger: logging.Logger

Module level logger

drain_swamp.parser_in.is_module_debug: bool

Module level debugging flag

class drain_swamp.parser_in.TomlParser(path, raise_exceptions=False)

Reverse searches for a pyproject.toml file and parses it.

Interface provides both the dict and the resolved absolute path

Variables:

  • path (Any | None) – Starting search absolute path. Can be a folder or file. Reverse searches for a pyproject.toml file

  • raise_exceptions (Any | None) – Default False. Expecting a bool. If True raise exceptions

Raises:
property d_pyproject_toml

Getter pyproject.toml dict.

Returns:

pyproject.toml dict. Not set if constructor raised an Exception

Return type:

collections.abc.Mapping[str, Any] | None

property path_file

Absolute Path to pyproject.toml.

Returns:

Absolute Path to pyproject.toml file. Not set if constructor raised an Exception

Return type:

pathlib.Path | None

classmethod read(path_config)

Read the current contents of pyproject.toml file.

Parameters:

path_config (pathlib.Path) – pyproject.toml folder path

Returns:

pyproject.toml dict and resolved path to file

Return type:

tuple[dict[str, Any], pathlib.Path]

Raises:
classmethod resolve(path_config)

Reverse search for a pyproject.toml file.

Leverages reverse search algo from Python package, black

Parameters:

path_config (Any | None) – Starting absolute path to reserve search for a pyproject.toml. Expecting an absolute path either: Path or str

Returns:

absolute path to a pyproject.toml

Return type:

pathlib.Path

Raises: