\n Thank you for finding the time to report the problem, we ask that you use \n the command `hatch self report` to report bugs instead of using this form.\n \n \n\n![\"Hatch](\"https://raw.githubusercontent.com/pypa/hatch/master/docs/assets/images/logo.svg\")
\n\n| | |\n| --- | --- |\n| CI/CD | [](https://github.com/pypa/hatch/actions/workflows/test.yml) [](https://github.com/pypa/hatch/actions/workflows/build-hatch.yml) [](https://github.com/pypa/hatch/actions/workflows/build-hatchling.yml) |\n| Docs | [](https://github.com/pypa/hatch/actions/workflows/docs-release.yml) [](https://github.com/pypa/hatch/actions/workflows/docs-dev.yml) |\n| Package | [](https://pypi.org/project/hatch/) [](https://pypi.org/project/hatch/) [](https://pypi.org/project/hatch/) [](https://github.com/pypa/hatch/releases) |\n| Meta | [](https://github.com/pypa/hatch) [](https://github.com/astral-sh/ruff) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/ofek) |\n\n
\n\n-----\n\nHatch is a modern, extensible Python project manager.\n\n## Features\n\n- Standardized [build system](https://hatch.pypa.io/latest/config/build/#build-system) with reproducible builds by default\n- Robust [environment management](https://hatch.pypa.io/latest/environment/) with support for custom scripts and UV\n- Configurable [Python distribution management](https://hatch.pypa.io/latest/tutorials/python/manage/)\n- [Test execution](https://hatch.pypa.io/latest/tutorials/testing/overview/) with known best practices\n- [Static analysis](https://hatch.pypa.io/latest/config/static-analysis/) with sane defaults\n- Built-in Python [script runner](https://hatch.pypa.io/latest/how-to/run/python-scripts/)\n- Easy [publishing](https://hatch.pypa.io/latest/publish/) to PyPI or other indices\n- [Version](https://hatch.pypa.io/latest/version/) management\n- Best practice [project generation](https://hatch.pypa.io/latest/config/project-templates/)\n- Responsive [CLI](https://hatch.pypa.io/latest/cli/about/), ~2-3x [faster](https://github.com/pypa/hatch/actions/workflows/cli.yml) than equivalent tools\n\nSee the [Why Hatch?](https://hatch.pypa.io/latest/why/) page for more information.\n\n## Documentation\n\nThe [documentation](https://hatch.pypa.io/) is made with [Material for MkDocs](https://github.com/squidfunk/mkdocs-material) and is hosted by [GitHub Pages](https://docs.github.com/en/pages).\n\n## License\n\nHatch is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n"
},
{
"path": "backend/LICENSE.txt",
"content": "MIT License\n\nCopyright (c) 2021-present Ofek Lev \n\n| | |\n| --- | --- |\n| CI/CD | [](https://github.com/pypa/hatch/actions/workflows/test.yml) [](https://github.com/pypa/hatch/actions/workflows/build-hatch.yml) [](https://github.com/pypa/hatch/actions/workflows/build-hatchling.yml) |\n| Docs | [](https://github.com/pypa/hatch/actions/workflows/docs-release.yml) [](https://github.com/pypa/hatch/actions/workflows/docs-dev.yml) |\n| Package | [](https://pypi.org/project/hatch/) [](https://pypi.org/project/hatch/) [](https://pypi.org/project/hatch/) [](https://github.com/pypa/hatch/releases) |\n| Meta | [](https://github.com/pypa/hatch) [](https://github.com/astral-sh/ruff) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/ofek) |\n\n\n\n\n\n| | |\n| --- | --- |\n| Package | [](https://pypi.org/project/hatchling/) [](https://pypi.org/project/hatchling/) [](https://pypi.org/project/hatchling/) |\n| Meta | [](https://github.com/pypa/hatch) [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/ofek) |\n\n
\n\n-----\n\nThis is the extensible, standards compliant build backend used by [Hatch](https://github.com/pypa/hatch).\n\n## Usage\n\nThe following snippet must be present in your project's `pyproject.toml` file in order to use Hatchling as your build backend:\n\n```toml\n[build-system]\nrequires = [\"hatchling\"]\nbuild-backend = \"hatchling.build\"\n```\n\nThen a build frontend like [pip](https://github.com/pypa/pip), [build](https://github.com/pypa/build), or Hatch itself can build or install your project automatically:\n\n```console\n# install using pip\npip install /path/to/project\n\n# build\npython -m build /path/to/project\n\n# build with Hatch\nhatch build /path/to/project\n```\n\n## Documentation\n\n- [Project metadata](https://hatch.pypa.io/latest/config/metadata/)\n- [Dependencies](https://hatch.pypa.io/latest/config/dependency/)\n- [Packaging](https://hatch.pypa.io/latest/config/build/)\n"
},
{
"path": "backend/pyproject.toml",
"content": "[build-system]\nrequires = []\nbuild-backend = 'hatchling.ouroboros'\nbackend-path = ['src']\n\n[project]\nname = \"hatchling\"\ndynamic = [\"version\"]\ndescription = \"Modern, extensible Python build backend\"\nreadme = \"README.md\"\nlicense = \"MIT\"\nlicense-files = [\"LICENSE.txt\"]\nrequires-python = \">=3.10\"\nkeywords = [\n \"build\",\n \"hatch\",\n \"packaging\",\n]\nauthors = [\n { name = \"Ofek Lev\", email = \"oss@ofek.dev\" },\n]\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"Natural Language :: English\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: 3.14\",\n \"Programming Language :: Python :: Implementation :: CPython\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Topic :: Software Development :: Build Tools\",\n \"Topic :: Software Development :: Libraries :: Python Modules\",\n]\ndependencies = [\n \"packaging>=24.2\",\n \"pathspec>=0.10.1\",\n \"pluggy>=1.0.0\",\n \"tomli>=1.2.2; python_version < '3.11'\",\n \"trove-classifiers\",\n]\n\n[project.urls]\nHomepage = \"https://hatch.pypa.io/latest/\"\nSponsor = \"https://github.com/sponsors/ofek\"\nHistory = \"https://hatch.pypa.io/dev/history/hatchling/\"\nTracker = \"https://github.com/pypa/hatch/issues\"\nSource = \"https://github.com/pypa/hatch/tree/master/backend\"\n\n[project.scripts]\nhatchling = \"hatchling.cli:hatchling\"\n\n[tool.hatch.version]\npath = \"src/hatchling/__about__.py\"\n"
},
{
"path": "backend/src/hatchling/__about__.py",
"content": "__version__ = \"1.29.0\"\n"
},
{
"path": "backend/src/hatchling/__init__.py",
"content": ""
},
{
"path": "backend/src/hatchling/__main__.py",
"content": "import sys\n\nif __name__ == \"__main__\":\n from hatchling.cli import hatchling\n\n sys.exit(hatchling())\n"
},
{
"path": "backend/src/hatchling/bridge/__init__.py",
"content": ""
},
{
"path": "backend/src/hatchling/bridge/app.py",
"content": "from __future__ import annotations\n\nimport os\nimport sys\nfrom typing import Any\n\n\nclass Application:\n \"\"\"\n The way output is displayed can be [configured](../config/hatch.md#terminal) by users.\n\n !!! important\n Never import this directly; Hatch judiciously decides if a type of plugin requires\n the capabilities herein and will grant access via an attribute.\n \"\"\"\n\n def __init__(self) -> None:\n self.__verbosity = int(os.environ.get(\"HATCH_VERBOSE\", \"0\")) - int(os.environ.get(\"HATCH_QUIET\", \"0\"))\n\n @property\n def verbosity(self) -> int:\n \"\"\"\n The verbosity level of the application, with 0 as the default.\n \"\"\"\n return self.__verbosity\n\n @staticmethod\n def display(message: str = \"\", **kwargs: Any) -> None: # noqa: ARG004\n # Do not document\n _display(message, always=True)\n\n def display_info(self, message: str = \"\", **kwargs: Any) -> None: # noqa: ARG002\n \"\"\"\n Meant to be used for messages conveying basic information.\n \"\"\"\n if self.__verbosity >= 0:\n _display(message)\n\n def display_waiting(self, message: str = \"\", **kwargs: Any) -> None: # noqa: ARG002\n \"\"\"\n Meant to be used for messages shown before potentially time consuming operations.\n \"\"\"\n if self.__verbosity >= 0:\n _display(message)\n\n def display_success(self, message: str = \"\", **kwargs: Any) -> None: # noqa: ARG002\n \"\"\"\n Meant to be used for messages indicating some positive outcome.\n \"\"\"\n if self.__verbosity >= 0:\n _display(message)\n\n def display_warning(self, message: str = \"\", **kwargs: Any) -> None: # noqa: ARG002\n \"\"\"\n Meant to be used for messages conveying important information.\n \"\"\"\n if self.__verbosity >= -1:\n _display(message)\n\n def display_error(self, message: str = \"\", **kwargs: Any) -> None: # noqa: ARG002\n \"\"\"\n Meant to be used for messages indicating some unrecoverable error.\n \"\"\"\n if self.__verbosity >= -2: # noqa: PLR2004\n _display(message)\n\n def display_debug(self, message: str = \"\", level: int = 1, **kwargs: Any) -> None: # noqa: ARG002\n \"\"\"\n Meant to be used for messages that are not useful for most user experiences.\n The `level` option must be between 1 and 3 (inclusive).\n \"\"\"\n if not 1 <= level <= 3: # noqa: PLR2004\n error_message = \"Debug output can only have verbosity levels between 1 and 3 (inclusive)\"\n raise ValueError(error_message)\n\n if self.__verbosity >= level:\n _display(message)\n\n def display_mini_header(self, message: str = \"\", **kwargs: Any) -> None: # noqa: ARG002\n if self.__verbosity >= 0:\n _display(f\"[{message}]\")\n\n def abort(self, message: str = \"\", code: int = 1, **kwargs: Any) -> None: # noqa: ARG002\n \"\"\"\n Terminate the program with the given return code.\n \"\"\"\n if message and self.__verbosity >= -2: # noqa: PLR2004\n _display(message)\n\n sys.exit(code)\n\n def get_safe_application(self) -> SafeApplication:\n return SafeApplication(self)\n\n\nclass SafeApplication:\n def __init__(self, app: Application) -> None:\n self.abort = app.abort\n self.verbosity = app.verbosity\n self.display = app.display\n self.display_info = app.display_info\n self.display_error = app.display_error\n self.display_success = app.display_success\n self.display_waiting = app.display_waiting\n self.display_warning = app.display_warning\n self.display_debug = app.display_debug\n self.display_mini_header = app.display_mini_header\n\n\ndef _display(message: str, *, always: bool = False) -> None:\n print(message, file=None if always else sys.stderr)\n"
},
{
"path": "backend/src/hatchling/build.py",
"content": "from __future__ import annotations\n\nimport os\nfrom typing import Any\n\n__all__ = [\n \"build_editable\",\n \"build_sdist\",\n \"build_wheel\",\n \"get_requires_for_build_editable\",\n \"get_requires_for_build_sdist\",\n \"get_requires_for_build_wheel\",\n]\n__all__ += [\"__all__\"]\n\n\ndef get_requires_for_build_sdist(config_settings: dict[str, Any] | None = None) -> list[str]: # noqa: ARG001\n \"\"\"\n https://peps.python.org/pep-0517/#get-requires-for-build-sdist\n \"\"\"\n from hatchling.builders.sdist import SdistBuilder\n\n builder = SdistBuilder(os.getcwd())\n return builder.config.dependencies\n\n\ndef build_sdist(sdist_directory: str, config_settings: dict[str, Any] | None = None) -> str: # noqa: ARG001\n \"\"\"\n https://peps.python.org/pep-0517/#build-sdist\n \"\"\"\n from hatchling.builders.sdist import SdistBuilder\n\n builder = SdistBuilder(os.getcwd())\n return os.path.basename(next(builder.build(directory=sdist_directory, versions=[\"standard\"])))\n\n\ndef get_requires_for_build_wheel(config_settings: dict[str, Any] | None = None) -> list[str]: # noqa: ARG001\n \"\"\"\n https://peps.python.org/pep-0517/#get-requires-for-build-wheel\n \"\"\"\n from hatchling.builders.wheel import WheelBuilder\n\n builder = WheelBuilder(os.getcwd())\n return builder.config.dependencies\n\n\ndef build_wheel(\n wheel_directory: str,\n config_settings: dict[str, Any] | None = None, # noqa: ARG001\n metadata_directory: str | None = None, # noqa: ARG001\n) -> str:\n \"\"\"\n https://peps.python.org/pep-0517/#build-wheel\n \"\"\"\n from hatchling.builders.wheel import WheelBuilder\n\n builder = WheelBuilder(os.getcwd())\n return os.path.basename(next(builder.build(directory=wheel_directory, versions=[\"standard\"])))\n\n\ndef get_requires_for_build_editable(config_settings: dict[str, Any] | None = None) -> list[str]: # noqa: ARG001\n \"\"\"\n https://peps.python.org/pep-0660/#get-requires-for-build-editable\n \"\"\"\n from hatchling.builders.constants import EDITABLES_REQUIREMENT\n from hatchling.builders.wheel import WheelBuilder\n\n builder = WheelBuilder(os.getcwd())\n return [*builder.config.dependencies, EDITABLES_REQUIREMENT]\n\n\ndef build_editable(\n wheel_directory: str,\n config_settings: dict[str, Any] | None = None, # noqa: ARG001\n metadata_directory: str | None = None, # noqa: ARG001\n) -> str:\n \"\"\"\n https://peps.python.org/pep-0660/#build-editable\n \"\"\"\n from hatchling.builders.wheel import WheelBuilder\n\n builder = WheelBuilder(os.getcwd())\n return os.path.basename(next(builder.build(directory=wheel_directory, versions=[\"editable\"])))\n\n\n# Any builder that has build-time hooks like Hatchling and setuptools cannot technically keep PEP 517's identical\n# metadata promise e.g. C extensions would require different tags in the `WHEEL` file. Therefore, we consider the\n# methods as mostly being for non-frontend tools like tox and dependency updaters. So Hatchling only writes the\n# `METADATA` file to the metadata directory and continues to ignore that directory itself.\n#\n# An issue we encounter by supporting this metadata-only access is that for installations with pip the required\n# dependencies of the project are read at this stage. This means that build hooks that add to the `dependencies`\n# build data or modify the built wheel have no effect on what dependencies are or are not installed.\n#\n# There are legitimate use cases in which this is required, so we only define these when no pip build is detected.\n# See: https://github.com/pypa/pip/blob/22.2.2/src/pip/_internal/operations/build/build_tracker.py#L41-L51\n# Example use case: https://github.com/pypa/hatch/issues/532\nif \"PIP_BUILD_TRACKER\" not in os.environ:\n __all__ += [\"prepare_metadata_for_build_editable\", \"prepare_metadata_for_build_wheel\"]\n\n def prepare_metadata_for_build_wheel(\n metadata_directory: str,\n config_settings: dict[str, Any] | None = None, # noqa: ARG001\n ) -> str:\n \"\"\"\n https://peps.python.org/pep-0517/#prepare-metadata-for-build-wheel\n \"\"\"\n from hatchling.builders.wheel import WheelBuilder\n\n builder = WheelBuilder(os.getcwd())\n\n directory = os.path.join(metadata_directory, f\"{builder.artifact_project_id}.dist-info\")\n if not os.path.isdir(directory):\n os.mkdir(directory)\n\n with open(os.path.join(directory, \"METADATA\"), \"w\", encoding=\"utf-8\") as f:\n f.write(builder.config.core_metadata_constructor(builder.metadata))\n\n return os.path.basename(directory)\n\n def prepare_metadata_for_build_editable(\n metadata_directory: str,\n config_settings: dict[str, Any] | None = None, # noqa: ARG001\n ) -> str:\n \"\"\"\n https://peps.python.org/pep-0660/#prepare-metadata-for-build-editable\n \"\"\"\n from hatchling.builders.constants import EDITABLES_REQUIREMENT\n from hatchling.builders.wheel import WheelBuilder\n\n builder = WheelBuilder(os.getcwd())\n\n directory = os.path.join(metadata_directory, f\"{builder.artifact_project_id}.dist-info\")\n if not os.path.isdir(directory):\n os.mkdir(directory)\n\n extra_dependencies = []\n if not builder.config.dev_mode_dirs and builder.config.dev_mode_exact:\n extra_dependencies.append(EDITABLES_REQUIREMENT)\n\n with open(os.path.join(directory, \"METADATA\"), \"w\", encoding=\"utf-8\") as f:\n f.write(builder.config.core_metadata_constructor(builder.metadata, extra_dependencies=extra_dependencies))\n\n return os.path.basename(directory)\n"
},
{
"path": "backend/src/hatchling/builders/__init__.py",
"content": ""
},
{
"path": "backend/src/hatchling/builders/app.py",
"content": "from __future__ import annotations\n\nfrom typing import Any\n\nfrom hatchling.builders.binary import BinaryBuilder\n\n\nclass AppBuilder(BinaryBuilder):\n PLUGIN_NAME = \"app\"\n\n def build_bootstrap(\n self,\n directory: str,\n **build_data: Any,\n ) -> str:\n self.app.display_warning(\n \"The `app` build target is deprecated and will be removed in a future release. \"\n \"Use the `binary` build target instead.\"\n )\n return super().build_bootstrap(directory, **build_data)\n"
},
{
"path": "backend/src/hatchling/builders/binary.py",
"content": "from __future__ import annotations\n\nimport os\nimport sys\nfrom typing import TYPE_CHECKING, Any\n\nfrom hatchling.builders.config import BuilderConfig\nfrom hatchling.builders.plugin.interface import BuilderInterface\n\nif TYPE_CHECKING:\n from collections.abc import Callable\n\n\nclass BinaryBuilderConfig(BuilderConfig):\n SUPPORTED_VERSIONS = (\"3.12\", \"3.11\", \"3.10\", \"3.9\", \"3.8\", \"3.7\")\n\n def __init__(self, *args: Any, **kwargs: Any) -> None:\n super().__init__(*args, **kwargs)\n\n self.__scripts: list[str] | None = None\n self.__python_version: str | None = None\n self.__pyapp_version: str | None = None\n\n @property\n def scripts(self) -> list[str]:\n if self.__scripts is None:\n known_scripts = self.builder.metadata.core.scripts\n scripts = self.target_config.get(\"scripts\", [])\n\n if not isinstance(scripts, list):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.scripts` must be an array\"\n raise TypeError(message)\n\n for i, script in enumerate(scripts, 1):\n if not isinstance(script, str):\n message = (\n f\"Script #{i} of field `tool.hatch.build.targets.{self.plugin_name}.scripts` must be a string\"\n )\n raise TypeError(message)\n\n if script not in known_scripts:\n message = f\"Unknown script in field `tool.hatch.build.targets.{self.plugin_name}.scripts`: {script}\"\n raise ValueError(message)\n\n self.__scripts = sorted(set(scripts)) if scripts else list(known_scripts)\n\n return self.__scripts\n\n @property\n def python_version(self) -> str:\n if self.__python_version is None:\n python_version = self.target_config.get(\"python-version\", \"\")\n\n if not isinstance(python_version, str):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.python-version` must be a string\"\n raise TypeError(message)\n\n if not python_version and \"PYAPP_DISTRIBUTION_SOURCE\" not in os.environ:\n for supported_version in self.SUPPORTED_VERSIONS:\n if self.builder.metadata.core.python_constraint.contains(supported_version):\n python_version = supported_version\n break\n else:\n message = \"Field `project.requires-python` is incompatible with the known distributions\"\n raise ValueError(message)\n\n self.__python_version = python_version\n\n return self.__python_version\n\n @property\n def pyapp_version(self) -> str:\n if self.__pyapp_version is None:\n pyapp_version = self.target_config.get(\"pyapp-version\", \"\")\n\n if not isinstance(pyapp_version, str):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.pyapp-version` must be a string\"\n raise TypeError(message)\n\n self.__pyapp_version = pyapp_version\n\n return self.__pyapp_version\n\n\nclass BinaryBuilder(BuilderInterface):\n \"\"\"\n Build binaries\n \"\"\"\n\n PLUGIN_NAME = \"binary\"\n\n def get_version_api(self) -> dict[str, Callable]:\n return {\"bootstrap\": self.build_bootstrap}\n\n def get_default_versions(self) -> list[str]: # noqa: PLR6301\n return [\"bootstrap\"]\n\n def clean(\n self,\n directory: str,\n versions: list[str], # noqa: ARG002\n ) -> None:\n import shutil\n\n app_dir = os.path.join(directory, self.PLUGIN_NAME)\n if os.path.isdir(app_dir):\n shutil.rmtree(app_dir)\n\n def build_bootstrap(\n self,\n directory: str,\n **build_data: Any, # noqa: ARG002\n ) -> str:\n import shutil\n import tempfile\n\n cargo_path = os.environ.get(\"CARGO\", \"\")\n if not cargo_path:\n if not shutil.which(\"cargo\"):\n message = \"Executable `cargo` could not be found on PATH\"\n raise OSError(message)\n\n cargo_path = \"cargo\"\n\n app_dir = os.path.join(directory, self.PLUGIN_NAME)\n if not os.path.isdir(app_dir):\n os.makedirs(app_dir)\n\n on_windows = sys.platform == \"win32\"\n base_env = dict(os.environ)\n base_env[\"PYAPP_PROJECT_NAME\"] = self.metadata.name\n base_env[\"PYAPP_PROJECT_VERSION\"] = self.metadata.version\n\n if self.config.python_version:\n base_env[\"PYAPP_PYTHON_VERSION\"] = self.config.python_version\n\n # https://doc.rust-lang.org/cargo/reference/config.html#buildtarget\n build_target = os.environ.get(\"CARGO_BUILD_TARGET\", \"\")\n\n # This will determine whether we install from crates.io or build locally and is currently required for\n # cross compilation: https://github.com/cross-rs/cross/issues/1215\n repo_path = os.environ.get(\"PYAPP_REPO\", \"\")\n\n with tempfile.TemporaryDirectory() as temp_dir:\n exe_name = \"pyapp.exe\" if on_windows else \"pyapp\"\n if repo_path:\n context_dir = repo_path\n target_dir = os.path.join(temp_dir, \"build\")\n if build_target:\n temp_exe_path = os.path.join(target_dir, build_target, \"release\", exe_name)\n else:\n temp_exe_path = os.path.join(target_dir, \"release\", exe_name)\n install_command = [cargo_path, \"build\", \"--release\", \"--target-dir\", target_dir]\n else:\n context_dir = temp_dir\n temp_exe_path = os.path.join(temp_dir, \"bin\", exe_name)\n install_command = [cargo_path, \"install\", \"pyapp\", \"--force\", \"--root\", temp_dir]\n if self.config.pyapp_version:\n install_command.extend([\"--version\", self.config.pyapp_version])\n\n if self.config.scripts:\n for script in self.config.scripts:\n env = dict(base_env)\n env[\"PYAPP_EXEC_SPEC\"] = self.metadata.core.scripts[script]\n\n self.cargo_build(install_command, cwd=context_dir, env=env)\n\n exe_stem = (\n f\"{script}-{self.metadata.version}-{build_target}\"\n if build_target\n else f\"{script}-{self.metadata.version}\"\n )\n exe_path = os.path.join(app_dir, f\"{exe_stem}.exe\" if on_windows else exe_stem)\n shutil.move(temp_exe_path, exe_path)\n else:\n self.cargo_build(install_command, cwd=context_dir, env=base_env)\n\n exe_stem = (\n f\"{self.metadata.name}-{self.metadata.version}-{build_target}\"\n if build_target\n else f\"{self.metadata.name}-{self.metadata.version}\"\n )\n exe_path = os.path.join(app_dir, f\"{exe_stem}.exe\" if on_windows else exe_stem)\n shutil.move(temp_exe_path, exe_path)\n\n return app_dir\n\n def cargo_build(self, *args: Any, **kwargs: Any) -> None:\n import subprocess\n\n if self.app.verbosity < 0:\n kwargs[\"stdout\"] = subprocess.PIPE\n kwargs[\"stderr\"] = subprocess.STDOUT\n\n process = subprocess.run(*args, **kwargs) # noqa: PLW1510\n if process.returncode:\n message = f\"Compilation failed (code {process.returncode})\"\n raise OSError(message)\n\n @classmethod\n def get_config_class(cls) -> type[BinaryBuilderConfig]:\n return BinaryBuilderConfig\n"
},
{
"path": "backend/src/hatchling/builders/config.py",
"content": "from __future__ import annotations\n\nimport os\nfrom contextlib import contextmanager\nfrom functools import cached_property\nfrom typing import TYPE_CHECKING, Any, TypeVar\n\nimport pathspec\n\nfrom hatchling.builders.constants import DEFAULT_BUILD_DIRECTORY, EXCLUDED_DIRECTORIES, BuildEnvVars\nfrom hatchling.builders.utils import normalize_inclusion_map, normalize_relative_directory, normalize_relative_path\nfrom hatchling.metadata.utils import normalize_project_name\nfrom hatchling.utils.fs import locate_file\n\nif TYPE_CHECKING:\n from collections.abc import Generator\n\n from hatchling.builders.plugin.interface import BuilderInterface\n\n\nclass BuilderConfig:\n def __init__(\n self,\n builder: BuilderInterface,\n root: str,\n plugin_name: str,\n build_config: dict[str, Any],\n target_config: dict[str, Any],\n ) -> None:\n self.__builder = builder\n self.__root = root\n self.__plugin_name = plugin_name\n self.__build_config = build_config\n self.__target_config = target_config\n\n # This is used when the only file selection is based on forced inclusion or build-time artifacts. This\n # instructs to `exclude` every encountered path without doing pattern matching that matches everything.\n self.__exclude_all: bool = False\n\n # Modified at build time\n self.build_artifact_spec: pathspec.GitIgnoreSpec | None = None\n self.build_force_include: dict[str, str] = {}\n self.build_reserved_paths: set[str] = set()\n\n @property\n def builder(self) -> BuilderInterface:\n return self.__builder\n\n @property\n def root(self) -> str:\n return self.__root\n\n @property\n def plugin_name(self) -> str:\n return self.__plugin_name\n\n @property\n def build_config(self) -> dict[str, Any]:\n return self.__build_config\n\n @property\n def target_config(self) -> dict[str, Any]:\n return self.__target_config\n\n def include_path(self, relative_path: str, *, explicit: bool = False, is_package: bool = True) -> bool:\n return (\n self.path_is_build_artifact(relative_path)\n or self.path_is_artifact(relative_path)\n or (\n not (self.only_packages and not is_package)\n and not self.path_is_excluded(relative_path)\n and (explicit or self.path_is_included(relative_path))\n )\n )\n\n def path_is_included(self, relative_path: str) -> bool:\n if self.include_spec is None:\n return True\n\n return self.include_spec.match_file(relative_path)\n\n def path_is_excluded(self, relative_path: str) -> bool:\n if self.__exclude_all:\n return True\n\n if self.exclude_spec is None:\n return False\n\n return self.exclude_spec.match_file(relative_path)\n\n def path_is_artifact(self, relative_path: str) -> bool:\n if self.artifact_spec is None:\n return False\n\n return self.artifact_spec.match_file(relative_path)\n\n def path_is_build_artifact(self, relative_path: str) -> bool:\n if self.build_artifact_spec is None:\n return False\n\n return self.build_artifact_spec.match_file(relative_path)\n\n def path_is_reserved(self, relative_path: str) -> bool:\n return relative_path in self.build_reserved_paths\n\n def directory_is_excluded(self, name: str, relative_path: str) -> bool:\n if name in EXCLUDED_DIRECTORIES:\n return True\n\n relative_directory = os.path.join(relative_path, name)\n return (\n self.path_is_reserved(relative_directory)\n # The trailing slash is necessary so e.g. `bar/` matches `foo/bar`\n or (self.skip_excluded_dirs and self.path_is_excluded(f\"{relative_directory}/\"))\n )\n\n @cached_property\n def include_spec(self) -> pathspec.GitIgnoreSpec | None:\n if \"include\" in self.target_config:\n include_config = self.target_config\n include_location = f\"tool.hatch.build.targets.{self.plugin_name}.include\"\n else:\n include_config = self.build_config\n include_location = \"tool.hatch.build.include\"\n\n all_include_patterns = []\n\n include_patterns = include_config.get(\"include\", self.default_include())\n if not isinstance(include_patterns, list):\n message = f\"Field `{include_location}` must be an array of strings\"\n raise TypeError(message)\n\n for i, include_pattern in enumerate(include_patterns, 1):\n if not isinstance(include_pattern, str):\n message = f\"Pattern #{i} in field `{include_location}` must be a string\"\n raise TypeError(message)\n\n if not include_pattern:\n message = f\"Pattern #{i} in field `{include_location}` cannot be an empty string\"\n raise ValueError(message)\n\n all_include_patterns.append(include_pattern)\n\n # Matching only at the root requires a forward slash, back slashes do not work. As such,\n # normalize to forward slashes for consistency.\n all_include_patterns.extend(f\"/{relative_path.replace(os.sep, '/')}/\" for relative_path in self.packages)\n\n if all_include_patterns:\n return pathspec.GitIgnoreSpec.from_lines(all_include_patterns)\n return None\n\n @cached_property\n def exclude_spec(self) -> pathspec.GitIgnoreSpec | None:\n if \"exclude\" in self.target_config:\n exclude_config = self.target_config\n exclude_location = f\"tool.hatch.build.targets.{self.plugin_name}.exclude\"\n else:\n exclude_config = self.build_config\n exclude_location = \"tool.hatch.build.exclude\"\n\n all_exclude_patterns = self.default_global_exclude()\n\n if not self.ignore_vcs:\n all_exclude_patterns.extend(self.load_vcs_exclusion_patterns())\n\n exclude_patterns = exclude_config.get(\"exclude\", self.default_exclude())\n if not isinstance(exclude_patterns, list):\n message = f\"Field `{exclude_location}` must be an array of strings\"\n raise TypeError(message)\n\n for i, exclude_pattern in enumerate(exclude_patterns, 1):\n if not isinstance(exclude_pattern, str):\n message = f\"Pattern #{i} in field `{exclude_location}` must be a string\"\n raise TypeError(message)\n\n if not exclude_pattern:\n message = f\"Pattern #{i} in field `{exclude_location}` cannot be an empty string\"\n raise ValueError(message)\n\n all_exclude_patterns.append(exclude_pattern)\n\n if all_exclude_patterns:\n return pathspec.GitIgnoreSpec.from_lines(all_exclude_patterns)\n return None\n\n @property\n def artifact_spec(self) -> pathspec.GitIgnoreSpec | None:\n if \"artifacts\" in self.target_config:\n artifact_config = self.target_config\n artifact_location = f\"tool.hatch.build.targets.{self.plugin_name}.artifacts\"\n else:\n artifact_config = self.build_config\n artifact_location = \"tool.hatch.build.artifacts\"\n\n all_artifact_patterns = []\n\n artifact_patterns = artifact_config.get(\"artifacts\", [])\n if not isinstance(artifact_patterns, list):\n message = f\"Field `{artifact_location}` must be an array of strings\"\n raise TypeError(message)\n\n for i, artifact_pattern in enumerate(artifact_patterns, 1):\n if not isinstance(artifact_pattern, str):\n message = f\"Pattern #{i} in field `{artifact_location}` must be a string\"\n raise TypeError(message)\n\n if not artifact_pattern:\n message = f\"Pattern #{i} in field `{artifact_location}` cannot be an empty string\"\n raise ValueError(message)\n\n all_artifact_patterns.append(artifact_pattern)\n\n if all_artifact_patterns:\n return pathspec.GitIgnoreSpec.from_lines(all_artifact_patterns)\n return None\n\n @cached_property\n def hook_config(self) -> dict[str, Any]:\n hook_config: dict[str, dict[str, Any]] = {}\n\n global_hook_config = self.build_config.get(\"hooks\", {})\n if not isinstance(global_hook_config, dict):\n message = \"Field `tool.hatch.build.hooks` must be a table\"\n raise TypeError(message)\n\n for hook_name, config in global_hook_config.items():\n if not isinstance(config, dict):\n message = f\"Field `tool.hatch.build.hooks.{hook_name}` must be a table\"\n raise TypeError(message)\n\n hook_config.setdefault(hook_name, config)\n\n target_hook_config = self.target_config.get(\"hooks\", {})\n if not isinstance(target_hook_config, dict):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.hooks` must be a table\"\n raise TypeError(message)\n\n for hook_name, config in target_hook_config.items():\n if not isinstance(config, dict):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.hooks.{hook_name}` must be a table\"\n raise TypeError(message)\n\n hook_config[hook_name] = config\n\n if not env_var_enabled(BuildEnvVars.NO_HOOKS):\n all_hooks_enabled = env_var_enabled(BuildEnvVars.HOOKS_ENABLE)\n final_hook_config = {\n hook_name: config\n for hook_name, config in hook_config.items()\n if (\n all_hooks_enabled\n or config.get(\"enable-by-default\", True)\n or env_var_enabled(f\"{BuildEnvVars.HOOK_ENABLE_PREFIX}{hook_name.upper()}\")\n )\n }\n else:\n final_hook_config = {}\n\n return final_hook_config\n\n @cached_property\n def directory(self) -> str:\n if \"directory\" in self.target_config:\n directory = self.target_config[\"directory\"]\n if not isinstance(directory, str):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.directory` must be a string\"\n raise TypeError(message)\n else:\n directory = self.build_config.get(\"directory\", DEFAULT_BUILD_DIRECTORY)\n if not isinstance(directory, str):\n message = \"Field `tool.hatch.build.directory` must be a string\"\n raise TypeError(message)\n\n return self.normalize_build_directory(directory)\n\n @cached_property\n def skip_excluded_dirs(self) -> bool:\n if \"skip-excluded-dirs\" in self.target_config:\n skip_excluded_dirs = self.target_config[\"skip-excluded-dirs\"]\n if not isinstance(skip_excluded_dirs, bool):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.skip-excluded-dirs` must be a boolean\"\n raise TypeError(message)\n else:\n skip_excluded_dirs = self.build_config.get(\"skip-excluded-dirs\", False)\n if not isinstance(skip_excluded_dirs, bool):\n message = \"Field `tool.hatch.build.skip-excluded-dirs` must be a boolean\"\n raise TypeError(message)\n\n return skip_excluded_dirs\n\n @cached_property\n def ignore_vcs(self) -> bool:\n if \"ignore-vcs\" in self.target_config:\n ignore_vcs = self.target_config[\"ignore-vcs\"]\n if not isinstance(ignore_vcs, bool):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.ignore-vcs` must be a boolean\"\n raise TypeError(message)\n else:\n ignore_vcs = self.build_config.get(\"ignore-vcs\", False)\n if not isinstance(ignore_vcs, bool):\n message = \"Field `tool.hatch.build.ignore-vcs` must be a boolean\"\n raise TypeError(message)\n\n return ignore_vcs\n\n @cached_property\n def require_runtime_dependencies(self) -> bool:\n if \"require-runtime-dependencies\" in self.target_config:\n require_runtime_dependencies = self.target_config[\"require-runtime-dependencies\"]\n if not isinstance(require_runtime_dependencies, bool):\n message = (\n f\"Field `tool.hatch.build.targets.{self.plugin_name}.require-runtime-dependencies` \"\n f\"must be a boolean\"\n )\n raise TypeError(message)\n else:\n require_runtime_dependencies = self.build_config.get(\"require-runtime-dependencies\", False)\n if not isinstance(require_runtime_dependencies, bool):\n message = \"Field `tool.hatch.build.require-runtime-dependencies` must be a boolean\"\n raise TypeError(message)\n\n return require_runtime_dependencies\n\n @cached_property\n def require_runtime_features(self) -> list[str]:\n if \"require-runtime-features\" in self.target_config:\n features_config = self.target_config\n features_location = f\"tool.hatch.build.targets.{self.plugin_name}.require-runtime-features\"\n else:\n features_config = self.build_config\n features_location = \"tool.hatch.build.require-runtime-features\"\n\n require_runtime_features = features_config.get(\"require-runtime-features\", [])\n if not isinstance(require_runtime_features, list):\n message = f\"Field `{features_location}` must be an array\"\n raise TypeError(message)\n\n all_features: dict[str, None] = {}\n for i, raw_feature in enumerate(require_runtime_features, 1):\n if not isinstance(raw_feature, str):\n message = f\"Feature #{i} of field `{features_location}` must be a string\"\n raise TypeError(message)\n\n if not raw_feature:\n message = f\"Feature #{i} of field `{features_location}` cannot be an empty string\"\n raise ValueError(message)\n\n feature = normalize_project_name(raw_feature)\n if feature not in self.builder.metadata.core.optional_dependencies:\n message = (\n f\"Feature `{feature}` of field `{features_location}` is not defined in \"\n f\"field `project.optional-dependencies`\"\n )\n raise ValueError(message)\n\n all_features[feature] = None\n\n return list(all_features)\n\n @cached_property\n def only_packages(self) -> bool:\n \"\"\"\n Whether or not the target should ignore non-artifact files that do not reside within a Python package.\n \"\"\"\n if \"only-packages\" in self.target_config:\n only_packages = self.target_config[\"only-packages\"]\n if not isinstance(only_packages, bool):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.only-packages` must be a boolean\"\n raise TypeError(message)\n else:\n only_packages = self.build_config.get(\"only-packages\", False)\n if not isinstance(only_packages, bool):\n message = \"Field `tool.hatch.build.only-packages` must be a boolean\"\n raise TypeError(message)\n\n return only_packages\n\n @cached_property\n def reproducible(self) -> bool:\n \"\"\"\n Whether or not the target should be built in a reproducible manner, defaulting to true.\n \"\"\"\n if \"reproducible\" in self.target_config:\n reproducible = self.target_config[\"reproducible\"]\n if not isinstance(reproducible, bool):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.reproducible` must be a boolean\"\n raise TypeError(message)\n else:\n reproducible = self.build_config.get(\"reproducible\", True)\n if not isinstance(reproducible, bool):\n message = \"Field `tool.hatch.build.reproducible` must be a boolean\"\n raise TypeError(message)\n\n return reproducible\n\n @cached_property\n def dev_mode_dirs(self) -> list[str]:\n \"\"\"\n Directories which must be added to Python's search path in\n [dev mode](../config/environment/overview.md#dev-mode).\n \"\"\"\n if \"dev-mode-dirs\" in self.target_config:\n dev_mode_dirs_config = self.target_config\n dev_mode_dirs_location = f\"tool.hatch.build.targets.{self.plugin_name}.dev-mode-dirs\"\n else:\n dev_mode_dirs_config = self.build_config\n dev_mode_dirs_location = \"tool.hatch.build.dev-mode-dirs\"\n\n all_dev_mode_dirs = []\n\n dev_mode_dirs = dev_mode_dirs_config.get(\"dev-mode-dirs\", [])\n if not isinstance(dev_mode_dirs, list):\n message = f\"Field `{dev_mode_dirs_location}` must be an array of strings\"\n raise TypeError(message)\n\n for i, dev_mode_dir in enumerate(dev_mode_dirs, 1):\n if not isinstance(dev_mode_dir, str):\n message = f\"Directory #{i} in field `{dev_mode_dirs_location}` must be a string\"\n raise TypeError(message)\n\n if not dev_mode_dir:\n message = f\"Directory #{i} in field `{dev_mode_dirs_location}` cannot be an empty string\"\n raise ValueError(message)\n\n all_dev_mode_dirs.append(dev_mode_dir)\n\n return all_dev_mode_dirs\n\n @cached_property\n def dev_mode_exact(self) -> bool:\n if \"dev-mode-exact\" in self.target_config:\n dev_mode_exact = self.target_config[\"dev-mode-exact\"]\n if not isinstance(dev_mode_exact, bool):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.dev-mode-exact` must be a boolean\"\n raise TypeError(message)\n else:\n dev_mode_exact = self.build_config.get(\"dev-mode-exact\", False)\n if not isinstance(dev_mode_exact, bool):\n message = \"Field `tool.hatch.build.dev-mode-exact` must be a boolean\"\n raise TypeError(message)\n\n return dev_mode_exact\n\n @cached_property\n def versions(self) -> list[str]:\n # Used as an ordered set\n all_versions: dict[str, None] = {}\n\n versions = self.target_config.get(\"versions\", [])\n if not isinstance(versions, list):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.versions` must be an array of strings\"\n raise TypeError(message)\n\n for i, version in enumerate(versions, 1):\n if not isinstance(version, str):\n message = (\n f\"Version #{i} in field `tool.hatch.build.targets.{self.plugin_name}.versions` must be a string\"\n )\n raise TypeError(message)\n\n if not version:\n message = (\n f\"Version #{i} in field `tool.hatch.build.targets.{self.plugin_name}.versions` \"\n f\"cannot be an empty string\"\n )\n raise ValueError(message)\n\n all_versions[version] = None\n\n if not all_versions:\n default_versions = self.__builder.get_default_versions()\n for version in default_versions:\n all_versions[version] = None\n else:\n unknown_versions = set(all_versions) - set(self.__builder.get_version_api())\n if unknown_versions:\n message = (\n f\"Unknown versions in field `tool.hatch.build.targets.{self.plugin_name}.versions`: \"\n f\"{', '.join(map(str, sorted(unknown_versions)))}\"\n )\n raise ValueError(message)\n\n return list(all_versions)\n\n @cached_property\n def dependencies(self) -> list[str]:\n # Used as an ordered set\n dependencies: dict[str, None] = {}\n\n target_dependencies = self.target_config.get(\"dependencies\", [])\n if not isinstance(target_dependencies, list):\n message = f\"Field `tool.hatch.build.targets.{self.plugin_name}.dependencies` must be an array\"\n raise TypeError(message)\n\n for i, dependency in enumerate(target_dependencies, 1):\n if not isinstance(dependency, str):\n message = (\n f\"Dependency #{i} of field `tool.hatch.build.targets.{self.plugin_name}.dependencies` \"\n f\"must be a string\"\n )\n raise TypeError(message)\n\n dependencies[dependency] = None\n\n global_dependencies = self.build_config.get(\"dependencies\", [])\n if not isinstance(global_dependencies, list):\n message = \"Field `tool.hatch.build.dependencies` must be an array\"\n raise TypeError(message)\n\n for i, dependency in enumerate(global_dependencies, 1):\n if not isinstance(dependency, str):\n message = f\"Dependency #{i} of field `tool.hatch.build.dependencies` must be a string\"\n raise TypeError(message)\n\n dependencies[dependency] = None\n\n require_runtime_dependencies = self.require_runtime_dependencies\n require_runtime_features = dict.fromkeys(self.require_runtime_features)\n for hook_name, config in self.hook_config.items():\n hook_require_runtime_dependencies = config.get(\"require-runtime-dependencies\", False)\n if not isinstance(hook_require_runtime_dependencies, bool):\n message = f\"Option `require-runtime-dependencies` of build hook `{hook_name}` must be a boolean\"\n raise TypeError(message)\n\n if hook_require_runtime_dependencies:\n require_runtime_dependencies = True\n\n hook_require_runtime_features = config.get(\"require-runtime-features\", [])\n if not isinstance(hook_require_runtime_features, list):\n message = f\"Option `require-runtime-features` of build hook `{hook_name}` must be an array\"\n raise TypeError(message)\n\n for i, raw_feature in enumerate(hook_require_runtime_features, 1):\n if not isinstance(raw_feature, str):\n message = (\n f\"Feature #{i} of option `require-runtime-features` of build hook `{hook_name}` \"\n f\"must be a string\"\n )\n raise TypeError(message)\n\n if not raw_feature:\n message = (\n f\"Feature #{i} of option `require-runtime-features` of build hook `{hook_name}` \"\n f\"cannot be an empty string\"\n )\n raise ValueError(message)\n\n feature = normalize_project_name(raw_feature)\n if feature not in self.builder.metadata.core.optional_dependencies:\n message = (\n f\"Feature `{feature}` of option `require-runtime-features` of build hook `{hook_name}` \"\n f\"is not defined in field `project.optional-dependencies`\"\n )\n raise ValueError(message)\n\n require_runtime_features[feature] = None\n\n hook_dependencies = config.get(\"dependencies\", [])\n if not isinstance(hook_dependencies, list):\n message = f\"Option `dependencies` of build hook `{hook_name}` must be an array\"\n raise TypeError(message)\n\n for i, dependency in enumerate(hook_dependencies, 1):\n if not isinstance(dependency, str):\n message = f\"Dependency #{i} of option `dependencies` of build hook `{hook_name}` must be a string\"\n raise TypeError(message)\n\n dependencies[dependency] = None\n\n if require_runtime_dependencies:\n for dependency in self.builder.metadata.core.dependencies:\n dependencies[dependency] = None\n\n if require_runtime_features:\n for feature in require_runtime_features:\n for dependency in self.builder.metadata.core.optional_dependencies[feature]:\n dependencies[dependency] = None\n\n for dependency in self.dynamic_dependencies:\n dependencies[dependency] = None\n\n return list(dependencies)\n\n @cached_property\n def dynamic_dependencies(self) -> list[str]:\n dependencies = []\n for hook_name, config in self.hook_config.items():\n build_hook_cls = self.builder.plugin_manager.build_hook.get(hook_name)\n if build_hook_cls is None:\n continue\n\n # Hook exists but dynamic dependencies are not imported lazily.\n # This happens for example when using the `custom` build hook.\n try:\n build_hook = build_hook_cls(\n self.root, config, self, self.builder.metadata, \"\", self.builder.PLUGIN_NAME, self.builder.app\n )\n except ImportError:\n continue\n\n dependencies.extend(build_hook.dependencies())\n\n return dependencies\n\n @cached_property\n def sources(self) -> dict[str, str]:\n if \"sources\" in self.target_config:\n sources_config = self.target_config\n sources_location = f\"tool.hatch.build.targets.{self.plugin_name}.sources\"\n else:\n sources_config = self.build_config\n sources_location = \"tool.hatch.build.sources\"\n\n sources = {}\n\n raw_sources = sources_config.get(\"sources\", [])\n if isinstance(raw_sources, list):\n for i, source in enumerate(raw_sources, 1):\n if not isinstance(source, str):\n message = f\"Source #{i} in field `{sources_location}` must be a string\"\n raise TypeError(message)\n\n if not source:\n message = f\"Source #{i} in field `{sources_location}` cannot be an empty string\"\n raise ValueError(message)\n\n sources[normalize_relative_directory(source)] = \"\"\n elif isinstance(raw_sources, dict):\n for source, path in raw_sources.items():\n if not isinstance(path, str):\n message = f\"Path for source `{source}` in field `{sources_location}` must be a string\"\n raise TypeError(message)\n\n normalized_path = normalize_relative_path(path)\n if normalized_path == \".\":\n normalized_path = \"\"\n else:\n normalized_path += os.sep\n\n sources[normalize_relative_directory(source) if source else source] = normalized_path\n else:\n message = f\"Field `{sources_location}` must be a mapping or array of strings\"\n raise TypeError(message)\n\n for relative_path in self.packages:\n source, _package = os.path.split(relative_path)\n if source and normalize_relative_directory(relative_path) not in sources:\n sources[normalize_relative_directory(source)] = \"\"\n\n return dict(sorted(sources.items()))\n\n @cached_property\n def packages(self) -> list[str]:\n if \"packages\" in self.target_config:\n package_config = self.target_config\n package_location = f\"tool.hatch.build.targets.{self.plugin_name}.packages\"\n else:\n package_config = self.build_config\n package_location = \"tool.hatch.build.packages\"\n\n packages = package_config.get(\"packages\", self.default_packages())\n if not isinstance(packages, list):\n message = f\"Field `{package_location}` must be an array of strings\"\n raise TypeError(message)\n\n for i, package in enumerate(packages, 1):\n if not isinstance(package, str):\n message = f\"Package #{i} in field `{package_location}` must be a string\"\n raise TypeError(message)\n\n if not package:\n message = f\"Package #{i} in field `{package_location}` cannot be an empty string\"\n raise ValueError(message)\n\n return sorted(normalize_relative_path(package) for package in packages)\n\n @cached_property\n def force_include(self) -> dict[str, str]:\n if \"force-include\" in self.target_config:\n force_include_config = self.target_config\n force_include_location = f\"tool.hatch.build.targets.{self.plugin_name}.force-include\"\n else:\n force_include_config = self.build_config\n force_include_location = \"tool.hatch.build.force-include\"\n\n force_include = force_include_config.get(\"force-include\", {})\n if not isinstance(force_include, dict):\n message = f\"Field `{force_include_location}` must be a mapping\"\n raise TypeError(message)\n\n for i, (source, relative_path) in enumerate(force_include.items(), 1):\n if not source:\n message = f\"Source #{i} in field `{force_include_location}` cannot be an empty string\"\n raise ValueError(message)\n\n if not isinstance(relative_path, str):\n message = f\"Path for source `{source}` in field `{force_include_location}` must be a string\"\n raise TypeError(message)\n\n if not relative_path:\n message = f\"Path for source `{source}` in field `{force_include_location}` cannot be an empty string\"\n raise ValueError(message)\n\n return normalize_inclusion_map(force_include, self.root)\n\n @cached_property\n def only_include(self) -> dict[str, str]:\n if \"only-include\" in self.target_config:\n only_include_config = self.target_config\n only_include_location = f\"tool.hatch.build.targets.{self.plugin_name}.only-include\"\n else:\n only_include_config = self.build_config\n only_include_location = \"tool.hatch.build.only-include\"\n\n only_include = only_include_config.get(\"only-include\", self.default_only_include()) or self.packages\n if not isinstance(only_include, list):\n message = f\"Field `{only_include_location}` must be an array\"\n raise TypeError(message)\n\n inclusion_map = {}\n\n for i, relative_path in enumerate(only_include, 1):\n if not isinstance(relative_path, str):\n message = f\"Path #{i} in field `{only_include_location}` must be a string\"\n raise TypeError(message)\n\n normalized_path = normalize_relative_path(relative_path)\n if not normalized_path or normalized_path.startswith((\"~\", \"..\")):\n message = f\"Path #{i} in field `{only_include_location}` must be relative: {relative_path}\"\n raise ValueError(message)\n\n if normalized_path in inclusion_map:\n message = f\"Duplicate path in field `{only_include_location}`: {normalized_path}\"\n raise ValueError(message)\n\n inclusion_map[normalized_path] = normalized_path\n\n return normalize_inclusion_map(inclusion_map, self.root)\n\n def get_distribution_path(self, relative_path: str) -> str:\n # src/foo/bar.py -> foo/bar.py\n for source, replacement in self.sources.items():\n if not source:\n return replacement + relative_path\n\n if relative_path.startswith(source):\n return relative_path.replace(source, replacement, 1)\n\n return relative_path\n\n @cached_property\n def vcs_exclusion_files(self) -> dict[str, list[str]]:\n exclusion_files: dict[str, list[str]] = {\"git\": [], \"hg\": []}\n\n local_gitignore = locate_file(self.root, \".gitignore\", boundary=\".git\")\n if local_gitignore is not None:\n exclusion_files[\"git\"].append(local_gitignore)\n\n local_hgignore = locate_file(self.root, \".hgignore\", boundary=\".hg\")\n if local_hgignore is not None:\n exclusion_files[\"hg\"].append(local_hgignore)\n\n return exclusion_files\n\n def load_vcs_exclusion_patterns(self) -> list[str]:\n patterns = []\n\n # https://git-scm.com/docs/gitignore#_pattern_format\n for exclusion_file in self.vcs_exclusion_files[\"git\"]:\n with open(exclusion_file, encoding=\"utf-8\") as f:\n patterns.extend(f.readlines())\n\n # https://linux.die.net/man/5/hgignore\n for exclusion_file in self.vcs_exclusion_files[\"hg\"]:\n with open(exclusion_file, encoding=\"utf-8\") as f:\n glob_mode = False\n for line in f:\n exact_line = line.strip()\n if exact_line == \"syntax: glob\":\n glob_mode = True\n continue\n\n if exact_line.startswith(\"syntax: \"):\n glob_mode = False\n continue\n\n if glob_mode:\n patterns.append(line)\n\n # validate project root is not excluded by vcs\n exclude_spec = pathspec.GitIgnoreSpec.from_lines(patterns)\n if exclude_spec.match_file(self.root):\n return []\n\n return patterns\n\n def normalize_build_directory(self, build_directory: str) -> str:\n if not os.path.isabs(build_directory):\n build_directory = os.path.join(self.root, build_directory)\n\n return os.path.normpath(build_directory)\n\n def default_include(self) -> list: # noqa: PLR6301\n return []\n\n def default_exclude(self) -> list: # noqa: PLR6301\n return []\n\n def default_packages(self) -> list: # noqa: PLR6301\n return []\n\n def default_only_include(self) -> list: # noqa: PLR6301\n return []\n\n def default_global_exclude(self) -> list[str]: # noqa: PLR6301\n patterns = [\"*.py[cdo]\", f\"/{DEFAULT_BUILD_DIRECTORY}\"]\n patterns.sort()\n return patterns\n\n def set_exclude_all(self) -> None:\n self.__exclude_all = True\n\n def get_force_include(self) -> dict[str, str]:\n force_include = self.force_include.copy()\n force_include.update(self.build_force_include)\n return force_include\n\n @contextmanager\n def set_build_data(self, build_data: dict[str, Any]) -> Generator:\n try:\n # Include anything the hooks indicate\n build_artifacts = build_data[\"artifacts\"]\n if build_artifacts:\n self.build_artifact_spec = pathspec.GitIgnoreSpec.from_lines(build_artifacts)\n\n self.build_force_include.update(normalize_inclusion_map(build_data[\"force_include\"], self.root))\n\n for inclusion_map in (self.force_include, self.build_force_include):\n for source, target in inclusion_map.items():\n # Ignore source\n # old/ -> new/\n # old.ext -> new.ext\n if source.startswith(f\"{self.root}{os.sep}\"):\n self.build_reserved_paths.add(self.get_distribution_path(os.path.relpath(source, self.root)))\n # Ignore target files only\n # ../out.ext -> ../in.ext\n elif os.path.isfile(source):\n self.build_reserved_paths.add(self.get_distribution_path(target))\n\n yield\n finally:\n self.build_artifact_spec = None\n self.build_force_include.clear()\n self.build_reserved_paths.clear()\n\n\ndef env_var_enabled(env_var: str, *, default: bool = False) -> bool:\n if env_var in os.environ:\n return os.environ[env_var] in {\"1\", \"true\"}\n\n return default\n\n\nBuilderConfigBound = TypeVar(\"BuilderConfigBound\", bound=BuilderConfig)\n"
},
{
"path": "backend/src/hatchling/builders/constants.py",
"content": "DEFAULT_BUILD_DIRECTORY = \"dist\"\n\nEXCLUDED_DIRECTORIES = frozenset((\n # Python bytecode\n \"__pycache__\",\n # Single virtual environment\n \".venv\",\n # Git\n \".git\",\n # Mercurial\n \".hg\",\n # Hatch\n \".hatch\",\n # tox\n \".tox\",\n # nox\n \".nox\",\n # Ruff\n \".ruff_cache\",\n # pytest\n \".pytest_cache\",\n # Mypy\n \".mypy_cache\",\n # pixi\n \".pixi\",\n))\nEXCLUDED_FILES = frozenset((\n # https://en.wikipedia.org/wiki/.DS_Store\n \".DS_Store\",\n))\n\n\nclass BuildEnvVars:\n LOCATION = \"HATCH_BUILD_LOCATION\"\n HOOKS_ONLY = \"HATCH_BUILD_HOOKS_ONLY\"\n NO_HOOKS = \"HATCH_BUILD_NO_HOOKS\"\n HOOKS_ENABLE = \"HATCH_BUILD_HOOKS_ENABLE\"\n HOOK_ENABLE_PREFIX = \"HATCH_BUILD_HOOK_ENABLE_\"\n CLEAN = \"HATCH_BUILD_CLEAN\"\n CLEAN_HOOKS_AFTER = \"HATCH_BUILD_CLEAN_HOOKS_AFTER\"\n\n\nEDITABLES_REQUIREMENT = \"editables~=0.3\"\n"
},
{
"path": "backend/src/hatchling/builders/custom.py",
"content": "from __future__ import annotations\n\nimport os\nfrom typing import TYPE_CHECKING, Any, Generic\n\nfrom hatchling.builders.plugin.interface import BuilderInterface\nfrom hatchling.metadata.core import ProjectMetadata\nfrom hatchling.plugin.manager import PluginManagerBound\nfrom hatchling.plugin.utils import load_plugin_from_script\nfrom hatchling.utils.constants import DEFAULT_BUILD_SCRIPT\n\nif TYPE_CHECKING:\n from hatchling.bridge.app import Application\n\n\nclass CustomBuilder(Generic[PluginManagerBound]):\n PLUGIN_NAME = \"custom\"\n\n def __new__( # type: ignore[misc]\n cls,\n root: str,\n plugin_manager: PluginManagerBound | None = None,\n config: dict[str, Any] | None = None,\n metadata: ProjectMetadata | None = None,\n app: Application | None = None,\n ) -> BuilderInterface:\n project_metadata = ProjectMetadata(root, plugin_manager, config)\n\n target_config = project_metadata.hatch.build_targets.get(cls.PLUGIN_NAME, {})\n if not isinstance(target_config, dict):\n message = f\"Field `tool.hatch.build.targets.{cls.PLUGIN_NAME}` must be a table\"\n raise TypeError(message)\n\n build_script = target_config.get(\"path\", DEFAULT_BUILD_SCRIPT)\n if not isinstance(build_script, str):\n message = f\"Option `path` for builder `{cls.PLUGIN_NAME}` must be a string\"\n raise TypeError(message)\n\n if not build_script:\n message = f\"Option `path` for builder `{cls.PLUGIN_NAME}` must not be empty if defined\"\n raise ValueError(message)\n\n path = os.path.normpath(os.path.join(root, build_script))\n if not os.path.isfile(path):\n message = f\"Build script does not exist: {build_script}\"\n raise OSError(message)\n\n hook_class = load_plugin_from_script(path, build_script, BuilderInterface, \"builder\") # type: ignore[type-abstract]\n hook = hook_class(root, plugin_manager=plugin_manager, config=config, metadata=metadata, app=app)\n\n # Always keep the name to avoid confusion\n hook.PLUGIN_NAME = cls.PLUGIN_NAME\n\n return hook\n"
},
{
"path": "backend/src/hatchling/builders/hooks/__init__.py",
"content": ""
},
{
"path": "backend/src/hatchling/builders/hooks/custom.py",
"content": "from __future__ import annotations\n\nimport os\nfrom typing import Any\n\nfrom hatchling.builders.hooks.plugin.interface import BuildHookInterface\nfrom hatchling.plugin.utils import load_plugin_from_script\nfrom hatchling.utils.constants import DEFAULT_BUILD_SCRIPT\n\n\nclass CustomBuildHook:\n PLUGIN_NAME = \"custom\"\n\n def __new__( # type: ignore[misc]\n cls,\n root: str,\n config: dict[str, Any],\n *args: Any,\n **kwargs: Any,\n ) -> BuildHookInterface:\n build_script = config.get(\"path\", DEFAULT_BUILD_SCRIPT)\n if not isinstance(build_script, str):\n message = f\"Option `path` for build hook `{cls.PLUGIN_NAME}` must be a string\"\n raise TypeError(message)\n\n if not build_script:\n message = f\"Option `path` for build hook `{cls.PLUGIN_NAME}` must not be empty if defined\"\n raise ValueError(message)\n\n path = os.path.normpath(os.path.join(root, build_script))\n if not os.path.isfile(path):\n message = f\"Build script does not exist: {build_script}\"\n raise OSError(message)\n\n hook_class = load_plugin_from_script(path, build_script, BuildHookInterface, \"build_hook\")\n hook = hook_class(root, config, *args, **kwargs)\n\n # Always keep the name to avoid confusion\n hook.PLUGIN_NAME = cls.PLUGIN_NAME\n\n return hook\n"
},
{
"path": "backend/src/hatchling/builders/hooks/plugin/__init__.py",
"content": ""
},
{
"path": "backend/src/hatchling/builders/hooks/plugin/hooks.py",
"content": "from __future__ import annotations\n\nimport typing\n\nfrom hatchling.builders.hooks.custom import CustomBuildHook\nfrom hatchling.builders.hooks.version import VersionBuildHook\nfrom hatchling.plugin import hookimpl\n\nif typing.TYPE_CHECKING:\n from hatchling.builders.hooks.plugin.interface import BuildHookInterface\n\n\n@hookimpl\ndef hatch_register_build_hook() -> list[type[BuildHookInterface]]:\n return [CustomBuildHook, VersionBuildHook]\n"
},
{
"path": "backend/src/hatchling/builders/hooks/plugin/interface.py",
"content": "from __future__ import annotations\n\nfrom typing import TYPE_CHECKING, Any, Generic, cast\n\nfrom hatchling.builders.config import BuilderConfigBound\n\nif TYPE_CHECKING:\n from hatchling.bridge.app import Application\n from hatchling.metadata.core import ProjectMetadata\n\n\nclass BuildHookInterface(Generic[BuilderConfigBound]): # no cov\n \"\"\"\n Example usage:\n\n ```python tab=\"plugin.py\"\n from hatchling.builders.hooks.plugin.interface import BuildHookInterface\n\n\n class SpecialBuildHook(BuildHookInterface):\n PLUGIN_NAME = \"special\"\n ...\n ```\n\n ```python tab=\"hooks.py\"\n from hatchling.plugin import hookimpl\n\n from .plugin import SpecialBuildHook\n\n\n @hookimpl\n def hatch_register_build_hook():\n return SpecialBuildHook\n ```\n \"\"\"\n\n PLUGIN_NAME = \"\"\n \"\"\"The name used for selection.\"\"\"\n\n def __init__(\n self,\n root: str,\n config: dict[str, Any],\n build_config: BuilderConfigBound,\n metadata: ProjectMetadata,\n directory: str,\n target_name: str,\n app: Application | None = None,\n ) -> None:\n self.__root = root\n self.__config = config\n self.__build_config = build_config\n self.__metadata = metadata\n self.__directory = directory\n self.__target_name = target_name\n self.__app = app\n\n @property\n def app(self) -> Application:\n \"\"\"\n An instance of [Application](../utilities.md#hatchling.bridge.app.Application).\n \"\"\"\n if self.__app is None:\n from hatchling.bridge.app import Application\n\n self.__app = cast(Application, Application().get_safe_application())\n\n return self.__app\n\n @property\n def root(self) -> str:\n \"\"\"\n The root of the project tree.\n \"\"\"\n return self.__root\n\n @property\n def config(self) -> dict[str, Any]:\n \"\"\"\n The cumulative hook configuration.\n\n ```toml config-example\n [tool.hatch.build.hooks.\n\n| | |\n| --- | --- |\n| Package | [](https://pypi.org/project/hatchling/) [](https://pypi.org/project/hatchling/) [](https://pypi.org/project/hatchling/) |\n| Meta | [](https://github.com/pypa/hatch) [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/ofek) |\n\n\n {% if config.copyright %}\n \n Material for MkDocs\n \n {% endif %}\n
\n"
},
{
"path": "docs/.snippets/abbrs.txt",
"content": "*[PyPI]: Python Package Index\n"
},
{
"path": "docs/.snippets/links.txt",
"content": "[PEP 440 version specifiers]: https://peps.python.org/pep-0440/#version-specifiers\n[PEP 508]: https://peps.python.org/pep-0508/\n[PEP 517]: https://peps.python.org/pep-0517/\n[PEP 639]: https://peps.python.org/pep-0639/\n[PEP 660]: https://peps.python.org/pep-0660/\n[PEP 665]: https://peps.python.org/pep-0665/\n[project metadata standard]: https://packaging.python.org/en/latest/specifications/pyproject-toml/#declaring-project-metadata-the-project-table\n"
},
{
"path": "docs/assets/badge/v0.json",
"content": "{\"schemaVersion\":1,\"label\":\"\",\"message\":\"Hatch\",\"labelColor\":\"grey\",\"color\":\"#4051b5\",\"logoSvg\":\"\"}"
},
{
"path": "docs/assets/css/custom.css",
"content": ":root > * {\n /* Use font but disable ligatures, see https://github.com/pypa/hatch/issues/104 */\n font-variant-ligatures: none;\n}\n\n/* Brighter links for dark mode */\n[data-md-color-scheme=slate] {\n /* https://github.com/squidfunk/mkdocs-material/blob/9.1.2/src/assets/stylesheets/main/_colors.scss#L91-L92 */\n --md-typeset-a-color: var(--md-primary-fg-color--light);\n}\n\n/* FiraCode https://github.com/tonsky/FiraCode */\ncode { font-family: 'Fira Code', monospace; }\n@supports (font-variation-settings: normal) {\n code { font-family: 'Fira Code VF', monospace; }\n}\n\n/* https://github.com/squidfunk/mkdocs-material/issues/1522 */\n.md-typeset h5 {\n color: var(--md-default-fg-color);\n text-transform: none;\n}\n"
},
{
"path": "docs/blog/.authors.yml",
"content": "authors:\n ofek:\n name: Ofek Lev\n description: Creator\n avatar: https://avatars.githubusercontent.com/u/9677399\n flying-sheep:\n name: Phil A.\n description: Contributor\n avatar: https://avatars.githubusercontent.com/u/291575\n cjames23:\n name: Cary Hawkins\n description: Co-maintainer\n avatar: https://avatars.githubusercontent.com/u/8369962?v=4\n"
},
{
"path": "docs/blog/index.md",
"content": "# Blog\n"
},
{
"path": "docs/blog/posts/release-hatch-1100.md",
"content": "---\ndate: 2024-05-02\nauthors: [ofek,flying-sheep]\ndescription: >-\n Hatch v1.10.0 brings a test command, support for UV, and a Python script runner.\ncategories:\n - Release\n---\n\n# Hatch v1.10.0\n\nHatch [v1.10.0](https://github.com/pypa/hatch/releases/tag/hatch-v1.10.0) brings a test command, support for UV, and a Python script runner.\n\n\n\n## Test command\n\nThe new [`test`](../../cli/reference.md#hatch-test) command allows you to easily run tests for your project on multiple versions of Python. The default behavior follows best practices, using [pytest](https://github.com/pytest-dev/pytest) with select plugins for test execution and [coverage.py](https://github.com/nedbat/coveragepy) for code coverage measurement.\n\nThe command is designed to be both simple to use while also satisfying the needs of most projects. For example, the following shows Hatch running tests for [Jinja](https://github.com/pallets/jinja) in all environments in the [default matrix](../../config/internal/testing.md#matrix):\n\n\n {{ config.copyright }}\n
\n \n Logo by\n \n DALL·E\n \n and\n \n Boris Crowther\n \n
\n {% endif %}\n {% if not config.extra.generator == false %}\n Made with\n `os.name` |
- posix
- java
`sys.platform` |
- linux
- win32
- darwin
`platform.machine()` |
- x86_64
`platform.python_implementation()` |
- CPython
- Jython
`platform.release()` |
- 1.8.0_51
- 3.14.1-x86_64-linode39
`platform.system()` |
- Linux
- Windows
- Darwin
`platform.version()` |
- 10.0.19041
- \\#1 SMP Fri Apr 2 22:23:49 UTC 2021
`'.'.join(platform.python_version_tuple()[:2])` |
- 2.7
- 3.10
`platform.python_version()` |
- 2.7.18
- 3.11.0b1
`sys.implementation.name` |
- cpython
- 2.7.18
- 3.11.0b1
git+filegit+httpsgit+sshgit+http:warning:git+git:warning:git:warning:
- Commit hash
- Tag name
- Branch name
hg+filehg+httpshg+sshhg+http:warning:hg+static-http:warning:
- Revision hash
- Revision number
- Tag name
- Branch name
svn+httpssvn+sshsvn+http:warning:svn+svn:warning:svn:warning:
- Revision number
bzr+httpsbzr+sshbzr+sftpbzr+lpbzr+http:warning:bzr+ftp:warning:
- Revision number
- Tag name