Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commite096701

Browse files
authored
Improve type annotations for versions and languages (#253)
1 parent8d0b9c3 commite096701

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

‎build_docs.py

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333
importsys
3434
fromargparseimportArgumentParser,Namespace
3535
frombisectimportbisect_leftasbisect
36-
fromcollections.abcimportIterable,Sequence
3736
fromcontextlibimportcontextmanager,suppress
3837
fromdataclassesimportdataclass
3938
fromdatetimeimportdatetimeasdt,timezone
@@ -42,14 +41,21 @@
4241
frompathlibimportPath
4342
fromstringimportTemplate
4443
fromtimeimportperf_counter,sleep
45-
fromtypingimportLiteral
4644
fromurllib.parseimporturljoin
4745

4846
importjinja2
4947
importtomlkit
5048
importurllib3
5149
importzc.lockfile
5250

51+
TYPE_CHECKING=False
52+
ifTYPE_CHECKING:
53+
fromcollections.abcimportSequence
54+
fromtypingimportLiteral,TypeAlias
55+
56+
Versions:TypeAlias=Sequence["Version"]
57+
Languages:TypeAlias=Sequence["Language"]
58+
5359
try:
5460
fromosimportEX_OK,EX_SOFTWAREasEX_FAILURE
5561
exceptImportError:
@@ -170,7 +176,7 @@ def picker_label(self):
170176
returnf"pre ({self.name})"
171177
returnself.name
172178

173-
defsetup_indexsidebar(self,versions:Sequence[Version],dest_path:Path):
179+
defsetup_indexsidebar(self,versions:Versions,dest_path:Path):
174180
"""Build indexsidebar.html for Sphinx."""
175181
template_path=HERE/"templates"/"indexsidebar.html"
176182
template=jinja2.Template(template_path.read_text(encoding="UTF-8"))
@@ -388,9 +394,7 @@ def edit(file: Path):
388394
temporary.rename(file)
389395

390396

391-
defsetup_switchers(
392-
versions:Sequence[Version],languages:Sequence[Language],html_root:Path
393-
):
397+
defsetup_switchers(versions:Versions,languages:Languages,html_root:Path):
394398
"""Setup cross-links between CPython versions:
395399
- Cross-link various languages in a language switcher
396400
- Cross-link various versions in a version switcher
@@ -462,9 +466,9 @@ class DocBuilder:
462466
"""Builder for a CPython version and a language."""
463467

464468
version:Version
465-
versions:Sequence[Version]
469+
versions:Versions
466470
language:Language
467-
languages:Sequence[Language]
471+
languages:Languages
468472
cpython_repo:Repository
469473
build_root:Path
470474
www_root:Path
@@ -1070,7 +1074,7 @@ def build_docs(args) -> bool:
10701074
returnall_built_successfully
10711075

10721076

1073-
defparse_versions_from_devguide(http:urllib3.PoolManager)->list[Version]:
1077+
defparse_versions_from_devguide(http:urllib3.PoolManager)->Versions:
10741078
releases=http.request(
10751079
"GET",
10761080
"https://raw.githubusercontent.com/"
@@ -1082,7 +1086,7 @@ def parse_versions_from_devguide(http: urllib3.PoolManager) -> list[Version]:
10821086
returnversions
10831087

10841088

1085-
defparse_languages_from_config()->list[Language]:
1089+
defparse_languages_from_config()->Languages:
10861090
"""Read config.toml to discover languages to build."""
10871091
config=tomlkit.parse((HERE/"config.toml").read_text(encoding="UTF-8"))
10881092
defaults=config["defaults"]
@@ -1103,9 +1107,7 @@ def parse_languages_from_config() -> list[Language]:
11031107
]
11041108

11051109

1106-
defbuild_sitemap(
1107-
versions:Iterable[Version],languages:Iterable[Language],www_root:Path,group
1108-
):
1110+
defbuild_sitemap(versions:Versions,languages:Languages,www_root:Path,group):
11091111
"""Build a sitemap with all live versions and translations."""
11101112
ifnotwww_root.exists():
11111113
logging.info("Skipping sitemap generation (www root does not even exist).")
@@ -1155,8 +1157,8 @@ def copy_robots_txt(
11551157
defmajor_symlinks(
11561158
www_root:Path,
11571159
group:str,
1158-
versions:Iterable[Version],
1159-
languages:Iterable[Language],
1160+
versions:Versions,
1161+
languages:Languages,
11601162
skip_cache_invalidation:bool,
11611163
http:urllib3.PoolManager,
11621164
)->None:

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp