[lint] run mypy on the utils/ directory (#12090)

Co-authored-by: daniel.eades <[email protected]>

pyproject.toml

@@ -131,7 +131,7 @@ exclude = [
 ]
 
 [tool.mypy]
-files = ["sphinx"]
+files = ["sphinx", "utils"]
 check_untyped_defs = true
 disallow_incomplete_defs = true
 python_version = "3.9"

utils/babel_runner.py

@@ -233,16 +233,16 @@ def _get_logger():
 
  os.chdir(ROOT)
  if action == "extract":
- raise SystemExit(run_extract())
- if action == "update":
- raise SystemExit(run_update())
- if action == "compile":
- raise SystemExit(run_compile())
- if action == "all":
- exit_code = run_extract()
- if exit_code:
-  raise SystemExit(exit_code)
-  exit_code = run_update()
- if exit_code:
-  raise SystemExit(exit_code)
-  raise SystemExit(run_compile())
+ run_extract()
+ elif action == "update":
+ run_update()
+ elif action == "compile":
+ run_compile()
+ elif action == "all":
+ run_extract()
+ run_update()
+ run_compile()
+ else:
+ msg = f"invalid action: '{action}'"
+ raise ValueError(msg)
+ raise SystemExit

utils/bump_version.py

@@ -1,27 +1,41 @@
 #!/usr/bin/env python3
 
+from __future__ import annotations
+
 import argparse
-import os
 import re
 import sys
 import time
 from contextlib import contextmanager
+from pathlib import Path
+from typing import TYPE_CHECKING, Sequence
+
+from typing_extensions import TypeAlias
 
-script_dir = os.path.dirname(__file__)
-package_dir = os.path.abspath(os.path.join(script_dir, '..'))
+if TYPE_CHECKING:
+ from collections.abc import Iterator
+
+script_dir = Path(__file__).parent
+package_dir = script_dir.parent
 
 RELEASE_TYPE = {'a': 'alpha', 'b': 'beta'}
 
+VersionInfo: TypeAlias = tuple[int, int, int, str, int]
+
 
-def stringify_version(version_info, in_develop=True):
+def stringify_version(
+ version_info: VersionInfo, in_develop: bool = True,
+) -> str:
  version = '.'.join(str(v) for v in version_info[:3])
  if not in_develop and version_info[3] != 'final':
  version += version_info[3][0] + str(version_info[4])
 
  return version
 
 
-def bump_version(path, version_info, in_develop=True) -> None:
+def bump_version(
+ path: Path, version_info: VersionInfo, in_develop: bool = True,
+) -> None:
  version = stringify_version(version_info, in_develop)
 
  with open(path, encoding='utf-8') as f:
@@ -42,7 +56,7 @@ def bump_version(path, version_info, in_develop=True) -> None:
  f.write('\n'.join(lines) + '\n')
 
 
-def parse_version(version):
+def parse_version(version: str) -> VersionInfo:
  matched = re.search(r'^(\d+)\.(\d+)$', version)
  if matched:
  major, minor = matched.groups()
@@ -73,7 +87,7 @@ class Skip(Exception):
 
 
 @contextmanager
-def processing(message):
+def processing(message: str) -> Iterator[None]:
  try:
  print(message + ' ... ', end='')
  yield
@@ -87,7 +101,7 @@ def processing(message):
 
 
 class Changes:
- def __init__(self, path):
+ def __init__(self, path: Path) -> None:
  self.path = path
  self.fetch_version()
 
@@ -120,16 +134,18 @@ def finalize_release_date(self) -> None:
  f.write('=' * len(heading) + '\n')
  f.write(self.filter_empty_sections(body))
 
- def add_release(self, version_info) -> None:
+ def add_release(self, version_info: VersionInfo) -> None:
  if version_info[-2:] in (('beta', 0), ('final', 0)):
  version = stringify_version(version_info)
  else:
  reltype = version_info[3]
- version = (f'{stringify_version(version_info)} '
- f'{RELEASE_TYPE.get(reltype, reltype)}{version_info[4] or ""}')
+ version = (
+ f'{stringify_version(version_info)} '
+ f'{RELEASE_TYPE.get(reltype, reltype)}{version_info[4] or ""}'
+ )
  heading = 'Release %s (in development)' % version
 
- with open(os.path.join(script_dir, 'CHANGES_template.rst'), encoding='utf-8') as f:
+ with open(script_dir / 'CHANGES_template.rst', encoding='utf-8') as f:
  f.readline() # skip first two lines
  f.readline()
  tmpl = f.read()
@@ -145,11 +161,11 @@ def add_release(self, version_info) -> None:
  f.write('\n')
  f.write(body)
 
- def filter_empty_sections(self, body):
+ def filter_empty_sections(self, body: str) -> str:
  return re.sub('^\n.+\n-{3,}\n+(?=\n.+\n[-=]{3,}\n)', '', body, flags=re.MULTILINE)
 
 
-def parse_options(argv):
+def parse_options(argv: Sequence[str]) -> argparse.Namespace:
  parser = argparse.ArgumentParser()
  parser.add_argument('version', help='A version number (cf. 1.6b0)')
  parser.add_argument('--in-develop', action='store_true')
@@ -162,11 +178,11 @@ def main() -> None:
  options = parse_options(sys.argv[1:])
 
  with processing("Rewriting sphinx/__init__.py"):
- bump_version(os.path.join(package_dir, 'sphinx/__init__.py'),
+ bump_version(package_dir / 'sphinx' / '__init__.py',
  options.version, options.in_develop)
 
  with processing('Rewriting CHANGES'):
- changes = Changes(os.path.join(package_dir, 'CHANGES.rst'))
+ changes = Changes(package_dir / 'CHANGES.rst')
  if changes.version_info == options.version:
  if changes.in_development:
  changes.finalize_release_date()