hatch の API リファレンス

hatch (pypa/hatch) の公開 API 67 件 —— クラス 6、関数 31、メソッド 30。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: pypa/hatch

種別	件数
クラス	6
関数	31
メソッド	30

API 一覧

methodbackend.src.hatchling.bridge.app.Application.abort(message:str='', code:int=1, **kwargs:Any) -> None

Terminate the program with the given return code.

methodbackend.src.hatchling.bridge.app.Application.display_info(message:str='', **kwargs:Any) -> None

Meant to be used for messages conveying basic information.

methodbackend.src.hatchling.bridge.app.Application.display_warning(message:str='', **kwargs:Any) -> None

Meant to be used for messages conveying important information.

func

backend.src.hatchling.build.build_editable(wheel_directory:str, config_settings:dict[str, Any] | None=None, metadata_directory:str | None=None) -> str

https://peps.python.org/pep-0660/#build-editable

funcbackend.src.hatchling.build.build_sdist(sdist_directory:str, config_settings:dict[str, Any] | None=None) -> str

https://peps.python.org/pep-0517/#build-sdist

func

backend.src.hatchling.build.build_wheel(wheel_directory:str, config_settings:dict[str, Any] | None=None, metadata_directory:str | None=None) -> str

https://peps.python.org/pep-0517/#build-wheel

classbackend.src.hatchling.builders.binary.BinaryBuilder

Build binaries

funcbackend.src.hatchling.builders.macos.normalize_macos_version(version:str, *arm:bool, *compat:bool) -> str

Set minor version to 0 if major is 11+.

funcbackend.src.hatchling.builders.macos.process_macos_plat_tag(plat:str, *compat:bool) -> str

Process the macOS platform tag.

classbackend.src.hatchling.builders.sdist.SdistBuilder

Build an archive of the source files

funcbackend.src.hatchling.builders.utils.normalize_artifact_permissions(path:str) -> None

Normalize the permission bits for artifacts

classbackend.src.hatchling.builders.wheel.WheelBuilder

Build a binary distribution (.whl file)

classbackend.src.hatchling.metadata.core.BuildMetadata

https://peps.python.org/pep-0517/

classbackend.src.hatchling.metadata.core.CoreMetadata

https://peps.python.org/pep-0621/

methodbackend.src.hatchling.metadata.core.CoreMetadata.classifiers() -> list[str]

https://peps.python.org/pep-0621/#classifiers

methodbackend.src.hatchling.metadata.core.CoreMetadata.description() -> str

https://peps.python.org/pep-0621/#description

methodbackend.src.hatchling.metadata.core.CoreMetadata.dynamic() -> list[str]

https://peps.python.org/pep-0621/#dynamic

methodbackend.src.hatchling.metadata.core.CoreMetadata.entry_points() -> dict[str, dict[str, str]]

https://peps.python.org/pep-0621/#entry-points

methodbackend.src.hatchling.metadata.core.CoreMetadata.gui_scripts() -> dict[str, str]

https://peps.python.org/pep-0621/#entry-points

methodbackend.src.hatchling.metadata.core.CoreMetadata.import_names() -> list[str] | None

https://peps.python.org/pep-0794/

methodbackend.src.hatchling.metadata.core.CoreMetadata.keywords() -> list[str]

https://peps.python.org/pep-0621/#keywords

methodbackend.src.hatchling.metadata.core.CoreMetadata.license() -> str

https://peps.python.org/pep-0621/#license

methodbackend.src.hatchling.metadata.core.CoreMetadata.license_expression() -> str

https://peps.python.org/pep-0639/

methodbackend.src.hatchling.metadata.core.CoreMetadata.license_files() -> list[str]

https://peps.python.org/pep-0639/

methodbackend.src.hatchling.metadata.core.CoreMetadata.name() -> str

https://peps.python.org/pep-0621/#name

methodbackend.src.hatchling.metadata.core.CoreMetadata.raw_name() -> str

https://peps.python.org/pep-0621/#name

methodbackend.src.hatchling.metadata.core.CoreMetadata.readme() -> str

https://peps.python.org/pep-0621/#readme

methodbackend.src.hatchling.metadata.core.CoreMetadata.readme_content_type() -> str

https://peps.python.org/pep-0621/#readme

methodbackend.src.hatchling.metadata.core.CoreMetadata.readme_path() -> str

https://peps.python.org/pep-0621/#readme

methodbackend.src.hatchling.metadata.core.CoreMetadata.requires_python() -> str

https://peps.python.org/pep-0621/#requires-python

methodbackend.src.hatchling.metadata.core.CoreMetadata.scripts() -> dict[str, str]

https://peps.python.org/pep-0621/#entry-points

methodbackend.src.hatchling.metadata.core.CoreMetadata.urls() -> dict[str, str]

https://peps.python.org/pep-0621/#urls

methodbackend.src.hatchling.metadata.core.CoreMetadata.version() -> str

https://peps.python.org/pep-0621/#version

func

backend.src.hatchling.metadata.spec.construct_metadata_file_1_2(metadata:ProjectMetadata, extra_dependencies:tuple[str] | None=None) -> str

https://peps.python.org/pep-0345/

func

backend.src.hatchling.metadata.spec.construct_metadata_file_2_1(metadata:ProjectMetadata, extra_dependencies:tuple[str] | None=None) -> str

https://peps.python.org/pep-0566/

func

backend.src.hatchling.metadata.spec.construct_metadata_file_2_2(metadata:ProjectMetadata, extra_dependencies:tuple[str] | None=None) -> str

https://peps.python.org/pep-0643/

func

backend.src.hatchling.metadata.spec.construct_metadata_file_2_3(metadata:ProjectMetadata, extra_dependencies:tuple[str] | None=None) -> str

https://peps.python.org/pep-0685/

func

backend.src.hatchling.metadata.spec.construct_metadata_file_2_4(metadata:ProjectMetadata, extra_dependencies:tuple[str] | None=None) -> str

https://peps.python.org/pep-0639/

func

backend.src.hatchling.metadata.spec.construct_metadata_file_2_5(metadata:ProjectMetadata, extra_dependencies:tuple[str] | None=None) -> str

https://peps.python.org/pep-0794/

classbackend.src.hatchling.version.scheme.standard.StandardScheme

See https://peps.python.org/pep-0440/

funcsrc.hatch.cli.check.fmt.fmt(app:Application, *args:tuple[str, ...], *fix:bool, *sync:bool)

Verify formatting, using Ruff by default.

funcsrc.hatch.cli.clean.clean(ctx, location, targets, hooks_only, no_hooks, ext)

Remove build artifacts.

funcsrc.hatch.cli.config.find(app)

Show the location of the config file.

funcsrc.hatch.cli.config.set_value(app, key, value)

Assign values to config file entries.

funcsrc.hatch.cli.config.show(app, all_keys)

Show the contents of the config file.

funcsrc.hatch.cli.config.update(app)

Update the config file with any new fields.

funcsrc.hatch.cli.fmt.fmt(app:Application, *args:tuple[str, ...], *check:bool, *linter:bool, *formatter:bool, *sync:bool)

Format and lint source code.

funcsrc.hatch.cli.project.metadata.metadata(app:Application, field:str | None)

Display project metadata.

funcsrc.hatch.cli.python.find.find(app:Application, *name:str, *parent:bool, *directory:str | None)

Locate Python binaries.

func

src.hatch.cli.python.install.install(app:Application, *names:tuple[str, ...], *private:bool, *update:bool, *directory:str | None)

Install Python distributions.

funcsrc.hatch.cli.python.remove.remove(app:Application, *names:tuple[str, ...], *directory:str | None)

Remove Python distributions.

funcsrc.hatch.cli.python.show.show(app:Application, *force_ascii:bool, *directory:str | None)

Show the available Python distributions.

funcsrc.hatch.cli.python.update.update(ctx:click.Context, *names:tuple[str, ...], *directory:str | None)

Update Python distributions.

funcsrc.hatch.cli.run.run(ctx:click.Context, args:tuple[str, ...])

Run commands within project environments.

funcsrc.hatch.cli.self.report.report(app:Application, *no_open:bool) -> None

Generate a pre-populated GitHub issue.

funcsrc.hatch.cli.shell.shell(app:Application, env_name:str | None, name:str, path:str)

Enter a shell within a project's environment.

funcsrc.hatch.cli.status.status(app)

Show information about the current environment.

funcsrc.hatch.cli.version.version(app:Application, *desired_version:str | None, *force:bool)

View or set a project's version.

methodsrc.hatch.project.core.Project.dependency_groups() -> dict[str, Any]

https://peps.python.org/pep-0735/

funcsrc.hatch.project.utils.parse_inline_script_metadata(script:str) -> dict[str, Any] | None

https://peps.python.org/pep-0723/#reference-implementation

methodsrc.hatch.utils.platform.Platform.default_shell() -> str

Returns the default shell of the system.

methodsrc.hatch.utils.platform.Platform.display_name() -> str

One of the following: - `Linux` - `Windows` - `macOS`

methodsrc.hatch.utils.platform.Platform.exit_with_command(command:list[str | os.PathLike]) -> None

Run the given command and exit with its exit code.

methodsrc.hatch.utils.platform.Platform.home() -> Path

The user's home directory as a path-like object.

methodsrc.hatch.utils.platform.Platform.macos() -> bool

Indicates whether Hatch is running on macOS.

methodsrc.hatch.utils.platform.Platform.name() -> str

One of the following: - `linux` - `windows` - `macos`

methodsrc.hatch.utils.platform.Platform.windows() -> bool

Indicates whether Hatch is running on Windows.

この情報について

掲載しているシグネチャは pypa/hatch の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る