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

antsibull_nox/__init__.py

@@ -10,71 +10,27 @@ Antsibull Nox Helper.
 
 from __future__ import annotations
 
-from .collection import CollectionSource, setup_collection_sources
-from .config import load_config_from_toml
-from .interpret_config import interpret_config
-from .sessions import (
-    ActionGroup,
-    add_all_ansible_test_sanity_test_sessions,
-    add_all_ansible_test_unit_test_sessions,
-    add_ansible_lint,
-    add_ansible_test_integration_sessions_default_container,
-    add_ansible_test_sanity_test_session,
-    add_ansible_test_session,
-    add_ansible_test_unit_test_session,
-    add_build_import_check,
-    add_docs_check,
-    add_extra_checks,
-    add_license_check,
-    add_lint_sessions,
-    add_matrix_generator,
+from .config import (
+    CONFIG_FILENAME,
+    load_config_from_toml,
 )
+from .interpret_config import interpret_config
+from .sessions.ansible_test import add_ansible_test_session
 
-__version__ = "0.2.0"
-
-
-def setup(
-    *,
-    collection_sources: dict[str, str | CollectionSource] | None = None,
-) -> None:
-    """
-    Set-up antsibull-nox.
-    """
-    if collection_sources:
-        setup_collection_sources(
-            {
-                name: CollectionSource.parse(name, source)
-                for name, source in collection_sources.items()
-            }
-        )
+__version__ = "0.4.0"
 
 
 def load_antsibull_nox_toml() -> None:
     """
     Load and interpret antsibull-nox.toml config file.
     """
-    config = load_config_from_toml("antsibull-nox.toml")
+    config = load_config_from_toml(CONFIG_FILENAME)
     interpret_config(config)
 
 
 # pylint:disable=duplicate-code
 __all__ = (
     "__version__",
-    "ActionGroup",
-    "add_build_import_check",
-    "add_docs_check",
-    "add_extra_checks",
-    "add_license_check",
-    "add_lint_sessions",
     "add_ansible_test_session",
-    "add_ansible_test_sanity_test_session",
-    "add_all_ansible_test_sanity_test_sessions",
-    "add_ansible_test_unit_test_session",
-    "add_all_ansible_test_unit_test_sessions",
-    "add_ansible_test_integration_sessions_default_container",
-    "add_ansible_lint",
-    "add_matrix_generator",
-    "CollectionSource",
-    "setup",
     "load_antsibull_nox_toml",
 )

antsibull_nox/_pydantic.py

@@ -0,0 +1,98 @@
+# 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: Ansible Project, 2024
+
+# ========================================================================
+# **Vendored** from antsibull-core.
+#
+# I vendored this to avoid depending on antsibull-core only for this.
+# TBH, most of this should be part of pydantic anyway. See
+# https://github.com/pydantic/pydantic/discussions/2652 for a discussion
+# on this.
+#
+# pylint: disable=missing-function-docstring
+# ========================================================================
+
+"""
+Helpers for pydantic.
+"""
+
+from __future__ import annotations
+
+import typing as t
+from collections.abc import Callable, Collection
+
+import pydantic as p
+
+if t.TYPE_CHECKING:
+    from typing_extensions import TypeGuard
+
+
+def _is_basemodel(a_type: t.Any) -> TypeGuard[type[p.BaseModel]]:
+    try:
+        return issubclass(a_type, p.BaseModel)
+    except TypeError:
+        # If inspect.isclass(a_type) is checked first, no TypeError happens for
+        # Python 3.11+.
+
+        # On Python 3.9 and 3.10, issubclass(dict[int, int], p.BaseModel) raises
+        # "TypeError: issubclass() arg 1 must be a class".
+        # (https://github.com/pydantic/pydantic/discussions/5970)
+        return False
+
+
+def _modify_config(
+    cls: type[p.BaseModel],
+    processed_classes: set[type[p.BaseModel]],
+    change_config: Callable[[p.ConfigDict], bool],
+) -> bool:
+    if cls in processed_classes:
+        return False
+    change = False
+    for field_info in cls.model_fields.values():
+        if _is_basemodel(field_info.annotation):
+            change |= _modify_config(
+                field_info.annotation,
+                processed_classes,
+                change_config,
+            )
+        for subcls in t.get_args(field_info.annotation):
+            if _is_basemodel(subcls):
+                change |= _modify_config(subcls, processed_classes, change_config)
+    change |= change_config(cls.model_config)
+    if change:
+        cls.model_rebuild(force=True)
+    processed_classes.add(cls)
+    return change
+
+
+def set_extras(
+    models: type[p.BaseModel] | Collection[type[p.BaseModel]],
+    value: t.Literal["allow", "ignore", "forbid"],
+) -> None:
+    def change_config(model_config: p.ConfigDict) -> bool:
+        if model_config.get("extra") == value:
+            return False
+        model_config["extra"] = value
+        return True
+
+    processed_classes: set[type[p.BaseModel]] = set()
+    if isinstance(models, Collection):
+        for cls in models:
+            _modify_config(cls, processed_classes, change_config)
+    else:
+        _modify_config(models, processed_classes, change_config)
+
+
+def forbid_extras(models: type[p.BaseModel] | Collection[type[p.BaseModel]]) -> None:
+    set_extras(models, "forbid")
+
+
+def get_formatted_error_messages(error: p.ValidationError) -> list[str]:
+    def format_error(err) -> str:
+        location = " -> ".join(str(loc) for loc in err["loc"])
+        return f'{location}: {err["msg"]}'
+
+    return [format_error(err) for err in error.errors()]

antsibull_nox/ansible.py

@@ -253,8 +253,23 @@ def get_supported_core_versions(
     return result
 
 
+def parse_ansible_core_version(
+    version: str | AnsibleCoreVersion,
+) -> AnsibleCoreVersion:
+    """
+    Coerce a string or a AnsibleCoreVersion to a AnsibleCoreVersion.
+    """
+    if version in ("devel", "milestone"):
+        # For some reason mypy doesn't notice that
+        return t.cast(AnsibleCoreVersion, version)
+    if isinstance(version, Version):
+        return version
+    return Version.parse(version)
+
+
 __all__ = [
     "AnsibleCoreInfo",
     "get_ansible_core_info",
     "get_ansible_core_package_name",
+    "parse_ansible_core_version",
 ]

antsibull_nox/cli.py

@@ -0,0 +1,132 @@
+# 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
+
+# PYTHON_ARGCOMPLETE_OK
+
+"""Entrypoint to the antsibull-docs script."""
+
+from __future__ import annotations
+
+import argparse
+import os
+import os.path
+import sys
+from collections.abc import Callable
+
+from . import __version__
+from .init import create_initial_config as _create_initial_config
+from .lint_config import lint_config as _lint_config
+
+try:
+    import argcomplete
+
+    HAS_ARGCOMPLETE = True
+except ImportError:
+    HAS_ARGCOMPLETE = False
+
+
+def lint_config(_: argparse.Namespace) -> int:
+    """
+    Lint antsibull-nox config file.
+    """
+    errors = _lint_config()
+    for error in errors:
+        print(error)
+    return 0 if len(errors) == 0 else 3
+
+
+def create_initial_config(_: argparse.Namespace) -> int:
+    """
+    Create noxfile.py and antsibull-nox.toml.
+    """
+    try:
+        _create_initial_config()
+    except Exception as exc:  # pylint: disable=broad-exception-caught
+        print(f"Error: {exc}", file=sys.stderr)
+        return 3
+    return 0
+
+
+# Mapping from command line subcommand names to functions which implement those.
+# The functions need to take a single argument, the processed list of args.
+ARGS_MAP: dict[str, Callable[[argparse.Namespace], int]] = {
+    "lint-config": lint_config,
+    "init": create_initial_config,
+}
+
+
+class InvalidArgumentError(Exception):
+    """
+    Error while parsing arguments.
+    """
+
+
+def parse_args(program_name: str, args: list[str]) -> argparse.Namespace:
+    """
+    Parse the command line arguments.
+    """
+
+    toplevel_parser = argparse.ArgumentParser(
+        prog=program_name,
+        description="Script to manage generated documentation for ansible",
+    )
+    toplevel_parser.add_argument(
+        "--version",
+        action="version",
+        version=__version__,
+        help="Print the antsibull-nox version",
+    )
+    subparsers = toplevel_parser.add_subparsers(
+        title="Subcommands", dest="command", help="for help use: `SUBCOMMANDS -h`"
+    )
+    subparsers.required = True
+
+    subparsers.add_parser(
+        "lint-config",
+        description="Lint antsibull-nox configuration file",
+    )
+
+    subparsers.add_parser(
+        "init",
+        description="Create noxfile and antsibull-nox configuration file",
+    )
+
+    # This must come after all parser setup
+    if HAS_ARGCOMPLETE:
+        argcomplete.autocomplete(toplevel_parser)
+
+    parsed_args: argparse.Namespace = toplevel_parser.parse_args(args)
+    return parsed_args
+
+
+def run(args: list[str]) -> int:
+    """
+    Run the program.
+    """
+    program_name = os.path.basename(args[0])
+    try:
+        parsed_args: argparse.Namespace = parse_args(program_name, args[1:])
+    except InvalidArgumentError as e:
+        print(e, file=sys.stderr)
+        return 2
+
+    return ARGS_MAP[parsed_args.command](parsed_args)
+
+
+def main() -> int:
+    """
+    Entrypoint called from the script.
+
+    Return codes:
+        :0: Success
+        :1: Unhandled error.  See the Traceback for more information.
+        :2: There was a problem with the command line arguments
+    """
+    return run(sys.argv)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

antsibull_nox/collection/__init__.py

@@ -21,7 +21,7 @@ from .install import (
     setup_collections,
     setup_current_tree,
 )
-from .search import CollectionList, load_collection_data_from_disk
+from .search import GALAXY_YML, CollectionList, load_collection_data_from_disk
 
 
 def force_collection_version(path: Path, *, version: str) -> bool:
@@ -31,7 +31,7 @@ def force_collection_version(path: Path, *, version: str) -> bool:
     Returns ``True`` if the version was changed, and ``False`` if the version
     was already set to this value.
     """
-    galaxy_yml = path / "galaxy.yml"
+    galaxy_yml = path / GALAXY_YML
     try:
         data = load_yaml_file(galaxy_yml)
     except Exception as exc:

antsibull_nox/collection/data.py

@@ -10,6 +10,8 @@ Data types for collections.
 
 from __future__ import annotations
 
+import base64
+import hashlib
 from dataclasses import dataclass
 from pathlib import Path
 
@@ -98,6 +100,16 @@ class CollectionSource:
             )
         return source
 
+    def identifier(self) -> str:
+        """
+        Compute a source identifier.
+        """
+        hasher = hashlib.sha256()
+        hasher.update(self.name.encode("utf-8"))
+        hasher.update(b"::")
+        hasher.update(self.source.encode("utf-8"))
+        return base64.b32encode(hasher.digest())[:16].decode("ascii")
+
 
 __all__ = [
     "CollectionData",