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

antsibull_nox/sessions/utils.py

@@ -0,0 +1,206 @@
+# 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
+
+"""
+Utils for creating nox sessions.
+"""
+
+from __future__ import annotations
+
+import logging
+import os
+import sys
+import typing as t
+from contextlib import contextmanager
+from pathlib import Path
+
+import nox
+from nox.logger import OUTPUT as nox_OUTPUT
+
+from ..data_util import prepare_data_script
+from ..paths import (
+    find_data_directory,
+    list_all_files,
+)
+
+# https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables
+# https://docs.gitlab.com/ci/variables/predefined_variables/#predefined-variables
+# https://docs.travis-ci.com/user/environment-variables/#default-environment-variables
+IN_CI = os.environ.get("CI") == "true"
+IN_GITHUB_ACTIONS = bool(os.environ.get("GITHUB_ACTION"))
+ALLOW_EDITABLE = os.environ.get("ALLOW_EDITABLE", str(not IN_CI)).lower() in (
+    "1",
+    "true",
+)
+
+_SESSIONS: dict[str, list[dict[str, t.Any]]] = {}
+
+
+def nox_has_verbosity() -> bool:
+    """
+    Determine whether nox is run with verbosity enabled.
+    """
+    logger = logging.getLogger()
+    return logger.level <= nox_OUTPUT
+
+
+@contextmanager
+def silence_run_verbosity() -> t.Iterator[None]:
+    """
+    When using session.run() with silent=True, nox will log the output
+    if -v is used. Using this context manager prevents printing the output.
+    """
+    logger = logging.getLogger()
+    original_level = logger.level
+    try:
+        logger.setLevel(max(nox_OUTPUT + 1, original_level))
+        yield
+    finally:
+        logger.setLevel(original_level)
+
+
+@contextmanager
+def ci_group(name: str) -> t.Iterator[tuple[str, bool]]:
+    """
+    Try to ensure that the output inside the context is printed in a collapsable group.
+
+    This is highly CI system dependent, and currently only works for GitHub Actions.
+    """
+    is_collapsing = False
+    if IN_GITHUB_ACTIONS:
+        print(f"::group::{name}")
+        sys.stdout.flush()
+        is_collapsing = True
+    yield ("  " if is_collapsing else "", is_collapsing)
+    if IN_GITHUB_ACTIONS:
+        print("::endgroup::")
+        sys.stdout.flush()
+
+
+def register(name: str, data: dict[str, t.Any]) -> None:
+    """
+    Register a session name for matrix generation with additional data.
+    """
+    if name not in _SESSIONS:
+        _SESSIONS[name] = []
+    _SESSIONS[name].append(data)
+
+
+def get_registered_sessions() -> dict[str, list[dict[str, t.Any]]]:
+    """
+    Return all registered sessions.
+    """
+    return {
+        name: [session.copy() for session in sessions]
+        for name, sessions in _SESSIONS.items()
+    }
+
+
+def install(session: nox.Session, *args: str, editable: bool = False, **kwargs):
+    """
+    Install Python packages.
+    """
+    if not args:
+        return
+    # nox --no-venv
+    if isinstance(session.virtualenv, nox.virtualenv.PassthroughEnv):
+        session.warn(f"No venv. Skipping installation of {args}")
+        return
+    # Don't install in editable mode in CI or if it's explicitly disabled.
+    # This ensures that the wheel contains all of the correct files.
+    if editable and ALLOW_EDITABLE:
+        args = ("-e", *args)
+    session.install(*args, "-U", **kwargs)
+
+
+def run_bare_script(
+    session: nox.Session,
+    /,
+    name: str,
+    *,
+    use_session_python: bool = False,
+    files: list[Path] | None = None,
+    extra_data: dict[str, t.Any] | None = None,
+) -> None:
+    """
+    Run a bare script included in antsibull-nox's data directory.
+    """
+    if files is None:
+        files = list_all_files()
+    data = prepare_data_script(
+        session,
+        base_name=name,
+        paths=files,
+        extra_data=extra_data,
+    )
+    python = sys.executable
+    env = {}
+    if use_session_python:
+        python = "python"
+        env["PYTHONPATH"] = str(find_data_directory())
+    session.run(
+        python,
+        find_data_directory() / f"{name}.py",
+        "--data",
+        data,
+        external=True,
+        env=env,
+    )
+
+
+def compose_description(
+    *,
+    prefix: str | dict[t.Literal["one", "other"], str] | None = None,
+    programs: dict[str, str | bool | None],
+) -> str:
+    """
+    Compose a description for a nox session from several configurable parts.
+    """
+    parts: list[str] = []
+
+    def add(text: str, *, comma: bool = False) -> None:
+        if parts:
+            if comma:
+                parts.append(", ")
+            else:
+                parts.append(" ")
+        parts.append(text)
+
+    active_programs = [
+        (program, value if isinstance(value, str) else None)
+        for program, value in programs.items()
+        if value not in (False, None)
+    ]
+
+    if prefix:
+        if isinstance(prefix, dict):
+            if len(active_programs) == 1 and "one" in prefix:
+                add(prefix["one"])
+            else:
+                add(prefix["other"])
+        else:
+            add(prefix)
+
+    for index, (program, value) in enumerate(active_programs):
+        if index + 1 == len(active_programs) and index > 0:
+            add("and", comma=index > 1)
+        add(program, comma=index > 0 and index + 1 < len(active_programs))
+        if value is not None:
+            add(f"({value})")
+
+    return "".join(parts)
+
+
+__all__ = [
+    "ci_group",
+    "compose_description",
+    "get_registered_sessions",
+    "install",
+    "nox_has_verbosity",
+    "register",
+    "run_bare_script",
+    "silence_run_verbosity",
+]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: antsibull-nox
-Version: 0.2.0
+Version: 0.4.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/
@@ -11,7 +11,7 @@ Author-email: Felix Fontein <felix@fontein.de>, Toshio Kuratomi <a.badger@gmail.
 Maintainer-email: Felix Fontein <felix@fontein.de>, Maxwell G <maxwell@gtmx.me>
 License-Expression: GPL-3.0-or-later
 License-File: LICENSES/GPL-3.0-or-later.txt
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Ansible
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3

antsibull_nox-0.4.0.dist-info/RECORD

@@ -0,0 +1,41 @@
+antsibull_nox/__init__.py,sha256=D9rbPsKuklFL2MNeCAGCo6Qrm1C71Gaje9Om-vviX4k,845
+antsibull_nox/_pydantic.py,sha256=VTIh-u0TpWvnY6Dhe4ba8nAmR2tYmz4PXNp2_8Sr9pw,3203
+antsibull_nox/ansible.py,sha256=2EgaPK9ckS_KYTgpvb5HU9UOb6q5dpP3Az8sr1S7MU4,9346
+antsibull_nox/cli.py,sha256=NKeRlWc_0taNRcZcdMv9LHZ5nCz8-DEJxBLPxJ9vFYQ,3358
+antsibull_nox/config.py,sha256=SNiqRhu5P6XS-Uve0faLTEG0THaMEoiYti-n9-f_Kec,11037
+antsibull_nox/data_util.py,sha256=7FVoqESEc-_QdqrQ16K1AHRVHEglNbRCH_mNaYDJ7a4,953
+antsibull_nox/init.py,sha256=eRltIrS3AcHqEHk2yNAqJXv7kR6m_ysvFxIHpowd-2M,2259
+antsibull_nox/interpret_config.py,sha256=tEG6Hr7kQVpZrSAbprSqrlsVa7oPfUUcKd7WxiC5t84,10844
+antsibull_nox/lint_config.py,sha256=ZnsUbX6IdQK_IP9nvs8Kk6jb5lPdiREFSHAUuEGGceU,3848
+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/utils.py,sha256=lgBNuJ67Agl9YpFNWCjr6TBUcbC1LroZrJkv6S5VuxA,2437
+antsibull_nox/collection/__init__.py,sha256=2k6uYdiPjAgJgmz5oviYpu2Sh5ZSKSJEJCR01iz-29A,1494
+antsibull_nox/collection/data.py,sha256=HmnASNuv97xFM08gYuQcAF3Nz6Oc6eXd5NN-wbMtYUU,2966
+antsibull_nox/collection/extract.py,sha256=qNVknQRtRrCt10aawuU1Z6NTs16CA1bUEX3WDGBw68g,684
+antsibull_nox/collection/install.py,sha256=xRXJ0kY8J1eOMmtHBZC6DqG38BF-RhjhvLF-GRT-Bb0,21622
+antsibull_nox/collection/search.py,sha256=WZkcgNldl-feAqtKvn9fMMFxJ46kLeS0mqU-5R6yt7o,19296
+antsibull_nox/data/action-groups.py,sha256=qLuh2YqIpc6i2jpWFzjtFhZhx6_SDbbvJe6VH7EXrqg,6934
+antsibull_nox/data/antsibull-nox-lint-config.py,sha256=tXkKd9AqgfDs5w7S6OaBIt9HnT0KSbiQIU9tFxtYE2U,657
+antsibull_nox/data/antsibull_nox_data_util.py,sha256=D4i_sKxjAeZuDV-z9Ibow0YYIqhXo2V_YC0LONLcEXM,2931
+antsibull_nox/data/file-yamllint.py,sha256=hlS9tULwQSUMkdbYFfGtQGcPSj2scxEay6IalQfjSFE,3625
+antsibull_nox/data/license-check.py,sha256=or3GyQC0WWYMxMqL-369krGsHaySH1vX-2fwpRyJGp0,5665
+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=bPIFmNwuTznaUjUhebccFa0IF_joyjIO7d3uF2HqjZQ,8466
+antsibull_nox/sessions/__init__.py,sha256=4wTTO1E6rdCz4pVMuGUeuXi_vqFaH4whAL9qcjfOqto,2022
+antsibull_nox/sessions/ansible_lint.py,sha256=ik2heGsvpRwYm_4XGwlm53UvWQ_7FHDWaBt7ttvUYbU,1661
+antsibull_nox/sessions/ansible_test.py,sha256=uZ5fa9fBY-D4BBWqgl1bI-GfpKmXAu9YKC5G4ajum18,20379
+antsibull_nox/sessions/build_import_check.py,sha256=kdr_Cqc0jb8XQQ-2QL-g_X7wgezE04oMVFCPr7a34iA,4719
+antsibull_nox/sessions/collections.py,sha256=nhj_W2tbnsVJw6p7NkyP1xvmr3ZUmSJzwVuK0HE3oxw,4681
+antsibull_nox/sessions/docs_check.py,sha256=mVYt278xy5AVwo5rCf6FLZlhqBiEYgJ3mmWsVBShKD0,2344
+antsibull_nox/sessions/extra_checks.py,sha256=sBn0YFD8cM3OqeQ4UgYwD0NAcjKnYoy2zd8q-z4Xl2I,4110
+antsibull_nox/sessions/license_check.py,sha256=t5ut4ZluhFfk-qE6kcU8VNdvIGvzND81N7WCsbA4jLc,1824
+antsibull_nox/sessions/lint.py,sha256=Idl3g3CB_zqlDbrCvItkjvYMw4TzbBcQWQnYLt5AL5Y,21639
+antsibull_nox/sessions/utils.py,sha256=rrQdzmjdrLQula8t-BCTKbO-tAmzfOKHNn1pN2B1QVc,5632
+antsibull_nox-0.4.0.dist-info/METADATA,sha256=h--FXM-iETEiwgpBeIGAQajtcGMWAkwjKmyuFoOCZFg,7670
+antsibull_nox-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+antsibull_nox-0.4.0.dist-info/entry_points.txt,sha256=solWA9TCB37UlaGk8sHXxJg-k1HWckfKdncHDBsVSsI,57
+antsibull_nox-0.4.0.dist-info/licenses/LICENSES/GPL-3.0-or-later.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+antsibull_nox-0.4.0.dist-info/RECORD,,

antsibull_nox-0.4.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+antsibull-nox = antsibull_nox.cli:main