Skip to content

Wheel builder

wheelは、環境に直接インストールできるPythonパッケージのバイナリディストリビューションです。

Configuration

ビルダープラグイン名はwheelです。

[tool.hatch.build.targets.wheel]

[build.targets.wheel]

Options

Option Default Description
core-metadata-version "2.3" 使用するcore metadataのバージョン。
shared-data 標準のdata directory内のdataサブディレクトリに対応するforced inclusionオプションに似たマッピング。このサブディレクトリは、特定のPython環境(通常はsys.prefixの下)にグローバルにインストールされます。
shared-scripts 標準のdata directory内のscriptsサブディレクトリに対応するforced inclusionオプションに似たマッピングで、特定のPython環境にインストールされます。通常は、WindowsではScriptsの下、それ以外の場合はbinの下にインストールされ、通常はPATHで利用できます。
extra-metadata forced inclusionオプションに似たマッピングは、extra_metadataという名前のディレクトリに出荷される追加のmetadataに対応します。
strict-naming true ファイル名にプロジェクト名の正規化バージョンを含めるかどうかを指定します。
macos-max-compat false macOSであるかどうかにかかわらず、ビルドフックがinfer_tagbuild dataを設定している場合、ホイール名は新しいSDKバージョンの特定のバージョンではなく、広範なサポートを示す必要があります。

注:このオプションは最終的に削除されます。
bypass-selection false ファイル選択オプションが定義されておらず、すべてのヒューリスティックが出荷対象の決定に失敗した場合に、エラーを抑制するかどうか。

Versions

Version Description
standard (default) 最新の標準化された形式
editable リアルタイム開発用の.pthファイルまたはインポートフックのみを提供するホイール

Default file selection

ユーザがfile selectionオプションを設定していない場合、project nameを使用して、次のヒューリスティックな順序でパッケージの出荷が決定されます。:

  1. <NAME>/__init__.py
  2. src/<NAME>/__init__.py
  3. <NAME>.py
  4. <NAMESPACE>/<NAME>/__init__.py

これらのヒューリスティックがいずれも満たされない場合は、エラーが発生します。

Reproducibility

Reproducible buildsがサポートされています。

Build data

このデータは、build hooksで変更できます。

Data Default Description
tag ファイル名の完全なtag部分(例:py3-none-any)。デフォルトでは、project metadataに基づいて、サポートされているPythonのメジャーバージョンを使用したクロスプラットフォームホイールになる。
infer_tag False tagが設定されていない場合は、プラットフォーム、Pythonインタプリタ、およびABIに最も固有のものを使用するように有効にすることができます。
pure_python True パッケージにプラットフォーム固有のファイルが含まれていないことを示すメタデータを書き込むかどうか。
dependencies 追加のproject dependencies。
shared_data 競合が発生した場合に優先される追加のshared-dataエントリ。
shared_scripts 競合が発生した場合に優先される追加のshared-scriptsエントリ。
extra_metadata 競合が発生した場合に優先される追加のextra-metadataエントリ。
force_include_editable force_include optionに似ていますが、特にeditableversionに対して優先されます。