FAQ¶FAQ¶

Interoperability¶相互運用性¶

Q: What is the risk of lock-in?Q: ロックインのリスクは何ですか？

A: Not much! Other than the plugin system, everything uses Python's established standards by default. Project metadata is based entirely on the standard, the build system is compatible with PEP 517/PEP 660, versioning uses the scheme specified by PEP 440, dependencies are defined with PEP 508 strings, and environments use virtualenv.A: あまりありません！プラグインシステムを除いて、すべてはデフォルトでPythonの確立された標準を使用しています。プロジェクトメタデータは完全に標準に基づいており、ビルドシステムはPEP 517/PEP 660と互換性があり、バージョニングはPEP 440で指定されたスキームを使用し、依存関係はPEP 508文字列で定義され、環境はvirtualenvを使用します。

Q: Must one use all features?Q: すべての機能を使用する必要がありますか？

A: No, all features are optional! You can use just the build system, publish wheels and source distributions that were built by other tools, only use the environment management, etc.A: いいえ、すべての機能はオプションです！ビルドシステムだけを使用したり、他のツールでビルドされたホイールやソース配布を公開したり、環境管理だけを使用したりすることができます。

Libraries vs applications¶ライブラリとアプリケーション¶

Q: Are workflows for both libraries and applications supported?Q: ライブラリとアプリケーションの両方のワークフローはサポートされていますか？

A: Yes, mostly! Applications can utilize environment management just like libraries, and plugins can be used to build projects in arbitrary formats or publish artifacts to arbitrary destinations.A: はい、ほとんど！アプリケーションはライブラリと同様に環境管理を利用でき、プラグインを使用してプロジェクトをビルドしたり、任意の宛先にアーティファクトを公開したりできます。

The only caveat is that currently there is no support for re-creating an environment given a set of dependencies in a reproducible manner. Although a standard lock file format may be far off since PEP 665 was rejected, resolving capabilities are coming to pip. When that is stabilized, Hatch will add locking functionality and dedicated documentation for managing applications.唯一の注意点は、現在のところ、依存関係のセットを考慮して環境を再作成するためのサポートが再現可能な方法でないことです。PEP 665が拒否されたため、標準のロックファイル形式は遠いかもしれませんが、解決機能はpipに来ています。それが安定すれば、Hatchはロック機能とアプリケーション管理のための専用ドキュメントを追加します。

Tool migration¶ツールの移行¶

Q: How to migrate to Hatch?Q: Hatchに移行するにはどうすればよいですか？

Build system¶ビルドシステム¶

SetuptoolsHatch

setup.py MANIFEST.in

import os
from io import open

from setuptools import find_packages, setup

about = {}
with open(os.path.join('src', 'foo', '__about__.py'), 'r', 'utf-8') as f:
    exec(f.read(), about)

with open('README.md', 'r', 'utf-8') as f:
    readme = f.read()

setup(
    # Metadata
    name='foo',
    version=about['__version__'],
    description='...',
    long_description=readme,
    long_description_content_type='text/markdown',
    author='...',
    author_email='...',
    project_urls={
        'Documentation': '...',
        'Source': '...',
    },
    classifiers=[
        '...',
    ],
    keywords=[
        '...',
    ],
    python_requires='>=3.8',
    install_requires=[
        '...',
    ],
    extras_require={
        'feature': ['...'],
    },

    # Packaging
    packages=find_packages(where='src'),
    package_dir={'': 'src'},
    package_data={
        'foo': ['py.typed'],
    },
    zip_safe=False,
    entry_points={
        'console_scripts': [
            'foo = foo.cli:main',
        ],
    },
)

graft tests

global-exclude *.py[cod] __pycache__

pyproject.toml

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "foo"
description = "..."
readme = "README.md"
authors = [
  { name = "...", email = "..." },
]
classifiers = [
  "...",
]
keywords = [
  "...",
]
requires-python = ">=3.8"
dependencies = [
  "...",
]
dynamic = ["version"]

[project.urls]
Documentation = "..."
Source = "..."

[project.optional-dependencies]
feature = ["..."]

[project.scripts]
foo = "foo.cli:main"

[tool.hatch.version]
path = "src/foo/__about__.py"

[tool.hatch.build.targets.sdist]
include = [
  "/src",
  "/tests",
]

Environments¶環境¶

ToxHatch

Invocation:呼び出し:

tox

tox.ini

[tox]
envlist =
    py{38,39}-{42,3.14}
    py{39,310}-{9000}-{foo,bar}

[testenv]
usedevelop = true
deps =
    coverage[toml]
    pytest
    pytest-cov
    foo: cryptography
commands =
    pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests {posargs}
setenv =
    3.14: PRODUCT_VERSION=3.14
    42: PRODUCT_VERSION=42
    9000: PRODUCT_VERSION=9000
    {foo,bar}: EXPERIMENTAL=true

Invocation:呼び出し:

hatch run test

pyproject.toml hatch.toml

[tool.hatch.envs.default]
dependencies = [
  "coverage[toml]",
  "pytest",
  "pytest-cov",
]

[tool.hatch.envs.default.scripts]
test = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'

[tool.hatch.envs.default.overrides]
matrix.version.env-vars = "PRODUCT_VERSION"
matrix.feature.env-vars = "EXPERIMENTAL=true"
matrix.feature.dependencies = [
  { value = "cryptography", if = ["foo"] },
]

[[tool.hatch.envs.default.matrix]]
python = ["3.8", "3.9"]
version = ["42", "3.14"]

[[tool.hatch.envs.default.matrix]]
python = ["3.9", "3.10"]
version = ["9000"]
feature = ["foo", "bar"]

[envs.default]
dependencies = [
  "coverage[toml]",
  "pytest",
  "pytest-cov",
]

[envs.default.scripts]
test = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'

[envs.default.overrides]
matrix.version.env-vars = "PRODUCT_VERSION"
matrix.feature.env-vars = "EXPERIMENTAL=true"
matrix.feature.dependencies = [
  { value = "cryptography", if = ["foo"] },
]

[[envs.default.matrix]]
python = ["3.8", "3.9"]
version = ["42", "3.14"]

[[envs.default.matrix]]
python = ["3.9", "3.10"]
version = ["9000"]
feature = ["foo", "bar"]

Fast CLI?¶高速CLI?¶

The claim about being faster than other tools is based on timings that are always checked in CI.他のツールよりも速いという主張は、CIで常にチェックされるタイミングに基づいています。

Hatch achieves this by using lazy imports, lazily performing computation manually and with functools.cached_property, using hacks like not not ... instead of bool(...), etc.Hatchは、遅延インポートを使用し、手動で計算を遅延実行し、functools.cached_propertyを使用し、bool(...)の代わりにnot not ...のようなハックを使用することでこれを実現しています。