Skip to content

Version source plugins

Known third-party

  • hatch-vcs - お好みのバージョン管理システム(Gitなど)を使用します。
  • hatch-NodeJS-version - NodeJSpackage.jsonファイルのversionフィールドを使用します。
  • hatch-regex-commit - バージョンバンピング後にGitコミットとタグを自動的に作成する
  • versioningit - カスタマイズ可能なバージョンフォーマットを使用して、GitまたはMercurialタグからバージョンを決定する

VersionSourceInterface

Example usage:

from hatchling.version.source.plugin.interface import VersionSourceInterface


class SpecialVersionSource(VersionSourceInterface):
    PLUGIN_NAME = 'special'
    ...

from hatchling.plugin import hookimpl

from .plugin import SpecialVersionSource


@hookimpl
def hatch_register_version_source():
    return SpecialVersionSource
Source code in backend/src/hatchling/version/source/plugin/interface.py 
class VersionSourceInterface(ABC):  # no cov
    """
    Example usage:

    ```python tab="plugin.py"
    from hatchling.version.source.plugin.interface import VersionSourceInterface


    class SpecialVersionSource(VersionSourceInterface):
        PLUGIN_NAME = 'special'
        ...
    ```

    ```python tab="hooks.py"
    from hatchling.plugin import hookimpl

    from .plugin import SpecialVersionSource


    @hookimpl
    def hatch_register_version_source():
        return SpecialVersionSource
    ```
    """

    PLUGIN_NAME = ''
    """The name used for selection."""

    def __init__(self, root: str, config: dict) -> None:
        self.__root = root
        self.__config = config

    @property
    def root(self) -> str:
        """
        The root of the project tree as a string.
        """
        return self.__root

    @property
    def config(self) -> dict:
        """
        ```toml config-example
        [tool.hatch.version]
        ```
        """
        return self.__config

    @abstractmethod
    def get_version_data(self) -> dict:
        """
        This should return a mapping with a `version` key representing the current version of the project and will be
        displayed when invoking the [`version`](../../cli/reference.md#hatch-version) command without any arguments.

        The mapping can contain anything else and will be passed to
        [set_version](reference.md#hatchling.version.source.plugin.interface.VersionSourceInterface.set_version)
        when updating the version.
        """

    def set_version(self, version: str, version_data: dict) -> None:
        """
        This should update the version to the first argument with the data provided during retrieval.
        """
        raise NotImplementedError

PLUGIN_NAME = '' class-attribute instance-attribute

The name used for selection.

root: str property

The root of the project tree as a string.

config: dict property 

[tool.hatch.version]

[version]

get_version_data() -> dict abstractmethod

This should return a mapping with a version key representing the current version of the project and will be displayed when invoking the version command without any arguments.

The mapping can contain anything else and will be passed to set_version when updating the version.

Source code in backend/src/hatchling/version/source/plugin/interface.py 
@abstractmethod
def get_version_data(self) -> dict:
    """
    This should return a mapping with a `version` key representing the current version of the project and will be
    displayed when invoking the [`version`](../../cli/reference.md#hatch-version) command without any arguments.

    The mapping can contain anything else and will be passed to
    [set_version](reference.md#hatchling.version.source.plugin.interface.VersionSourceInterface.set_version)
    when updating the version.
    """

set_version(version: str, version_data: dict) -> None

This should update the version to the first argument with the data provided during retrieval.

Source code in backend/src/hatchling/version/source/plugin/interface.py 
def set_version(self, version: str, version_data: dict) -> None:
    """
    This should update the version to the first argument with the data provided during retrieval.
    """
    raise NotImplementedError