envoy.code.check 0.5.14__tar.gz → 0.6.1__tar.gz

envoy_code_check-0.6.1/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: envoy.code.check
+Version: 0.6.1
+Summary: Code checker used in Envoy proxy's CI
+Home-page: https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check
+Author: Ryan Northey
+Author-email: ryan@synca.io
+Maintainer: Ryan Northey
+Maintainer-email: ryan@synca.io
+License: Apache Software License 2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: abstracts==0.2.0
+Requires-Dist: abstracts>=0.2.0
+Requires-Dist: aio-core==0.11.0
+Requires-Dist: aio-run-checker==0.6.0
+Requires-Dist: aio.core>=0.11.0
+Requires-Dist: aio.run.checker>=0.6.0
+Requires-Dist: envoy.base.utils==0.6.1
+Requires-Dist: envoy.base.utils>=0.6.0
+Requires-Dist: flake8==7.3.0
+Requires-Dist: flake8>=6.1.0
+Requires-Dist: packaging==26.2
+Requires-Dist: packaging>=23.0
+Requires-Dist: pep8-naming>=0.13.3
+Requires-Dist: types-pyyaml==6.0.12.20260508
+Requires-Dist: yamllint==1.38.0
+Requires-Dist: yamllint>=1.32.0
+Requires-Dist: yapf==0.43.0
+Requires-Dist: yapf>=0.40.2
+Provides-Extra: test
+Requires-Dist: pytest>=7.4.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.23.3; extra == "test"
+Requires-Dist: pytest-coverage; extra == "test"
+Requires-Dist: pytest-iters>=0.1.0; extra == "test"
+Requires-Dist: pytest-patches>=0.1.0; extra == "test"
+Provides-Extra: lint
+Requires-Dist: flake8>=6.1.0; extra == "lint"
+Provides-Extra: types
+Requires-Dist: mypy>=1.6.0; extra == "types"
+Requires-Dist: mypy-abstracts>=0.1.0; extra == "types"
+Provides-Extra: publish
+Requires-Dist: wheel>=0.41.0; extra == "publish"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+envoy.code.check
+================
+
+Code checker used in Envoy proxy's CI.
+
+This package provides an async checker that runs source-code checks against an
+Envoy (or Envoy-like) checkout. Registered checks include:
+
+- ``python_flake8`` and ``python_yapf`` for Python style
+- ``yamllint`` for YAML files
+- ``shellcheck`` for shell scripts
+- ``glint`` for file hygiene checks
+- ``gofmt`` for Go formatting
+- ``runtime_guards`` consistency checks
+- extension metadata, registration, owner, and fuzz-coverage checks
+- changelog validation, including RST sanity checks
+
+Usage
+-----
+
+Installed as a console script:
+
+.. code-block:: console
+
+   $ envoy.code.check --help
+
+Run a subset of checks against a checkout:
+
+.. code-block:: console
+
+   $ envoy.code.check --check python_flake8 python_yapf --path /path/to/envoy
+
+Run only against files changed since a given ref:
+
+.. code-block:: console
+
+   $ envoy.code.check --since main --path /path/to/envoy
+
+See ``envoy.code.check --help`` for the full set of options.
+
+Links
+-----
+
+- Source: https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check
+- Issues: https://github.com/envoyproxy/toolshed/issues

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/__init__.py

@@ -69,8 +69,6 @@ __all__ = (
     "interface",
     "main",
     "run",
-    "main",
-    "run",
     "RuntimeGuardsCheck",
     "ShellcheckCheck",
     "typing",

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/base.py

@@ -31,8 +31,8 @@ class ACodeCheck(event.AExecutive, metaclass=abstracts.Abstraction):
         self._binaries = binaries
 
     @property
-    def binaries(self):
-        return self._binaries
+    def binaries(self) -> dict[str, str]:
+        return self._binaries or {}
 
 
 @abstracts.implementer(interface.IFileCodeCheck)
@@ -58,12 +58,12 @@ class AFileCodeCheck(ACodeCheck, metaclass=abstracts.Abstraction):
     @async_property
     @abstracts.interfacemethod
     async def problem_files(self) -> dict[str, list[str]]:
-        """Discovered files with flake8 errors."""
+        """Discovered files with errors."""
         raise NotImplementedError
 
 
 @abstracts.implementer(interface.IProjectCodeCheck)
-class AProjectCodeCheck(ACodeCheck,  metaclass=abstracts.Abstraction):
+class AProjectCodeCheck(ACodeCheck, metaclass=abstracts.Abstraction):
 
     def __init__(
             self,

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/changelog.py

@@ -1,8 +1,9 @@
 
 import itertools
+import pathlib
 from datetime import datetime
 from functools import cached_property
-from typing import Iterator
+from collections.abc import Iterator
 
 from packaging import version as _version
 
@@ -11,6 +12,10 @@ import abstracts
 from aio.core.functional import async_property
 
 from envoy.base import utils
+from envoy.base.utils.abstract.project.changelog import (
+    CHANGELOG_ENTRY_GLOB,
+    ENTRY_SEPARATOR,
+)
 from envoy.code.check import abstract, interface
 
 
@@ -95,6 +100,50 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
                 f"{version}/changes: Invalid `changes` section "
                 "(this is no longer used)")
 
+    def check_entry_filename(
+            self,
+            path: pathlib.Path) -> str | None:
+        section = path.parent.name
+        if section not in self.sections:
+            return (
+                f"{path}: Invalid section `{section}`. "
+                f"Valid sections: {sorted(self.sections)}")
+        if path.suffix != ".rst":
+            return (
+                f"{path}: Invalid file extension `{path.suffix}` "
+                "(expected `.rst`)")
+        if path.stem.count(ENTRY_SEPARATOR) != 1:
+            return (
+                f"{path}: Filename stem must contain exactly one "
+                f"`{ENTRY_SEPARATOR}` separator "
+                f"(expected `<area>{ENTRY_SEPARATOR}<slug>`)")
+        area, slug = path.stem.split(ENTRY_SEPARATOR, 1)
+        if not area:
+            return f"{path}: Area part of filename is empty"
+        if not slug:
+            return f"{path}: Slug part of filename is empty"
+        return None
+
+    def check_entry_content(
+            self,
+            path: pathlib.Path) -> str | None:
+        content = path.read_text()
+        if not content.strip():
+            return (
+                f"{path}: Entry file is empty or contains only whitespace")
+        return None
+
+    def check_entry_files(
+            self,
+            paths: list[pathlib.Path]) -> tuple[str, ...]:
+        errors = []
+        for path in paths:
+            if err := self.check_entry_filename(path):
+                errors.append(err)
+            if err := self.check_entry_content(path):
+                errors.append(err)
+        return tuple(errors)
+
 
 @abstracts.implementer(interface.IChangelogStatus)
 class AChangelogStatus(metaclass=abstracts.Abstraction):
@@ -136,15 +185,26 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             and self.project.changelogs.changelog_path(
                 self.version).exists())
 
+    @property
+    def entry_dir(self) -> pathlib.Path | None:
+        if not self.is_current:
+            return None
+        return (
+            self.project.changelogs
+                        .changelog_path(self.version)
+                        .with_suffix(""))
+
     @async_property(cache=True)
     async def errors(self) -> tuple[str, ...]:
+        entry_errors = await self.check_entry_files()
         try:
             return (
                 *self.check_version(),
                 *await self.check_date(),
-                *await self.check_sections())
+                *await self.check_sections(),
+                *entry_errors)
         except utils.exceptions.ChangelogParseError as e:
-            return (f"{self.version}: {e}", )
+            return (*entry_errors, f"{self.version}: {e}")
 
     @async_property
     async def invalid_date(self) -> str | None:
@@ -215,6 +275,17 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             self.version,
             await self.sections)
 
+    async def check_entry_files(self) -> tuple[str, ...]:
+        entry_dir = self.entry_dir
+        if entry_dir is None or not entry_dir.exists():
+            return ()
+        paths = sorted(entry_dir.glob(CHANGELOG_ENTRY_GLOB))
+        if not paths:
+            return ()
+        return await self.project.execute(
+            self.checker.check_entry_files,
+            paths)
+
     def check_version(self) -> tuple[str, ...]:
         errors = []
         if self.duplicate_current:

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/checker.py

@@ -4,8 +4,8 @@ import abc
 import argparse
 import pathlib
 import re
+from collections.abc import Mapping
 from functools import cached_property
-from typing import Mapping, Pattern
 
 import yaml
 
@@ -207,11 +207,11 @@ class ACodeChecker(
         raise NotImplementedError
 
     @property
-    def grep_excluding_re(self) -> Pattern[str] | None:
+    def grep_excluding_re(self) -> re.Pattern[str] | None:
         return self._grep_re(self.args.excluding)
 
     @property
-    def grep_matching_re(self) -> Pattern[str] | None:
+    def grep_matching_re(self) -> re.Pattern[str] | None:
         return self._grep_re(self.args.matching)
 
     @property
@@ -230,7 +230,7 @@ class ACodeChecker(
 
     @cached_property
     def runtime_guards(self) -> "interface.IRuntimeGuardsCheck":
-        """Shellcheck checker."""
+        """Runtime guards checker."""
         return self.runtime_guards_class(
             self.project,
             **self.check_kwargs)
@@ -302,7 +302,7 @@ class ACodeChecker(
                     [f"{changelog.version}"])
 
     async def check_extensions_fuzzed(self) -> None:
-        """Check for glint issues."""
+        """Check that all fuzzed extensions are accounted for."""
         if await self.extensions.all_fuzzed:
             self.succeed(
                 "extensions_fuzzed",
@@ -315,7 +315,7 @@ class ACodeChecker(
                  f"in {self.extensions.fuzz_test_path}"])
 
     async def check_extensions_metadata(self) -> None:
-        """Check for glint issues."""
+        """Check extensions metadata."""
         errors = await self.extensions.metadata_errors
         for extension, errors in errors.items():
             if errors:
@@ -324,7 +324,7 @@ class ACodeChecker(
                 self.succeed("extensions_metadata", [f"{extension}"])
 
     async def check_extensions_owners(self) -> None:
-        """Check for glint issues."""
+        """Check extensions owners."""
         checks = await self.extensions.owners_errors
         for extension, errors in sorted(checks.items()):
             if errors:
@@ -333,7 +333,7 @@ class ACodeChecker(
                 self.succeed("extensions_owners", [f"{extension}"])
 
     async def check_extensions_registered(self) -> None:
-        """Check for glint issues."""
+        """Check extensions are registered."""
         if errors := await self.extensions.registration_errors:
             self.error("extensions_registered", errors)
         else:
@@ -359,7 +359,8 @@ class ACodeChecker(
         await self._code_check(self.yapf)
 
     async def check_runtime_guards(self) -> None:
-        """Check for shellcheck issues."""
+        """Check runtime guards."""
+
         async for guard, status in self.runtime_guards.status:
             if status is None:
                 self.log.info(f"Ignoring runtime guard: {guard}")
@@ -477,7 +478,7 @@ class ACodeChecker(
             await check.files,
             await check.problem_files)
 
-    def _grep_re(self, arg: str | None) -> Pattern[str] | None:
+    def _grep_re(self, arg: str | None) -> re.Pattern[str] | None:
         # When using system `grep` we want to filter out at least some
         # of the files that .gitignore would.
         # TODO: use globs on cli and covert to re here

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/extensions.py

@@ -6,7 +6,7 @@ import logging
 import pathlib
 import re
 from functools import cached_property
-from typing import Any, cast, Pattern
+from typing import Any, cast
 
 import yaml as _yaml
 
@@ -45,6 +45,7 @@ UPSTREAM_EXTENSION_CATEGORY = "envoy.filters.http.upstream"
 @abstracts.implementer(interface.IExtensionsCheck)
 class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
     """Extensions check."""
+
     _owners_min_default: int = OWNERS_MIN_DEFAULT
 
     def __init__(
@@ -77,15 +78,15 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
         return self.extensions_schema["builtin"]
 
     @cached_property
-    def codeowner_re(self) -> Pattern[str]:
+    def codeowner_re(self) -> re.Pattern[str]:
         return re.compile(CODEOWNER_RE)
 
     @cached_property
-    def codeowners_contrib_re(self) -> Pattern[str]:
+    def codeowners_contrib_re(self) -> re.Pattern[str]:
         return re.compile(CODEOWNERS_CONTRIB_RE)
 
     @cached_property
-    def codeowners_extensions_re(self) -> Pattern[str]:
+    def codeowners_extensions_re(self) -> re.Pattern[str]:
         return re.compile(CODEOWNERS_EXTENSIONS_RE)
 
     @cached_property
@@ -160,7 +161,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
         return maintainers
 
     @cached_property
-    def maintainers_re(self) -> Pattern[str]:
+    def maintainers_re(self) -> re.Pattern[str]:
         return re.compile(MAINTAINERS_RE)
 
     @async_property(cache=True)
@@ -276,7 +277,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
             + tuple(self.owned["contrib"].keys()))
 
     @cached_property
-    def tracked_ownership_re(self) -> Pattern[str]:
+    def tracked_ownership_re(self) -> re.Pattern[str]:
         return re.compile(TRACKED_OWNERSHIP_RE)
 
     async def check_metadata(self, extension: str) -> tuple[str, ...]:
@@ -324,7 +325,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
                 "and category is set", )
         return tuple(
             (f"Unknown extension category for {extension}: {cat}. "
-             "Please add it to tools/extensions/extensions_check.py")
+             f"Please add it to {EXTENSIONS_SCHEMA}")
             for cat
             in categories
             if cat not in self.extension_categories)
@@ -456,7 +457,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
             self,
             line: str,
             matcher: (
-                Pattern[str] | None) = None) -> dict[str, dict[str, set]]:
+                re.Pattern[str] | None) = None) -> dict[str, dict[str, set]]:
         if line.startswith('#'):
             return {}
         m = (matcher or self.codeowners_extensions_re).search(line)

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/glint.py

@@ -2,9 +2,8 @@
 import asyncio
 import pathlib
 import re
+from collections.abc import Callable, Iterable, Iterator
 from functools import cached_property, partial
-from typing import (
-    Callable, Iterable, Iterator, Pattern)
 
 import abstracts
 
@@ -109,7 +108,7 @@ class AGlintCheck(abstract.AFileCodeCheck, metaclass=abstracts.Abstraction):
             target=await self.files)
 
     @cached_property
-    def noglint_re(self) -> Pattern[str]:
+    def noglint_re(self) -> re.Pattern[str]:
         """Regex for matching files that should not be checked."""
         return re.compile(r"|".join(NOGLINT_RE))
 

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/gofmt.py

@@ -5,7 +5,6 @@ import re
 import shutil
 import subprocess
 from functools import cached_property, partial
-from typing import Pattern
 
 import abstracts
 
@@ -40,14 +39,13 @@ class Gofmt(_subprocess.ASubprocessHandler):
         """Handle response for `gofmt -d`.
 
         As `gofmt` is called with multiple files, we need to parse the
-        diff line-by-line to match the diff content with the file that has
-        generated it.
+        diff line-by-line to match the diff content with the file that
+        has generated it.
 
         Returns the parsed or provided `filename`. If this is empty, or
-        doesnt match the files that we called `gofmt` with then something has
-        gone wrong.
+        doesnt match the files that we called `gofmt` with then
+        something has gone wrong.
         """
-
         result: typing.ProblemDict = dict()
         if not response.stdout:
             return result
@@ -105,7 +103,7 @@ class AGofmtCheck(abstract.AFileCodeCheck, metaclass=abstracts.Abstraction):
     def filter_files(
             cls,
             files: set[str],
-            exclude: Pattern[str] | None) -> set[str]:
+            exclude: re.Pattern[str] | None) -> set[str]:
         """Filter files for `gofmt` checking."""
         return set(
             path
@@ -187,7 +185,7 @@ class AGofmtCheck(abstract.AFileCodeCheck, metaclass=abstracts.Abstraction):
         return self._gofmt("-l")
 
     @cached_property
-    def nogofmt_re(self) -> Pattern[str] | None:
+    def nogofmt_re(self) -> re.Pattern[str] | None:
         """Regex for matching files that should not be checked."""
         # TODO(phlax): merge e.c.c config
         if not NOGOFMT_RE:

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/rst.py

@@ -1,7 +1,6 @@
 
 import re
 from functools import cached_property
-from typing import Pattern
 
 import abstracts
 
@@ -31,15 +30,15 @@ class ABackticksCheck(metaclass=abstracts.Abstraction):
             else None)
 
     @cached_property
-    def link_ticks_re(self) -> Pattern[str]:
+    def link_ticks_re(self) -> re.Pattern[str]:
         return re.compile(LINK_TICKS_RE)
 
     @cached_property
-    def ref_ticks_re(self) -> Pattern[str]:
+    def ref_ticks_re(self) -> re.Pattern[str]:
         return re.compile(REF_TICKS_RE)
 
     @cached_property
-    def single_tick_re(self) -> Pattern[str]:
+    def single_tick_re(self) -> re.Pattern[str]:
         return re.compile(SINGLE_TICK_RE)
 
     def _find_single_ticks(
@@ -70,7 +69,7 @@ class AReflinksCheck(metaclass=abstracts.Abstraction):
             else None)
 
     @cached_property
-    def invalid_reflink_re(self) -> Pattern[str]:
+    def invalid_reflink_re(self) -> re.Pattern[str]:
         return re.compile(INVALID_REFLINK_RE)
 
 
@@ -85,7 +84,7 @@ class APunctuationCheck(metaclass=abstracts.Abstraction):
             else None)
 
     @cached_property
-    def punctuation_re(self) -> Pattern[str]:
+    def punctuation_re(self) -> re.Pattern[str]:
         return re.compile(PUNCTUATION_RE, re.DOTALL)
 
     def _check_punctuation(

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/runtime_guards.py

@@ -1,8 +1,7 @@
 #
 import re
+from collections.abc import AsyncIterator, Awaitable, Iterable
 from functools import cached_property
-from typing import (
-    AsyncIterator, Awaitable, Iterable, Pattern)
 
 import abstracts
 
@@ -56,7 +55,7 @@ class ARuntimeGuardsCheck(
             - self.expected_missing)
 
     @cached_property
-    def reloadable_match_re(self) -> Pattern:
+    def reloadable_match_re(self) -> re.Pattern:
         return re.compile(RELOADABLE_MATCH_RE)
 
     @async_property

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/shellcheck.py

@@ -4,8 +4,9 @@ import pathlib
 import re
 import shutil
 import subprocess
+from collections.abc import Iterator
 from functools import cached_property, partial
-from typing import Iterator, Pattern, TypedDict
+from typing import TypedDict
 
 import abstracts
 
@@ -39,7 +40,7 @@ class ShellcheckErrorDict(TypedDict):
 class Shellcheck(_subprocess.ASubprocessHandler):
 
     @cached_property
-    def error_line_re(self) -> Pattern[str]:
+    def error_line_re(self) -> re.Pattern[str]:
         """Regex for matching a shellcheck error line.
 
         This demarcates the beginning of a specific error for a file.
@@ -145,12 +146,12 @@ class AShellcheckCheck(
             | await self.shebang_files)
 
     @cached_property
-    def path_match_exclude_re(self) -> Pattern[str]:
+    def path_match_exclude_re(self) -> re.Pattern[str]:
         """Regex to match files not to check."""
         return re.compile("|".join(SHELLCHECK_NOMATCH_RE))
 
     @cached_property
-    def path_match_re(self) -> Pattern[str]:
+    def path_match_re(self) -> re.Pattern[str]:
         """Regex to match files to check."""
         return re.compile("|".join(SHELLCHECK_MATCH_RE))
 

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/yamllint.py

@@ -1,9 +1,8 @@
 
 import io
 import pathlib
+from collections.abc import AsyncIterator, Generator, Iterator
 from functools import cached_property, partial
-from typing import (
-    AsyncIterator, Generator, Iterator)
 
 import yaml
 from yamllint import linter  # type:ignore

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/abstract/yapf.py

@@ -1,8 +1,8 @@
 
 import os
 import pathlib
+from collections.abc import AsyncIterator, Iterable, Iterator
 from functools import partial
-from typing import AsyncIterator, Iterable, Iterator
 
 import yapf  # type:ignore
 

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/checker.py

@@ -98,27 +98,27 @@ class ChangelogCheck(abstract.AChangelogCheck):
 class CodeChecker(abstract.ACodeChecker):
 
     @property
-    def extensions_class(self):
+    def extensions_class(self) -> type[ExtensionsCheck]:
         return ExtensionsCheck
 
     @property
-    def flake8_class(self):
+    def flake8_class(self) -> type[Flake8Check]:
         return Flake8Check
 
     @property
-    def fs_directory_class(self):
+    def fs_directory_class(self) -> type[directory.Directory]:
         return directory.Directory
 
     @property
-    def git_directory_class(self):
+    def git_directory_class(self) -> type[directory.GitDirectory]:
         return directory.GitDirectory
 
     @property
-    def glint_class(self):
+    def glint_class(self) -> type[GlintCheck]:
         return GlintCheck
 
     @property
-    def gofmt_class(self):
+    def gofmt_class(self) -> type[GofmtCheck]:
         return GofmtCheck
 
     @cached_property
@@ -130,21 +130,21 @@ class CodeChecker(abstract.ACodeChecker):
         return Project
 
     @property
-    def runtime_guards_class(self):
+    def runtime_guards_class(self) -> type[RuntimeGuardsCheck]:
         return RuntimeGuardsCheck
 
     @property
-    def shellcheck_class(self):
+    def shellcheck_class(self) -> type[ShellcheckCheck]:
         return ShellcheckCheck
 
     @property
-    def changelog_class(self):
+    def changelog_class(self) -> type[ChangelogCheck]:
         return ChangelogCheck
 
     @property
-    def yapf_class(self):
+    def yapf_class(self) -> type[YapfCheck]:
         return YapfCheck
 
     @property
-    def yamllint_class(self):
+    def yamllint_class(self) -> type[YamllintCheck]:
         return YamllintCheck

{envoy.code.check-0.5.14 → envoy_code_check-0.6.1}/envoy/code/check/interface.py

@@ -2,7 +2,7 @@
 import asyncio
 import pathlib
 from concurrent import futures
-from typing import AsyncIterator, Iterator
+from collections.abc import AsyncIterator, Iterator
 
 from packaging import version as _version
 
@@ -138,6 +138,24 @@ class IChangelogChangesChecker(metaclass=abstracts.Interface):
                 tuple[str, ...]):
         raise NotImplementedError
 
+    @abstracts.interfacemethod
+    def check_entry_filename(
+            self,
+            path: pathlib.Path) -> str | None:
+        raise NotImplementedError
+
+    @abstracts.interfacemethod
+    def check_entry_content(
+            self,
+            path: pathlib.Path) -> str | None:
+        raise NotImplementedError
+
+    @abstracts.interfacemethod
+    def check_entry_files(
+            self,
+            paths: list[pathlib.Path]) -> tuple[str, ...]:
+        raise NotImplementedError
+
 
 class IChangelogStatus(metaclass=abstracts.Interface):
     pass

envoy_code_check-0.6.1/envoy.code.check.egg-info/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: envoy.code.check
+Version: 0.6.1
+Summary: Code checker used in Envoy proxy's CI
+Home-page: https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check
+Author: Ryan Northey
+Author-email: ryan@synca.io
+Maintainer: Ryan Northey
+Maintainer-email: ryan@synca.io
+License: Apache Software License 2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: abstracts==0.2.0
+Requires-Dist: abstracts>=0.2.0
+Requires-Dist: aio-core==0.11.0
+Requires-Dist: aio-run-checker==0.6.0
+Requires-Dist: aio.core>=0.11.0
+Requires-Dist: aio.run.checker>=0.6.0
+Requires-Dist: envoy.base.utils==0.6.1
+Requires-Dist: envoy.base.utils>=0.6.0
+Requires-Dist: flake8==7.3.0
+Requires-Dist: flake8>=6.1.0
+Requires-Dist: packaging==26.2
+Requires-Dist: packaging>=23.0
+Requires-Dist: pep8-naming>=0.13.3
+Requires-Dist: types-pyyaml==6.0.12.20260508
+Requires-Dist: yamllint==1.38.0
+Requires-Dist: yamllint>=1.32.0
+Requires-Dist: yapf==0.43.0
+Requires-Dist: yapf>=0.40.2
+Provides-Extra: test
+Requires-Dist: pytest>=7.4.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.23.3; extra == "test"
+Requires-Dist: pytest-coverage; extra == "test"
+Requires-Dist: pytest-iters>=0.1.0; extra == "test"
+Requires-Dist: pytest-patches>=0.1.0; extra == "test"
+Provides-Extra: lint
+Requires-Dist: flake8>=6.1.0; extra == "lint"
+Provides-Extra: types
+Requires-Dist: mypy>=1.6.0; extra == "types"
+Requires-Dist: mypy-abstracts>=0.1.0; extra == "types"
+Provides-Extra: publish
+Requires-Dist: wheel>=0.41.0; extra == "publish"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+envoy.code.check
+================
+
+Code checker used in Envoy proxy's CI.
+
+This package provides an async checker that runs source-code checks against an
+Envoy (or Envoy-like) checkout. Registered checks include:
+
+- ``python_flake8`` and ``python_yapf`` for Python style
+- ``yamllint`` for YAML files
+- ``shellcheck`` for shell scripts
+- ``glint`` for file hygiene checks
+- ``gofmt`` for Go formatting
+- ``runtime_guards`` consistency checks
+- extension metadata, registration, owner, and fuzz-coverage checks
+- changelog validation, including RST sanity checks
+
+Usage
+-----
+
+Installed as a console script:
+
+.. code-block:: console
+
+   $ envoy.code.check --help
+
+Run a subset of checks against a checkout:
+
+.. code-block:: console
+
+   $ envoy.code.check --check python_flake8 python_yapf --path /path/to/envoy
+
+Run only against files changed since a given ref:
+
+.. code-block:: console
+
+   $ envoy.code.check --since main --path /path/to/envoy
+
+See ``envoy.code.check --help`` for the full set of options.
+
+Links
+-----
+
+- Source: https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check
+- Issues: https://github.com/envoyproxy/toolshed/issues

envoy_code_check-0.6.1/envoy.code.check.egg-info/requires.txt

@@ -0,0 +1,35 @@
+abstracts==0.2.0
+abstracts>=0.2.0
+aio-core==0.11.0
+aio-run-checker==0.6.0
+aio.core>=0.11.0
+aio.run.checker>=0.6.0
+envoy.base.utils==0.6.1
+envoy.base.utils>=0.6.0
+flake8==7.3.0
+flake8>=6.1.0
+packaging==26.2
+packaging>=23.0
+pep8-naming>=0.13.3
+types-pyyaml==6.0.12.20260508
+yamllint==1.38.0
+yamllint>=1.32.0
+yapf==0.43.0
+yapf>=0.40.2
+
+[lint]
+flake8>=6.1.0
+
+[publish]
+wheel>=0.41.0
+
+[test]
+pytest>=7.4.0
+pytest-asyncio>=0.23.3
+pytest-coverage
+pytest-iters>=0.1.0
+pytest-patches>=0.1.0
+
+[types]
+mypy>=1.6.0
+mypy-abstracts>=0.1.0

envoy_code_check-0.6.1/setup.py

@@ -0,0 +1,134 @@
+
+# DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
+# Target: py/envoy.code.check:package
+
+from setuptools import setup
+
+setup(**{
+    'author': 'Ryan Northey',
+    'author_email': 'ryan@synca.io',
+    'classifiers': [
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: Apache Software License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3 :: Only',
+        'Programming Language :: Python :: 3.12',
+        'Programming Language :: Python :: 3.13',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Topic :: Software Development',
+        'Typing :: Typed',
+    ],
+    'description': 'Code checker used in Envoy proxy\'s CI',
+    'entry_points': {
+        'console_scripts': [
+            'envoy.code.check=envoy.code.check:run',
+        ],
+    },
+    'extras_require': {
+        'test': [
+            'pytest>=7.4.0',
+            'pytest-asyncio>=0.23.3',
+            'pytest-coverage',
+            'pytest-iters>=0.1.0',
+            'pytest-patches>=0.1.0',
+        ],
+        'lint': [
+            'flake8>=6.1.0',
+        ],
+        'types': [
+            'mypy>=1.6.0',
+            'mypy-abstracts>=0.1.0',
+        ],
+        'publish': [
+            'wheel>=0.41.0',
+        ],
+    },
+    'install_requires': (
+        'abstracts==0.2.0',
+        'abstracts>=0.2.0',
+        'aio-core==0.11.0',
+        'aio-run-checker==0.6.0',
+        'aio.core>=0.11.0',
+        'aio.run.checker>=0.6.0',
+        'envoy.base.utils==0.6.1',
+        'envoy.base.utils>=0.6.0',
+        'flake8==7.3.0',
+        'flake8>=6.1.0',
+        'packaging==26.2',
+        'packaging>=23.0',
+        'pep8-naming>=0.13.3',
+        'types-pyyaml==6.0.12.20260508',
+        'yamllint==1.38.0',
+        'yamllint>=1.32.0',
+        'yapf==0.43.0',
+        'yapf>=0.40.2',
+    ),
+    'license': 'Apache Software License 2.0',
+    'long_description': """
+envoy.code.check
+================
+
+Code checker used in Envoy proxy's CI.
+
+This package provides an async checker that runs source-code checks against an
+Envoy (or Envoy-like) checkout. Registered checks include:
+
+- ``python_flake8`` and ``python_yapf`` for Python style
+- ``yamllint`` for YAML files
+- ``shellcheck`` for shell scripts
+- ``glint`` for file hygiene checks
+- ``gofmt`` for Go formatting
+- ``runtime_guards`` consistency checks
+- extension metadata, registration, owner, and fuzz-coverage checks
+- changelog validation, including RST sanity checks
+
+Usage
+-----
+
+Installed as a console script:
+
+.. code-block:: console
+
+   $ envoy.code.check --help
+
+Run a subset of checks against a checkout:
+
+.. code-block:: console
+
+   $ envoy.code.check --check python_flake8 python_yapf --path /path/to/envoy
+
+Run only against files changed since a given ref:
+
+.. code-block:: console
+
+   $ envoy.code.check --since main --path /path/to/envoy
+
+See ``envoy.code.check --help`` for the full set of options.
+
+Links
+-----
+
+- Source: https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check
+- Issues: https://github.com/envoyproxy/toolshed/issues
+""",
+    'maintainer': 'Ryan Northey',
+    'maintainer_email': 'ryan@synca.io',
+    'name': 'envoy.code.check',
+    'namespace_packages': (
+    ),
+    'package_data': {
+        'envoy.code.check': (
+            'py.typed',
+        ),
+    },
+    'packages': (
+        'envoy.code.check',
+        'envoy.code.check.abstract',
+    ),
+    'python_requires': '>=3.12',
+    'url': 'https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check',
+    'version': '0.6.1',
+})

envoy.code.check-0.5.14/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: envoy.code.check
-Version: 0.5.14
-Summary: "Code checker used in Envoy proxy's CI"
-Home-page: https://github.com/envoyproxy/toolshed/tree/main/envoy.code.check
-Author: Ryan Northey
-Author-email: ryan@synca.io
-Maintainer: Ryan Northey
-Maintainer-email: ryan@synca.io
-License: Apache Software License 2.0
-Requires-Python: >=3.10.0
-
-
-envoy.code.check
-================
-
-Code checker used in Envoy proxy's CI

envoy.code.check-0.5.14/envoy.code.check.egg-info/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: envoy.code.check
-Version: 0.5.14
-Summary: "Code checker used in Envoy proxy's CI"
-Home-page: https://github.com/envoyproxy/toolshed/tree/main/envoy.code.check
-Author: Ryan Northey
-Author-email: ryan@synca.io
-Maintainer: Ryan Northey
-Maintainer-email: ryan@synca.io
-License: Apache Software License 2.0
-Requires-Python: >=3.10.0
-
-
-envoy.code.check
-================
-
-Code checker used in Envoy proxy's CI

envoy.code.check-0.5.14/envoy.code.check.egg-info/requires.txt

@@ -1,9 +0,0 @@
-abstracts>=0.0.12
-aio.core>=0.10.5
-aio.run.checker>=0.5.8
-envoy.base.utils>=0.4.7
-flake8>=6
-packaging>=23.0
-types-pyyaml
-yamllint
-yapf

envoy.code.check-0.5.14/setup.py

@@ -1,51 +0,0 @@
-
-# DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
-# Target: envoy.code.check:package
-
-from setuptools import setup
-
-setup(**{
-    'author': 'Ryan Northey',
-    'author_email': 'ryan@synca.io',
-    'description': '"Code checker used in Envoy proxy\'s CI"',
-    'entry_points': {
-        'console_scripts': [
-            'envoy.code.check=envoy.code.check:run',
-        ],
-    },
-    'install_requires': (
-        'abstracts>=0.0.12',
-        'aio.core>=0.10.5',
-        'aio.run.checker>=0.5.8',
-        'envoy.base.utils>=0.4.7',
-        'flake8>=6',
-        'packaging>=23.0',
-        'types-pyyaml',
-        'yamllint',
-        'yapf',
-    ),
-    'license': 'Apache Software License 2.0',
-    'long_description': """
-envoy.code.check
-================
-
-Code checker used in Envoy proxy's CI
-""",
-    'maintainer': 'Ryan Northey',
-    'maintainer_email': 'ryan@synca.io',
-    'name': 'envoy.code.check',
-    'namespace_packages': (
-    ),
-    'package_data': {
-        'envoy.code.check': (
-            'py.typed',
-        ),
-    },
-    'packages': (
-        'envoy.code.check',
-        'envoy.code.check.abstract',
-    ),
-    'python_requires': '>=3.10.0',
-    'url': 'https://github.com/envoyproxy/toolshed/tree/main/envoy.code.check',
-    'version': '0.5.14',
-})