pip._internal.operations.build.metadata Namespace Reference

Functions
str	generate_metadata (BuildEnvironment build_env, BuildBackendHookCaller backend, str details)

Detailed Description

Metadata generation logic for source distributions.

Function Documentation

generate_metadata()

str generate_metadata	(	BuildEnvironment	build_env,
		BuildBackendHookCaller	backend,
		str	details
	)

Generate metadata using mechanisms described in PEP 517.

Returns the generated metadata directory.

Definition at line 17 of file metadata.py.

) -> str:
    """Generate metadata using mechanisms described in PEP 517.
 
    Returns the generated metadata directory.
    """
    metadata_tmpdir = TempDirectory(kind="modern-metadata", globally_managed=True)
 
    metadata_dir = metadata_tmpdir.path
 
    with build_env:
        # Note that BuildBackendHookCaller implements a fallback for
        # prepare_metadata_for_build_wheel, so we don't have to
        # consider the possibility that this hook doesn't exist.
        runner = runner_with_spinner_message("Preparing metadata (pyproject.toml)")
        with backend.subprocess_runner(runner):
            try:
                distinfo_dir = backend.prepare_metadata_for_build_wheel(metadata_dir)
            except InstallationSubprocessError as error:
                raise MetadataGenerationFailed(package_details=details) from error
 
    return os.path.join(metadata_dir, distinfo_dir)

References i.