Skip to content

Commit 8ce9af8

Browse files
committed
gh-133403: Check Tools/build/generate-build-details.py with mypy
1 parent 308ceff commit 8ce9af8

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

.github/workflows/mypy.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ on:
1515
- "Misc/mypy/**"
1616
- "Tools/build/compute-changes.py"
1717
- "Tools/build/generate_sbom.py"
18+
- "Tools/build/generate-build-details.py"
1819
- "Tools/build/verify_ensurepip_wheels.py"
1920
- "Tools/build/update_file.py"
2021
- "Tools/cases_generator/**"

Tools/build/generate-build-details.py

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
# Script initially imported from:
44
# https://github.com/FFY00/python-instrospection/blob/main/python_introspection/scripts/generate-build-details.py
55

6+
from __future__ import annotations
7+
68
import argparse
79
import collections
810
import importlib.machinery
@@ -11,19 +13,24 @@
1113
import sys
1214
import sysconfig
1315

16+
TYPE_CHECKING = False
17+
if TYPE_CHECKING:
18+
from sys import _version_info
19+
from typing import Any
20+
1421

15-
def version_info_to_dict(obj): # (object) -> dict[str, Any]
22+
def version_info_to_dict(obj: _version_info) -> dict[str, Any]:
1623
field_names = ('major', 'minor', 'micro', 'releaselevel', 'serial')
1724
return {field: getattr(obj, field) for field in field_names}
1825

1926

20-
def get_dict_key(container, key): # (dict[str, Any], str) -> dict[str, Any]
27+
def get_dict_key(container: dict[str, Any], key: str) -> dict[str, Any]:
2128
for part in key.split('.'):
2229
container = container[part]
2330
return container
2431

2532

26-
def generate_data(schema_version):
33+
def generate_data(schema_version: str) -> collections.defaultdict[str, Any]:
2734
"""Generate the build-details.json data (PEP 739).
2835
2936
:param schema_version: The schema version of the data we want to generate.
@@ -32,7 +39,9 @@ def generate_data(schema_version):
3239
if schema_version != '1.0':
3340
raise ValueError(f'Unsupported schema_version: {schema_version}')
3441

35-
data = collections.defaultdict(lambda: collections.defaultdict(dict))
42+
data: collections.defaultdict[str, Any] = collections.defaultdict(
43+
lambda: collections.defaultdict(dict),
44+
)
3645

3746
data['schema_version'] = schema_version
3847

@@ -122,7 +131,7 @@ def generate_data(schema_version):
122131
return data
123132

124133

125-
def make_paths_relative(data, config_path=None): # (dict[str, Any], str | None) -> None
134+
def make_paths_relative(data: dict[str, Any], config_path: str | None = None) -> None:
126135
# Make base_prefix relative to the config_path directory
127136
if config_path:
128137
data['base_prefix'] = os.path.relpath(data['base_prefix'], os.path.dirname(config_path))
@@ -152,7 +161,7 @@ def make_paths_relative(data, config_path=None): # (dict[str, Any], str | None)
152161
container[child] = new_path
153162

154163

155-
def main(): # () -> None
164+
def main() -> None:
156165
parser = argparse.ArgumentParser(exit_on_error=False)
157166
parser.add_argument('location')
158167
parser.add_argument(

Tools/build/mypy.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
# .github/workflows/mypy.yml
55
files =
66
Tools/build/compute-changes.py,
7+
Tools/build/generate-build-details.py,
78
Tools/build/generate_sbom.py,
89
Tools/build/verify_ensurepip_wheels.py,
910
Tools/build/update_file.py

0 commit comments

Comments
 (0)