pep518 read

These PEP 518 (aka pyproject.toml) functions are not app specific

These functions are lifted from the black project. With minor changes:

  • Removed black specific version handling

  • Added sphinx style code documentation

  • Removed py38 styles typing like: Tuple or Dict

  • Import Sequence correctly

See also

pyproject.toml handling

Note

Flake8 config files handling

Flake8 load_config function

Monkeypatch of configparser to support pyproject.toml, ConfigParserTomlMixin

Apply monkeypatch FixFilenames.apply

Module private variables

drain_swamp.pep518_read.__all__: tuple[str] = ("find_project_root", "find_pyproject_toml")

Exported objects from this module

Module objects

drain_swamp.pep518_read.find_project_root(srcs, stdin_filename=None)

Return folder containing .git, .hg, or pyproject.toml.

If no directory in the tree contains a marker that would specify it’s the project root, the root of the file system is returned.

Returns a two-tuple with the first element as the project root path and the second element as a string describing the method by which the project root was discovered.

Parameters:

  • srcs (collections.abc.Sequence[Any] | None) – Files or folders, for files will take the parent folder. Potential folders that may contain pyproject.toml

  • stdin_filename (str | None) – Default None. stdin file name, considers files parent as the project top folder

Returns:

Folder containing .git, .hg, or pyproject.toml, will be a common parent of all files and directories passed in srcs

Return type:

tuple[pathlib.Path, str]

Raises:

Note

Passing pyproject.toml, by stdin, could be useful for testing recipes

Warning

functools.lru_cache causes optional parameter stdin_filename to NOT BE OPTIONAL

See also

black.files.find_project_root() source and credit Black

drain_swamp.pep518_read.find_pyproject_toml(path_search_start, stdin_filename)

Find the absolute filepath to a pyproject.toml if it exists.

Parameters:

  • path_search_start (tuple[str, ...]) – absolute paths of files or folders to start search for project base folder

  • stdin_filename (str | None) – pyproject.toml passed into stdin. May be a file

Returns:

Absolute path to project pyproject.toml otherwise None

Return type:

str | None