o yAf}@sdddlmZddlmZmZmZmZddlmZer&ddl m Z ddl m Z GdddeeZ dS) ) annotations) TYPE_CHECKINGAnyGenericcast)BuilderConfigBound Application)ProjectMetadatac@seZdZdZdZ d.d/ddZed0ddZed1ddZed2ddZ ed3ddZ ed4ddZ ed1dd Z ed1d!d"Z d5d%d&Zd6d)d*Zd7d,d-ZdS)8BuildHookInterfacea Example usage: ```python tab="plugin.py" from hatchling.builders.hooks.plugin.interface import BuildHookInterface class SpecialBuildHook(BuildHookInterface): PLUGIN_NAME = 'special' ... ``` ```python tab="hooks.py" from hatchling.plugin import hookimpl from .plugin import SpecialBuildHook @hookimpl def hatch_register_build_hook(): return SpecialBuildHook ``` Nrootstrconfigdict[str, Any] build_configrmetadatar directory target_nameappApplication | NonereturnNonecCs.||_||_||_||_||_||_||_dSN)_BuildHookInterface__root_BuildHookInterface__config!_BuildHookInterface__build_config_BuildHookInterface__metadata_BuildHookInterface__directory _BuildHookInterface__target_name_BuildHookInterface__app)selfr rrrrrrr"N/usr/lib/python3.10/site-packages/hatchling/builders/hooks/plugin/interface.py__init__(s  zBuildHookInterface.__init__r cCs.|jdurddlm}t|||_|jS)za An instance of [Application](../utilities.md#hatchling.bridge.app.Application). Nrr)r hatchling.bridge.appr rZget_safe_application)r!r r"r"r#r:s  zBuildHookInterface.appcC|jS)z/ The root of the project tree. )rr!r"r"r#r FzBuildHookInterface.rootcCr&)z The cumulative hook configuration. ```toml config-example [tool.hatch.build.hooks.] [tool.hatch.build.targets..hooks.] ``` )rr'r"r"r#rMs zBuildHookInterface.configcCr&r)rr'r"r"r#rYszBuildHookInterface.metadatacCr&)zj An instance of [BuilderConfig](../utilities.md#hatchling.builders.config.BuilderConfig). )rr'r"r"r#r^r(zBuildHookInterface.build_configcCr&)z& The build directory. )rr'r"r"r#rer(zBuildHookInterface.directorycCr&)z6 The plugin name of the build target. )rr'r"r"r#rlr(zBuildHookInterface.target_nameversions list[str]cCdS)z This occurs before the build process if the `-c`/`--clean` flag was passed to the [`build`](../../cli/reference.md#hatch-build) command, or when invoking the [`clean`](../../cli/reference.md#hatch-clean) command. Nr")r!r)r"r"r#cleanszBuildHookInterface.cleanversion build_datacCr+)z This occurs immediately before each build. Any modifications to the build data will be seen by the build target. Nr")r!r.r/r"r"r# initializezr-zBuildHookInterface.initialize artifact_pathcCr+)a This occurs immediately after each build and will not run if the `--hooks-only` flag was passed to the [`build`](../../cli/reference.md#hatch-build) command. The build data will reflect any modifications done by the target during the build. Nr")r!r.r/r1r"r"r#finalizer-zBuildHookInterface.finalizer)r rrrrrrr rrrrrrrr)rr )rr)rr)rr )rr)r)r*rr)r.rr/rrr)r.rr/rr1rrr)__name__ __module__ __qualname____doc__Z PLUGIN_NAMEr$propertyrr rrrrrr,r0r2r"r"r"r#r s.          r N) __future__rtypingrrrrZhatchling.builders.configrr%r Zhatchling.metadata.corer r r"r"r"r#s