python-semantic-release 9.8.2__tar.gz → 9.8.4__tar.gz

{python_semantic_release-9.8.2/python_semantic_release.egg-info → python_semantic_release-9.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.8.2
+Version: 9.8.4
 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.4; 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.2 → python_semantic_release-9.8.4}/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.2 → python_semantic_release-9.8.4}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.8.2"
+version = "9.8.4"
 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.4"
+  "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.2 → python_semantic_release-9.8.4/python_semantic_release.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.8.2
+Version: 9.8.4
 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.4; 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.2 → python_semantic_release-9.8.4}/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.4/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.2 → python_semantic_release-9.8.4}/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.4
+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.2 → python_semantic_release-9.8.4}/semantic_release/__init__.py

@@ -24,7 +24,25 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.8.2"
+__version__ = "9.8.4"
+
+__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.2 → python_semantic_release-9.8.4}/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.2 → python_semantic_release-9.8.4}/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.2 → python_semantic_release-9.8.4}/semantic_release/changelog/release_history.py

@@ -99,6 +99,7 @@ class ReleaseHistory:
                         committer=committer,
                         tagged_date=tagged_date,
                         elements=defaultdict(list),
+                        version=the_version,
                     )
 
                     released.setdefault(the_version, release)
@@ -165,6 +166,7 @@ class ReleaseHistory:
                     "committer": committer,
                     "tagged_date": tagged_date,
                     "elements": self.unreleased,
+                    "version": version,
                 },
                 **self.released,
             },
@@ -183,3 +185,4 @@ class Release(TypedDict):
     committer: Actor
     tagged_date: datetime
     elements: dict[str, list[ParseResult]]
+    version: Version

python_semantic_release-9.8.4/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.2/semantic_release/cli/commands → python_semantic_release-9.8.4/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
@@ -58,7 +62,7 @@ class CliContextObj:
 
         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"
                 )
 
@@ -75,7 +79,7 @@ class CliContextObj:
                 raw_config,
                 global_cli_options=self.global_opts,
             )
-        except NotAReleaseBranch as exc:
+        except (DetachedHeadGitError, NotAReleaseBranch) as exc:
             rprint(f"[bold {'red' if self.global_opts.strict else 'orange1'}]{exc!s}")
             # If not strict, exit 0 so other processes can continue. For example, in
             # multibranch CI it might be desirable to run a non-release branch's pipeline

python_semantic_release-9.8.4/semantic_release/cli/commands/changelog.py

@@ -0,0 +1,129 @@
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING
+
+import click
+from git import Repo
+
+from semantic_release.changelog import ReleaseHistory
+from semantic_release.cli.changelog_writer import (
+    generate_release_notes,
+    write_changelog_files,
+)
+from semantic_release.cli.util import noop_report
+from semantic_release.hvcs.remote_hvcs_base import RemoteHvcsBase
+
+if TYPE_CHECKING:
+    from semantic_release.cli.cli_context import CliContextObj
+
+
+log = logging.getLogger(__name__)
+
+
+def post_release_notes(
+    release_tag: str,
+    release_notes: str,
+    prerelease: bool,
+    hvcs_client: RemoteHvcsBase,
+    noop: bool = False,
+) -> None:
+    if noop:
+        noop_report(
+            str.join(
+                "\n",
+                [
+                    f"would have posted the following release notes for tag {release_tag}:",
+                    release_notes,
+                ],
+            )
+        )
+        return
+
+    hvcs_client.create_or_update_release(
+        release_tag, f"{release_notes}\n", prerelease=prerelease
+    )
+
+
+@click.command(
+    short_help="Generate a changelog",
+    context_settings={
+        "help_option_names": ["-h", "--help"],
+    },
+)
+@click.option(
+    "--post-to-release-tag",
+    "release_tag",
+    default=None,
+    help="Post the generated release notes to the remote VCS's release for this tag",
+)
+@click.pass_obj
+def changelog(cli_ctx: CliContextObj, release_tag: str | None) -> None:
+    """Generate and optionally publish a changelog for your project"""
+    ctx = click.get_current_context()
+    runtime = cli_ctx.runtime_ctx
+    translator = runtime.version_translator
+    hvcs_client = runtime.hvcs_client
+
+    with Repo(str(runtime.repo_dir)) as git_repo:
+        release_history = ReleaseHistory.from_git_history(
+            repo=git_repo,
+            translator=translator,
+            commit_parser=runtime.commit_parser,
+            exclude_commit_patterns=runtime.changelog_excluded_commit_patterns,
+        )
+
+    write_changelog_files(
+        runtime_ctx=runtime,
+        release_history=release_history,
+        hvcs_client=hvcs_client,
+        noop=runtime.global_cli_options.noop,
+    )
+
+    if not release_tag:
+        return
+
+    if not isinstance(hvcs_client, RemoteHvcsBase):
+        click.echo(
+            "Remote does not support releases. Skipping release notes update...",
+            err=True,
+        )
+        return
+
+    if not (version := translator.from_tag(release_tag)):
+        click.echo(
+            str.join(
+                " ",
+                [
+                    f"Tag {release_tag!r} does not match the tag format",
+                    repr(translator.tag_format),
+                ],
+            ),
+            err=True,
+        )
+        ctx.exit(1)
+
+    try:
+        release = release_history.released[version]
+    except KeyError:
+        click.echo(f"tag {release_tag} not in release history", err=True)
+        ctx.exit(2)
+
+    release_notes = generate_release_notes(
+        hvcs_client,
+        release,
+        template_dir=runtime.template_dir,
+    )
+
+    try:
+        post_release_notes(
+            release_tag=release_tag,
+            release_notes=release_notes,
+            prerelease=version.is_prerelease,
+            hvcs_client=hvcs_client,
+            noop=runtime.global_cli_options.noop,
+        )
+    except Exception as e:
+        log.exception(e)
+        click.echo("Failed to post release notes to remote", err=True)
+        ctx.exit(1)

{python_semantic_release-9.8.2 → python_semantic_release-9.8.4}/semantic_release/cli/commands/main.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
+import importlib
 import logging
+from enum import Enum
 
 # from typing import TYPE_CHECKING
 import click
@@ -8,7 +10,7 @@ from rich.console import Console
 from rich.logging import RichHandler
 
 import semantic_release
-from semantic_release.cli.commands.cli_context import CliContextObj
+from semantic_release.cli.cli_context import CliContextObj
 from semantic_release.cli.config import GlobalCommandLineOptions
 from semantic_release.cli.const import DEFAULT_CONFIG_FILE
 from semantic_release.cli.util import rprint
@@ -20,7 +22,35 @@ from semantic_release.cli.util import rprint
 FORMAT = "[%(name)s] %(levelname)s %(module)s.%(funcName)s: %(message)s"
 
 
-@click.group(
+class Cli(click.MultiCommand):
+    """Root MultiCommand for the semantic-release CLI"""
+
+    class SubCmds(Enum):
+        """Subcommand import definitions"""
+
+        # SUBCMD_FUNCTION_NAME => MODULE_WITH_FUNCTION
+        CHANGELOG = f"{__package__}.changelog"
+        GENERATE_CONFIG = f"{__package__}.generate_config"
+        VERSION = f"{__package__}.version"
+        PUBLISH = f"{__package__}.publish"
+
+    def list_commands(self, _ctx: click.Context) -> list[str]:
+        # Used for shell-completion
+        return [subcmd.lower().replace("_", "-") for subcmd in Cli.SubCmds.__members__]
+
+    def get_command(self, _ctx: click.Context, name: str) -> click.Command | None:
+        subcmd_name = name.lower().replace("-", "_")
+        try:
+            subcmd_def: Cli.SubCmds = Cli.SubCmds.__dict__[subcmd_name.upper()]
+            module_path = subcmd_def.value
+            subcmd_module = importlib.import_module(module_path)
+            return getattr(subcmd_module, subcmd_name)
+        except (KeyError, ModuleNotFoundError, AttributeError):
+            return None
+
+
+@click.command(
+    cls=Cli,
     context_settings={
         "help_option_names": ["-h", "--help"],
     },