|
1
|
|
|
import argparse |
|
|
|
|
|
|
2
|
|
|
|
|
3
|
|
|
from pathlib import Path |
|
4
|
|
|
|
|
5
|
|
|
from typing import Callable |
|
|
|
|
|
|
6
|
|
|
from typing import Iterable |
|
7
|
|
|
from typing import List |
|
8
|
|
|
from typing import Optional |
|
9
|
|
|
from typing import Set |
|
10
|
|
|
from typing import Text |
|
11
|
|
|
from typing import Type |
|
|
|
|
|
|
12
|
|
|
|
|
13
|
|
|
try: |
|
14
|
|
|
from typing import Literal |
|
|
|
|
|
|
15
|
|
|
MODE = Literal["w", "a"] |
|
|
|
|
|
|
16
|
|
|
except ImportError: |
|
17
|
|
|
MODE = Text |
|
|
|
|
|
|
18
|
|
|
|
|
19
|
|
|
from .command_base import BaseCommand |
|
20
|
|
|
from .command_base import BaseCommandExecutor |
|
21
|
|
|
|
|
22
|
|
|
from .gettext_tools import extract_translations |
|
23
|
|
|
from .gettext_tools import extract_unique_messages |
|
24
|
|
|
from .gettext_tools import merge_new_and_existing_translations |
|
25
|
|
|
from .gettext_tools import remove_obsolete_translations |
|
26
|
|
|
from .gettext_tools import strip_translations_header |
|
27
|
|
|
from .gettext_tools import validate_gettext_tools_exist |
|
28
|
|
|
|
|
29
|
|
|
from .paths import ensure_dir_exists |
|
30
|
|
|
from .paths import find_source_files_paths |
|
31
|
|
|
from .paths import get_names_of_immediate_subdirectories |
|
32
|
|
|
from .paths import make_messages_dir_path |
|
|
|
|
|
|
33
|
|
|
from .paths import make_po_file_path |
|
34
|
|
|
from .paths import make_pot_file_path |
|
35
|
|
|
|
|
36
|
|
|
from .text import flatten_comma_separated_values |
|
37
|
|
|
from .text import stringify_path |
|
38
|
|
|
|
|
39
|
|
|
from .utils import print_err |
|
40
|
|
|
from .utils import print_out |
|
41
|
|
|
from .utils import show_usage_error_and_halt |
|
42
|
|
|
|
|
43
|
|
|
from . import defaults |
|
44
|
|
|
|
|
45
|
|
|
|
|
46
|
|
|
class ExtractCommandExecutor(BaseCommandExecutor): |
|
|
|
|
|
|
47
|
|
|
|
|
48
|
|
|
def __init__(self, args=argparse.Namespace) -> None: |
|
|
|
|
|
|
49
|
|
|
self._domain = args.domain |
|
|
|
|
|
|
50
|
|
|
self._validate_domain(self._domain) |
|
|
|
|
|
|
51
|
|
|
|
|
52
|
|
|
self._process_all_locales = args.all |
|
|
|
|
|
|
53
|
|
|
|
|
54
|
|
|
self._locales_dir_path = self._handle_locales_dir_path(args.output_dir) |
|
|
|
|
|
|
55
|
|
|
self._validate_locales_dir_path(self._locales_dir_path) |
|
|
|
|
|
|
56
|
|
|
|
|
57
|
|
|
self._pot_file_path = make_pot_file_path(self._locales_dir_path, self._domain) |
|
|
|
|
|
|
58
|
|
|
|
|
59
|
|
|
self._locales = self._handle_locales( |
|
|
|
|
|
|
60
|
|
|
locales=args.locale, |
|
|
|
|
|
|
61
|
|
|
process_all=self._process_all_locales, |
|
|
|
|
|
|
62
|
|
|
locales_dir_path=self._locales_dir_path, |
|
|
|
|
|
|
63
|
|
|
) |
|
64
|
|
|
self._validate_locales(self._locales) |
|
|
|
|
|
|
65
|
|
|
|
|
66
|
|
|
self._keywords = self._handle_keywords( |
|
|
|
|
|
|
67
|
|
|
keywords=args.keyword, |
|
|
|
|
|
|
68
|
|
|
no_defaults=args.no_default_keywords, |
|
|
|
|
|
|
69
|
|
|
) |
|
70
|
|
|
self._extensions = self._handle_extensions(args.extensions) |
|
|
|
|
|
|
71
|
|
|
self._follow_links = args.follow_links |
|
|
|
|
|
|
72
|
|
|
self._ignore_patterns = self._handle_ignore_patterns( |
|
|
|
|
|
|
73
|
|
|
ignore_patterns=args.ignore_patterns, |
|
|
|
|
|
|
74
|
|
|
no_defaults=args.no_default_ignore_patterns, |
|
|
|
|
|
|
75
|
|
|
) |
|
76
|
|
|
self._no_wrap = args.no_wrap |
|
|
|
|
|
|
77
|
|
|
self._no_location = args.no_location |
|
|
|
|
|
|
78
|
|
|
self._no_obsolete = args.no_obsolete |
|
|
|
|
|
|
79
|
|
|
self._keep_pot = args.keep_pot |
|
|
|
|
|
|
80
|
|
|
self._xgettext_extra_args = flatten_comma_separated_values(args.xgettext_extra_args) |
|
|
|
|
|
|
81
|
|
|
self._msguniq_extra_args = flatten_comma_separated_values(args.msguniq_extra_args) |
|
|
|
|
|
|
82
|
|
|
self._msgmerge_extra_args = flatten_comma_separated_values(args.msgmerge_extra_args) |
|
|
|
|
|
|
83
|
|
|
self._msgattrib_extra_args = flatten_comma_separated_values(args.msgattrib_extra_args) |
|
|
|
|
|
|
84
|
|
|
self._verbose = args.verbose |
|
|
|
|
|
|
85
|
|
|
|
|
86
|
|
|
@staticmethod |
|
|
|
|
|
|
87
|
|
|
def _handle_keywords( |
|
|
|
|
|
|
88
|
|
|
keywords: Optional[Iterable[Text]]=None, |
|
|
|
|
|
|
89
|
|
|
no_defaults: bool=False, |
|
|
|
|
|
|
90
|
|
|
) -> List[Text]: |
|
91
|
|
|
|
|
92
|
|
|
keywords = ( |
|
|
|
|
|
|
93
|
|
|
list(keywords) |
|
|
|
|
|
|
94
|
|
|
if keywords is not None |
|
|
|
|
|
|
95
|
|
|
else [] |
|
|
|
|
|
|
96
|
|
|
) |
|
97
|
|
|
|
|
98
|
|
|
if not no_defaults: |
|
|
|
|
|
|
99
|
|
|
keywords.extend(defaults.DEFAULT_KEYWORDS) |
|
|
|
|
|
|
100
|
|
|
|
|
101
|
|
|
return list(sorted(set(keywords))) |
|
|
|
|
|
|
102
|
|
|
|
|
103
|
|
|
@staticmethod |
|
|
|
|
|
|
104
|
|
|
def _handle_extensions( |
|
|
|
|
|
|
105
|
|
|
extensions: Optional[Iterable[Text]]=None, |
|
|
|
|
|
|
106
|
|
|
ignored: Optional[Iterable[Text]]=None, |
|
|
|
|
|
|
107
|
|
|
) -> Set[Text]: |
|
108
|
|
|
|
|
109
|
|
|
extensions = ( |
|
|
|
|
|
|
110
|
|
|
list(extensions) |
|
|
|
|
|
|
111
|
|
|
if extensions is not None |
|
|
|
|
|
|
112
|
|
|
else [] |
|
|
|
|
|
|
113
|
|
|
) |
|
114
|
|
|
|
|
115
|
|
|
ignored = ( |
|
|
|
|
|
|
116
|
|
|
set(ignored) |
|
|
|
|
|
|
117
|
|
|
if ignored is not None |
|
|
|
|
|
|
118
|
|
|
else set() |
|
|
|
|
|
|
119
|
|
|
) |
|
120
|
|
|
|
|
121
|
|
|
ext_list = [] |
|
|
|
|
|
|
122
|
|
|
|
|
123
|
|
|
for ext in extensions: |
|
|
|
|
|
|
124
|
|
|
ext_list.extend(ext.replace(" ", "").split(",")) |
|
|
|
|
|
|
125
|
|
|
|
|
126
|
|
|
for i, ext in enumerate(ext_list): |
|
|
|
|
|
|
127
|
|
|
if not ext.startswith("."): |
|
|
|
|
|
|
128
|
|
|
ext_list[i] = ".%s" % ext_list[i] |
|
|
|
|
|
|
129
|
|
|
|
|
130
|
|
|
ext_list.append(".py") |
|
|
|
|
|
|
131
|
|
|
|
|
132
|
|
|
return { |
|
|
|
|
|
|
133
|
|
|
x |
|
|
|
|
|
|
134
|
|
|
for x in ext_list |
|
|
|
|
|
|
135
|
|
|
if x.strip(".") not in ignored |
|
|
|
|
|
|
136
|
|
|
} |
|
137
|
|
|
|
|
138
|
|
|
@staticmethod |
|
|
|
|
|
|
139
|
|
|
def _handle_ignore_patterns( |
|
|
|
|
|
|
140
|
|
|
ignore_patterns: Optional[Iterable[Text]]=None, |
|
|
|
|
|
|
141
|
|
|
no_defaults: bool=False, |
|
|
|
|
|
|
142
|
|
|
) -> List[Text]: |
|
143
|
|
|
|
|
144
|
|
|
ignore_patterns = ( |
|
|
|
|
|
|
145
|
|
|
list(ignore_patterns) |
|
|
|
|
|
|
146
|
|
|
if ignore_patterns is not None |
|
|
|
|
|
|
147
|
|
|
else [] |
|
|
|
|
|
|
148
|
|
|
) |
|
149
|
|
|
|
|
150
|
|
|
if not no_defaults: |
|
|
|
|
|
|
151
|
|
|
ignore_patterns.extend(defaults.DEFAULT_IGNORE_PATTERNS) |
|
|
|
|
|
|
152
|
|
|
|
|
153
|
|
|
return list(sorted(set(ignore_patterns))) |
|
|
|
|
|
|
154
|
|
|
|
|
155
|
|
|
@staticmethod |
|
|
|
|
|
|
156
|
|
|
def _validate_domain(domain: Optional[Text]) -> None: |
|
|
|
|
|
|
157
|
|
|
if not domain: |
|
|
|
|
|
|
158
|
|
|
print_err(f"invalid domain value: '{domain}'") |
|
|
|
|
|
|
159
|
|
|
show_usage_error_and_halt() |
|
|
|
|
|
|
160
|
|
|
|
|
161
|
|
|
@staticmethod |
|
|
|
|
|
|
162
|
|
|
def _handle_locales_dir_path(path: Text) -> Path: |
|
|
|
|
|
|
163
|
|
|
return Path(path).absolute() |
|
|
|
|
|
|
164
|
|
|
|
|
165
|
|
|
@staticmethod |
|
|
|
|
|
|
166
|
|
|
def _validate_locales_dir_path(path: Path) -> None: |
|
|
|
|
|
|
167
|
|
|
if path.exists() and not path.is_dir(): |
|
|
|
|
|
|
168
|
|
|
print_err( |
|
|
|
|
|
|
169
|
|
|
f"locales dir already exists but it is not a directory " |
|
|
|
|
|
|
170
|
|
|
f"(path={stringify_path(path)})" |
|
171
|
|
|
) |
|
172
|
|
|
show_usage_error_and_halt() |
|
|
|
|
|
|
173
|
|
|
|
|
174
|
|
|
@staticmethod |
|
|
|
|
|
|
175
|
|
|
def _handle_locales( |
|
|
|
|
|
|
176
|
|
|
locales: Optional[List[Text]], |
|
|
|
|
|
|
177
|
|
|
process_all: bool, |
|
|
|
|
|
|
178
|
|
|
locales_dir_path: Path, |
|
|
|
|
|
|
179
|
|
|
) -> List[Text]: |
|
180
|
|
|
|
|
181
|
|
|
if locales: |
|
|
|
|
|
|
182
|
|
|
return flatten_comma_separated_values(locales) |
|
|
|
|
|
|
183
|
|
|
elif process_all: |
|
|
|
|
|
|
184
|
|
|
return get_names_of_immediate_subdirectories(locales_dir_path) |
|
|
|
|
|
|
185
|
|
|
else: |
|
|
|
|
|
|
186
|
|
|
return [] |
|
|
|
|
|
|
187
|
|
|
|
|
188
|
|
|
@staticmethod |
|
|
|
|
|
|
189
|
|
|
def _validate_locales(locales: List[Text]) -> None: |
|
|
|
|
|
|
190
|
|
|
if not locales: |
|
|
|
|
|
|
191
|
|
|
print_err( |
|
|
|
|
|
|
192
|
|
|
"specify at least 1 locale or specify processing of all existing locales" |
|
|
|
|
|
|
193
|
|
|
) |
|
194
|
|
|
show_usage_error_and_halt() |
|
|
|
|
|
|
195
|
|
|
|
|
196
|
|
|
def __call__(self) -> None: |
|
|
|
|
|
|
197
|
|
|
validate_gettext_tools_exist() |
|
|
|
|
|
|
198
|
|
|
|
|
199
|
|
|
if self._verbose: |
|
|
|
|
|
|
200
|
|
|
self._print_input_args( |
|
|
|
|
|
|
201
|
|
|
domain=self._domain, |
|
|
|
|
|
|
202
|
|
|
locales_dir_path=stringify_path(self._locales_dir_path), |
|
|
|
|
|
|
203
|
|
|
process_all_locales=self._process_all_locales, |
|
|
|
|
|
|
204
|
|
|
locales=self._locales, |
|
|
|
|
|
|
205
|
|
|
keywords=self._keywords, |
|
|
|
|
|
|
206
|
|
|
extensions=self._extensions, |
|
|
|
|
|
|
207
|
|
|
follow_links=self._follow_links, |
|
|
|
|
|
|
208
|
|
|
ignore_patterns=self._ignore_patterns, |
|
|
|
|
|
|
209
|
|
|
no_wrap=self._no_wrap, |
|
|
|
|
|
|
210
|
|
|
no_location=self._no_location, |
|
|
|
|
|
|
211
|
|
|
no_obsolete=self._no_obsolete, |
|
|
|
|
|
|
212
|
|
|
keep_pot=self._keep_pot, |
|
|
|
|
|
|
213
|
|
|
xgettext_extra_args=self._xgettext_extra_args, |
|
|
|
|
|
|
214
|
|
|
msguniq_extra_args=self._msguniq_extra_args, |
|
|
|
|
|
|
215
|
|
|
msgmerge_extra_args=self._msgmerge_extra_args, |
|
|
|
|
|
|
216
|
|
|
msgattrib_extra_args=self._msgattrib_extra_args, |
|
|
|
|
|
|
217
|
|
|
verbose=self._verbose, |
|
|
|
|
|
|
218
|
|
|
) |
|
219
|
|
|
|
|
220
|
|
|
ensure_dir_exists(self._locales_dir_path) |
|
|
|
|
|
|
221
|
|
|
|
|
222
|
|
|
try: |
|
|
|
|
|
|
223
|
|
|
self._make_pot_file() |
|
|
|
|
|
|
224
|
|
|
self._ensure_no_duplicates_in_pot_file() |
|
|
|
|
|
|
225
|
|
|
self._make_all_po_files() |
|
|
|
|
|
|
226
|
|
|
finally: |
|
|
|
|
|
|
227
|
|
|
if not self._keep_pot: |
|
|
|
|
|
|
228
|
|
|
self._maybe_remove_pot_file() |
|
|
|
|
|
|
229
|
|
|
|
|
230
|
|
|
def _make_pot_file(self) -> None: |
|
|
|
|
|
|
231
|
|
|
if self._verbose: |
|
|
|
|
|
|
232
|
|
|
print_out(f"making '.pot' file") |
|
|
|
|
|
|
233
|
|
|
|
|
234
|
|
|
self._maybe_remove_pot_file() |
|
|
|
|
|
|
235
|
|
|
|
|
236
|
|
|
sources_root_dir_path = Path(".") # explicitly use relative path |
|
|
|
|
|
|
237
|
|
|
|
|
238
|
|
|
for file_path in find_source_files_paths( |
|
|
|
|
|
|
239
|
|
|
root_dir_path=sources_root_dir_path, |
|
|
|
|
|
|
240
|
|
|
ignore_patterns=self._ignore_patterns, |
|
|
|
|
|
|
241
|
|
|
extensions=self._extensions, |
|
|
|
|
|
|
242
|
|
|
follow_links=self._follow_links, |
|
|
|
|
|
|
243
|
|
|
verbose=self._verbose, |
|
|
|
|
|
|
244
|
|
|
): |
|
245
|
|
|
self._process_source_file(file_path) |
|
|
|
|
|
|
246
|
|
|
|
|
247
|
|
|
def _process_source_file(self, source_file_path: Path) -> None: |
|
|
|
|
|
|
248
|
|
|
if self._verbose: |
|
|
|
|
|
|
249
|
|
|
print_out(f"processing source '{stringify_path(source_file_path.absolute())}'") |
|
|
|
|
|
|
250
|
|
|
|
|
251
|
|
|
content = extract_translations( |
|
|
|
|
|
|
252
|
|
|
source_file_path=source_file_path, |
|
|
|
|
|
|
253
|
|
|
domain=self._domain, |
|
|
|
|
|
|
254
|
|
|
keywords=self._keywords, |
|
|
|
|
|
|
255
|
|
|
no_wrap=self._no_wrap, |
|
|
|
|
|
|
256
|
|
|
no_location=self._no_location, |
|
|
|
|
|
|
257
|
|
|
xgettext_extra_args=self._xgettext_extra_args, |
|
|
|
|
|
|
258
|
|
|
) |
|
259
|
|
|
|
|
260
|
|
|
if content: |
|
|
|
|
|
|
261
|
|
|
if self._pot_file_path.exists(): |
|
|
|
|
|
|
262
|
|
|
content = strip_translations_header(content) |
|
|
|
|
|
|
263
|
|
|
else: |
|
|
|
|
|
|
264
|
|
|
content = content.replace("charset=CHARSET", "charset=UTF-8") |
|
|
|
|
|
|
265
|
|
|
|
|
266
|
|
|
self._write_translations_file( |
|
|
|
|
|
|
267
|
|
|
file_path=self._pot_file_path, |
|
|
|
|
|
|
268
|
|
|
content=content, |
|
|
|
|
|
|
269
|
|
|
mode="a", |
|
|
|
|
|
|
270
|
|
|
) |
|
271
|
|
|
|
|
272
|
|
|
def _ensure_no_duplicates_in_pot_file(self) -> None: |
|
|
|
|
|
|
273
|
|
|
unique_messages = self._extract_unique_messages() |
|
|
|
|
|
|
274
|
|
|
|
|
275
|
|
|
self._write_translations_file( |
|
|
|
|
|
|
276
|
|
|
file_path=self._pot_file_path, |
|
|
|
|
|
|
277
|
|
|
content=unique_messages, |
|
|
|
|
|
|
278
|
|
|
mode="w", |
|
|
|
|
|
|
279
|
|
|
) |
|
280
|
|
|
|
|
281
|
|
|
def _extract_unique_messages(self) -> Text: |
|
|
|
|
|
|
282
|
|
|
if self._verbose: |
|
|
|
|
|
|
283
|
|
|
print_out("extracting unique messages from '.pot' file") |
|
|
|
|
|
|
284
|
|
|
|
|
285
|
|
|
return extract_unique_messages( |
|
|
|
|
|
|
286
|
|
|
pot_file_path=self._pot_file_path, |
|
|
|
|
|
|
287
|
|
|
no_wrap=self._no_wrap, |
|
|
|
|
|
|
288
|
|
|
no_location=self._no_location, |
|
|
|
|
|
|
289
|
|
|
msguniq_extra_args=self._msguniq_extra_args, |
|
|
|
|
|
|
290
|
|
|
) |
|
291
|
|
|
|
|
292
|
|
|
def _make_all_po_files(self) -> None: |
|
|
|
|
|
|
293
|
|
|
if self._verbose: |
|
|
|
|
|
|
294
|
|
|
print_out(f"making '.po' files") |
|
|
|
|
|
|
295
|
|
|
|
|
296
|
|
|
for locale in self._locales: |
|
|
|
|
|
|
297
|
|
|
self._make_po_file_for_locale(locale=locale) |
|
|
|
|
|
|
298
|
|
|
|
|
299
|
|
|
def _make_po_file_for_locale(self, locale: Text) -> None: |
|
|
|
|
|
|
300
|
|
|
if self._verbose: |
|
|
|
|
|
|
301
|
|
|
print_out(f"processing locale '{locale}'") |
|
|
|
|
|
|
302
|
|
|
|
|
303
|
|
|
po_file_path = make_po_file_path( |
|
|
|
|
|
|
304
|
|
|
locales_dir_path=self._locales_dir_path, |
|
|
|
|
|
|
305
|
|
|
locale=locale, |
|
|
|
|
|
|
306
|
|
|
domain=self._domain, |
|
|
|
|
|
|
307
|
|
|
) |
|
308
|
|
|
|
|
309
|
|
|
ensure_dir_exists(po_file_path.parent) |
|
|
|
|
|
|
310
|
|
|
|
|
311
|
|
|
if po_file_path.exists(): |
|
|
|
|
|
|
312
|
|
|
content = self._merge_new_and_existing_translations(po_file_path) |
|
|
|
|
|
|
313
|
|
|
else: |
|
|
|
|
|
|
314
|
|
|
content = self._pot_file_path.read_text(encoding="utf-8") |
|
|
|
|
|
|
315
|
|
|
|
|
316
|
|
|
self._write_translations_file( |
|
|
|
|
|
|
317
|
|
|
file_path=po_file_path, |
|
|
|
|
|
|
318
|
|
|
content=content, |
|
|
|
|
|
|
319
|
|
|
mode="w", |
|
|
|
|
|
|
320
|
|
|
) |
|
321
|
|
|
|
|
322
|
|
|
if self._no_obsolete: |
|
|
|
|
|
|
323
|
|
|
self._remove_obsolete_translations(po_file_path) |
|
|
|
|
|
|
324
|
|
|
|
|
325
|
|
|
def _merge_new_and_existing_translations(self, po_file_path: Path) -> Text: |
|
|
|
|
|
|
326
|
|
|
if self._verbose: |
|
|
|
|
|
|
327
|
|
|
print_out("merging existing and new messages") |
|
|
|
|
|
|
328
|
|
|
|
|
329
|
|
|
return merge_new_and_existing_translations( |
|
|
|
|
|
|
330
|
|
|
po_file_path=po_file_path, |
|
|
|
|
|
|
331
|
|
|
pot_file_path=self._pot_file_path, |
|
|
|
|
|
|
332
|
|
|
no_wrap=self._no_wrap, |
|
|
|
|
|
|
333
|
|
|
no_location=self._no_location, |
|
|
|
|
|
|
334
|
|
|
msgmerge_extra_args=self._msgmerge_extra_args, |
|
|
|
|
|
|
335
|
|
|
) |
|
336
|
|
|
|
|
337
|
|
|
def _remove_obsolete_translations(self, file_path: Path) -> None: |
|
|
|
|
|
|
338
|
|
|
if self._verbose: |
|
|
|
|
|
|
339
|
|
|
print_out("removing obsolete translations") |
|
|
|
|
|
|
340
|
|
|
|
|
341
|
|
|
remove_obsolete_translations( |
|
|
|
|
|
|
342
|
|
|
po_file_path=file_path, |
|
|
|
|
|
|
343
|
|
|
no_wrap=self._no_wrap, |
|
|
|
|
|
|
344
|
|
|
no_location=self._no_location, |
|
|
|
|
|
|
345
|
|
|
msgattrib_extra_args=self._msgattrib_extra_args, |
|
|
|
|
|
|
346
|
|
|
) |
|
347
|
|
|
|
|
348
|
|
|
def _write_translations_file( |
|
|
|
|
|
|
349
|
|
|
self, |
|
|
|
|
|
|
350
|
|
|
file_path: Path, |
|
|
|
|
|
|
351
|
|
|
content=Text, |
|
|
|
|
|
|
352
|
|
|
mode=MODE, |
|
|
|
|
|
|
353
|
|
|
) -> None: |
|
354
|
|
|
|
|
355
|
|
|
if self._verbose: |
|
|
|
|
|
|
356
|
|
|
print_out(f"writing to '{stringify_path(file_path)}' file") |
|
|
|
|
|
|
357
|
|
|
|
|
358
|
|
|
# Force newlines to '\n' to work around |
|
359
|
|
|
# https://savannah.gnu.org/bugs/index.php?52395 |
|
360
|
|
|
with file_path.open(mode, encoding="utf-8", newline="\n") as f: |
|
|
|
|
|
|
361
|
|
|
f.write(content) |
|
|
|
|
|
|
362
|
|
|
|
|
363
|
|
|
def _maybe_remove_pot_file(self) -> None: |
|
|
|
|
|
|
364
|
|
|
if self._pot_file_path.exists(): |
|
|
|
|
|
|
365
|
|
|
if self._verbose: |
|
|
|
|
|
|
366
|
|
|
print_out(f"removing '.pot' file") |
|
|
|
|
|
|
367
|
|
|
|
|
368
|
|
|
self._pot_file_path.unlink() |
|
|
|
|
|
|
369
|
|
|
|
|
370
|
|
|
|
|
371
|
|
|
class ExtractCommand(BaseCommand): |
|
|
|
|
|
|
372
|
|
|
name = "extract" |
|
|
|
|
|
|
373
|
|
|
aliases = ["x", ] |
|
|
|
|
|
|
374
|
|
|
executor_class = ExtractCommandExecutor |
|
|
|
|
|
|
375
|
|
|
|
|
376
|
|
|
@classmethod |
|
|
|
|
|
|
377
|
|
|
def make_parser(cls, factory=argparse.ArgumentParser) -> argparse.ArgumentParser: |
|
|
|
|
|
|
378
|
|
|
description = "extract translatable strings from sources into '.po' files" |
|
|
|
|
|
|
379
|
|
|
parser = factory( |
|
|
|
|
|
|
380
|
|
|
prog=cls.name, |
|
|
|
|
|
|
381
|
|
|
description=description, |
|
|
|
|
|
|
382
|
|
|
add_help=True, |
|
|
|
|
|
|
383
|
|
|
help=description, |
|
|
|
|
|
|
384
|
|
|
formatter_class=argparse.ArgumentDefaultsHelpFormatter, |
|
|
|
|
|
|
385
|
|
|
) |
|
386
|
|
|
parser.add_argument( |
|
|
|
|
|
|
387
|
|
|
"-d", "--domain", |
|
|
|
|
|
|
388
|
|
|
dest="domain", |
|
|
|
|
|
|
389
|
|
|
default=defaults.DEFAULT_DOMAIN, |
|
|
|
|
|
|
390
|
|
|
help="domain of message files", |
|
|
|
|
|
|
391
|
|
|
) |
|
392
|
|
|
parser.add_argument( |
|
|
|
|
|
|
393
|
|
|
"-l", "--locale", |
|
|
|
|
|
|
394
|
|
|
dest="locale", |
|
|
|
|
|
|
395
|
|
|
action="append", |
|
|
|
|
|
|
396
|
|
|
help=( |
|
|
|
|
|
|
397
|
|
|
"create or update '.po' message files for the given locale(s), " |
|
|
|
|
|
|
398
|
|
|
"ex: 'en_US'; can be specified multiple times" |
|
399
|
|
|
), |
|
400
|
|
|
) |
|
401
|
|
|
parser.add_argument( |
|
|
|
|
|
|
402
|
|
|
"-a", "--all", |
|
|
|
|
|
|
403
|
|
|
dest="all", |
|
|
|
|
|
|
404
|
|
|
action="store_true", |
|
|
|
|
|
|
405
|
|
|
default=False, |
|
|
|
|
|
|
406
|
|
|
help="update all '.po' message files for all existing locales", |
|
|
|
|
|
|
407
|
|
|
) |
|
408
|
|
|
parser.add_argument( |
|
|
|
|
|
|
409
|
|
|
"-o", "--output-dir", |
|
|
|
|
|
|
410
|
|
|
dest="output_dir", |
|
|
|
|
|
|
411
|
|
|
default=defaults.DEFAULT_LOCALE_DIR_NAME, |
|
|
|
|
|
|
412
|
|
|
help="path to the directory where locales will be stored, a.k.a. 'locale dir'", |
|
|
|
|
|
|
413
|
|
|
) |
|
414
|
|
|
parser.add_argument( |
|
|
|
|
|
|
415
|
|
|
"-k", "--keyword", |
|
|
|
|
|
|
416
|
|
|
action="append", |
|
|
|
|
|
|
417
|
|
|
dest="keyword", |
|
|
|
|
|
|
418
|
|
|
help="extra keyword to look for, ex: 'L_'; can be specified multiple times", |
|
|
|
|
|
|
419
|
|
|
) |
|
420
|
|
|
parser.add_argument( |
|
|
|
|
|
|
421
|
|
|
"--no-default-keywords", |
|
|
|
|
|
|
422
|
|
|
action="store_true", |
|
|
|
|
|
|
423
|
|
|
dest="no_default_keywords", |
|
|
|
|
|
|
424
|
|
|
default=False, |
|
|
|
|
|
|
425
|
|
|
help=( |
|
|
|
|
|
|
426
|
|
|
"do not use default keywords as {{{:}}}".format( |
|
|
|
|
|
|
427
|
|
|
", ".join(map(repr, defaults.DEFAULT_KEYWORDS)) |
|
|
|
|
|
|
428
|
|
|
) |
|
429
|
|
|
), |
|
430
|
|
|
) |
|
431
|
|
|
parser.add_argument( |
|
|
|
|
|
|
432
|
|
|
"-e", "--extension", |
|
|
|
|
|
|
433
|
|
|
dest="extensions", |
|
|
|
|
|
|
434
|
|
|
action="append", |
|
|
|
|
|
|
435
|
|
|
help=( |
|
|
|
|
|
|
436
|
|
|
"extra file extension(s) to scan in addition to '.py'; separate multiple " |
|
|
|
|
|
|
437
|
|
|
"values with commas or specify the parameter multiple times" |
|
438
|
|
|
), |
|
439
|
|
|
) |
|
440
|
|
|
parser.add_argument( |
|
|
|
|
|
|
441
|
|
|
"-s", "--links", |
|
|
|
|
|
|
442
|
|
|
action="store_true", |
|
|
|
|
|
|
443
|
|
|
dest="follow_links", |
|
|
|
|
|
|
444
|
|
|
default=False, |
|
|
|
|
|
|
445
|
|
|
help=( |
|
|
|
|
|
|
446
|
|
|
"follow links to files and directories when scanning sources for " |
|
|
|
|
|
|
447
|
|
|
"translation strings" |
|
448
|
|
|
), |
|
449
|
|
|
) |
|
450
|
|
|
parser.add_argument( |
|
|
|
|
|
|
451
|
|
|
"-i", "--ignore", |
|
|
|
|
|
|
452
|
|
|
action="append", |
|
|
|
|
|
|
453
|
|
|
dest="ignore_patterns", |
|
|
|
|
|
|
454
|
|
|
metavar="PATTERN", |
|
|
|
|
|
|
455
|
|
|
help=( |
|
|
|
|
|
|
456
|
|
|
"extra glob-style patterns for ignoring files or directories; " |
|
|
|
|
|
|
457
|
|
|
"can be specified multiple times" |
|
458
|
|
|
), |
|
459
|
|
|
) |
|
460
|
|
|
parser.add_argument( |
|
|
|
|
|
|
461
|
|
|
"--no-default-ignore", |
|
|
|
|
|
|
462
|
|
|
action="store_true", |
|
|
|
|
|
|
463
|
|
|
dest="no_default_ignore_patterns", |
|
|
|
|
|
|
464
|
|
|
default=False, |
|
|
|
|
|
|
465
|
|
|
help=( |
|
|
|
|
|
|
466
|
|
|
"do not ignore the common glob-style patterns as {{{:}}}".format( |
|
|
|
|
|
|
467
|
|
|
", ".join(map(repr, defaults.DEFAULT_IGNORE_PATTERNS)) |
|
|
|
|
|
|
468
|
|
|
) |
|
469
|
|
|
), |
|
470
|
|
|
) |
|
471
|
|
|
parser.add_argument( |
|
|
|
|
|
|
472
|
|
|
"--no-wrap", |
|
|
|
|
|
|
473
|
|
|
action="store_true", |
|
|
|
|
|
|
474
|
|
|
dest="no_wrap", |
|
|
|
|
|
|
475
|
|
|
default=False, |
|
|
|
|
|
|
476
|
|
|
help="do not break long message lines into several lines", |
|
|
|
|
|
|
477
|
|
|
) |
|
478
|
|
|
parser.add_argument( |
|
|
|
|
|
|
479
|
|
|
"--no-location", |
|
|
|
|
|
|
480
|
|
|
action="store_true", |
|
|
|
|
|
|
481
|
|
|
dest="no_location", |
|
|
|
|
|
|
482
|
|
|
default=False, |
|
|
|
|
|
|
483
|
|
|
help="do not write location lines, ex: '#: filename:lineno'", |
|
|
|
|
|
|
484
|
|
|
) |
|
485
|
|
|
parser.add_argument( |
|
|
|
|
|
|
486
|
|
|
"--no-obsolete", |
|
|
|
|
|
|
487
|
|
|
action="store_true", |
|
|
|
|
|
|
488
|
|
|
dest="no_obsolete", |
|
|
|
|
|
|
489
|
|
|
default=False, |
|
|
|
|
|
|
490
|
|
|
help="remove obsolete message strings", |
|
|
|
|
|
|
491
|
|
|
) |
|
492
|
|
|
parser.add_argument( |
|
|
|
|
|
|
493
|
|
|
"--keep-pot", |
|
|
|
|
|
|
494
|
|
|
action="store_true", |
|
|
|
|
|
|
495
|
|
|
dest="keep_pot", |
|
|
|
|
|
|
496
|
|
|
default=False, |
|
|
|
|
|
|
497
|
|
|
help="keep '.pot' file after creating '.po' files (useful for debugging)", |
|
|
|
|
|
|
498
|
|
|
) |
|
499
|
|
|
parser.add_argument( |
|
|
|
|
|
|
500
|
|
|
"--xgettext-extra-args", |
|
|
|
|
|
|
501
|
|
|
action="append", |
|
|
|
|
|
|
502
|
|
|
dest="xgettext_extra_args", |
|
|
|
|
|
|
503
|
|
|
help=( |
|
|
|
|
|
|
504
|
|
|
"extra arguments for 'xgettext' utility; " |
|
|
|
|
|
|
505
|
|
|
"can be comma-separated or specified multiple times" |
|
506
|
|
|
), |
|
507
|
|
|
) |
|
508
|
|
|
parser.add_argument( |
|
|
|
|
|
|
509
|
|
|
"--msguniq-extra-args", |
|
|
|
|
|
|
510
|
|
|
action="append", |
|
|
|
|
|
|
511
|
|
|
dest="msguniq_extra_args", |
|
|
|
|
|
|
512
|
|
|
help=( |
|
|
|
|
|
|
513
|
|
|
"extra arguments for 'msguniq' utility; " |
|
|
|
|
|
|
514
|
|
|
"can be comma-separated or specified multiple times" |
|
515
|
|
|
), |
|
516
|
|
|
) |
|
517
|
|
|
parser.add_argument( |
|
|
|
|
|
|
518
|
|
|
"--msgmerge-extra-args", |
|
|
|
|
|
|
519
|
|
|
action="append", |
|
|
|
|
|
|
520
|
|
|
dest="msgmerge_extra_args", |
|
|
|
|
|
|
521
|
|
|
help=( |
|
|
|
|
|
|
522
|
|
|
"extra arguments for 'msgmerge' utility; " |
|
|
|
|
|
|
523
|
|
|
"can be comma-separated or specified multiple times" |
|
524
|
|
|
), |
|
525
|
|
|
) |
|
526
|
|
|
parser.add_argument( |
|
|
|
|
|
|
527
|
|
|
"--msgattrib-extra-args", |
|
|
|
|
|
|
528
|
|
|
action="append", |
|
|
|
|
|
|
529
|
|
|
dest="msgattrib_extra_args", |
|
|
|
|
|
|
530
|
|
|
help=( |
|
|
|
|
|
|
531
|
|
|
"extra arguments for 'msgattrib' utility; " |
|
|
|
|
|
|
532
|
|
|
"can be comma-separated or specified multiple times" |
|
533
|
|
|
), |
|
534
|
|
|
) |
|
535
|
|
|
parser.add_argument( |
|
|
|
|
|
|
536
|
|
|
"-v", "--verbose", |
|
|
|
|
|
|
537
|
|
|
action="store_true", |
|
|
|
|
|
|
538
|
|
|
dest="verbose", |
|
|
|
|
|
|
539
|
|
|
default=False, |
|
|
|
|
|
|
540
|
|
|
help="use verbose output", |
|
|
|
|
|
|
541
|
|
|
) |
|
542
|
|
|
return parser |
|
|
|
|
|
|
543
|
|
|
|
oblalex /
verboselib
Loading history...