python-docs-theme/babel_runner.py at main · python/python-docs-theme · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
"""Script for handling translations with Babel"""

from __future__ importannotations

importargparse
importast
importsubprocess
importtomllib
frompathlibimportPath

fromhatchling.builders.hooks.plugin.interfaceimportBuildHookInterface

# Global variables used by pybabel below (paths relative to PROJECT_DIR)
DOMAIN="python-docs-theme"
COPYRIGHT_HOLDER="Python Software Foundation"
SOURCE_DIR="python_docs_theme"
MAPPING_FILE=".babel.cfg"

PROJECT_DIR=Path(__file__).resolve().parent
PYPROJECT_TOML=Path(PROJECT_DIR, "pyproject.toml")
INIT_PY=PROJECT_DIR/SOURCE_DIR/"__init__.py"
LOCALES_DIR=Path(f"{SOURCE_DIR}", "locale")
POT_FILE=Path(LOCALES_DIR, f"{DOMAIN}.pot")


defget_project_info() ->dict:
"""Retrieve project's info to populate the message catalog template"""
pyproject_text=PYPROJECT_TOML.read_text(encoding="utf-8")
project_data=tomllib.loads(pyproject_text)["project"]

# read __version__ from __init__.py
forchildinast.parse(INIT_PY.read_bytes()).body:
ifnotisinstance(child, ast.Assign):
continue
target=child.targets[0]
ifnotisinstance(target, ast.Name) ortarget.id!="__version__":
continue
version_node=child.value
ifnotisinstance(version_node, ast.Constant):
continue
project_data["version"] =version_node.value
break

returnproject_data


defextract_messages() ->None:
"""Extract messages from all source files into message catalog template"""
Path(PROJECT_DIR, LOCALES_DIR).mkdir(parents=True, exist_ok=True)
project_data=get_project_info()
subprocess.run(
 [
"pybabel",
"extract",
"-F",
MAPPING_FILE,
"--copyright-holder",
COPYRIGHT_HOLDER,
"--project",
project_data["name"],
"--version",
project_data["version"],
"--msgid-bugs-address",
project_data["urls"]["Issue tracker"],
"-o",
POT_FILE,
SOURCE_DIR,
 ],
cwd=PROJECT_DIR,
check=True,
 )


definit_locale(locale: str) ->None:
"""Initialize a new locale based on existing message catalog template"""
pofile=PROJECT_DIR/LOCALES_DIR/locale/"LC_MESSAGES"/f"{DOMAIN}.po"
ifpofile.exists():
print(f"There is already a message catalog for locale {locale}, skipping.")
return
cmd= [
"pybabel",
"init",
"-i",
POT_FILE,
"-d",
LOCALES_DIR,
"-D",
DOMAIN,
"-l",
locale,
 ]
subprocess.run(cmd, cwd=PROJECT_DIR, check=True)


defupdate_catalogs(locale: str) ->None:
"""Update translations from existing message catalogs"""
cmd= ["pybabel", "update", "-i", POT_FILE, "-d", LOCALES_DIR, "-D", DOMAIN]
iflocale:
cmd.extend(["-l", locale])
subprocess.run(cmd, cwd=PROJECT_DIR, check=True)


defcompile_catalogs(locale: str) ->None:
"""Compile existing message catalogs"""
cmd= ["pybabel", "compile", "-d", LOCALES_DIR, "-D", DOMAIN]
iflocale:
cmd.extend(["-l", locale])
subprocess.run(cmd, cwd=PROJECT_DIR, check=True)


classCustomBuildHook(BuildHookInterface):
definitialize(self, version: str, build_data: dict[str, object]) ->None:
compile_catalogs("")


defmain() ->None:
parser=argparse.ArgumentParser(description=__doc__)
parser.add_argument(
"command",
choices=["extract", "init", "update", "compile"],
help="command to be executed",
 )
parser.add_argument(
"-l",
"--locale",
default="",
help="language code (needed for init, optional for update and compile)",
 )

args=parser.parse_args()
locale=args.locale

ifargs.command=="extract":
extract_messages()
elifargs.command=="init":
ifnotlocale:
parser.error("init requires passing the --locale option")
init_locale(locale)
elifargs.command=="update":
update_catalogs(locale)
elifargs.command=="compile":
compile_catalogs(locale)


if__name__=="__main__":
main()