python-semantic-release 9.8.3__tar.gz → 9.8.5__tar.gz

{python_semantic_release-9.8.3/python_semantic_release.egg-info → python_semantic_release-9.8.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.8.3
+Version: 9.8.5
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -55,10 +55,10 @@ Requires-Dist: types-pytest-lazy-fixture~=0.6.3; extra == "test"
 Provides-Extra: dev
 Requires-Dist: pre-commit~=3.5; extra == "dev"
 Requires-Dist: tox~=4.11; extra == "dev"
-Requires-Dist: ruff==0.4.9; extra == "dev"
+Requires-Dist: ruff==0.5.0; extra == "dev"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.10.0; extra == "mypy"
-Requires-Dist: types-requests~=2.31.0; extra == "mypy"
+Requires-Dist: mypy==1.10.1; extra == "mypy"
+Requires-Dist: types-requests~=2.32.0; extra == "mypy"
 
 Python Semantic Release
 ***********************

{python_semantic_release-9.8.3 → python_semantic_release-9.8.5}/docs/configuration.rst

@@ -107,7 +107,7 @@ If a setting is not provided, than PSR will fill in the value with the default v
 Python Semantic Release expects a root level key to start the configuration definition. Make
 sure to use the correct root key dependending on the configuration format you are using.
 
-.. note:: If you are using ``pyproject.toml``, this heading should include the `tool`` prefix
+.. note:: If you are using ``pyproject.toml``, this heading should include the ``tool`` prefix
           as specified within PEP 517, resulting in ``[tool.semantic_release]``.
 
 .. note:: If you are using a ``releaserc.toml``, use ``[semantic_release]`` as the root key

{python_semantic_release-9.8.3 → python_semantic_release-9.8.5}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.8.3"
+version = "9.8.5"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -37,8 +37,8 @@ dependencies = [
 ]
 
 [project.scripts]
-semantic-release = "semantic_release.cli:main"
-psr = "semantic_release.cli:main"
+semantic-release = "semantic_release.cli.commands.main:main"
+psr = "semantic_release.cli.commands.main:main"
 
 [project.urls]
 changelog = "https://github.com/python-semantic-release/python-semantic-release/blob/master/CHANGELOG.md"
@@ -74,11 +74,11 @@ test = [
 dev = [
   "pre-commit ~= 3.5",
   "tox ~= 4.11",
-  "ruff == 0.4.9"
+  "ruff == 0.5.0"
 ]
 mypy = [
-  "mypy == 1.10.0",
-  "types-requests ~= 2.31.0"
+  "mypy == 1.10.1",
+  "types-requests ~= 2.32.0",
 ]
 
 [tool.pytest.ini_options]
@@ -156,6 +156,7 @@ show_error_context = true
 pretty = true
 error_summary = true
 follow_imports = "normal"
+enable_error_code = ["ignore-without-code"]
 ignore_missing_imports = true   # gitpython is very dynamic
 disallow_untyped_calls = true
 # warn_return_any = true
@@ -222,6 +223,8 @@ ignore = [
   "DTZ",
   # flake8-errmsg
   "EM",
+  # Some todos and some examples; leave this disabled for now
+  "ERA001",
   # don't compare types, use isinstance()
   # sometimes using type(x) == y is deliberately chosen to exclude
   # subclasses
@@ -234,6 +237,8 @@ ignore = [
   "INP001",
   # Errors should end with "Error"
   "N818",
+  # mypy prevents blanket-type-ignore
+  "PGH003",
   # Fixtures that do not return a value need an underscore prefix.  The rule
   # does not handle generators.
   "PT004",
@@ -282,13 +287,13 @@ ignore = [
 ]
 
 external = ["V"]
-ignore-init-module-imports = true
 task-tags = ["NOTE", "TODO", "FIXME", "XXX"]
 
 [tool.ruff.format]
-quote-style = "double"
+docstring-code-format = true
 indent-style = "space"
 line-ending = "lf"
+quote-style = "double"
 
 [tool.ruff.lint.per-file-ignores]
 # Imported but unused

{python_semantic_release-9.8.3 → python_semantic_release-9.8.5/python_semantic_release.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.8.3
+Version: 9.8.5
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -55,10 +55,10 @@ Requires-Dist: types-pytest-lazy-fixture~=0.6.3; extra == "test"
 Provides-Extra: dev
 Requires-Dist: pre-commit~=3.5; extra == "dev"
 Requires-Dist: tox~=4.11; extra == "dev"
-Requires-Dist: ruff==0.4.9; extra == "dev"
+Requires-Dist: ruff==0.5.0; extra == "dev"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.10.0; extra == "mypy"
-Requires-Dist: types-requests~=2.31.0; extra == "mypy"
+Requires-Dist: mypy==1.10.1; extra == "mypy"
+Requires-Dist: types-requests~=2.32.0; extra == "mypy"
 
 Python Semantic Release
 ***********************

{python_semantic_release-9.8.3 → python_semantic_release-9.8.5}/python_semantic_release.egg-info/SOURCES.txt

@@ -36,13 +36,15 @@ semantic_release/__main__.py
 semantic_release/const.py
 semantic_release/enums.py
 semantic_release/errors.py
+semantic_release/gitproject.py
 semantic_release/helpers.py
 semantic_release/changelog/__init__.py
 semantic_release/changelog/context.py
 semantic_release/changelog/release_history.py
 semantic_release/changelog/template.py
 semantic_release/cli/__init__.py
-semantic_release/cli/common.py
+semantic_release/cli/changelog_writer.py
+semantic_release/cli/cli_context.py
 semantic_release/cli/config.py
 semantic_release/cli/const.py
 semantic_release/cli/github_actions_output.py
@@ -50,7 +52,6 @@ semantic_release/cli/masking_filter.py
 semantic_release/cli/util.py
 semantic_release/cli/commands/__init__.py
 semantic_release/cli/commands/changelog.py
-semantic_release/cli/commands/cli_context.py
 semantic_release/cli/commands/generate_config.py
 semantic_release/cli/commands/main.py
 semantic_release/cli/commands/publish.py

python_semantic_release-9.8.5/python_semantic_release.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+psr = semantic_release.cli.commands.main:main
+semantic-release = semantic_release.cli.commands.main:main

{python_semantic_release-9.8.3 → python_semantic_release-9.8.5}/python_semantic_release.egg-info/requires.txt

@@ -17,7 +17,7 @@ build~=1.2
 [dev]
 pre-commit~=3.5
 tox~=4.11
-ruff==0.4.9
+ruff==0.5.0
 
 [docs]
 Sphinx~=6.0
@@ -26,8 +26,8 @@ sphinx-autobuild==2024.2.4
 furo~=2024.1
 
 [mypy]
-mypy==1.10.0
-types-requests~=2.31.0
+mypy==1.10.1
+types-requests~=2.32.0
 
 [test]
 coverage[toml]~=7.0

{python_semantic_release-9.8.3 → python_semantic_release-9.8.5}/semantic_release/__init__.py

@@ -24,7 +24,25 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.8.3"
+__version__ = "9.8.5"
+
+__all__ = [
+    "CommitParser",
+    "ParsedCommit",
+    "ParseError",
+    "ParseResult",
+    "ParseResultType",
+    "ParserOptions",
+    "LevelBump",
+    "SemanticReleaseBaseError",
+    "CommitParseError",
+    "InvalidConfiguration",
+    "InvalidVersion",
+    "Version",
+    "VersionTranslator",
+    "next_version",
+    "tags_and_versions",
+]
 
 
 def setup_hook(argv: list[str]) -> None:
@@ -36,6 +54,6 @@ def setup_hook(argv: list[str]) -> None:
     if len(argv) > 1 and any(
         cmd in argv for cmd in ["version", "publish", "changelog"]
     ):
-        from semantic_release.cli import main
+        from semantic_release.cli.commands.main import main
 
         main()

{python_semantic_release-9.8.3 → python_semantic_release-9.8.5}/semantic_release/__main__.py

@@ -1,6 +1,6 @@
 import sys
 
-from semantic_release.cli import main
+from semantic_release.cli.commands.main import main
 
 if __name__ == "__main__":
     main(args=sys.argv[1:])

{python_semantic_release-9.8.3 → python_semantic_release-9.8.5}/semantic_release/changelog/context.py

@@ -6,8 +6,32 @@ from typing import TYPE_CHECKING, Any, Callable
 if TYPE_CHECKING:
     from jinja2 import Environment
 
-    from semantic_release.changelog.release_history import ReleaseHistory
+    from semantic_release.changelog.release_history import Release, ReleaseHistory
     from semantic_release.hvcs._base import HvcsBase
+    from semantic_release.version.version import Version
+
+
+@dataclass
+class ReleaseNotesContext:
+    repo_name: str
+    repo_owner: str
+    hvcs_type: str
+    version: Version
+    release: Release
+    filters: tuple[Callable[..., Any], ...] = ()
+
+    def bind_to_environment(self, env: Environment) -> Environment:
+        env_globals = dict(
+            filter(lambda k_v: k_v[0] != "filters", self.__dict__.items())
+        )
+
+        for g, v in env_globals.items():
+            env.globals[g] = v
+
+        for f in self.filters:
+            env.filters[f.__name__] = f
+
+        return env
 
 
 @dataclass

{python_semantic_release-9.8.3 → python_semantic_release-9.8.5}/semantic_release/changelog/release_history.py

@@ -41,6 +41,13 @@ class ReleaseHistory:
         unreleased: dict[str, list[ParseResult]] = defaultdict(list)
         released: dict[Version, Release] = {}
 
+        # Performance optimization: create a mapping of tag sha to version
+        # so we can quickly look up the version for a given commit based on sha
+        tag_sha_2_version_lookup = {
+            tag.commit.hexsha: (tag, version)
+            for tag, version in all_git_tags_and_versions
+        }
+
         # Strategy:
         # Loop through commits in history, parsing as we go.
         # Add these commits to `unreleased` as a key-value mapping
@@ -54,7 +61,7 @@ class ReleaseHistory:
         is_commit_released = False
         the_version: Version | None = None
 
-        for commit in repo.iter_commits():
+        for commit in repo.iter_commits("HEAD", topo_order=True):
             # mypy will be happy if we make this an explicit string
             commit_message = str(commit.message)
 
@@ -64,45 +71,44 @@ class ReleaseHistory:
             )
             log.debug("commit has type %s", commit_type)
 
-            for tag, version in all_git_tags_and_versions:
-                if tag.commit == commit:
-                    # we have found the latest commit introduced by this tag
-                    # so we create a new Release entry
-                    log.debug("found commit %s for tag %s", commit.hexsha, tag.name)
-                    is_commit_released = True
-                    the_version = version
-
-                    # tag.object is a Commit if the tag is lightweight, otherwise
-                    # it is a TagObject with additional metadata about the tag
-                    if isinstance(tag.object, TagObject):
-                        tagger = tag.object.tagger
-                        committer = tag.object.tagger.committer()
-                        _tz = timezone(
-                            timedelta(seconds=-1 * tag.object.tagger_tz_offset)
-                        )
-                        tagged_date = datetime.fromtimestamp(
-                            tag.object.tagged_date, tz=_tz
-                        )
-                    else:
-                        # For some reason, sometimes tag.object is a Commit
-                        tagger = tag.object.author
-                        committer = tag.object.author
-                        _tz = timezone(
-                            timedelta(seconds=-1 * tag.object.author_tz_offset)
-                        )
-                        tagged_date = datetime.fromtimestamp(
-                            tag.object.committed_date, tz=_tz
-                        )
-
-                    release = Release(
-                        tagger=tagger,
-                        committer=committer,
-                        tagged_date=tagged_date,
-                        elements=defaultdict(list),
+            log.debug("checking if commit %s matches any tags", commit.hexsha)
+            t_v = tag_sha_2_version_lookup.get(commit.hexsha, None)
+
+            if t_v is None:
+                log.debug("no tags correspond to commit %s", commit.hexsha)
+            else:
+                # Unpack the tuple (overriding the current version)
+                tag, the_version = t_v
+                # we have found the latest commit introduced by this tag
+                # so we create a new Release entry
+                log.debug("found commit %s for tag %s", commit.hexsha, tag.name)
+                is_commit_released = True
+
+                # tag.object is a Commit if the tag is lightweight, otherwise
+                # it is a TagObject with additional metadata about the tag
+                if isinstance(tag.object, TagObject):
+                    tagger = tag.object.tagger
+                    committer = tag.object.tagger.committer()
+                    _tz = timezone(timedelta(seconds=-1 * tag.object.tagger_tz_offset))
+                    tagged_date = datetime.fromtimestamp(tag.object.tagged_date, tz=_tz)
+                else:
+                    # For some reason, sometimes tag.object is a Commit
+                    tagger = tag.object.author
+                    committer = tag.object.author
+                    _tz = timezone(timedelta(seconds=-1 * tag.object.author_tz_offset))
+                    tagged_date = datetime.fromtimestamp(
+                        tag.object.committed_date, tz=_tz
                     )
 
-                    released.setdefault(the_version, release)
-                    break
+                release = Release(
+                    tagger=tagger,
+                    committer=committer,
+                    tagged_date=tagged_date,
+                    elements=defaultdict(list),
+                    version=the_version,
+                )
+
+                released.setdefault(the_version, release)
 
             if any(pat.match(commit_message) for pat in exclude_commit_patterns):
                 log.debug(
@@ -165,6 +171,7 @@ class ReleaseHistory:
                     "committer": committer,
                     "tagged_date": tagged_date,
                     "elements": self.unreleased,
+                    "version": version,
                 },
                 **self.released,
             },
@@ -183,3 +190,4 @@ class Release(TypedDict):
     committer: Actor
     tagged_date: datetime
     elements: dict[str, list[ParseResult]]
+    version: Version

python_semantic_release-9.8.5/semantic_release/cli/changelog_writer.py

@@ -0,0 +1,169 @@
+from __future__ import annotations
+
+from logging import getLogger
+from os import listdir
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+# NOTE: use backport with newer API than stdlib
+from importlib_resources import files
+
+from semantic_release.changelog.context import (
+    ReleaseNotesContext,
+    make_changelog_context,
+)
+from semantic_release.changelog.template import environment, recursive_render
+from semantic_release.cli.util import noop_report
+
+if TYPE_CHECKING:
+    from jinja2 import Environment
+
+    from semantic_release.changelog.release_history import Release, ReleaseHistory
+    from semantic_release.cli.config import RuntimeContext
+    from semantic_release.hvcs._base import HvcsBase
+
+
+log = getLogger(__name__)
+
+
+def get_release_notes_template(template_dir: Path) -> str:
+    """Read the project's template for release notes, falling back to the default."""
+    fname = template_dir / ".release_notes.md.j2"
+    try:
+        return fname.read_text(encoding="utf-8")
+    except FileNotFoundError:
+        return (
+            files("semantic_release")
+            .joinpath("data/templates/release_notes.md.j2")
+            .read_text(encoding="utf-8")
+        )
+
+
+def render_default_changelog_file(template_env: Environment) -> str:
+    changelog_text = (
+        files("semantic_release")
+        .joinpath("data/templates/CHANGELOG.md.j2")
+        .read_text(encoding="utf-8")
+    )
+    template = template_env.from_string(changelog_text)
+    return template.render().rstrip()
+
+
+def render_release_notes(
+    release_notes_template: str,
+    template_env: Environment,
+) -> str:
+    template = template_env.from_string(release_notes_template)
+    return template.render().rstrip()
+
+
+def apply_user_changelog_template_directory(
+    template_dir: Path,
+    environment: Environment,
+    destination_dir: Path,
+    noop: bool = False,
+) -> list[str]:
+    if noop:
+        noop_report(
+            str.join(
+                " ",
+                [
+                    "would have recursively rendered the template directory",
+                    f"{template_dir!r} relative to {destination_dir!r}.",
+                    "Paths which would be modified by this operation cannot be",
+                    "determined in no-op mode.",
+                ],
+            )
+        )
+        return []
+
+    return recursive_render(
+        template_dir, environment=environment, _root_dir=destination_dir
+    )
+
+
+def write_default_changelog(
+    changelog_file: Path,
+    destination_dir: Path,
+    environment: Environment,
+    noop: bool = False,
+) -> str:
+    if noop:
+        noop_report(
+            str.join(
+                " ",
+                [
+                    "would have written your changelog to",
+                    str(changelog_file.relative_to(destination_dir)),
+                ],
+            )
+        )
+    else:
+        changelog_text = render_default_changelog_file(environment)
+        changelog_file.write_text(f"{changelog_text}\n", encoding="utf-8")
+
+    return str(changelog_file)
+
+
+def write_changelog_files(
+    runtime_ctx: RuntimeContext,
+    release_history: ReleaseHistory,
+    hvcs_client: HvcsBase,
+    noop: bool = False,
+) -> list[str]:
+    project_dir = Path(runtime_ctx.repo_dir)
+    template_dir = runtime_ctx.template_dir
+
+    changelog_context = make_changelog_context(
+        hvcs_client=hvcs_client,
+        release_history=release_history,
+    )
+
+    changelog_context.bind_to_environment(runtime_ctx.template_environment)
+
+    use_user_template_dir = bool(
+        # Directory exists and directory is not empty
+        template_dir.exists() and template_dir.is_dir() and listdir(template_dir)
+    )
+
+    if use_user_template_dir:
+        return apply_user_changelog_template_directory(
+            template_dir=template_dir,
+            environment=runtime_ctx.template_environment,
+            destination_dir=project_dir,
+            noop=noop,
+        )
+
+    log.info("No contents found in %r, using default changelog template", template_dir)
+    return [
+        write_default_changelog(
+            changelog_file=runtime_ctx.changelog_file,
+            destination_dir=project_dir,
+            environment=runtime_ctx.template_environment,
+            noop=noop,
+        )
+    ]
+
+
+def generate_release_notes(
+    hvcs_client: HvcsBase,
+    release: Release,
+    template_dir: Path,
+) -> str:
+    release_notes_env = ReleaseNotesContext(
+        repo_name=hvcs_client.repo_name,
+        repo_owner=hvcs_client.owner,
+        hvcs_type=hvcs_client.__class__.__name__.lower(),
+        version=release["version"],
+        release=release,
+        filters=(*hvcs_client.get_changelog_context_filters(),),
+    ).bind_to_environment(
+        # Use a new, non-configurable environment for release notes -
+        # not user-configurable at the moment
+        environment(template_dir=template_dir)
+    )
+
+    return render_release_notes(
+        release_notes_template=get_release_notes_template(template_dir),
+        template_env=release_notes_env,
+    )

{python_semantic_release-9.8.3/semantic_release/cli/commands → python_semantic_release-9.8.5/semantic_release/cli}/cli_context.py

@@ -14,7 +14,11 @@ from semantic_release.cli.config import (
     RuntimeContext,
 )
 from semantic_release.cli.util import load_raw_config_file, rprint
-from semantic_release.errors import InvalidConfiguration, NotAReleaseBranch
+from semantic_release.errors import (
+    DetachedHeadGitError,
+    InvalidConfiguration,
+    NotAReleaseBranch,
+)
 
 if TYPE_CHECKING:
     from semantic_release.cli.config import GlobalCommandLineOptions
@@ -30,10 +34,17 @@ class CliContextObj:
         logger: logging.Logger,
         global_opts: GlobalCommandLineOptions,
     ) -> None:
-        self._runtime_ctx: RuntimeContext | None = None
         self.ctx = ctx
         self.logger = logger
         self.global_opts = global_opts
+        self._raw_config: RawConfig | None = None
+        self._runtime_ctx: RuntimeContext | None = None
+
+    @property
+    def raw_config(self) -> RawConfig:
+        if self._raw_config is None:
+            self._raw_config = self._init_raw_config()
+        return self._raw_config
 
     @property
     def runtime_ctx(self) -> RuntimeContext:
@@ -45,7 +56,7 @@ class CliContextObj:
             self._runtime_ctx = self._init_runtime_ctx()
         return self._runtime_ctx
 
-    def _init_runtime_ctx(self) -> RuntimeContext:
+    def _init_raw_config(self) -> RawConfig:
         config_path = Path(self.global_opts.config_file)
         conf_file_exists = config_path.exists()
         was_conf_file_user_provided = bool(
@@ -56,9 +67,10 @@ class CliContextObj:
             )
         )
 
+        # TODO: Evaluate Exeception catches
         try:
             if was_conf_file_user_provided and not conf_file_exists:
-                raise FileNotFoundError(
+                raise FileNotFoundError(  # noqa: TRY301
                     f"File {self.global_opts.config_file} does not exist"
                 )
 
@@ -70,9 +82,23 @@ class CliContextObj:
                     "configuration empty, falling back to default configuration"
                 )
 
-            raw_config = RawConfig.model_validate(config_obj)
+            return RawConfig.model_validate(config_obj)
+        except FileNotFoundError as exc:
+            click.echo(str(exc), err=True)
+            self.ctx.exit(2)
+        except (
+            ValidationError,
+            InvalidConfiguration,
+            InvalidGitRepositoryError,
+        ) as exc:
+            click.echo(str(exc), err=True)
+            self.ctx.exit(1)
+
+    def _init_runtime_ctx(self) -> RuntimeContext:
+        # TODO: Evaluate Exception catches
+        try:
             runtime = RuntimeContext.from_raw_config(
-                raw_config,
+                self.raw_config,
                 global_cli_options=self.global_opts,
             )
         except NotAReleaseBranch as exc:
@@ -81,13 +107,11 @@ class CliContextObj:
             # multibranch CI it might be desirable to run a non-release branch's pipeline
             # without specifying conditional execution of PSR based on branch name
             self.ctx.exit(2 if self.global_opts.strict else 0)
-        except FileNotFoundError as exc:
-            click.echo(str(exc), err=True)
-            self.ctx.exit(2)
         except (
-            ValidationError,
+            DetachedHeadGitError,
             InvalidConfiguration,
             InvalidGitRepositoryError,
+            ValidationError,
         ) as exc:
             click.echo(str(exc), err=True)
             self.ctx.exit(1)