| | import importlib.util |
| | import os |
| | import sys |
| | from collections import namedtuple |
| | from typing import Any, List, Optional |
| |
|
| | if sys.version_info >= (3, 11): |
| | import tomllib |
| | else: |
| | from pip._vendor import tomli as tomllib |
| |
|
| | from pip._vendor.packaging.requirements import InvalidRequirement |
| |
|
| | from pip._internal.exceptions import ( |
| | InstallationError, |
| | InvalidPyProjectBuildRequires, |
| | MissingPyProjectBuildRequires, |
| | ) |
| | from pip._internal.utils.packaging import get_requirement |
| |
|
| |
|
| | def _is_list_of_str(obj: Any) -> bool: |
| | return isinstance(obj, list) and all(isinstance(item, str) for item in obj) |
| |
|
| |
|
| | def make_pyproject_path(unpacked_source_directory: str) -> str: |
| | return os.path.join(unpacked_source_directory, "pyproject.toml") |
| |
|
| |
|
| | BuildSystemDetails = namedtuple( |
| | "BuildSystemDetails", ["requires", "backend", "check", "backend_path"] |
| | ) |
| |
|
| |
|
| | def load_pyproject_toml( |
| | use_pep517: Optional[bool], pyproject_toml: str, setup_py: str, req_name: str |
| | ) -> Optional[BuildSystemDetails]: |
| | """Load the pyproject.toml file. |
| | |
| | Parameters: |
| | use_pep517 - Has the user requested PEP 517 processing? None |
| | means the user hasn't explicitly specified. |
| | pyproject_toml - Location of the project's pyproject.toml file |
| | setup_py - Location of the project's setup.py file |
| | req_name - The name of the requirement we're processing (for |
| | error reporting) |
| | |
| | Returns: |
| | None if we should use the legacy code path, otherwise a tuple |
| | ( |
| | requirements from pyproject.toml, |
| | name of PEP 517 backend, |
| | requirements we should check are installed after setting |
| | up the build environment |
| | directory paths to import the backend from (backend-path), |
| | relative to the project root. |
| | ) |
| | """ |
| | has_pyproject = os.path.isfile(pyproject_toml) |
| | has_setup = os.path.isfile(setup_py) |
| |
|
| | if not has_pyproject and not has_setup: |
| | raise InstallationError( |
| | f"{req_name} does not appear to be a Python project: " |
| | f"neither 'setup.py' nor 'pyproject.toml' found." |
| | ) |
| |
|
| | if has_pyproject: |
| | with open(pyproject_toml, encoding="utf-8") as f: |
| | pp_toml = tomllib.loads(f.read()) |
| | build_system = pp_toml.get("build-system") |
| | else: |
| | build_system = None |
| |
|
| | |
| | |
| | |
| | |
| | |
| | |
| | if has_pyproject and not has_setup: |
| | if use_pep517 is not None and not use_pep517: |
| | raise InstallationError( |
| | "Disabling PEP 517 processing is invalid: " |
| | "project does not have a setup.py" |
| | ) |
| | use_pep517 = True |
| | elif build_system and "build-backend" in build_system: |
| | if use_pep517 is not None and not use_pep517: |
| | raise InstallationError( |
| | "Disabling PEP 517 processing is invalid: " |
| | "project specifies a build backend of {} " |
| | "in pyproject.toml".format(build_system["build-backend"]) |
| | ) |
| | use_pep517 = True |
| |
|
| | |
| | |
| | |
| | |
| |
|
| | |
| | |
| | |
| | |
| | |
| | elif use_pep517 is None: |
| | use_pep517 = ( |
| | has_pyproject |
| | or not importlib.util.find_spec("setuptools") |
| | or not importlib.util.find_spec("wheel") |
| | ) |
| |
|
| | |
| | assert use_pep517 is not None |
| |
|
| | |
| | |
| | if not use_pep517: |
| | return None |
| |
|
| | if build_system is None: |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| |
|
| | build_system = { |
| | "requires": ["setuptools>=40.8.0"], |
| | "build-backend": "setuptools.build_meta:__legacy__", |
| | } |
| |
|
| | |
| | |
| | |
| | |
| | assert build_system is not None |
| |
|
| | |
| | |
| |
|
| | |
| | if "requires" not in build_system: |
| | raise MissingPyProjectBuildRequires(package=req_name) |
| |
|
| | |
| | requires = build_system["requires"] |
| | if not _is_list_of_str(requires): |
| | raise InvalidPyProjectBuildRequires( |
| | package=req_name, |
| | reason="It is not a list of strings.", |
| | ) |
| |
|
| | |
| | for requirement in requires: |
| | try: |
| | get_requirement(requirement) |
| | except InvalidRequirement as error: |
| | raise InvalidPyProjectBuildRequires( |
| | package=req_name, |
| | reason=f"It contains an invalid requirement: {requirement!r}", |
| | ) from error |
| |
|
| | backend = build_system.get("build-backend") |
| | backend_path = build_system.get("backend-path", []) |
| | check: List[str] = [] |
| | if backend is None: |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | backend = "setuptools.build_meta:__legacy__" |
| | check = ["setuptools>=40.8.0"] |
| |
|
| | return BuildSystemDetails(requires, backend, check, backend_path) |
| |
|