python-semantic-release 9.8.8__tar.gz → 9.8.9__tar.gz

python_semantic_release-9.8.9/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: python-semantic-release
+Version: 9.8.9
+Summary: Automatic Semantic Versioning for Python projects
+Author-email: Rolf Erik Lekang <me@rolflekang.com>
+License: MIT
+Project-URL: changelog, https://github.com/python-semantic-release/python-semantic-release/blob/master/CHANGELOG.md
+Project-URL: documentation, https://python-semantic-release.readthedocs.io
+Project-URL: homepage, https://python-semantic-release.readthedocs.io
+Project-URL: issues, https://github.com/python-semantic-release/python-semantic-release/issues
+Project-URL: repository, http://github.com/python-semantic-release/python-semantic-release.git
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: click~=8.0
+Requires-Dist: click-option-group~=0.5
+Requires-Dist: gitpython~=3.0
+Requires-Dist: requests~=2.25
+Requires-Dist: jinja2~=3.1
+Requires-Dist: python-gitlab~=4.0
+Requires-Dist: tomlkit~=0.11
+Requires-Dist: dotty-dict~=1.3
+Requires-Dist: importlib-resources~=6.0
+Requires-Dist: pydantic~=2.0
+Requires-Dist: rich~=13.0
+Requires-Dist: shellingham~=1.5
+Provides-Extra: build
+Requires-Dist: build~=1.2; extra == "build"
+Provides-Extra: docs
+Requires-Dist: Sphinx~=6.0; extra == "docs"
+Requires-Dist: sphinxcontrib-apidoc==0.5.0; extra == "docs"
+Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
+Requires-Dist: furo~=2024.1; extra == "docs"
+Provides-Extra: test
+Requires-Dist: coverage[toml]~=7.0; extra == "test"
+Requires-Dist: pyyaml~=6.0; extra == "test"
+Requires-Dist: pytest~=8.3; extra == "test"
+Requires-Dist: pytest-env~=1.0; extra == "test"
+Requires-Dist: pytest-xdist~=3.0; extra == "test"
+Requires-Dist: pytest-mock~=3.0; extra == "test"
+Requires-Dist: pytest-lazy-fixtures~=1.1.1; extra == "test"
+Requires-Dist: pytest-cov~=5.0; extra == "test"
+Requires-Dist: pytest-pretty~=1.2; extra == "test"
+Requires-Dist: pytest-clarity~=1.0; extra == "test"
+Requires-Dist: responses~=0.25.0; extra == "test"
+Requires-Dist: requests-mock~=1.10; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pre-commit~=3.5; extra == "dev"
+Requires-Dist: tox~=4.11; extra == "dev"
+Requires-Dist: ruff==0.6.1; extra == "dev"
+Provides-Extra: mypy
+Requires-Dist: mypy==1.11.2; extra == "mypy"
+Requires-Dist: types-requests~=2.32.0; extra == "mypy"
+
+Python Semantic Release
+***********************
+
+*Automating Releases via SemVer and Commit Message Conventions*
+
+----
+
+The official documentation for Python Semantic Release can be found at
+`python-semantic-release.readthedocs.io`_.
+
+GitHub Action
+=============
+
+When using the Python Semantic Release GitHub Action, it executes the command
+``semantic-release version`` using `python-semantic-release`_.
+
+The usage information and examples for this GitHub Action is available under
+the `GitHub Actions section`_ of `python-semantic-release.readthedocs.io`_.
+
+.. _python-semantic-release: https://pypi.org/project/python-semantic-release/
+.. _python-semantic-release.readthedocs.io: https://python-semantic-release.readthedocs.io/en/latest/
+.. _GitHub Actions section: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html

python_semantic_release-9.8.9/README.rst

@@ -0,0 +1,22 @@
+Python Semantic Release
+***********************
+
+*Automating Releases via SemVer and Commit Message Conventions*
+
+----
+
+The official documentation for Python Semantic Release can be found at
+`python-semantic-release.readthedocs.io`_.
+
+GitHub Action
+=============
+
+When using the Python Semantic Release GitHub Action, it executes the command
+``semantic-release version`` using `python-semantic-release`_.
+
+The usage information and examples for this GitHub Action is available under
+the `GitHub Actions section`_ of `python-semantic-release.readthedocs.io`_.
+
+.. _python-semantic-release: https://pypi.org/project/python-semantic-release/
+.. _python-semantic-release.readthedocs.io: https://python-semantic-release.readthedocs.io/en/latest/
+.. _GitHub Actions section: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/docs/automatic-releases/github-actions.rst

@@ -53,7 +53,7 @@ Example Workflow
           - name: Python Semantic Release
             # Adjust tag with desired version if applicable. Version shorthand
             # is NOT available, e.g. vX or vX.X will not work.
-            uses: python-semantic-release/python-semantic-release@v9.8.8
+            uses: python-semantic-release/python-semantic-release@v9.8.9
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -94,13 +94,13 @@ multiple projects.
 .. code:: yaml
 
    - name: Release Project 1
-     uses: python-semantic-release/python-semantic-release@v9.8.8
+     uses: python-semantic-release/python-semantic-release@v9.8.9
      with:
        directory: ./project1
        github_token: ${{ secrets.GITHUB_TOKEN }}
 
    - name: Release Project 2
-     uses: python-semantic-release/python-semantic-release@v9.8.8
+     uses: python-semantic-release/python-semantic-release@v9.8.9
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/docs/conf.py

@@ -16,6 +16,8 @@ extensions = [
     "sphinxcontrib.apidoc",
 ]
 
+autodoc_default_options = {"ignore-module-all": True}
+
 templates_path = ["_templates"]
 source_suffix = ".rst"
 master_doc = "index"

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/docs/configuration.rst

@@ -1102,4 +1102,33 @@ specified in ``file:variable`` format. For example:
         "docs/conf.py:version",
     ]
 
+Each version variable will be transformed into a Regular Expression that will be used
+to substitute the version number in the file. The replacement algorithm is **ONLY** a
+pattern match and replace. It will **NOT** evaluate the code nor will PSR understand
+any internal object structures (ie. ``file:object.version`` will not work).
+
+.. important::
+    The Regular Expression expects a version value to exist in the file to be replaced.
+    It cannot be an empty string or a non-semver compliant string. If this is the very
+    first time you are using PSR, we recommend you set the version to ``0.0.0``. This
+    may become more flexible in the future with resolution of issue `#941`_.
+
+.. _#941: https://github.com/python-semantic-release/python-semantic-release/issues/941
+
+Given the pattern matching nature of this feature, the Regular Expression is able to
+support most file formats as a variable declaration in most languages is very similar.
+We specifically support Python, YAML, and JSON as these have been the most common
+requests. This configuration option will also work regardless of file extension
+because its only a pattern match.
+
+.. note::
+    This will also work for TOML but we recommend using :ref:`config-version_toml` for
+    TOML files as it actually will interpret the TOML file and replace the version
+    number before writing the file back to disk.
+
+.. warning::
+    If the file (ex. JSON) you are replacing has two of the same variable name in it,
+    this pattern match will not be able to differentiate between the two and will replace
+    both. This is a limitation of the pattern matching and not a bug.
+
 **Default:** ``[]``

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/docs/github-action.rst

@@ -131,7 +131,7 @@ provide the following inputs:
    - name: Python Semantic Release
      # Adjust tag with desired version if applicable. Version shorthand
      # is NOT available, e.g. vX or vX.X will not work.
-     uses: python-semantic-release/python-semantic-release@v9.8.8
+     uses: python-semantic-release/python-semantic-release@v9.8.9
      with:
        # ... other options
        force: "patch"

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/docs/index.rst

@@ -1,4 +1,54 @@
-.. include:: ../README.rst
+Python Semantic Release
+***********************
+
+|Ruff| |Test Status| |PyPI Version| |conda-forge version| |Read the Docs Status| |Pre-Commit Enabled|
+
+Automatic Semantic Versioning for Python projects. This is a Python
+implementation of `semantic-release`_ for JS by Stephan Bönnemann. If
+you find this topic interesting you should check out his `talk from
+JSConf Budapest`_.
+
+The general idea is to be able to detect what the next version of the
+project should be based on the commits. This tool will use that to
+automate the whole release, upload to an artifact repository and post changelogs to
+GitHub. You can run the tool on a CI service, or just run it locally.
+
+Installation
+============
+
+::
+
+  python3 -m pip install python-semantic-release
+  semantic-release --help
+
+Python Semantic Release is also available from `conda-forge`_ or as a `GitHub Action`_.
+Read more about the setup and configuration in our `getting started guide`_.
+
+.. _semantic-release: https://github.com/semantic-release/semantic-release
+.. _talk from JSConf Budapest: https://www.youtube.com/watch?v=tc2UgG5L7WM
+.. _getting started guide: https://python-semantic-release.readthedocs.io/en/latest/#getting-started
+.. _GitHub Action: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html
+.. _conda-forge: https://anaconda.org/conda-forge/python-semantic-release
+
+.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/python-semantic-release/python-semantic-release/main.yml?branch=master&label=Test%20Status&logo=github
+   :target: https://github.com/python-semantic-release/python-semantic-release/actions/workflows/main.yml
+   :alt: test-status
+.. |PyPI Version| image:: https://img.shields.io/pypi/v/python-semantic-release?label=PyPI&logo=pypi
+   :target: https://pypi.org/project/python-semantic-release/
+   :alt: pypi
+.. |conda-forge Version| image:: https://img.shields.io/conda/vn/conda-forge/python-semantic-release?logo=anaconda
+   :target: https://anaconda.org/conda-forge/python-semantic-release
+   :alt: conda-forge
+.. |Read the Docs Status| image:: https://img.shields.io/readthedocs/python-semantic-release?label=Read%20the%20Docs&logo=Read%20the%20Docs
+   :target: https://python-semantic-release.readthedocs.io/en/latest/
+   :alt: docs
+.. |Pre-Commit Enabled| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+   :target: https://github.com/pre-commit/pre-commit
+   :alt: pre-commit
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
 
 Documentation Contents
 ======================

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.8.8"
+version = "9.8.9"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -59,6 +59,7 @@ docs = [
 ]
 test = [
   "coverage[toml] ~= 7.0",
+  "pyyaml ~= 6.0",
   "pytest ~= 8.3",
   "pytest-env ~= 1.0",
   "pytest-xdist ~= 3.0",
@@ -73,10 +74,10 @@ test = [
 dev = [
   "pre-commit ~= 3.5",
   "tox ~= 4.11",
-  "ruff == 0.5.0"
+  "ruff == 0.6.1"
 ]
 mypy = [
-  "mypy == 1.10.1",
+  "mypy == 1.11.2",
   "types-requests ~= 2.32.0",
 ]
 
@@ -86,8 +87,8 @@ env = [
 ]
 addopts = [
   # TO DEBUG in single process, swap auto to 0
-  "-nauto",
-  # "-n0",
+  # "-nauto",
+  "-n0",
   "-ra",
   "--diff-symbols",
   "--cache-clear",

python_semantic_release-9.8.9/python_semantic_release.egg-info/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: python-semantic-release
+Version: 9.8.9
+Summary: Automatic Semantic Versioning for Python projects
+Author-email: Rolf Erik Lekang <me@rolflekang.com>
+License: MIT
+Project-URL: changelog, https://github.com/python-semantic-release/python-semantic-release/blob/master/CHANGELOG.md
+Project-URL: documentation, https://python-semantic-release.readthedocs.io
+Project-URL: homepage, https://python-semantic-release.readthedocs.io
+Project-URL: issues, https://github.com/python-semantic-release/python-semantic-release/issues
+Project-URL: repository, http://github.com/python-semantic-release/python-semantic-release.git
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: click~=8.0
+Requires-Dist: click-option-group~=0.5
+Requires-Dist: gitpython~=3.0
+Requires-Dist: requests~=2.25
+Requires-Dist: jinja2~=3.1
+Requires-Dist: python-gitlab~=4.0
+Requires-Dist: tomlkit~=0.11
+Requires-Dist: dotty-dict~=1.3
+Requires-Dist: importlib-resources~=6.0
+Requires-Dist: pydantic~=2.0
+Requires-Dist: rich~=13.0
+Requires-Dist: shellingham~=1.5
+Provides-Extra: build
+Requires-Dist: build~=1.2; extra == "build"
+Provides-Extra: docs
+Requires-Dist: Sphinx~=6.0; extra == "docs"
+Requires-Dist: sphinxcontrib-apidoc==0.5.0; extra == "docs"
+Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
+Requires-Dist: furo~=2024.1; extra == "docs"
+Provides-Extra: test
+Requires-Dist: coverage[toml]~=7.0; extra == "test"
+Requires-Dist: pyyaml~=6.0; extra == "test"
+Requires-Dist: pytest~=8.3; extra == "test"
+Requires-Dist: pytest-env~=1.0; extra == "test"
+Requires-Dist: pytest-xdist~=3.0; extra == "test"
+Requires-Dist: pytest-mock~=3.0; extra == "test"
+Requires-Dist: pytest-lazy-fixtures~=1.1.1; extra == "test"
+Requires-Dist: pytest-cov~=5.0; extra == "test"
+Requires-Dist: pytest-pretty~=1.2; extra == "test"
+Requires-Dist: pytest-clarity~=1.0; extra == "test"
+Requires-Dist: responses~=0.25.0; extra == "test"
+Requires-Dist: requests-mock~=1.10; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pre-commit~=3.5; extra == "dev"
+Requires-Dist: tox~=4.11; extra == "dev"
+Requires-Dist: ruff==0.6.1; extra == "dev"
+Provides-Extra: mypy
+Requires-Dist: mypy==1.11.2; extra == "mypy"
+Requires-Dist: types-requests~=2.32.0; extra == "mypy"
+
+Python Semantic Release
+***********************
+
+*Automating Releases via SemVer and Commit Message Conventions*
+
+----
+
+The official documentation for Python Semantic Release can be found at
+`python-semantic-release.readthedocs.io`_.
+
+GitHub Action
+=============
+
+When using the Python Semantic Release GitHub Action, it executes the command
+``semantic-release version`` using `python-semantic-release`_.
+
+The usage information and examples for this GitHub Action is available under
+the `GitHub Actions section`_ of `python-semantic-release.readthedocs.io`_.
+
+.. _python-semantic-release: https://pypi.org/project/python-semantic-release/
+.. _python-semantic-release.readthedocs.io: https://python-semantic-release.readthedocs.io/en/latest/
+.. _GitHub Actions section: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/python_semantic_release.egg-info/SOURCES.txt

@@ -111,6 +111,7 @@ tests/scenario/__init__.py
 tests/scenario/test_next_version.py
 tests/scenario/test_release_history.py
 tests/scenario/test_template_render.py
+tests/scenario/test_version_stamp.py
 tests/unit/__init__.py
 tests/unit/semantic_release/__init__.py
 tests/unit/semantic_release/test_helpers.py

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/python_semantic_release.egg-info/requires.txt

@@ -17,7 +17,7 @@ build~=1.2
 [dev]
 pre-commit~=3.5
 tox~=4.11
-ruff==0.5.0
+ruff==0.6.1
 
 [docs]
 Sphinx~=6.0
@@ -26,11 +26,12 @@ sphinx-autobuild==2024.2.4
 furo~=2024.1
 
 [mypy]
-mypy==1.10.1
+mypy==1.11.2
 types-requests~=2.32.0
 
 [test]
 coverage[toml]~=7.0
+pyyaml~=6.0
 pytest~=8.3
 pytest-env~=1.0
 pytest-xdist~=3.0

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/semantic_release/__init__.py

@@ -24,7 +24,7 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.8.8"
+__version__ = "9.8.9"
 
 __all__ = [
     "CommitParser",

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/semantic_release/cli/commands/version.py

@@ -219,19 +219,12 @@ def build_distributions(
     """
     Run the build command to build the distributions.
 
-    Arguments:
-    ---------
-        build_command: str | None
-            The build command to run
-        build_command_env: Mapping[str, str] | None
-            The environment variables to use when running the build command
-        noop: bool
-            Whether or not to run the build command
-
-    Raises:
-    ------
-        BuildDistributionsError: if the build command fails
+    :param build_command: The build command to run.
+    :param build_command_env: The environment variables to use when running the
+        build command.
+    :param noop: Whether or not to run the build command.
 
+    :raises: BuildDistributionsError: if the build command fails
     """
     if not build_command:
         rprint("[green]No build command specified, skipping")

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/semantic_release/cli/config.py

@@ -540,7 +540,18 @@ class RuntimeContext:
             try:
                 path, variable = decl.split(":", maxsplit=1)
                 # VersionDeclarationABC handles path existence check
-                search_text = rf"(?x){variable}\s*(:=|[:=])\s*(?P<quote>['\"])(?P<version>{SEMVER_REGEX.pattern})(?P=quote)"  # noqa: E501
+                search_text = str.join(
+                    "",
+                    [
+                        # Supports optional matching quotations around variable name
+                        # Negative lookbehind to ensure we don't match part of a variable name
+                        f"""(?x)(?P<quote1>['"])?(?<![\\w.-]){variable}(?P=quote1)?""",
+                        # Supports walrus, equals sign, or colon as assignment operator ignoring whitespace separation
+                        r"\s*(:=|[:=])\s*",
+                        # Supports optional matching quotations around version number of a SEMVER pattern
+                        f"""(?P<quote2>['"])?(?P<version>{SEMVER_REGEX.pattern})(?P=quote2)?""",
+                    ],
+                )
                 pd = PatternVersionDeclaration(path, search_text)
             except ValueError as exc:
                 log.exception("Invalid variable declaration %r", decl)

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/semantic_release/hvcs/gitea.py

@@ -95,11 +95,9 @@ class Gitea(RemoteHvcsBase):
         Ref: https://gitea.com/api/swagger#/repository/repoCreateRelease
 
         :param tag: Tag to create release for
-
         :param release_notes: The release notes for this version
-
         :param prerelease: Whether or not this release should be specified as a
-        prerelease
+            prerelease
 
         :return: Whether the request succeeded
         """
@@ -181,6 +179,7 @@ class Gitea(RemoteHvcsBase):
         Get a release by its tag name
         https://gitea.com/api/swagger#/repository/repoGetReleaseByTag
         :param tag: Tag to get release for
+
         :return: ID of found release
         """
         tag_endpoint = self.create_api_url(
@@ -206,6 +205,7 @@ class Gitea(RemoteHvcsBase):
         https://gitea.com/api/swagger#/repository/repoEditRelease
         :param id: ID of release to update
         :param release_notes: The release notes for this version
+
         :return: The ID of the release that was edited
         """
         log.info("Updating release %s", release_id)
@@ -231,6 +231,7 @@ class Gitea(RemoteHvcsBase):
         Post release changelog
         :param version: The version number
         :param changelog: The release notes for this version
+
         :return: The status of the request
         """
         log.info("Creating release for %s", tag)
@@ -274,6 +275,7 @@ class Gitea(RemoteHvcsBase):
         :param release_id: ID of the release to upload to
         :param file: Path of the file to upload
         :param label: this parameter has no effect
+
         :return: The status of the request
         """
         url = self.asset_upload_url(release_id)
@@ -312,6 +314,7 @@ class Gitea(RemoteHvcsBase):
         Upload distributions to a release
         :param tag: Tag to upload for
         :param path: Path to the dist directory
+
         :return: The number of distributions successfully uploaded
         """
         # Find the release corresponding to this tag

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/semantic_release/hvcs/gitlab.py

@@ -106,23 +106,16 @@ class Gitlab(RemoteHvcsBase):
         """
         Create a release in a remote VCS, adding any release notes and assets to it
 
-        Arguments:
-        ---------
-            tag(str): The tag to create the release for
-            release_notes(str): The changelog description for this version only
-            prerelease(bool): This parameter has no effect in GitLab
-            assets(list[str]): A list of paths to files to upload as assets (TODO: not implemented)
-            noop(bool): If True, do not perform any actions, only log intents
-
-        Returns:
-        -------
-            str: The tag of the release
-
-        Raises:
-        ------
-            GitlabAuthenticationError: If authentication is not correct
-            GitlabCreateError: If the server cannot perform the request
+        :param tag: The tag to create the release for
+        :param release_notes: The changelog description for this version only
+        :param prerelease: This parameter has no effect in GitLab
+        :param assets: A list of paths to files to upload as assets (TODO: not implemented)
+        :param noop: If True, do not perform any actions, only log intents
 
+        :return: The tag of the release
+
+        :raises: GitlabAuthenticationError: If authentication is not correct
+        :raises: GitlabCreateError: If the server cannot perform the request
         """
         if noop:
             noop_report(f"would have created a release for tag {tag}")
@@ -145,20 +138,13 @@ class Gitlab(RemoteHvcsBase):
     @suppress_not_found
     def get_release_by_tag(self, tag: str) -> gitlab.v4.objects.ProjectRelease | None:
         """
-        Get a release by its tag name
-
-        Arguments:
-        ---------
-            tag(str): The tag name to get the release for
+        Get a release by its tag name.
 
-        Returns:
-        -------
-            gitlab.v4.objects.ProjectRelease | None: The release object or None if not found
+        :param tag: The tag name to get the release for
 
-        Raises:
-        ------
-            gitlab.exceptions.GitlabAuthenticationError: If the user is not authenticated
+        :return: gitlab.v4.objects.ProjectRelease or None if not found
 
+        :raises: gitlab.exceptions.GitlabAuthenticationError: If the user is not authenticated
         """
         try:
             return self.project.releases.get(tag)
@@ -175,21 +161,15 @@ class Gitlab(RemoteHvcsBase):
         release_notes: str,
     ) -> str:
         """
-        Update the release notes for a given release
+        Update the release notes for a given release.
 
-        Arguments:
-        ---------
-            release(gitlab.v4.objects.ProjectRelease): The release object to update
-            release_notes(str): The new release notes
+        :param release: The release object to update
+        :param release_notes: The new release notes
 
-        Returns:
-        -------
-            str: The release id
+        :return: The release id
 
-        Raises:
-        ------
-            GitlabAuthenticationError: If authentication is not correct
-            GitlabUpdateError: If the server cannot perform the request
+        :raises: GitlabAuthenticationError: If authentication is not correct
+        :raises: GitlabUpdateError: If the server cannot perform the request
 
         """
         log.info(
@@ -206,24 +186,17 @@ class Gitlab(RemoteHvcsBase):
         self, tag: str, release_notes: str, prerelease: bool = False
     ) -> str:
         """
-        Create or update a release for the given tag in a remote VCS
-
-        Arguments:
-        ---------
-            tag(str): The tag to create or update the release for
-            release_notes(str): The changelog description for this version only
-            prerelease(bool): This parameter has no effect in GitLab
+        Create or update a release for the given tag in a remote VCS.
 
-        Returns:
-        -------
-            str: The release id
+        :param tag: The tag to create or update the release for
+        :param release_notes: The changelog description for this version only
+        :param prerelease: This parameter has no effect in GitLab
 
-        Raises:
-        ------
-            ValueError: If the release could not be created or updated
-            gitlab.exceptions.GitlabAuthenticationError: If the user is not authenticated
-            GitlabUpdateError: If the server cannot perform the request
+        :return: The release id
 
+        :raises ValueError: If the release could not be created or updated
+        :raises gitlab.exceptions.GitlabAuthenticationError: If the user is not authenticated
+        :raises GitlabUpdateError: If the server cannot perform the request
         """
         try:
             return self.create_release(

{python_semantic_release-9.8.8 → python_semantic_release-9.8.9}/semantic_release/hvcs/util.py

@@ -21,12 +21,14 @@ def build_requests_session(
 ) -> Session:
     """
     Create a requests session.
+
     :param raise_for_status: If True, a hook to invoke raise_for_status be installed
     :param retry: If true, it will use default Retry configuration. if an integer, it
-                  will use default Retry configuration with given integer as total retry
-                  count. if Retry instance, it will use this instance.
+        will use default Retry configuration with given integer as total retry
+        count. if Retry instance, it will use this instance.
     :param auth: Optional TokenAuth instance to be used to provide the Authorization
-                 header to the session
+        header to the session
+
     :return: configured requests Session
     """
     session = Session()