envoy.code.check(0.5.14): Typing cleanups (#2342)

Signed-off-by: Ryan Northey <[email protected]>

Author: phlax

envoy.code.check/VERSION

@@ -1 +1 @@
-0.5.14-dev
+0.5.14

envoy.code.check/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
 
@@ -20,10 +19,10 @@ def __init__(
             self,
             directory: ADirectory,
             fix: bool = False,
-            binaries: Optional[Dict[str, str]] = None,
-            config: Optional[typing.YAMLConfigDict] = 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
@@ -41,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
@@ -58,7 +57,7 @@ def fix(self) -> bool:
 
     @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/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 @@ def __init__(
 
     @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 @@ def check_entry(
             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 @@ def check_section(
             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 @@ def check_sections(
             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 @@ def check_sections(
     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 @@ def duplicate_current(self) -> bool:
                 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 @@ async def errors(self) -> Tuple[str, ...]:
             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 @@ def version_higher_than_current(self) -> bool:
             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,15 +207,15 @@ async def check_date(self) -> Tuple[str, ...]:
             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(
             self.checker.check_sections,
             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 @@ def __iter__(self) -> Iterator[interface.IChangelogStatus]:
     @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 @@ def changes_checker(self) -> interface.IChangelogChangesChecker:
 
     @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/envoy/code/check/abstract/checker.py

@@ -5,7 +5,7 @@
 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
 
@@ -75,7 +75,7 @@ def all_files(self) -> bool:
         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
@@ -93,7 +93,7 @@ def disabled_checks(self):
         return disabled
 
     @property
-    def changed_since(self) -> Optional[str]:
+    def changed_since(self) -> str | None:
         return self.args.since
 
     @cached_property
@@ -105,7 +105,7 @@ def changelog(self) -> "interface.IChangelogCheck":
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def changelog_class(self) -> Type["interface.IChangelogCheck"]:
+    def changelog_class(self) -> type["interface.IChangelogCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -124,7 +124,7 @@ def config(self) -> typing.YAMLConfigDict:
             else {})
 
     @property
-    def config_path(self) -> Optional[pathlib.Path]:
+    def config_path(self) -> pathlib.Path | None:
         if not self.args.config:
             return None
         path = pathlib.Path(self.args.config)
@@ -141,8 +141,8 @@ def directory(self) -> "_directory.ADirectory":
         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)
@@ -163,7 +163,7 @@ def extensions(self) -> "interface.IExtensionsCheck":
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def extensions_class(self) -> Type["interface.IExtensionsCheck"]:
+    def extensions_class(self) -> type["interface.IExtensionsCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -173,17 +173,17 @@ def flake8(self) -> "interface.IFlake8Check":
 
     @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
@@ -193,7 +193,7 @@ def glint(self) -> "interface.IGlintCheck":
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def glint_class(self) -> Type["interface.IGlintCheck"]:
+    def glint_class(self) -> type["interface.IGlintCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -203,15 +203,15 @@ def gofmt(self) -> "interface.IGofmtCheck":
 
     @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
@@ -225,7 +225,7 @@ def project(self) -> IProject:
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def project_class(self) -> Type[IProject]:
+    def project_class(self) -> type[IProject]:
         raise NotImplementedError
 
     @cached_property
@@ -237,7 +237,7 @@ def runtime_guards(self) -> "interface.IRuntimeGuardsCheck":
 
     @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
@@ -247,11 +247,11 @@ def shellcheck(self) -> "interface.IShellcheckCheck":
 
     @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
 
@@ -262,7 +262,7 @@ def yamllint(self) -> interface.IYamllintCheck:
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def yamllint_class(self) -> Type[interface.IYamllintCheck]:
+    def yamllint_class(self) -> type[interface.IYamllintCheck]:
         raise NotImplementedError
 
     @cached_property
@@ -272,7 +272,7 @@ def yapf(self) -> interface.IYapfCheck:
 
     @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:
@@ -451,7 +451,7 @@ async def preload_yapf(self) -> None:
 
     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
@@ -477,7 +477,7 @@ async def _code_check(self, check: "interface.IFileCodeCheck") -> None:
             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