metadata_editable.py 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. """Metadata generation logic for source distributions."""
  2. import os
  3. from pip._vendor.pyproject_hooks import BuildBackendHookCaller
  4. from pip._internal.build_env import BuildEnvironment
  5. from pip._internal.exceptions import (
  6. InstallationSubprocessError,
  7. MetadataGenerationFailed,
  8. )
  9. from pip._internal.utils.subprocess import runner_with_spinner_message
  10. from pip._internal.utils.temp_dir import TempDirectory
  11. def generate_editable_metadata(
  12. build_env: BuildEnvironment, backend: BuildBackendHookCaller, details: str
  13. ) -> str:
  14. """Generate metadata using mechanisms described in PEP 660.
  15. Returns the generated metadata directory.
  16. """
  17. metadata_tmpdir = TempDirectory(kind="modern-metadata", globally_managed=True)
  18. metadata_dir = metadata_tmpdir.path
  19. with build_env:
  20. # Note that BuildBackendHookCaller implements a fallback for
  21. # prepare_metadata_for_build_wheel/editable, so we don't have to
  22. # consider the possibility that this hook doesn't exist.
  23. runner = runner_with_spinner_message(
  24. "Preparing editable metadata (pyproject.toml)"
  25. )
  26. with backend.subprocess_runner(runner):
  27. try:
  28. distinfo_dir = backend.prepare_metadata_for_build_editable(metadata_dir)
  29. except InstallationSubprocessError as error:
  30. raise MetadataGenerationFailed(package_details=details) from error
  31. assert distinfo_dir is not None
  32. return os.path.join(metadata_dir, distinfo_dir)