SourceDistribution Class Reference

Inheritance diagram for SourceDistribution:

Collaboration diagram for SourceDistribution:

Public Member Functions
BaseDistribution	get_metadata_distribution (self)
None	prepare_distribution_metadata (self, PackageFinder finder, bool build_isolation, bool check_build_deps)
Public Member Functions inherited from AbstractDistribution
None	__init__ (self, InstallRequirement req)

Data Fields
	req
Data Fields inherited from AbstractDistribution
	req

Protected Member Functions
None	_prepare_build_backend (self, PackageFinder finder)
Iterable[str]	_get_build_requires_wheel (self)
Iterable[str]	_get_build_requires_editable (self)
None	_install_build_reqs (self, PackageFinder finder)
None	_raise_conflicts (self, str conflicting_with, Set[Tuple[str, str]] conflicting_reqs)
None	_raise_missing_reqs (self, Set[str] missing)

Detailed Description

Represents a source distribution.

The preparation step for these needs metadata for the packages to be
generated, either using PEP 517 or using the legacy `setup.py egg_info`.

Definition at line 14 of file sdist.py.

Member Function Documentation

_get_build_requires_editable()

Iterable[str] _get_build_requires_editable (   self )

protected

Definition at line 97 of file sdist.py.

    def _get_build_requires_editable(self) -> Iterable[str]:
        with self.req.build_env:
            runner = runner_with_spinner_message(
                "Getting requirements to build editable"
            )
            backend = self.req.pep517_backend
            assert backend is not None
            with backend.subprocess_runner(runner):
                return backend.get_requires_for_build_editable()
 

References i, AbstractDistribution.req, SourceDistribution.req, HashError.req, HashMissing.req, FrozenRequirement.req, InstallRequirement.req, VersionConflict.req(), and DistributionNotFound.req().

Referenced by SourceDistribution._install_build_reqs().

Here is the call graph for this function:

Here is the caller graph for this function:

_get_build_requires_wheel()

Iterable[str] _get_build_requires_wheel (   self )

protected

Definition at line 89 of file sdist.py.

    def _get_build_requires_wheel(self) -> Iterable[str]:
        with self.req.build_env:
            runner = runner_with_spinner_message("Getting requirements to build wheel")
            backend = self.req.pep517_backend
            assert backend is not None
            with backend.subprocess_runner(runner):
                return backend.get_requires_for_build_wheel()
 

References i, AbstractDistribution.req, SourceDistribution.req, HashError.req, HashMissing.req, FrozenRequirement.req, InstallRequirement.req, VersionConflict.req(), and DistributionNotFound.req().

Referenced by SourceDistribution._install_build_reqs().

Here is the call graph for this function:

Here is the caller graph for this function:

_install_build_reqs()

None _install_build_reqs (   self, PackageFinder  finder  )

protected

Definition at line 107 of file sdist.py.

    def _install_build_reqs(self, finder: PackageFinder) -> None:
        # Install any extra build dependencies that the backend requests.
        # This must be done in a second pass, as the pyproject.toml
        # dependencies must be installed before we can call the backend.
        if (
            self.req.editable
            and self.req.permit_editable_wheels
            and self.req.supports_pyproject_editable()
        ):
            build_reqs = self._get_build_requires_editable()
        else:
            build_reqs = self._get_build_requires_wheel()
        conflicting, missing = self.req.build_env.check_requirements(build_reqs)
        if conflicting:
            self._raise_conflicts("the backend dependencies", conflicting)
        self.req.build_env.install_requirements(
            finder, missing, "normal", kind="backend dependencies"
        )
 

References SourceDistribution._get_build_requires_editable(), SourceDistribution._get_build_requires_wheel(), SourceDistribution._raise_conflicts(), i, AbstractDistribution.req, SourceDistribution.req, HashError.req, HashMissing.req, FrozenRequirement.req, InstallRequirement.req, VersionConflict.req(), and DistributionNotFound.req().

Referenced by SourceDistribution.prepare_distribution_metadata().

Here is the call graph for this function:

Here is the caller graph for this function:

_prepare_build_backend()

None _prepare_build_backend (   self, PackageFinder  finder  )

protected

Definition at line 63 of file sdist.py.

    def _prepare_build_backend(self, finder: PackageFinder) -> None:
        # Isolate in a BuildEnvironment and install the build-time
        # requirements.
        pyproject_requires = self.req.pyproject_requires
        assert pyproject_requires is not None
 
        self.req.build_env = BuildEnvironment()
        self.req.build_env.install_requirements(
            finder, pyproject_requires, "overlay", kind="build dependencies"
        )
        conflicting, missing = self.req.build_env.check_requirements(
            self.req.requirements_to_check
        )
        if conflicting:
            self._raise_conflicts("PEP 517/518 supported requirements", conflicting)
        if missing:
            logger.warning(
                "Missing build requirements in pyproject.toml for %s.",
                self.req,
            )
            logger.warning(
                "The project does not specify a build backend, and "
                "pip cannot fall back to setuptools without %s.",
                " and ".join(map(repr, sorted(missing))),
            )
 

References SourceDistribution._raise_conflicts(), i, AbstractDistribution.req, SourceDistribution.req, HashError.req, HashMissing.req, FrozenRequirement.req, InstallRequirement.req, VersionConflict.req(), and DistributionNotFound.req().

Referenced by SourceDistribution.prepare_distribution_metadata().

Here is the call graph for this function:

Here is the caller graph for this function:

_raise_conflicts()

None _raise_conflicts (   self, str  conflicting_with, Set[Tuple[str, str]]   conflicting_reqs  )

protected

Definition at line 126 of file sdist.py.

    ) -> None:
        format_string = (
            "Some build dependencies for {requirement} "
            "conflict with {conflicting_with}: {description}."
        )
        error_message = format_string.format(
            requirement=self.req,
            conflicting_with=conflicting_with,
            description=", ".join(
                f"{installed} is incompatible with {wanted}"
                for installed, wanted in sorted(conflicting_reqs)
            ),
        )
        raise InstallationError(error_message)
 

References i, AbstractDistribution.req, SourceDistribution.req, HashError.req, HashMissing.req, FrozenRequirement.req, InstallRequirement.req, VersionConflict.req(), and DistributionNotFound.req().

Referenced by SourceDistribution._install_build_reqs(), SourceDistribution._prepare_build_backend(), and SourceDistribution.prepare_distribution_metadata().

Here is the call graph for this function:

Here is the caller graph for this function:

_raise_missing_reqs()

None _raise_missing_reqs (   self, Set[str]  missing  )

protected

Definition at line 143 of file sdist.py.

    def _raise_missing_reqs(self, missing: Set[str]) -> None:
        format_string = (
            "Some build dependencies for {requirement} are missing: {missing}."
        )
        error_message = format_string.format(
            requirement=self.req, missing=", ".join(map(repr, sorted(missing)))
        )
        raise InstallationError(error_message)

References i, AbstractDistribution.req, SourceDistribution.req, HashError.req, HashMissing.req, FrozenRequirement.req, InstallRequirement.req, VersionConflict.req(), and DistributionNotFound.req().

Referenced by SourceDistribution.prepare_distribution_metadata().

Here is the call graph for this function:

Here is the caller graph for this function:

get_metadata_distribution()

BaseDistribution get_metadata_distribution

(

self

)

Reimplemented from AbstractDistribution.

Definition at line 21 of file sdist.py.

    def get_metadata_distribution(self) -> BaseDistribution:
        return self.req.get_dist()
 

References AbstractDistribution.req, SourceDistribution.req, HashError.req, HashMissing.req, FrozenRequirement.req, InstallRequirement.req, VersionConflict.req(), and DistributionNotFound.req().

Here is the call graph for this function:

prepare_distribution_metadata()

None prepare_distribution_metadata	(		self,
		PackageFinder	finder,
		bool	build_isolation,
		bool	check_build_deps
	)

Reimplemented from AbstractDistribution.

Definition at line 24 of file sdist.py.

    ) -> None:
        # Load pyproject.toml, to determine whether PEP 517 is to be used
        self.req.load_pyproject_toml()
 
        # Set up the build isolation, if this requirement should be isolated
        should_isolate = self.req.use_pep517 and build_isolation
        if should_isolate:
            # Setup an isolated environment and install the build backend static
            # requirements in it.
            self._prepare_build_backend(finder)
            # Check that if the requirement is editable, it either supports PEP 660 or
            # has a setup.py or a setup.cfg. This cannot be done earlier because we need
            # to setup the build backend to verify it supports build_editable, nor can
            # it be done later, because we want to avoid installing build requirements
            # needlessly. Doing it here also works around setuptools generating
            # UNKNOWN.egg-info when running get_requires_for_build_wheel on a directory
            # without setup.py nor setup.cfg.
            self.req.isolated_editable_sanity_check()
            # Install the dynamic build requirements.
            self._install_build_reqs(finder)
        # Check if the current environment provides build dependencies
        should_check_deps = self.req.use_pep517 and check_build_deps
        if should_check_deps:
            pyproject_requires = self.req.pyproject_requires
            assert pyproject_requires is not None
            conflicting, missing = self.req.build_env.check_requirements(
                pyproject_requires
            )
            if conflicting:
                self._raise_conflicts("the backend dependencies", conflicting)
            if missing:
                self._raise_missing_reqs(missing)
        self.req.prepare_metadata()
 

References SourceDistribution._install_build_reqs(), SourceDistribution._prepare_build_backend(), SourceDistribution._raise_conflicts(), SourceDistribution._raise_missing_reqs(), i, AbstractDistribution.req, SourceDistribution.req, HashError.req, HashMissing.req, FrozenRequirement.req, InstallRequirement.req, VersionConflict.req(), and DistributionNotFound.req().

Here is the call graph for this function:

Field Documentation

req

req

Definition at line 81 of file sdist.py.

Referenced by FrozenRequirement.__str__(), InstallRequirement.__str__(), SourceDistribution._get_build_requires_editable(), SourceDistribution._get_build_requires_wheel(), SourceDistribution._install_build_reqs(), SourceDistribution._prepare_build_backend(), SourceDistribution._raise_conflicts(), SourceDistribution._raise_missing_reqs(), InstallRequirement._set_requirement(), InstallRequirement.assert_source_matches_version(), InstallRequirement.check_if_exists(), InstallRequirement.ensure_build_location(), InstallRequirement.from_path(), InstalledDistribution.get_metadata_distribution(), SourceDistribution.get_metadata_distribution(), WheelDistribution.get_metadata_distribution(), InstallRequirement.name(), SourceDistribution.prepare_distribution_metadata(), InstallRequirement.specifier(), InstallRequirement.uninstall(), and InstallRequirement.warn_on_mismatching_name().

---

The documentation for this class was generated from the following file:

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/distributions/sdist.py