Expand the mypy whitelist for 'sphinx.util' (#11406)

Author: danieleades

pyproject.toml

@@ -372,7 +372,18 @@ module = [
     "sphinx.roles",
     "sphinx.search.*",
     "sphinx.testing.*",
-    "sphinx.util.*",
+    "sphinx.util",
+    "sphinx.util.display",
+    "sphinx.util.docfields",
+    "sphinx.util.docutils",
+    "sphinx.util.fileutil",
+    "sphinx.util.i18n",
+    "sphinx.util.inspect",
+    "sphinx.util.inventory",
+    "sphinx.util.logging",
+    "sphinx.util.nodes",
+    "sphinx.util.parallel",
+    "sphinx.util.template",
 ]
 disallow_any_generics = false
 

sphinx/util/__init__.py

@@ -44,8 +44,8 @@
 logger = logging.getLogger(__name__)
 
 # Generally useful regular expressions.
-ws_re: re.Pattern = re.compile(r'\s+')
-url_re: re.Pattern = re.compile(r'(?P<schema>.+)://.*')
+ws_re: re.Pattern[str] = re.compile(r'\s+')
+url_re: re.Pattern[str] = re.compile(r'(?P<schema>.+)://.*')
 
 
 # High-level utility functions.

sphinx/util/cfamily.py

@@ -244,8 +244,8 @@ def __init__(self, definition: str, *,
 
         self.pos = 0
         self.end = len(self.definition)
-        self.last_match: re.Match = None
-        self._previous_state: tuple[int, re.Match] = (0, None)
+        self.last_match: re.Match[str] | None = None
+        self._previous_state: tuple[int, re.Match[str] | None] = (0, None)
         self.otherErrors: list[DefinitionError] = []
 
         # in our tests the following is set to False to capture bad parsing
@@ -297,7 +297,7 @@ def fail(self, msg: str) -> None:
     def warn(self, msg: str) -> None:
         logger.warning(msg, location=self.location)
 
-    def match(self, regex: re.Pattern) -> bool:
+    def match(self, regex: re.Pattern[str]) -> bool:
         match = regex.match(self.definition, self.pos)
         if match is not None:
             self._previous_state = (self.pos, self.last_match)

sphinx/util/console.py

@@ -14,7 +14,7 @@
     colorama = None
 
 
-_ansi_re: re.Pattern = re.compile('\x1b\\[(\\d\\d;){0,2}\\d\\dm')
+_ansi_re: re.Pattern[str] = re.compile('\x1b\\[(\\d\\d;){0,2}\\d\\dm')
 codes: dict[str, str] = {}
 
 

sphinx/util/matching.py

@@ -83,7 +83,7 @@ def match(self, string: str) -> bool:
 DOTFILES = Matcher(['**/.*'])
 
 
-_pat_cache: dict[str, re.Pattern] = {}
+_pat_cache: dict[str, re.Pattern[str]] = {}
 
 
 def patmatch(name: str, pat: str) -> re.Match[str] | None:

sphinx/util/typing.py

@@ -61,7 +61,7 @@ def is_invalid_builtin_class(obj: Any) -> bool:
 
 
 def get_type_hints(
-    obj: Any, globalns: dict[str, Any] | None = None, localns: dict | None = None,
+    obj: Any, globalns: dict[str, Any] | None = None, localns: dict[str, Any] | None = None,
 ) -> dict[str, Any]:
     """Return a dictionary containing type hints for a function, method, module or class
     object.