antsibull-nox 0.0.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

antsibull_nox/utils.py

@@ -0,0 +1,85 @@
+# Author: Felix Fontein <felix@fontein.de>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
+# https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2025, Ansible Project
+
+"""
+General utilities.
+"""
+
+from __future__ import annotations
+
+import typing as t
+from dataclasses import dataclass
+
+
+@dataclass(order=True, frozen=True)
+class Version:
+    """
+    Models a two-part version (major and minor).
+    """
+
+    major: int
+    minor: int
+
+    @classmethod
+    def parse(cls, version_string: str) -> Version:
+        """
+        Given a version string, parses it into a Version object.
+        Other components than major and minor version are ignored.
+        """
+        try:
+            major, minor = [int(v) for v in version_string.split(".")[:2]]
+        except (AttributeError, ValueError) as exc:
+            raise ValueError(
+                f"Cannot parse {version_string!r} as version string."
+            ) from exc
+        return Version(major=major, minor=minor)
+
+    def __str__(self) -> str:
+        return f"{self.major}.{self.minor}"
+
+    def next_minor_version(self) -> Version:
+        """
+        Returns the next minor version.
+
+        The major version stays the same, and the minor version is increased by 1.
+        """
+        return Version(self.major, self.minor + 1)
+
+    def previous_minor_version(self) -> Version:
+        """
+        Returns the previous minor version.
+        Raises a ValueError if there is none.
+
+        The major version stays the same, and the minor version is decreased by 1.
+        """
+        if self.minor == 0:
+            raise ValueError("No previous minor version exists")
+        return Version(self.major, self.minor - 1)
+
+
+def version_range(
+    start: Version, end: Version, *, inclusive: bool
+) -> t.Generator[Version]:
+    """
+    Enumerate all versions starting at ``start`` until ``end``.
+
+    Whether ``end`` is included in the range depends on ``inclusive``.
+    """
+    if start.major != end.major:
+        raise ValueError(
+            f"Cannot list all versions from {start} to {end}"
+            " since they have different major versions"
+        )
+    version = start
+    while (version <= end) if inclusive else (version < end):
+        yield version
+        version = Version(major=version.major, minor=version.minor + 1)
+
+
+__all__ = [
+    "Version",
+    "version_range",
+]

{antsibull_nox-0.0.1.dist-info → antsibull_nox-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: antsibull-nox
-Version: 0.0.1
+Version: 0.2.0
 Summary: Changelog tool for Ansible-core and Ansible collections
 Project-URL: Documentation, https://ansible.readthedocs.io/projects/antsibull-nox/
 Project-URL: Source code, https://github.com/ansible-community/antsibull-nox/
@@ -22,11 +22,13 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.9.0
-Requires-Dist: antsibull-fileutils<2.0.0,>=1.0.0
+Requires-Dist: antsibull-fileutils<2.0.0,>=1.2.0
 Requires-Dist: nox>=2025.2.9
 Requires-Dist: packaging
+Requires-Dist: pydantic~=2.0
 Requires-Dist: pyyaml
 Requires-Dist: semantic-version
+Requires-Dist: tomli; python_version < '3.11'
 Provides-Extra: codeqa
 Requires-Dist: antsibull-changelog; extra == 'codeqa'
 Requires-Dist: flake8>=3.8.0; extra == 'codeqa'
@@ -67,12 +69,14 @@ SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
 # antsibull-nox -- Antsibull Nox Helper
+[![Documentation](https://img.shields.io/badge/docs-brightgreen.svg)](https://ansible.readthedocs.io/projects/antsibull-nox/)
 [![Discuss on Matrix at #antsibull:ansible.com](https://img.shields.io/matrix/antsibull:ansible.com.svg?server_fqdn=ansible-accounts.ems.host&label=Discuss%20on%20Matrix%20at%20%23antsibull:ansible.com&logo=matrix)](https://matrix.to/#/#antsibull:ansible.com)
 [![Nox badge](https://github.com/ansible-community/antsibull-nox/actions/workflows/nox.yml/badge.svg)](https://github.com/ansible-community/antsibull-nox/actions?query=workflow%3A%22nox%22+branch%3Amain)
 [![Codecov badge](https://img.shields.io/codecov/c/github/ansible-community/antsibull-nox)](https://codecov.io/gh/ansible-community/antsibull-nox)
 [![REUSE status](https://api.reuse.software/badge/github.com/ansible-community/antsibull-nox)](https://api.reuse.software/info/github.com/ansible-community/antsibull-nox)
 
 A [nox](https://nox.thea.codes/en/stable/) helper for Ansible collections.
+Please check out the [documentation](https://ansible.readthedocs.io/projects/antsibull-nox/) for more information.
 
 antsibull-nox is covered by the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
 
@@ -86,6 +90,12 @@ It can be installed with pip:
 
     pip install antsibull-nox
 
+## Versioning and compatibility
+
+From version 1.0.0 on, antsibull-nox sticks to semantic versioning and aims at providing no backwards compatibility breaking changes [**to the documented API**](https://ansible.readthedocs.io/projects/antsibull-nox/reference/) during a major release cycle. We might make exceptions from this in case of security fixes for vulnerabilities that are severe enough.
+
+Interfaces and functions that are not [documented in the API reference](https://ansible.readthedocs.io/projects/antsibull-nox/reference/) are exempt from this and might break even in bugfix releases!
+
 ## Development
 
 Install and run `nox` to run all tests. That's it for simple contributions!
@@ -139,5 +149,5 @@ General Public License v3 or, at your option, later. See
 [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-community/antsibull-nox/tree/main/LICENSE)
 for a copy of the license.
 
-The repository follows the [REUSE Specification](https://reuse.software/spec/) for declaring copyright and
-licensing information. The only exception are changelog fragments in ``changelog/fragments/``.
+The repository follows the [REUSE Specification](https://reuse.software/spec/)
+for declaring copyright and licensing information.

antsibull_nox-0.2.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+antsibull_nox/__init__.py,sha256=GpVc0V0RONI7CXHDrGoyvTvL7Syl6UDKZWL_N_z6zGg,2145
+antsibull_nox/ansible.py,sha256=_PugP3a6JXijptFwuUki5nq_66VA8e9gVZUpA5HewVg,8891
+antsibull_nox/config.py,sha256=W1u-lL0x5o2XyGo7FiQY766Pr9bP9DAi0LDfO2O7FTQ,9412
+antsibull_nox/data_util.py,sha256=7FVoqESEc-_QdqrQ16K1AHRVHEglNbRCH_mNaYDJ7a4,953
+antsibull_nox/interpret_config.py,sha256=a7Zwm7k0t8rETOehxqpidigegcroJACS-4IsbIujW30,9703
+antsibull_nox/paths.py,sha256=86HOynhCMTVop3ml_77JI06vM9nyK7PHMzLP_4M0V88,6317
+antsibull_nox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+antsibull_nox/python.py,sha256=0pyGqgwsuyc0BhzoXNZLTLbjaFA4kAYEHrFD6A1o1-o,2113
+antsibull_nox/sessions.py,sha256=fYhSLOqA1YKskaxPAAudlnWGHpV5T0TVzB5APeNc1qI,57251
+antsibull_nox/utils.py,sha256=lgBNuJ67Agl9YpFNWCjr6TBUcbC1LroZrJkv6S5VuxA,2437
+antsibull_nox/collection/__init__.py,sha256=0zsFKqAZYw6Y5wdhddsbMAmx7dKvihS9bh6CstJ5b2A,1484
+antsibull_nox/collection/data.py,sha256=sacVZF517x54B3G6F0hW8fTpEF7zyB8exSQJO9mvhLk,2609
+antsibull_nox/collection/extract.py,sha256=qNVknQRtRrCt10aawuU1Z6NTs16CA1bUEX3WDGBw68g,684
+antsibull_nox/collection/install.py,sha256=DbnXUBzQlzW6TzU_TAszuApix2F2n7w1AcUcPZ4Q4G4,17082
+antsibull_nox/collection/search.py,sha256=cNe6zyR3l-5iSOX5kBRAeHgubkUKFJhwDtN7j0rn7w0,15477
+antsibull_nox/data/action-groups.py,sha256=24l3583jcVRmCm5t8VZuMx68Del0s4iReACsvg4ijnU,6913
+antsibull_nox/data/antsibull_nox_data_util.py,sha256=D4i_sKxjAeZuDV-z9Ibow0YYIqhXo2V_YC0LONLcEXM,2931
+antsibull_nox/data/license-check.py,sha256=uXC2aP2EDxLfAEpAe6nG4pOldp3N6NX6uc-k9jdXDpU,5575
+antsibull_nox/data/license-check.py.license,sha256=iPdFtdkeE3E2nCB-M5KHevbz4d5I-6ymOnKNTc954Dw,218
+antsibull_nox/data/no-unwanted-files.py,sha256=_B3m-XWvWpdzGN-XAP8rLIS_5RMJGntFWL-Jy0WY9Mc,2959
+antsibull_nox/data/plugin-yamllint.py,sha256=ELK1pTLwDFwGfGgwRSGUU0hvOgk4P6oF_4P-y0DQIqc,7368
+antsibull_nox-0.2.0.dist-info/METADATA,sha256=izOXagec2VtPCMSGtQYWmw_68UfA5nfVyx3E0gwIb5g,7671
+antsibull_nox-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+antsibull_nox-0.2.0.dist-info/licenses/LICENSES/GPL-3.0-or-later.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+antsibull_nox-0.2.0.dist-info/RECORD,,

antsibull_nox-0.0.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-antsibull_nox/__init__.py,sha256=UasB8S_Ty0XJP1KxodA8Wqksa1dt6Ghk7_PAD2VRpY8,425
-antsibull_nox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-antsibull_nox/sessions.py,sha256=g3b27aW8l3upzuxT5HRgsBxGb-UAf1NDcL9T8ucQx8s,15638
-antsibull_nox-0.0.1.dist-info/METADATA,sha256=qC9hAvaZIeFyNyur2t3H9vJt2iMsRfHpka85pjj-JkU,6830
-antsibull_nox-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-antsibull_nox-0.0.1.dist-info/licenses/LICENSES/GPL-3.0-or-later.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-antsibull_nox-0.0.1.dist-info/RECORD,,