refactor(BaseFormat): merge ChangelogFormat into BaseFormat

Author: bearomorphism

commitizen/changelog_formats/__init__.py

@@ -1,63 +1,28 @@
 from __future__ import annotations
 
 import sys
-from typing import Callable, ClassVar, Protocol
+from typing import Callable
+
+from commitizen.changelog_formats.base import BaseFormat
 
 if sys.version_info >= (3, 10):
     from importlib import metadata
 else:
     import importlib_metadata as metadata
 
-from commitizen.changelog import Metadata
 from commitizen.config.base_config import BaseConfig
 from commitizen.exceptions import ChangelogFormatUnknown
 
 CHANGELOG_FORMAT_ENTRYPOINT = "commitizen.changelog_format"
-TEMPLATE_EXTENSION = "j2"
-
-
-class ChangelogFormat(Protocol):
-    extension: ClassVar[str]
-    """Standard known extension associated with this format"""
-
-    alternative_extensions: ClassVar[set[str]]
-    """Known alternatives extensions for this format"""
-
-    config: BaseConfig
-
-    def __init__(self, config: BaseConfig) -> None:
-        self.config = config
-
-    @property
-    def ext(self) -> str:
-        """Dotted version of extensions, as in `pathlib` and `os` modules"""
-        return f".{self.extension}"
-
-    @property
-    def template(self) -> str:
-        """Expected template name for this format"""
-        return f"CHANGELOG.{self.extension}.{TEMPLATE_EXTENSION}"
-
-    @property
-    def default_changelog_file(self) -> str:
-        return f"CHANGELOG.{self.extension}"
-
-    def get_metadata(self, filepath: str) -> Metadata:
-        """
-        Extract the changelog metadata.
-        """
-        raise NotImplementedError
 
 
-KNOWN_CHANGELOG_FORMATS: dict[str, type[ChangelogFormat]] = {
+KNOWN_CHANGELOG_FORMATS: dict[str, type[BaseFormat]] = {
     ep.name: ep.load()
     for ep in metadata.entry_points(group=CHANGELOG_FORMAT_ENTRYPOINT)
 }
 
 
-def get_changelog_format(
-    config: BaseConfig, filename: str | None = None
-) -> ChangelogFormat:
+def get_changelog_format(config: BaseConfig, filename: str | None = None) -> BaseFormat:
     """
     Get a format from its name
 
@@ -74,7 +39,7 @@ def get_changelog_format(
     return format(config)
 
 
-def _guess_changelog_format(filename: str | None) -> type[ChangelogFormat] | None:
+def _guess_changelog_format(filename: str | None) -> type[BaseFormat] | None:
     """
     Try guessing the file format from the filename.
 
@@ -92,7 +57,7 @@ def _guess_changelog_format(filename: str | None) -> type[ChangelogFormat] | Non
     return None
 
 
-def __getattr__(name: str) -> Callable[[str], type[ChangelogFormat] | None]:
+def __getattr__(name: str) -> Callable[[str], type[BaseFormat] | None]:
     if name == "guess_changelog_format":
         return _guess_changelog_format
     raise AttributeError(f"module {__name__} has no attribute {name}")

commitizen/changelog_formats/base.py

@@ -1,24 +1,27 @@
 from __future__ import annotations
 
 import os
-from abc import ABCMeta
+from abc import ABCMeta, abstractmethod
 from typing import IO, Any, ClassVar
 
 from commitizen.changelog import Metadata
 from commitizen.config.base_config import BaseConfig
 from commitizen.tags import TagRules, VersionTag
 from commitizen.version_schemes import get_version_scheme
 
-from . import ChangelogFormat
+TEMPLATE_EXTENSION = "j2"
 
 
-class BaseFormat(ChangelogFormat, metaclass=ABCMeta):
+class BaseFormat(metaclass=ABCMeta):
     """
     Base class to extend to implement a changelog file format.
     """
 
     extension: ClassVar[str] = ""
+    """Standard known extension associated with this format"""
+
     alternative_extensions: ClassVar[set[str]] = set()
+    """Known alternatives extensions for this format"""
 
     def __init__(self, config: BaseConfig) -> None:
         # Constructor needs to be redefined because `Protocol` prevent instantiation by default
@@ -33,6 +36,20 @@ def __init__(self, config: BaseConfig) -> None:
             ignored_tag_formats=self.config.settings["ignored_tag_formats"],
         )
 
+    @property
+    def ext(self) -> str:
+        """Dotted version of extensions, as in `pathlib` and `os` modules"""
+        return f".{self.extension}"
+
+    @property
+    def template(self) -> str:
+        """Expected template name for this format"""
+        return f"CHANGELOG.{self.extension}.{TEMPLATE_EXTENSION}"
+
+    @property
+    def default_changelog_file(self) -> str:
+        return f"CHANGELOG.{self.extension}"
+
     def get_metadata(self, filepath: str) -> Metadata:
         if not os.path.isfile(filepath):
             return Metadata()
@@ -69,18 +86,14 @@ def get_metadata_from_file(self, file: IO[Any]) -> Metadata:
 
         return meta
 
+    @abstractmethod
     def parse_version_from_title(self, line: str) -> VersionTag | None:
         """
         Extract the version from a title line if any
         """
-        raise NotImplementedError(
-            "Default `get_metadata_from_file` requires `parse_version_from_changelog` to be implemented"
-        )
 
+    @abstractmethod
     def parse_title_level(self, line: str) -> int | None:
         """
         Get the title level/type of a line if any
         """
-        raise NotImplementedError(
-            "Default `get_metadata_from_file` requires `parse_title_type_of_line` to be implemented"
-        )

commitizen/changelog_formats/restructuredtext.py

@@ -5,6 +5,7 @@
 from typing import IO, TYPE_CHECKING, Any, Union
 
 from commitizen.changelog import Metadata
+from commitizen.tags import VersionTag
 
 from .base import BaseFormat
 
@@ -90,3 +91,9 @@ def is_underlined_title(self, first: str, second: str) -> bool:
             and not second.isalnum()
             and all(char == second[0] for char in second[1:])
         )
+
+    def parse_version_from_title(self, line: str) -> VersionTag | None:
+        raise NotImplementedError("parse_version_from_title is not implemented")
+
+    def parse_title_level(self, line: str) -> int | None:
+        raise NotImplementedError("parse_title_level is not implemented")

tests/commands/test_bump_command.py

@@ -13,7 +13,7 @@
 
 import commitizen.commands.bump as bump
 from commitizen import cli, cmd, defaults, git, hooks
-from commitizen.changelog_formats import ChangelogFormat
+from commitizen.changelog_formats import BaseFormat
 from commitizen.config.base_config import BaseConfig
 from commitizen.cz.base import BaseCommitizen
 from commitizen.exceptions import (
@@ -1289,7 +1289,7 @@ def test_bump_command_version_scheme_priority_over_version_type(mocker: MockFixt
 def test_bump_template_option_precedence(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
-    any_changelog_format: ChangelogFormat,
+    any_changelog_format: BaseFormat,
     arg: str,
     cfg: str,
     expected: str,
@@ -1331,7 +1331,7 @@ def test_bump_template_option_precedence(
 def test_bump_template_extras_precedence(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
-    any_changelog_format: ChangelogFormat,
+    any_changelog_format: BaseFormat,
     mock_plugin: BaseCommitizen,
 ):
     project_root = Path(tmp_commitizen_project)
@@ -1376,7 +1376,7 @@ def test_bump_template_extras_precedence(
 def test_bump_template_extra_quotes(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
-    any_changelog_format: ChangelogFormat,
+    any_changelog_format: BaseFormat,
 ):
     project_root = Path(tmp_commitizen_project)
     changelog_tpl = project_root / any_changelog_format.template

tests/commands/test_changelog_command.py

@@ -12,7 +12,7 @@
 
 from commitizen import __file__ as commitizen_init
 from commitizen import cli, git
-from commitizen.changelog_formats import ChangelogFormat
+from commitizen.changelog_formats import BaseFormat
 from commitizen.commands.changelog import Changelog
 from commitizen.config.base_config import BaseConfig
 from commitizen.cz.base import BaseCommitizen
@@ -77,7 +77,7 @@ def test_changelog_with_different_cz(mocker: MockFixture, capsys, file_regressio
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_changelog_from_start(
-    mocker: MockFixture, capsys, changelog_format: ChangelogFormat, file_regression
+    mocker: MockFixture, capsys, changelog_format: BaseFormat, file_regression
 ):
     create_file_and_commit("feat: new file")
     create_file_and_commit("refactor: is in changelog")
@@ -103,7 +103,7 @@ def test_changelog_from_start(
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_changelog_replacing_unreleased_using_incremental(
-    mocker: MockFixture, capsys, changelog_format: ChangelogFormat, file_regression
+    mocker: MockFixture, capsys, changelog_format: BaseFormat, file_regression
 ):
     create_file_and_commit("feat: add new output")
     create_file_and_commit("fix: output glitch")
@@ -1484,7 +1484,7 @@ def test_changelog_from_current_version_tag_with_nonversion_tag(
 def test_changelog_template_option_precedence(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
-    any_changelog_format: ChangelogFormat,
+    any_changelog_format: BaseFormat,
     arg: str,
     cfg: str,
     expected: str,
@@ -1527,7 +1527,7 @@ def test_changelog_template_extras_precedence(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
     mock_plugin: BaseCommitizen,
-    any_changelog_format: ChangelogFormat,
+    any_changelog_format: BaseFormat,
 ):
     project_root = Path(tmp_commitizen_project)
     changelog_tpl = project_root / any_changelog_format.template
@@ -1800,7 +1800,7 @@ def test_changelog_ignored_tags(
 def test_changelog_template_extra_quotes(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
-    any_changelog_format: ChangelogFormat,
+    any_changelog_format: BaseFormat,
 ):
     project_root = Path(tmp_commitizen_project)
     changelog_tpl = project_root / any_changelog_format.template
@@ -1836,7 +1836,7 @@ def test_changelog_template_extra_quotes(
 def test_changelog_template_extra_weird_but_valid(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
-    any_changelog_format: ChangelogFormat,
+    any_changelog_format: BaseFormat,
     extra: str,
     expected,
 ):
@@ -1858,7 +1858,7 @@ def test_changelog_template_extra_weird_but_valid(
 def test_changelog_template_extra_bad_format(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
-    any_changelog_format: ChangelogFormat,
+    any_changelog_format: BaseFormat,
     extra: str,
 ):
     project_root = Path(tmp_commitizen_project)
@@ -1876,7 +1876,7 @@ def test_changelog_template_extra_bad_format(
 def test_export_changelog_template_from_default(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
-    any_changelog_format: ChangelogFormat,
+    any_changelog_format: BaseFormat,
 ):
     project_root = Path(tmp_commitizen_project)
     target = project_root / "changelog.jinja"
@@ -1895,7 +1895,7 @@ def test_export_changelog_template_from_plugin(
     mocker: MockFixture,
     tmp_commitizen_project: Path,
     mock_plugin: BaseCommitizen,
-    changelog_format: ChangelogFormat,
+    changelog_format: BaseFormat,
     tmp_path: Path,
 ):
     project_root = Path(tmp_commitizen_project)

tests/conftest.py

@@ -11,7 +11,7 @@
 
 from commitizen import cmd, defaults
 from commitizen.changelog_formats import (
-    ChangelogFormat,
+    BaseFormat,
     get_changelog_format,
 )
 from commitizen.config import BaseConfig
@@ -265,9 +265,7 @@ def mock_plugin(mocker: MockerFixture, config: BaseConfig) -> BaseCommitizen:
 
 
 @pytest.fixture(params=SUPPORTED_FORMATS)
-def changelog_format(
-    config: BaseConfig, request: pytest.FixtureRequest
-) -> ChangelogFormat:
+def changelog_format(config: BaseConfig, request: pytest.FixtureRequest) -> BaseFormat:
     """For tests relying on formats specifics"""
     format: str = request.param
     config.settings["changelog_format"] = format
@@ -279,7 +277,7 @@ def changelog_format(
 
 
 @pytest.fixture
-def any_changelog_format(config: BaseConfig) -> ChangelogFormat:
+def any_changelog_format(config: BaseConfig) -> BaseFormat:
     """For test not relying on formats specifics, use the default"""
     config.settings["changelog_format"] = defaults.CHANGELOG_FORMAT
     return get_changelog_format(config)