-
-
Notifications
You must be signed in to change notification settings - Fork 627
/
update_docu_links.py
executable file
·685 lines (561 loc) · 18.7 KB
/
update_docu_links.py
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
#!/usr/bin/env python3
import argparse
import importlib
import inspect
import json
import re
import site
from pathlib import Path
from types import ModuleType
from typing import Any
import yaml
SECRET_FILENAME = "secrets.yaml"
SECRET_REGEX = re.compile(r"!secret\s(\w+)")
GENERICS = {
"/doc/source/ics.md",
"/doc/source/static.md",
}
BLACK_LIST = {
*GENERICS,
"/doc/source/multiple.md",
"/doc/source/example.md",
}
START_COUNTRY_SECTION = "<!--Begin of country section-->"
END_COUNTRY_SECTION = "<!--End of country section-->"
START_SERVICE_SECTION = "<!--Begin of service section-->"
END_SERVICE_SECTION = "<!--End of service section-->"
LANGUAGES = ["en", "de"]
class SourceInfo:
def __init__(
self,
filename: str,
module: str | None,
title: str,
url: str,
country: str,
params: list[str],
extra_info_default_params: dict[str, Any] = {},
custom_param_translation: dict[str, dict[str, str]] = {},
):
self._filename = filename
self._module = module
self._title = title
self._url = url
self._country = country
self._params = params
self._extra_info_default_params = extra_info_default_params
self._custom_param_translation = custom_param_translation
for k, v in custom_param_translation.items():
if k not in LANGUAGES:
print(
f"{self._filename} provided translation for non existing language {k}, You may want to use one of {LANGUAGES} or you need to add the language to LANGUAGES"
)
for parameter in v.keys():
if parameter not in self._params:
print(
f"{self._filename} provided translation for non existing parameter {parameter}"
)
def __repr__(self):
return f"filename:{self._filename}, title:{self._title}, url:{self._url}, country:{self._country}, params:{self._params}, extra_info_default_params:{self._extra_info_default_params}, custom_param_translation:{self._custom_param_translation}"
@property
def filename(self):
return self._filename
@property
def module(self):
return self._module
@property
def title(self):
return self._title
@property
def url(self):
return self._url
@property
def country(self):
return self._country
@property
def params(self):
return self._params
@property
def extra_info_default_params(self):
return self._extra_info_default_params
@property
def custom_param_translation(self):
return self._custom_param_translation
class Section:
def __init__(self, section):
self._section = section
@property
def start(self):
return f"<!--Begin of {self._section} section-->"
@property
def end(self):
return f"<!--End of {self._section} section-->"
def split_camel_and_snake_case(s):
s = re.sub("([a-z0-9])([A-Z])", r"\1 \2", s) # Split CamelCase
return s.replace("_", " ").split() # Split snake_case
def update_edpevent_se(modules: dict[str, ModuleType]):
module = modules.get("edpevent_se")
if not module:
print("edpevent_se not found")
return
services = getattr(module, "SERVICE_PROVIDERS", {})
str = ""
for provider, data in sorted(services.items()):
str += f'- `{provider}`: {data["title"]}\n'
_patch_file("doc/source/edpevent_se.md", "service", str)
def main() -> None:
sources: list[SourceInfo] = []
sources += browse_sources()
sources += browse_ics_yaml()
# sort into countries
country_code_map = make_country_code_map()
countries: dict[str, list[SourceInfo]] = {}
generics: list[SourceInfo] = []
orphans: list[SourceInfo] = []
for s in sources:
if s.filename in GENERICS:
generics.append(s)
if s.filename in BLACK_LIST:
continue # skip
# extract country code
code = s.country
if code in country_code_map:
countries.setdefault(country_code_map[code]["name"], []).append(s)
else:
orphans.append(s)
if len(orphans) > 0:
print("Orphaned sources without country =========================")
for o in orphans:
print(o)
update_json(countries, generics=generics)
update_readme_md(countries)
update_info_md(countries)
def browse_sources() -> list[SourceInfo]:
"""Browse all .py files in the `source` directory"""
package_dir = (
Path(__file__).resolve().parents[0]
/ "custom_components"
/ "waste_collection_schedule"
)
source_dir = package_dir / "waste_collection_schedule" / "source"
# add module directory to path
site.addsitedir(str(package_dir))
files = filter(
lambda x: x != "__init__",
map(lambda x: x.stem, source_dir.glob("*.py")),
)
modules: dict[str, ModuleType] = {}
sources: list[SourceInfo] = []
# retrieve all data from sources
for f in files:
# iterate through all *.py files in waste_collection_schedule/source
module = importlib.import_module(f"waste_collection_schedule.source.{f}")
modules[f] = module
title = module.TITLE
url = module.URL
country = getattr(module, "COUNTRY", f.split("_")[-1])
sig = inspect.signature(module.Source.__init__)
params = [param.name for param in sig.parameters.values()]
param_translations = getattr(module, "PARAM_TRANSLATIONS", {})
filename = f"/doc/source/{f}.md"
if title is not None:
sources.append(
SourceInfo(
filename=filename,
module=f,
title=title,
url=url,
country=country,
params=params,
custom_param_translation=param_translations,
)
)
extra_info = getattr(module, "EXTRA_INFO", [])
if callable(extra_info):
extra_info = extra_info()
for e in extra_info:
sources.append(
SourceInfo(
filename=filename,
module=f,
title=e.get("title", title),
url=e.get("url", url),
country=e.get("country", country),
params=params,
extra_info_default_params=e.get("default_params", {}),
)
)
update_awido_de(modules)
update_ctrace_de(modules)
update_citiesapps_com(modules)
update_app_abfallplus_de(modules)
update_abfallnavi_de(modules)
update_edpevent_se(modules)
return sources
def browse_ics_yaml() -> list[SourceInfo]:
"""Browse all .yaml files which are descriptions for the ICS source"""
doc_dir = Path(__file__).resolve().parents[0] / "doc"
yaml_dir = doc_dir / "ics" / "yaml"
md_dir = doc_dir / "ics"
files = yaml_dir.glob("*.yaml")
sources: list[SourceInfo] = []
for f in files:
with open(f, encoding="utf-8") as stream:
# write markdown file
filename = (md_dir / f.name).with_suffix(".md")
data = yaml.safe_load(stream)
write_ics_md_file(filename, data)
# extract country code
sources.append(
SourceInfo(
filename=f"/doc/ics/{filename.name}",
module=None,
title=data["title"],
url=data["url"],
country=data.get("country", f.stem.split("_")[-1]),
params=[],
extra_info_default_params=data.get("default_params", {}),
)
)
if "extra_info" in data:
for e in data["extra_info"]:
sources.append(
SourceInfo(
filename=f"/doc/ics/{filename.name}",
module=None,
title=e.get("title"),
url=e.get("url"),
country=e.get("country"),
params=[],
extra_info_default_params=data.get("default_params", {}),
)
)
update_ics_md(sources)
return sources
def write_ics_md_file(filename, data):
"""Write a markdown file for a ICS .yaml file"""
md = f"# {data['title']}\n"
md += "\n"
md += f"{data['title']} is supported by the generic [ICS](/doc/source/ics.md) source. For all available configuration options, please refer to the source description.\n"
md += "\n"
if "description" in data:
md += f"{data['description']}\n"
md += "\n"
md += "## How to get the configuration arguments\n"
md += "\n"
md += f"{data['howto']}"
md += "\n"
md += "## Examples\n"
md += "\n"
for title, tc in data["test_cases"].items():
md += f"### {title}\n"
md += "\n"
md += "```yaml\n"
md += "waste_collection_schedule:\n"
md += " sources:\n"
md += " - name: ics\n"
md += " args:\n"
md += multiline_indent(yaml.dump(tc).rstrip("\n"), 8) + "\n"
md += "```\n"
# md += "\n"
with open(filename, "w", encoding="utf-8") as f:
f.write(md)
def update_ics_md(sources: list[SourceInfo]):
country_code_map = make_country_code_map()
countries: dict = {}
for s in sources:
if s.filename in BLACK_LIST:
continue # skip
# extract country code
code = s.country
if code in country_code_map:
countries.setdefault(country_code_map[code]["name"], []).append(s)
str = ""
for country in sorted(countries):
str += f"### {country}\n"
str += "\n"
for e in sorted(
countries[country],
key=lambda e: (e.title.lower(), beautify_url(e.url), e.filename),
):
str += f"- [{e.title}]({e.filename}) / {beautify_url(e.url)}\n"
str += "\n"
_patch_file("doc/source/ics.md", "service", str)
def multiline_indent(s, numspaces):
"""Indent all lines within the given string by <numspace> spaces"""
lines = [(numspaces * " ") + line for line in s.split("\n")]
return "\n".join(lines)
def beautify_url(url):
if url is None:
return ""
url = url.removesuffix("/")
url = url.removeprefix("http://")
url = url.removeprefix("https://")
url = url.removeprefix("www.")
return url
def update_json(
countries: dict[str, list[SourceInfo]], generics: list[SourceInfo] = []
):
params = set()
param_translations: dict[str, dict[str, str]] = {}
countries = countries.copy()
countries["Generic"] = generics
# generate country list
output: dict[str, list[dict[str, str | dict[str, Any]]]] = {}
for country in sorted(countries):
output[country] = []
for e in sorted(
countries[country],
key=lambda e: (e.title.lower(), beautify_url(e.url), e.filename),
):
if e.module is None: # ICS source
output[country].append(
{
"title": e.title,
"module": "ics",
"default_params": e.extra_info_default_params,
}
)
continue
output[country].append(
{
"title": e.title,
"module": e.module,
"default_params": e.extra_info_default_params,
}
)
params.update(e.params)
for key, value in e.custom_param_translation.items():
if key in param_translations:
param_translations[key].update(value)
else:
param_translations[key] = value.copy()
# output["Generic"] = [{"title": "ICS", "module": "ics", "default_params": {}}, {"title": "Static", "module": "static", "default_params": {}}]
for lang in LANGUAGES:
tranlation_file = (
f"custom_components/waste_collection_schedule/translations/{lang}.json"
)
if not Path(tranlation_file).exists():
print(f"Translation file {tranlation_file} not found")
continue
with open(
tranlation_file,
encoding="utf-8",
) as f:
translations = json.load(f)
arg_translations = translations["config"]["step"]["args"]["data"]
for param in params:
if param in param_translations.get(lang, {}):
arg_translations[param] = param_translations[lang][param]
elif lang == "en" and param not in arg_translations:
arg_translations[param] = " ".join(
[s.capitalize() for s in split_camel_and_snake_case(param)]
)
translations["config"]["step"]["reconfigure"]["data"] = arg_translations
with open(
tranlation_file,
"w",
encoding="utf-8",
) as f:
json.dump(translations, f, indent=2, ensure_ascii=False)
with open(
"custom_components/waste_collection_schedule/sources.json",
"w",
encoding="utf-8",
) as f:
f.write(json.dumps(output, indent=2))
def update_readme_md(countries: dict[str, list[SourceInfo]]):
# generate country list
str = ""
for country in sorted(countries):
str += "<details>\n"
str += f"<summary>{country}</summary>\n"
str += "\n"
for e in sorted(
countries[country],
key=lambda e: (e.title.lower(), beautify_url(e.url), e.filename),
):
# print(f" {e.title} - {beautify_url(e.url)}")
str += f"- [{e.title}]({e.filename}) / {beautify_url(e.url)}\n"
str += "</details>\n"
str += "\n"
_patch_file("README.md", "country", str)
def update_info_md(countries: dict[str, list[SourceInfo]]):
# generate country list
str = ""
for country in sorted(countries):
str += f"| {country} | "
str += ", ".join(
[
e.title
for e in sorted(
countries[country],
key=lambda e: (e.title.lower(), beautify_url(e.url), e.filename),
)
]
)
str += " |\n"
_patch_file("info.md", "country", str)
def update_awido_de(modules: dict[str, ModuleType]):
module = modules.get("awido_de")
if not module:
print("awido_de not found")
return
services = getattr(module, "SERVICE_MAP", [])
str = ""
for service in sorted(services, key=lambda s: s["service_id"]):
str += f'- `{service["service_id"]}`: {service["title"]}\n'
_patch_file("doc/source/awido_de.md", "service", str)
def update_ctrace_de(modules: dict[str, ModuleType]):
module = modules.get("c_trace_de")
if not module:
print("ctrace_de not found")
return
services = getattr(module, "SERVICE_MAP", {})
str = "|Municipality|service|\n|-|-|\n"
for service in sorted(
services.keys(), key=lambda service: services[service]["title"]
):
str += f'| {services[service]["title"]} | `{service}` |\n'
_patch_file("doc/source/c_trace_de.md", "service", str)
def update_citiesapps_com(modules: dict[str, ModuleType]):
module = modules.get("citiesapps_com")
if not module:
print("citiesapps_com not found")
return
services = getattr(module, "SERVICE_MAP", [])
str = "|City|Website|\n|-|-|\n"
for service in sorted(services, key=lambda service: service["title"]):
str += f'| {service["title"]} | [{beautify_url(service["url"])}]({service["url"]}) |\n'
_patch_file("doc/source/citiesapps_com.md", "service", str)
def update_app_abfallplus_de(modules: dict[str, ModuleType]):
module = modules.get("app_abfallplus_de")
if not module:
print("app_abfallplus_de not found")
return
services = getattr(module, "SUPPORTED_SERVICES", {})
str = "|app_id|supported regions|\n|-|-|\n"
for app_id, region in services.items():
regions = ", ".join(region)
str += f"| {app_id} | {regions} |\n"
_patch_file("doc/source/app_abfallplus_de.md", "service", str)
def update_abfallnavi_de(modules: dict[str, ModuleType]):
module = modules.get("abfallnavi_de")
if not module:
print("app_abfallplus_de not found")
return
services = getattr(module, "SERVICE_DOMAINS", {})
str = "|Region|service|\n|-|-|\n"
for region in services:
str += f"| {region['title']} | {region['service_id']} |\n"
_patch_file("doc/source/abfallnavi_de.md", "service", str)
def _patch_file(filename, section_id, str):
# read entire file
with open(filename, encoding="utf-8") as f:
md = f.read()
section = Section(section_id)
# find beginning and end of country section
start_pos = md.index(section.start) + len(section.start) + 1
end_pos = md.index(section.end)
md = md[:start_pos] + str + md[end_pos:]
# write entire file
with open(filename, "w", encoding="utf-8") as f:
f.write(md)
def make_country_code_map():
return {x["code"]: x for x in COUNTRYCODES}
COUNTRYCODES = [
{
"code": "au",
"name": "Australia",
},
{
"code": "at",
"name": "Austria",
},
{
"code": "be",
"name": "Belgium",
},
{
"code": "ca",
"name": "Canada",
},
{
"code": "cz",
"name": "Czech Republic",
},
{
"code": "de",
"name": "Germany",
},
{
"code": "dk",
"name": "Denmark",
},
{
"code": "hamburg",
"name": "Germany",
},
{
"code": "hu",
"name": "Hungary",
},
{
"code": "it",
"name": "Italy",
},
{
"code": "lt",
"name": "Lithuania",
},
{
"code": "lu",
"name": "Luxembourg",
},
{
"code": "nl",
"name": "Netherlands",
},
{
"code": "nz",
"name": "New Zealand",
},
{
"code": "no",
"name": "Norway",
},
{
"code": "pl",
"name": "Poland",
},
{
"code": "se",
"name": "Sweden",
},
{
"code": "si",
"name": "Slovenia",
},
{
"code": "ch",
"name": "Switzerland",
},
{
"code": "us",
"name": "United States of America",
},
{
"code": "uk",
"name": "United Kingdom",
},
{
"code": "fr",
"name": "France",
},
{
"code": "fi",
"name": "Finland",
},
]
if __name__ == "__main__":
main()