FAQ¶

Interoperability¶

Q: ロックインのリスクはありますか?

A: ありませんを除いて、すべてがデフォルトでPythonの確立された標準を使用します。プロジェクトメタデータは完全にstandardに基づいており、ビルドシステムはPEP 517/PEP 660と互換性があり、バージョン管理はPEP 440で指定されたスキームを使用し、依存関係は[PEP 0440][]文字列で定義され、環境はvirtualenvを使用します。

Q: すべての機能を使用する必要がありますか?

A: いいえ、すべての機能はオプションですを使用したり、他のツールで構築されたホイールやソースディストリビューションを公開したり、環境管理のみを使用したりすることができます。

Libraries vs applications¶

Q: ライブラリとアプリケーションの両方のワークフローはサポートされていますか?

A: はい、ほとんどです!アプリケーションはライブラリと同様に環境管理を利用することができ、プラグインを使用して、任意の形式のプロジェクトをビルドしたり、任意の宛先にアーティファクトをpublishしたりすることができる。

唯一の注意点は、現時点では、再現可能な方法で一連の依存関係を指定して環境を再作成するサポートがないことです。PEP 665が拒否されたため、標準のロックファイルフォーマットははるか先のものになる可能性があるが、解決機能はcoming to pipです。これが安定すると、Hatchはロック機能とアプリケーション管理のための専用ドキュメントを追加します。

Tool migration¶

Q: How to migrate to 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?¶

他のツールよりも高速であるという主張は、CIで常にチェックされるbased on timingsです。

Hatchは、遅延インポートを使用し、functools.cached_propertyを使用して手動で計算を遅延実行し、bool(...)の代わりにnot not ...などのハックを使用することでこれを実現している。