Backend (PEP 517) partis.pyproj.backend

exception UnsupportedOperation

Bases: Exception

Note

If the backend cannot produce an dist because a dependency is missing, or for another well understood reason, it should raise an exception of a specific type which it makes available as UnsupportedOperation on the backend object.

See also

• https://www.python.org/dev/peps/pep-0517/

backend_init(root='.', config_settings=None, logger=None)

Called to inialialize the backend upon a call to one of the hooks

Parameters:

• root (str | pathlib.Path) – Directory containing ‘pyproject.toml’

• logger (logging.Logger) – Logger to use

Returns:

PyProjBase

get_requires_for_build_sdist(config_settings=None)

Note

This hook MUST return an additional list of strings containing PEP 508 dependency specifications, above and beyond those specified in the pyproject.toml file. These dependencies will be installed when calling the build_sdist hook.

See also

• https://www.python.org/dev/peps/pep-0517/#get-requires-for-build-sdist

build_sdist(dist_directory, config_settings=None)

Note

Must build a .tar.gz source distribution and place it in the specified dist_directory. It must return the basename (not the full path) of the .tar.gz file it creates, as a unicode string.

See also

• https://www.python.org/dev/peps/pep-0517/#build-sdist

get_requires_for_build_wheel(config_settings=None)

Note

This hook MUST return an additional list of strings containing PEP 508 dependency specifications, above and beyond those specified in the pyproject.toml file, to be installed when calling the build_wheel or prepare_metadata_for_build_wheel hooks.

Note

pip appears to not process environment markers for deps returned by get_requires_for_build_*, and may falsly report ERROR: Some build dependencies...conflict with the backend dependencies...

See also

• https://www.python.org/dev/peps/pep-0517/#get-requires-for-build-wheel

prepare_metadata_for_build_wheel(metadata_directory, config_settings=None)

Note

Must create a .dist-info directory containing wheel metadata inside the specified metadata_directory (i.e., creates a directory like {metadata_directory}/{package}-{version}.dist-info/).

See also

• https://www.python.org/dev/peps/pep-0517/#prepare-metadata-for-build-wheel

build_wheel(wheel_directory, config_settings=None, metadata_directory=None)

Note

Must build a .whl file, and place it in the specified wheel_directory. It must return the basename (not the full path) of the .whl file it creates, as a unicode string.

See also

• https://www.python.org/dev/peps/pep-0517/#build-wheel