gha-utils 4.17.9__py3-none-any.whl → 4.18.1__py3-none-any.whl

gha_utils/__init__.py

@@ -17,4 +17,4 @@
 
 from __future__ import annotations
 
-__version__ = "4.17.9"
+__version__ = "4.18.1"

gha_utils/cli.py

@@ -116,8 +116,8 @@ def gha_utils():
 )
 @option(
     "--format",
-    type=Choice(tuple(item.value for item in Dialects), case_sensitive=False),
-    default="github",
+    type=Choice(Dialects, case_sensitive=False),  # type: ignore[arg-type]
+    default=Dialects.github,
     help="Rendering format of the metadata.",
 )
 @option(

gha_utils/matrix.py

@@ -27,7 +27,7 @@ from boltons.iterutils import unique
 RESERVED_MATRIX_KEYWORDS = ["include", "exclude"]
 
 
-class Matrix(FrozenDict):
+class Matrix:
     """A matrix as defined by GitHub's actions workflows.
 
     See GitHub official documentation on `how-to implement variations of jobs in a
@@ -47,35 +47,43 @@ class Matrix(FrozenDict):
     matrix.
     """
 
-    # Tuples are used to keep track of the insertion order and force immutability.
-    include: tuple[dict[str, str], ...] = tuple()
-    exclude: tuple[dict[str, str], ...] = tuple()
+    def __init__(self, *args, **kwargs):
+        self.variations: dict[str, tuple[str, ...]] = {}
+
+        # Tuples are used to keep track of the insertion order and force immutability.
+        self.include: tuple[dict[str, str], ...] = tuple()
+        self.exclude: tuple[dict[str, str], ...] = tuple()
+
+        self._job_counter = None
 
     def matrix(
         self, ignore_includes: bool = False, ignore_excludes: bool = False
-    ) -> dict[str, str]:
+    ) -> FrozenDict[str, str]:
         """Returns a copy of the matrix.
 
         The special ``include`` and ``excludes`` directives will be added by default.
         You can selectively ignore them by passing the corresponding boolean parameters.
         """
-        dict_copy = dict(self)
+        dict_copy = self.variations.copy()
         if not ignore_includes and self.include:
-            dict_copy["include"] = self.include
+            dict_copy["include"] = self.include  # type: ignore[assignment]
         if not ignore_excludes and self.exclude:
-            dict_copy["exclude"] = self.exclude
-        return dict_copy
+            dict_copy["exclude"] = self.exclude  # type: ignore[assignment]
+        return FrozenDict(dict_copy)
 
     def __repr__(self) -> str:
-        return (
-            f"<{self.__class__.__name__}: {super(FrozenDict, self).__repr__()}; "
-            f"include={self.include}; exclude={self.exclude}>"
-        )
+        return f"<{self.__class__.__name__}: {self.matrix()}>"
 
     def __str__(self) -> str:
         """Render matrix as a JSON string."""
         return json.dumps(self.matrix())
 
+    def __getitem__(self, key: str) -> tuple[str, ...]:
+        """Returns the values of a variation by its ID."""
+        if key in self.variations:
+            return self.variations[key]
+        raise KeyError(f"Variation {key} not found in matrix")
+
     @staticmethod
     def _check_ids(*var_ids: str) -> None:
         for var_id in var_ids:
@@ -89,8 +97,8 @@ class Matrix(FrozenDict):
         if any(type(v) is not str for v in values):
             raise ValueError(f"Only strings are accepted in {values}")
         # Extend variation with values, and deduplicate them along the way.
-        var_values = list(self.get(variation_id, [])) + list(values)
-        super(FrozenDict, self).__setitem__(variation_id, tuple(unique(var_values)))
+        var_values = list(self.variations.get(variation_id, [])) + list(values)
+        self.variations[variation_id] = tuple(unique(var_values))
 
     def _add_and_dedup_dicts(
         self, *new_dicts: dict[str, str]
@@ -123,9 +131,9 @@ class Matrix(FrozenDict):
         passing the corresponding ``with_matrix``, ``with_includes`` and
         ``with_excludes`` boolean filter parameters.
         """
-        variations = {}
+        all_variations = {}
         if with_matrix:
-            variations = {k: list(v) for k, v in self.items()}
+            all_variations = {k: list(v) for k, v in self.variations.items()}
 
         for expand, directives in (
             (with_includes, self.include),
@@ -134,9 +142,9 @@ class Matrix(FrozenDict):
             if expand:
                 for value in directives:
                     for k, v in value.items():
-                        variations.setdefault(k, []).append(v)
+                        all_variations.setdefault(k, []).append(v)
 
-        return {k: tuple(unique(v)) for k, v in variations.items()}
+        return {k: tuple(unique(v)) for k, v in all_variations.items()}
 
     def product(
         self, with_includes: bool = False, with_excludes: bool = False
@@ -148,17 +156,17 @@ class Matrix(FrozenDict):
 
         Respects the order of variations and their values.
         """
-        variations = self.all_variations(
+        all_variations = self.all_variations(
             with_includes=with_includes, with_excludes=with_excludes
         )
-        if not variations:
+        if not all_variations:
             return
         yield from map(
             dict,
             itertools.product(
                 *(
                     tuple((variant_id, v) for v in variations)
-                    for variant_id, variations in variations.items()
+                    for variant_id, variations in all_variations.items()
                 )
             ),
         )
@@ -187,11 +195,11 @@ class Matrix(FrozenDict):
                 self.all_variations(
                     with_matrix=False, with_includes=True, with_excludes=True
                 )
-            ).difference(self)
+            ).difference(self.variations)
             if unreferenced_keys:
                 raise ValueError(
                     f"Matrix exclude keys {list(unreferenced_keys)} does not match any "
-                    f"{list(self)} key within the matrix"
+                    f"{self.variations.keys()} key within the matrix"
                 )
 
         # Reset the number of combinations.
@@ -202,7 +210,7 @@ class Matrix(FrozenDict):
 
         # The matrix is empty, none of the include directive will match, so condider all
         # directives as un-applicable.
-        if not self:
+        if not self.variations:
             leftover_includes = list(self.include)
 
         # Search for include directives that matches the original matrix variations

gha_utils/metadata.py

@@ -156,6 +156,7 @@ import json
 import logging
 import os
 import re
+import sys
 import tomllib
 from collections.abc import Iterable
 from enum import StrEnum
@@ -164,8 +165,9 @@ from operator import itemgetter
 from pathlib import Path
 from random import randint
 from re import escape
-from typing import Any, Final, Iterator, cast
+from typing import Any, Final, cast
 
+import gitignore_parser
 from bumpversion.config import get_configuration  # type: ignore[import-untyped]
 from bumpversion.config.files import find_config_file  # type: ignore[import-untyped]
 from bumpversion.show import resolve_name  # type: ignore[import-untyped]
@@ -196,6 +198,7 @@ SHORT_SHA_LENGTH = 7
     depends on the size of the repository.
 """
 
+GITIGNORE_PATH = Path(".gitignore")
 
 NUITKA_BUILD_TARGETS = {
     "linux-arm64": {
@@ -315,7 +318,7 @@ WorkflowEvent = StrEnum(
 """
 
 
-Dialects = StrEnum("Dialects", ("github", "plain"))
+Dialects = StrEnum("Dialects", ("github", "json"))
 """Dialects in which metadata can be formatted to."""
 
 
@@ -347,6 +350,75 @@ MYPY_VERSION_MIN: Final = (3, 8)
 """
 
 
+# XXX Patch gitignore-parser to support Windows paths. Refs:
+# https://github.com/mherrmann/gitignore_parser/issues/60
+# https://github.com/mherrmann/gitignore_parser/pull/61
+# XXX In the future, replace this with wcmatch once it supports gitignore files:
+# https://github.com/facelessuser/wcmatch/issues/226
+
+
+_OriginalIgnoreRule = gitignore_parser.IgnoreRule
+
+
+class PatchedIgnoreRule(_OriginalIgnoreRule):  # type: ignore[misc,valid-type]
+    """Patch version of ``IgnoreRule`` to support Windows paths.
+
+    Taken from: https://github.com/mherrmann/gitignore_parser/pull/61/files
+    """
+
+    @staticmethod
+    def _count_trailing_symbol(symbol: str, text: str) -> int:
+        """Count the number of trailing characters in a string."""
+        count = 0
+        for char in reversed(str(text)):
+            if char == symbol:
+                count += 1
+            else:
+                break
+        return count
+
+    def match(self, abs_path: str | Path) -> bool:
+        matched = False
+        if self.base_path:
+            rel_path = (
+                gitignore_parser._normalize_path(abs_path)
+                .relative_to(self.base_path)
+                .as_posix()
+            )
+        else:
+            rel_path = gitignore_parser._normalize_path(abs_path).as_posix()
+        # Path() strips the trailing following symbols on windows, so we need to
+        # preserve it: ' ', '.'
+        if sys.platform.startswith("win"):
+            rel_path += " " * self._count_trailing_symbol(" ", abs_path)
+            rel_path += "." * self._count_trailing_symbol(".", abs_path)
+        # Path() strips the trailing slash, so we need to preserve it
+        # in case of directory-only negation
+        if self.negation and type(abs_path) is str and abs_path[-1] == "/":
+            rel_path += "/"
+        if rel_path.startswith("./"):
+            rel_path = rel_path[2:]
+        if re.search(self.regex, rel_path):
+            matched = True
+        return matched
+
+
+gitignore_parser.IgnoreRule = PatchedIgnoreRule
+
+
+class JSONMetadata(json.JSONEncoder):
+    """Custom JSON encoder for metadata serialization."""
+
+    def default(self, o: Any) -> Any:
+        if isinstance(o, Matrix):
+            return o.matrix()
+
+        if isinstance(o, Path):
+            return str(o)
+
+        return super().default(o)
+
+
 class Metadata:
     """Metadata class."""
 
@@ -577,11 +649,15 @@ class Metadata:
         events.
 
         .. seealso::
-
             - https://stackoverflow.com/a/67204539
             - https://stackoverflow.com/a/62953566
             - https://stackoverflow.com/a/61861763
 
+        .. seealso::
+            Pull request events on GitHub are a bit complex, see: `The Many SHAs of a
+            GitHub Pull Request
+            <https://www.kenmuse.com/blog/the-many-shas-of-a-github-pull-request/>`_.
+
         .. todo::
             Refactor so we can get rid of ``self.github_context``. Maybe there's enough
             metadata lying around in the environment variables that we can inspect the
@@ -642,11 +718,7 @@ class Metadata:
     @cached_property
     def new_commits_hash(self) -> tuple[str, ...] | None:
         """List all hashes of new commits."""
-        return (
-            cast(tuple[str, ...], self.new_commits_matrix["commit"])
-            if self.new_commits_matrix
-            else None
-        )
+        return self.new_commits_matrix["commit"] if self.new_commits_matrix else None
 
     @cached_property
     def release_commits(self) -> tuple[Commit, ...] | None:
@@ -680,13 +752,16 @@ class Metadata:
     def release_commits_hash(self) -> tuple[str, ...] | None:
         """List all hashes of release commits."""
         return (
-            cast(tuple[str, ...], self.release_commits_matrix["commit"])
+            self.release_commits_matrix["commit"]
             if self.release_commits_matrix
             else None
         )
 
-    @staticmethod
-    def glob_files(*patterns: str) -> Iterator[Path]:
+    @cached_property
+    def gitignore_exists(self) -> bool:
+        return GITIGNORE_PATH.is_file()
+
+    def glob_files(self, *patterns: str) -> list[Path]:
         """Return all file path matching the ``patterns``.
 
         Patterns are glob patterns supporting ``**`` for recursive search, and ``!``
@@ -695,46 +770,77 @@ class Metadata:
         All directories are traversed, whether they are hidden (i.e. starting with a
         dot ``.``) or not, including symlinks.
 
-        Returns both hidden and non-hidden files, but no directories.
+        Skips:
+
+        - files which does not exists
+        - directories
+        - broken symlinks
+        - files matching patterns specified by ``.gitignore`` file
+
+        Returns both hidden and non-hidden files.
 
         All files are normalized to their absolute path, so that duplicates produced by
         symlinks are ignored.
 
-        Files that doesn't exist and broken symlinks are skipped.
+        File path are returned as relative to the current working directory if
+        possible, or as absolute path otherwise.
+
+        The resulting list of file paths is sorted.
         """
+        current_dir = Path.cwd()
         seen = set()
+
+        # If the .gitignore file exists, we parse it to filter out ignored files.
+        gitignore = None
+        if self.gitignore_exists:
+            logging.debug(f"Load {GITIGNORE_PATH} to filter out ignored files.")
+            gitignore = gitignore_parser.parse_gitignore(GITIGNORE_PATH)
+
         for file_path in iglob(
             patterns,
             flags=NODIR | GLOBSTAR | DOTGLOB | GLOBTILDE | BRACE | FOLLOW | NEGATE,
         ):
             # Normalize the path to avoid duplicates.
             try:
-                normalized_path = Path(file_path).resolve(strict=True)
-            # Skip files that do not exist or broken symlinks.
+                absolute_path = Path(file_path).resolve(strict=True)
+            # Skip files that do not exists and broken symlinks.
             except OSError:
-                logging.warning(
-                    f"Skipping non-existing file / broken symlink: {file_path}"
-                )
+                logging.warning(f"Skip non-existing file / broken symlink: {file_path}")
                 continue
+
+            # Simplify the path by trying to make it relative to the current location.
+            normalized_path = absolute_path
+            try:
+                normalized_path = absolute_path.relative_to(current_dir)
+            except ValueError:
+                # If the file is not relative to the current directory, keep its
+                # absolute path.
+                logging.debug(
+                    f"{absolute_path} is not relative to {current_dir}. "
+                    "Keeping the path absolute."
+                )
+
             if normalized_path in seen:
-                logging.debug(f"Skipping duplicate file: {normalized_path}")
+                logging.debug(f"Skip duplicate file: {normalized_path}")
                 continue
-            seen.add(normalized_path)
-            yield normalized_path
 
-    @cached_property
-    def gitignore_exists(self) -> bool:
-        return Path(".gitignore").is_file()
+            # Skip files that are ignored by .gitignore.
+            if gitignore and gitignore(file_path):
+                logging.debug(f"Skip file matching {GITIGNORE_PATH}: {file_path}")
+                continue
+
+            seen.add(normalized_path)
+        return sorted(seen)
 
     @cached_property
-    def python_files(self) -> Iterator[Path]:
+    def python_files(self) -> list[Path]:
         """Returns a list of python files."""
-        yield from self.glob_files("**/*.py", "!.venv/**")
+        return self.glob_files("**/*.py", "!.venv/**")
 
     @cached_property
-    def doc_files(self) -> Iterator[Path]:
+    def doc_files(self) -> list[Path]:
         """Returns a list of doc files."""
-        yield from self.glob_files("**/*.{md,markdown,rst,tex}", "!.venv/**")
+        return self.glob_files("**/*.{md,markdown,rst,tex}", "!.venv/**")
 
     @property
     def is_python_project(self):
@@ -844,7 +950,7 @@ class Metadata:
         return None
 
     @cached_property
-    def blacken_docs_params(self) -> tuple[str, ...] | None:
+    def blacken_docs_params(self) -> str | None:
         """Generates ``blacken-docs`` parameters.
 
         `Blacken-docs reuses Black's --target-version pyXY parameters
@@ -867,7 +973,7 @@ class Metadata:
         <https://github.com/psf/black/issues/751#issuecomment-473066811>`_.
         """
         if self.py_target_versions:
-            return tuple(
+            return " ".join(
                 f"--target-version py{version.major}{version.minor}"
                 for version in self.py_target_versions
             )
@@ -1185,7 +1291,7 @@ class Metadata:
         for variations in matrix.solve():
             # We will re-attach back this binary name to the with an include directive,
             # so we need a copy the main variants it corresponds to.
-            bin_name_include = {k: variations[k] for k in matrix}
+            bin_name_include = {k: variations[k] for k in matrix.variations}
             bin_name_include["bin_name"] = (
                 "{cli_id}-{target}-{short_sha}.{extension}"
             ).format(**variations)
@@ -1316,8 +1422,8 @@ class Metadata:
                     delimiter = f"ghadelimiter_{randint(10**8, (10**9) - 1)}"
                     content += f"{env_name}<<{delimiter}\n{env_value}\n{delimiter}\n"
         else:
-            assert dialect == Dialects.plain
-            content = repr(metadata)
+            assert dialect == Dialects.json
+            content = json.dumps(metadata, cls=JSONMetadata, indent=2)
 
         logging.debug(f"Formatted metadata:\n{content}")
 

{gha_utils-4.17.9.dist-info → gha_utils-4.18.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gha-utils
-Version: 4.17.9
+Version: 4.18.1
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -48,13 +48,14 @@ Requires-Dist: boltons>=24.0.0
 Requires-Dist: bump-my-version<1.1.1,>=0.32.2
 Requires-Dist: click-extra~=5.0.2
 Requires-Dist: extra-platforms~=3.2.0
+Requires-Dist: gitignore-parser~=0.1.12
 Requires-Dist: packaging~=25.0
 Requires-Dist: PyDriller~=2.6
 Requires-Dist: pyproject-metadata~=0.9.0
 Requires-Dist: pyyaml~=6.0.0
 Requires-Dist: wcmatch>=8.5
 Provides-Extra: test
-Requires-Dist: coverage[toml]~=7.9.1; extra == "test"
+Requires-Dist: coverage[toml]~=7.10.0; extra == "test"
 Requires-Dist: pytest~=8.4.0; extra == "test"
 Requires-Dist: pytest-cases~=3.9.1; extra == "test"
 Requires-Dist: pytest-cov~=6.2.1; extra == "test"

gha_utils-4.18.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+gha_utils/__init__.py,sha256=o9J48CI8G5T4jmGN-02kTDdQbhFJhuKtzAu2qUTN3GA,866
+gha_utils/__main__.py,sha256=Dck9BjpLXmIRS83k0mghAMcYVYiMiFLltQdfRuMSP_Q,1703
+gha_utils/changelog.py,sha256=JR7iQrWjLoIOpVNe6iXQSyEii82_hM_zrYpR7QO_Uxo,5777
+gha_utils/cli.py,sha256=WME8vPpWU8ZCe-Y53702Wc6Do5rVliYrOaruDcGOUpY,15299
+gha_utils/mailmap.py,sha256=g3LQiPNjHsAgCbEYOJcQwdlXqxzmFh697vv2sxHZq-s,7014
+gha_utils/matrix.py,sha256=sZq5JLBZ0pRokSXoY5r6zHxWwprilJKlbbzXLjMXfWU,12380
+gha_utils/metadata.py,sha256=HwSjuTl1smjPVLJDtwdBzkqp4iReBIGsZXTNw6VlGt4,56133
+gha_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gha_utils/test_plan.py,sha256=AE8Mf1vSQG5EZTytoTts-gzMwUg2Zy21gUwkMlzXT94,13394
+gha_utils-4.18.1.dist-info/METADATA,sha256=OAuMKGhIkibCE3_VM_Ly53orWBoBtZWmRgfDaWaqCZM,21301
+gha_utils-4.18.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gha_utils-4.18.1.dist-info/entry_points.txt,sha256=8bJOwQYf9ZqsLhBR6gUCzvwLNI9f8tiiBrJ3AR0EK4o,54
+gha_utils-4.18.1.dist-info/top_level.txt,sha256=C94Blb61YkkyPBwCdM3J_JPDjWH0lnKa5nGZeZ5M6yE,10
+gha_utils-4.18.1.dist-info/RECORD,,

gha_utils-4.17.9.dist-info/RECORD

@@ -1,14 +0,0 @@
-gha_utils/__init__.py,sha256=USpmOfv62pqoE9bNW_qKSAekPiCNcPTqNFgpuPn6BtQ,866
-gha_utils/__main__.py,sha256=Dck9BjpLXmIRS83k0mghAMcYVYiMiFLltQdfRuMSP_Q,1703
-gha_utils/changelog.py,sha256=JR7iQrWjLoIOpVNe6iXQSyEii82_hM_zrYpR7QO_Uxo,5777
-gha_utils/cli.py,sha256=1xx7gG0fXwqHQJSQWzBLEKO1p9rAnFnkcuPnmqPS5M4,15296
-gha_utils/mailmap.py,sha256=g3LQiPNjHsAgCbEYOJcQwdlXqxzmFh697vv2sxHZq-s,7014
-gha_utils/matrix.py,sha256=_afJD0K-xZLNxwykVnUhD0Gj9cdO0Z43g3VHa-q_tkI,11941
-gha_utils/metadata.py,sha256=o7vyW8d97PGtoGZ1pyvJQbeKl86mRRfbxJnEo5dxUos,52322
-gha_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gha_utils/test_plan.py,sha256=AE8Mf1vSQG5EZTytoTts-gzMwUg2Zy21gUwkMlzXT94,13394
-gha_utils-4.17.9.dist-info/METADATA,sha256=xcDI8qdaaaJGxnW8DrV6ImnZkrYzWQ1QBit9-WgVmW4,21260
-gha_utils-4.17.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-gha_utils-4.17.9.dist-info/entry_points.txt,sha256=8bJOwQYf9ZqsLhBR6gUCzvwLNI9f8tiiBrJ3AR0EK4o,54
-gha_utils-4.17.9.dist-info/top_level.txt,sha256=C94Blb61YkkyPBwCdM3J_JPDjWH0lnKa5nGZeZ5M6yE,10
-gha_utils-4.17.9.dist-info/RECORD,,