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

{envoy.code.check-0.5.13 → envoy.code.check-0.5.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envoy.code.check
-Version: 0.5.13
+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

{envoy.code.check-0.5.13 → envoy.code.check-0.5.14}/backend_shim.py

@@ -1,12 +1,13 @@
 
 # DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
 
+import errno
 import os
 import setuptools.build_meta
 
 backend = setuptools.build_meta.__legacy__
 
-dist_dir = "dist"
+dist_dir = "dist/"
 build_wheel = True
 build_sdist = True
 wheel_config_settings = {
@@ -14,7 +15,13 @@ wheel_config_settings = {
 sdist_config_settings = {
 }
 
-os.makedirs(dist_dir, exist_ok=True)
+# Python 2.7 doesn't have the exist_ok arg on os.makedirs().
+try:
+    os.makedirs(dist_dir)
+except OSError as e:
+    if e.errno != errno.EEXIST:
+        raise
+
 wheel_path = backend.build_wheel(dist_dir, wheel_config_settings) if build_wheel else None
 sdist_path = backend.build_sdist(dist_dir, sdist_config_settings) if build_sdist else None
 

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

@@ -1,7 +1,6 @@
 
 import asyncio
 from concurrent import futures
-from typing import Dict, List, Optional, Set
 
 import abstracts
 
@@ -10,7 +9,7 @@ from aio.core.directory import ADirectory
 from aio.core.functional import async_property
 
 from envoy.base import utils
-from envoy.code.check import interface
+from envoy.code.check import interface, typing
 
 
 @abstracts.implementer(event.IExecutive)
@@ -20,10 +19,12 @@ class ACodeCheck(event.AExecutive, metaclass=abstracts.Abstraction):
             self,
             directory: ADirectory,
             fix: bool = False,
-            binaries: Optional[Dict[str, str]] = None,
-            loop: Optional[asyncio.AbstractEventLoop] = None,
-            pool: Optional[futures.Executor] = None) -> None:
+            binaries: dict[str, str] | None = None,
+            config: typing.YAMLConfigDict | None = None,
+            loop: asyncio.AbstractEventLoop | None = None,
+            pool: futures.Executor | None = None) -> None:
         self.directory = directory
+        self.config = config
         self._fix = fix
         self._loop = loop
         self._pool = pool
@@ -39,11 +40,11 @@ class AFileCodeCheck(ACodeCheck, metaclass=abstracts.Abstraction):
 
     @async_property
     @abstracts.interfacemethod
-    async def checker_files(self) -> Set[str]:
+    async def checker_files(self) -> set[str]:
         raise NotImplementedError
 
     @async_property(cache=True)
-    async def files(self) -> Set[str]:
+    async def files(self) -> set[str]:
         files = await self.directory.files
         return (
             files & await self.checker_files
@@ -56,7 +57,7 @@ class AFileCodeCheck(ACodeCheck, metaclass=abstracts.Abstraction):
 
     @async_property
     @abstracts.interfacemethod
-    async def problem_files(self) -> Dict[str, List[str]]:
+    async def problem_files(self) -> dict[str, list[str]]:
         """Discovered files with flake8 errors."""
         raise NotImplementedError
 

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

@@ -2,7 +2,7 @@
 import itertools
 from datetime import datetime
 from functools import cached_property
-from typing import Iterator, Optional, Tuple, Type
+from typing import Iterator
 
 from packaging import version as _version
 
@@ -30,7 +30,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def change_checkers(self) -> Tuple[interface.IRSTCheck, ...]:
+    def change_checkers(self) -> tuple[interface.IRSTCheck, ...]:
         raise NotImplementedError
 
     @cached_property
@@ -41,7 +41,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
             self,
             version: _version.Version,
             section: str,
-            entry: utils.typing.ChangeDict) -> Tuple[str, ...]:
+            entry: utils.typing.ChangeDict) -> tuple[str, ...]:
         change = entry["change"].strip()
         errors = [
             checker(change)
@@ -61,7 +61,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
             self,
             version: _version.Version,
             section: str,
-            data: Optional[utils.typing.ChangeList]) -> Tuple[str, ...]:
+            data: utils.typing.ChangeList | None) -> tuple[str, ...]:
         name_error = self.check_section_name(version, section)
         return (
             *((name_error, )
@@ -76,7 +76,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
             self,
             version: _version.Version,
             sections: utils.typing.ChangelogChangeSectionsDict) -> (
-                Tuple[str, ...]):
+                tuple[str, ...]):
         return tuple(
             itertools.chain.from_iterable(
                 self.check_section(version, section, data)  # type:ignore
@@ -86,7 +86,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
     def check_section_name(
             self,
             version: _version.Version,
-            section: str) -> Optional[str]:
+            section: str) -> str | None:
         invalid_changes = (
             section == "changes"
             and version > self.max_version_for_changes_section)
@@ -137,7 +137,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
                 self.version).exists())
 
     @async_property(cache=True)
-    async def errors(self) -> Tuple[str, ...]:
+    async def errors(self) -> tuple[str, ...]:
         try:
             return (
                 *self.check_version(),
@@ -147,7 +147,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             return (f"{self.version}: {e}", )
 
     @async_property
-    async def invalid_date(self) -> Optional[str]:
+    async def invalid_date(self) -> str | None:
         if await self.is_pending:
             return None
         date = await self.date
@@ -194,7 +194,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             self.version
             > _version.Version(self.project.version.base_version))
 
-    async def check_date(self) -> Tuple[str, ...]:
+    async def check_date(self) -> tuple[str, ...]:
         errors = []
         if invalid_date := await self.invalid_date:
             errors.append(f"Format not recognized \"{invalid_date}\"")
@@ -207,7 +207,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             for e
             in errors)
 
-    async def check_sections(self) -> Tuple[str, ...]:
+    async def check_sections(self) -> tuple[str, ...]:
         # Runs checker in executor, uncomment following line for debugging
         # return self.checker.check_sections(self.version, await self.sections)
         return await self.project.execute(
@@ -215,7 +215,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             self.version,
             await self.sections)
 
-    def check_version(self) -> Tuple[str, ...]:
+    def check_version(self) -> tuple[str, ...]:
         errors = []
         if self.duplicate_current:
             errors.append(
@@ -245,7 +245,7 @@ class AChangelogCheck(
     @property  # type:ignore
     @abstracts.interfacemethod
     def changes_checker_class(
-            self) -> Type[interface.IChangelogChangesChecker]:
+            self) -> type[interface.IChangelogChangesChecker]:
         raise NotImplementedError
 
     @cached_property
@@ -255,11 +255,11 @@ class AChangelogCheck(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def changelog_status_class(self) -> Type[interface.IChangelogStatus]:
+    def changelog_status_class(self) -> type[interface.IChangelogStatus]:
         raise NotImplementedError
 
     @cached_property
-    def changelogs(self) -> Tuple[interface.IChangelogStatus, ...]:
+    def changelogs(self) -> tuple[interface.IChangelogStatus, ...]:
         return tuple(
             self.changelog_status_class(self, changelog)
             for changelog

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

@@ -5,7 +5,9 @@ import argparse
 import pathlib
 import re
 from functools import cached_property
-from typing import Dict, Mapping, Optional, Pattern, Set, Type
+from typing import Mapping, Pattern
+
+import yaml
 
 from yamllint.config import YamlLintConfigError  # type:ignore
 
@@ -73,7 +75,7 @@ class ACodeChecker(
         return self.args.all_files
 
     @cached_property
-    def binaries(self) -> Dict[str, str]:
+    def binaries(self) -> dict[str, str]:
         return dict(
             binary.split(":")
             for binary
@@ -91,7 +93,7 @@ class ACodeChecker(
         return disabled
 
     @property
-    def changed_since(self) -> Optional[str]:
+    def changed_since(self) -> str | None:
         return self.args.since
 
     @cached_property
@@ -103,7 +105,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def changelog_class(self) -> Type["interface.IChangelogCheck"]:
+    def changelog_class(self) -> type["interface.IChangelogCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -114,6 +116,23 @@ class ACodeChecker(
             loop=self.loop,
             pool=self.pool)
 
+    @cached_property
+    def config(self) -> typing.YAMLConfigDict:
+        return (
+            yaml.safe_load(self.config_path.read_text())
+            if self.config_path
+            else {})
+
+    @property
+    def config_path(self) -> pathlib.Path | None:
+        if not self.args.config:
+            return None
+        path = pathlib.Path(self.args.config)
+        if not path.exists():
+            raise exceptions.ConfigurationError(
+                f"Config specified but not found: {path}")
+        return path
+
     @cached_property
     def directory(self) -> "_directory.ADirectory":
         """Greppable directory - optionally in a git repo, depending on whether
@@ -122,8 +141,8 @@ class ACodeChecker(
         return self.project.directory.filtered(**self.directory_kwargs)
 
     @property
-    def directory_kwargs(self) -> Dict:
-        kwargs: Dict = dict(
+    def directory_kwargs(self) -> dict:
+        kwargs: dict = dict(
             exclude_matcher=self.grep_excluding_re,
             path_matcher=self.grep_matching_re,
             untracked=self.all_files)
@@ -144,7 +163,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def extensions_class(self) -> Type["interface.IExtensionsCheck"]:
+    def extensions_class(self) -> type["interface.IExtensionsCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -154,17 +173,17 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def flake8_class(self) -> Type["interface.IFlake8Check"]:
+    def flake8_class(self) -> type["interface.IFlake8Check"]:
         raise NotImplementedError
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def fs_directory_class(self) -> Type["_directory.ADirectory"]:
+    def fs_directory_class(self) -> type["_directory.ADirectory"]:
         raise NotImplementedError
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def git_directory_class(self) -> Type["_directory.AGitDirectory"]:
+    def git_directory_class(self) -> type["_directory.AGitDirectory"]:
         raise NotImplementedError
 
     @cached_property
@@ -174,7 +193,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def glint_class(self) -> Type["interface.IGlintCheck"]:
+    def glint_class(self) -> type["interface.IGlintCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -184,15 +203,15 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def gofmt_class(self) -> Type["interface.IGofmtCheck"]:
+    def gofmt_class(self) -> type["interface.IGofmtCheck"]:
         raise NotImplementedError
 
     @property
-    def grep_excluding_re(self) -> Optional[Pattern[str]]:
+    def grep_excluding_re(self) -> Pattern[str] | None:
         return self._grep_re(self.args.excluding)
 
     @property
-    def grep_matching_re(self) -> Optional[Pattern[str]]:
+    def grep_matching_re(self) -> Pattern[str] | None:
         return self._grep_re(self.args.matching)
 
     @property
@@ -206,7 +225,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def project_class(self) -> Type[IProject]:
+    def project_class(self) -> type[IProject]:
         raise NotImplementedError
 
     @cached_property
@@ -218,7 +237,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def runtime_guards_class(self) -> Type["interface.IRuntimeGuardsCheck"]:
+    def runtime_guards_class(self) -> type["interface.IRuntimeGuardsCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -228,11 +247,11 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def shellcheck_class(self) -> Type["interface.IShellcheckCheck"]:
+    def shellcheck_class(self) -> type["interface.IShellcheckCheck"]:
         raise NotImplementedError
 
     @property
-    def summary_class(self) -> Type[CodeCheckerSummary]:
+    def summary_class(self) -> type[CodeCheckerSummary]:
         """CodeChecker's summary class."""
         return CodeCheckerSummary
 
@@ -243,7 +262,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def yamllint_class(self) -> Type[interface.IYamllintCheck]:
+    def yamllint_class(self) -> type[interface.IYamllintCheck]:
         raise NotImplementedError
 
     @cached_property
@@ -253,7 +272,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def yapf_class(self) -> Type[interface.IYapfCheck]:
+    def yapf_class(self) -> type[interface.IYapfCheck]:
         raise NotImplementedError
 
     def add_arguments(self, parser: argparse.ArgumentParser) -> None:
@@ -263,6 +282,11 @@ class ACodeChecker(
         parser.add_argument("-x", "--excluding", action="append")
         parser.add_argument("-b", "--binary", action="append")
         parser.add_argument("-s", "--since")
+        parser.add_argument(
+            "--config",
+            default="./tools/code/config.yaml",
+            help=("specify the config path. "
+                  "Default './tools/code/config.yaml'."))
         parser.add_argument("--codeowners")
         parser.add_argument("--owners")
         parser.add_argument("--extensions_build_config")
@@ -427,7 +451,7 @@ class ACodeChecker(
 
     def _check_output(
             self,
-            check_files: Set[str],
+            check_files: set[str],
             problem_files: typing.ProblemDict) -> None:
         # This can be slow/blocking for large result sets, run
         # in a separate thread
@@ -453,7 +477,7 @@ class ACodeChecker(
             await check.files,
             await check.problem_files)
 
-    def _grep_re(self, arg: Optional[str]) -> Optional[Pattern[str]]:
+    def _grep_re(self, arg: str | None) -> 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.13 → envoy.code.check-0.5.14}/envoy/code/check/abstract/extensions.py

@@ -6,9 +6,7 @@ import logging
 import pathlib
 import re
 from functools import cached_property
-from typing import (
-    Any, cast, Dict, List,
-    Optional, Pattern, Set, Tuple, Type, Union)
+from typing import Any, cast, Pattern
 
 import yaml as _yaml
 
@@ -60,7 +58,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
         super().__init__(*args, **kwargs)
 
     @cached_property
-    def all_extensions(self) -> Set[str]:
+    def all_extensions(self) -> set[str]:
         return (
             set(self.configured_extensions)
             | set(self.builtin_extensions))
@@ -143,7 +141,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
         return self.directory.path.joinpath(FUZZ_TEST_PATH)
 
     @property
-    def fuzzed_count(self) -> Optional[int]:
+    def fuzzed_count(self) -> int | None:
         # TODO: shift this to the arg parse
         return (
             int(self._fuzzed_count)
@@ -186,27 +184,27 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
         return self.directory.path.joinpath(METADATA_PATH)
 
     @async_property
-    async def metadata_errors(self) -> Dict[str, Tuple[str, ...]]:
+    async def metadata_errors(self) -> dict[str, tuple[str, ...]]:
         return {
             extension: await self.check_metadata(extension)
             for extension
             in await self.metadata}
 
     @async_property
-    async def metadata_missing(self) -> Set[str]:
+    async def metadata_missing(self) -> set[str]:
         return (
             self.all_extensions
             - set(await self.metadata))
 
     @async_property
-    async def metadata_only(self) -> Set[str]:
+    async def metadata_only(self) -> set[str]:
         return (
             set(await self.metadata)
             - self.metadata_only_extensions
             - self.all_extensions)
 
     @property
-    def metadata_only_extensions(self) -> Set[str]:
+    def metadata_only_extensions(self) -> set[str]:
         return set(METADATA_ONLY_EXTENSIONS)
 
     @cached_property
@@ -223,7 +221,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
         return owned
 
     @async_property(cache=True)
-    async def owners_errors(self) -> Dict[str, Tuple[str, ...]]:
+    async def owners_errors(self) -> dict[str, tuple[str, ...]]:
         return (
             await self._owners_tracked
             | await self._owners_found)
@@ -243,7 +241,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
             "contrib/language/": dict(owners=1)}
 
     @async_property
-    async def registration_errors(self) -> List[str]:
+    async def registration_errors(self) -> list[str]:
         return [
             *[f"Metadata for unused extension found: {extension}"
               for extension
@@ -281,7 +279,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
     def tracked_ownership_re(self) -> Pattern[str]:
         return re.compile(TRACKED_OWNERSHIP_RE)
 
-    async def check_metadata(self, extension: str) -> Tuple[str, ...]:
+    async def check_metadata(self, extension: str) -> tuple[str, ...]:
         return tuple(
             itertools.chain.from_iterable(
                 await asyncio.gather(
@@ -317,7 +315,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
             for extension, data in extensions.items()}
 
     async def _check_metadata_categories(
-            self, extension: str) -> Tuple[str, ...]:
+            self, extension: str) -> tuple[str, ...]:
         categories = (await self.metadata)[extension].get("categories", ())
         if not categories:
             return (
@@ -332,7 +330,7 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
             if cat not in self.extension_categories)
 
     async def _check_metadata_security_posture(
-            self, extension: str) -> Tuple[str, ...]:
+            self, extension: str) -> tuple[str, ...]:
         security_posture = (await self.metadata)[extension]["security_posture"]
         if not security_posture:
             return (
@@ -346,14 +344,14 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
         return ()
 
     async def _check_metadata_status(
-            self, extension: str) -> Tuple[str, ...]:
+            self, extension: str) -> tuple[str, ...]:
         status = (await self.metadata)[extension]["status"]
         if status not in self.extension_status_values:
             return (f"Unknown status for {extension}: {status}", )
         return ()
 
     async def _check_metadata_status_upstream(
-            self, extension: str) -> Tuple[str, ...]:
+            self, extension: str) -> tuple[str, ...]:
         metadata = (await self.metadata)[extension]
         status = metadata.get("status_upstream")
         categories = metadata.get("categories", ())
@@ -371,8 +369,8 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
 
     def _from_json(
             self,
-            path: Union[str, pathlib.Path],
-            type: Type,
+            path: str | pathlib.Path,
+            type: type,
             err_message: str,
             warn_message: str) -> Any:
         # Parse JSON, handling errors
@@ -387,8 +385,8 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
 
     def _from_yaml(
             self,
-            path: Union[str, pathlib.Path],
-            type: Type,
+            path: str | pathlib.Path,
+            type: type,
             err_message: str,
             warn_message: str) -> Any:
         # Parse YAML, handling errors
@@ -457,8 +455,8 @@ class AExtensionsCheck(abstract.ACodeCheck, metaclass=abstracts.Abstraction):
     def _owners_extension_match_line(
             self,
             line: str,
-            matcher: Optional[
-                Pattern[str]] = None) -> dict[str, dict[str, set]]:
+            matcher: (
+                Pattern[str] | None) = None) -> dict[str, dict[str, set]]:
         if line.startswith('#'):
             return {}
         m = (matcher or self.codeowners_extensions_re).search(line)