-
Notifications
You must be signed in to change notification settings - Fork 170
/
generate_cdp.py
1202 lines (1043 loc) · 38.5 KB
/
generate_cdp.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
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import re
import os
import json
import typing
import shutil
import builtins
import logging
import operator
import itertools
import urllib.request
import urllib.parse
import inflection # type: ignore
from enum import Enum
from pathlib import Path
from dataclasses import dataclass
from argparse import ArgumentParser, ArgumentTypeError
from textwrap import dedent, indent as tw_indent
log_level = getattr(logging, os.environ.get("LOG_LEVEL", "info").upper())
logging.basicConfig(level=log_level)
logger = logging.getLogger("cdpgen")
GENERATED_PACKAGE_NOTICE = """
## Generated by PyCDP
The modules of this package were generated by [pycdp], do not modify their contents because the
changes will be overwritten in next generations.
"""
SHARED_HEADER = """# DO NOT EDIT THIS FILE!
#
# This file is generated from the CDP specification. If you need to make
# changes, edit the generator and regenerate all of the modules."""
INIT_HEADER = """{}
""".format(
SHARED_HEADER
)
MODULE_HEADER = """{}
#
# CDP domain: {{}}{{}}
from __future__ import annotations
import enum
import typing
from dataclasses import dataclass
from .util import event_class, T_JSON_DICT
""".format(
SHARED_HEADER
)
current_version = ""
BACKTICK_RE = re.compile(r"`([^`]+)`(\w+)?")
def indent(s: str, n: int):
"""A shortcut for ``textwrap.indent`` that always uses spaces."""
return tw_indent(s, n * " ")
def escape_backticks(docstr: str) -> str:
"""
Escape backticks in a docstring by doubling them up.
This is a little tricky because RST requires a non-letter character after
the closing backticks, but some CDPs docs have things like "`AxNodeId`s".
If we double the backticks in that string, then it won't be valid RST. The
fix is to insert an apostrophe if an "s" trails the backticks.
"""
def replace_one(match):
if match.group(2) == "s":
return f"``{match.group(1)}``'s"
elif match.group(2):
# This case (some trailer other than "s") doesn't currently exist
# in the CDP definitions, but it's here just to be safe.
return f"``{match.group(1)}`` {match.group(2)}"
else:
return f"``{match.group(1)}``"
# Sometimes pipes are used where backticks should have been used.
docstr = docstr.replace("|", "`")
return BACKTICK_RE.sub(replace_one, docstr)
def inline_doc(description) -> str:
"""Generate an inline doc, e.g. ``#: This type is a ...``"""
if not description:
return ""
description = escape_backticks(description)
lines = ["#: {}".format(l) for l in description.split("\n")]
return "\n".join(lines)
def docstring(description: typing.Optional[str]) -> str:
"""Generate a docstring from a description."""
if not description:
return ""
# if original description uses escape sequences it should be generated as a raw docstring
description = escape_backticks(description)
if "\\" in description:
return dedent("r'''\n{}\n'''").format(description)
else:
return dedent("'''\n{}\n'''").format(description)
def is_builtin(name: str) -> bool:
"""Return True if ``name`` would shadow a builtin."""
try:
getattr(builtins, name)
return True
except AttributeError:
return False
def snake_case(name: str) -> str:
"""Convert a camel case name to snake case. If the name would shadow a
Python builtin, then append an underscore."""
name = inflection.underscore(name)
if is_builtin(name):
name += "_"
return name
def ref_to_python(ref: str) -> str:
"""
Convert a CDP ``$ref`` to the name of a Python type.
For a dotted ref, the part before the dot is snake cased.
"""
if "." in ref:
domain, subtype = ref.split(".")
ref = "{}.{}".format(snake_case(domain), subtype)
return f"{ref}"
def ref_to_python_domain(ref: str, domain: str) -> str:
if ref.startswith(domain + "."):
return ref_to_python(ref[len(domain) + 1 :])
return ref_to_python(ref)
class CdpPrimitiveType(Enum):
"""All of the CDP types that map directly to a Python type."""
boolean = "bool"
integer = "int"
number = "float"
object = "dict"
string = "str"
@classmethod
def get_annotation(cls, cdp_type):
"""Return a type annotation for the CDP type."""
if cdp_type == "any":
return "typing.Any"
else:
return cls[cdp_type].value
@classmethod
def get_constructor(cls, cdp_type, val):
"""Return the code to construct a value for a given CDP type."""
if cdp_type == "any":
return val
else:
cons = cls[cdp_type].value
return f"{cons}({val})"
@dataclass
class CdpItems:
"""Represents the type of a repeated item."""
type: str
ref: str
@classmethod
def from_json(cls, type) -> "CdpItems":
"""Generate code to instantiate an item from a JSON object."""
return cls(type.get("type"), type.get("$ref"))
@dataclass
class CdpProperty:
"""A property belonging to a non-primitive CDP type."""
name: str
description: typing.Optional[str]
type: typing.Optional[str]
ref: typing.Optional[str]
enum: typing.List[str]
items: typing.Optional[CdpItems]
optional: bool
experimental: bool
deprecated: bool
domain: str
@property
def py_name(self) -> str:
"""Get this property's Python name."""
return snake_case(self.name)
@property
def py_annotation(self) -> str:
"""This property's Python type annotation."""
if self.items:
if self.items.ref:
py_ref = ref_to_python_domain(self.items.ref, self.domain)
ann = "typing.List[{}]".format(py_ref)
else:
ann = "typing.List[{}]".format(
CdpPrimitiveType.get_annotation(self.items.type)
)
else:
if self.ref:
py_ref = ref_to_python_domain(self.ref, self.domain)
ann = py_ref
else:
ann = CdpPrimitiveType.get_annotation(typing.cast(str, self.type))
if self.optional:
ann = f"typing.Optional[{ann}]"
return ann
@classmethod
def from_json(cls, prop, domain: str) -> "CdpProperty":
"""Instantiate a CDP property from a JSON object."""
return cls(
prop["name"],
prop.get("description"),
prop.get("type"),
prop.get("$ref"),
prop.get("enum"),
CdpItems.from_json(prop["items"]) if "items" in prop else None,
prop.get("optional", False),
prop.get("experimental", False),
prop.get("deprecated", False),
domain,
)
def generate_decl(self) -> str:
"""Generate the code that declares this property."""
code = inline_doc(self.description)
if code:
code += "\n"
code += f"{self.py_name}: {self.py_annotation}"
if self.optional:
code += " = None"
return code
def generate_to_json(self, dict_: str, use_self: bool = True) -> str:
"""Generate the code that exports this property to the specified JSON
dict."""
self_ref = "self." if use_self else ""
assign = f"{dict_}['{self.name}'] = "
if self.items:
if self.items.ref:
assign += f"[i.to_json() for i in {self_ref}{self.py_name}]"
else:
assign += f"[i for i in {self_ref}{self.py_name}]"
else:
if self.ref:
assign += f"{self_ref}{self.py_name}.to_json()"
else:
assign += f"{self_ref}{self.py_name}"
if self.optional:
code = dedent(
f"""\
if {self_ref}{self.py_name} is not None:
{assign}"""
)
else:
code = assign
return code
def generate_from_json(self, dict_) -> str:
"""Generate the code that creates an instance from a JSON dict named
``dict_``."""
if self.items:
if self.items.ref:
py_ref = ref_to_python_domain(self.items.ref, self.domain)
expr = f"[{py_ref}.from_json(i) for i in {dict_}['{self.name}']]"
else:
cons = CdpPrimitiveType.get_constructor(self.items.type, "i")
expr = f"[{cons} for i in {dict_}['{self.name}']]"
else:
if self.ref:
py_ref = ref_to_python_domain(self.ref, self.domain)
expr = f"{py_ref}.from_json({dict_}['{self.name}'])"
else:
expr = CdpPrimitiveType.get_constructor(
self.type, f"{dict_}['{self.name}']"
)
if self.optional:
expr = f"{expr} if {dict_}.get('{self.name}', None) is not None else None"
return expr
@dataclass
class CdpType:
"""A top-level CDP type."""
id: str
description: typing.Optional[str]
type: str
items: typing.Optional[CdpItems]
enum: typing.List[str]
properties: typing.List[CdpProperty]
@classmethod
def from_json(cls, type_, domain: str) -> "CdpType":
"""Instantiate a CDP type from a JSON object."""
return cls(
type_["id"],
type_.get("description"),
type_["type"],
CdpItems.from_json(type_["items"]) if "items" in type_ else None,
type_.get("enum"),
[CdpProperty.from_json(p, domain) for p in type_.get("properties", list())],
)
def generate_code(self) -> str:
"""Generate Python code for this type."""
logger.debug("Generating type %s: %s", self.id, self.type)
if self.enum:
return self.generate_enum_code()
elif self.properties:
return self.generate_class_code()
else:
return self.generate_primitive_code()
def generate_primitive_code(self) -> str:
"""Generate code for a primitive type."""
if self.items:
if self.items.ref:
nested_type = ref_to_python(self.items.ref)
else:
nested_type = CdpPrimitiveType.get_annotation(self.items.type)
py_type = f"typing.List[{nested_type}]"
superclass = "list"
else:
# A primitive type cannot have a ref, so there is no branch here.
py_type = CdpPrimitiveType.get_annotation(self.type)
superclass = py_type
code = f"class {self.id}({superclass}):\n"
doc = docstring(self.description)
if doc:
code += indent(doc, 4) + "\n"
def_to_json = dedent(
f"""\
def to_json(self) -> {py_type}:
return self"""
)
code += indent(def_to_json, 4)
def_from_json = dedent(
f"""\
@classmethod
def from_json(cls, json: {py_type}) -> {self.id}:
return cls(json)"""
)
code += "\n\n" + indent(def_from_json, 4)
def_repr = dedent(
f"""\
def __repr__(self):
return '{self.id}({{}})'.format(super().__repr__())"""
)
code += "\n\n" + indent(def_repr, 4)
return code
def generate_enum_code(self) -> str:
"""
Generate an "enum" type.
Enums are handled by making a python class that contains only class
members. Each class member is upper snaked case, e.g.
``MyTypeClass.MY_ENUM_VALUE`` and is assigned a string value from the
CDP metadata.
"""
def_to_json = dedent(
"""\
def to_json(self) -> str:
return self.value"""
)
def_from_json = dedent(
f"""\
@classmethod
def from_json(cls, json: str) -> {self.id}:
return cls(json)"""
)
code = f"class {self.id}(enum.Enum):\n"
doc = docstring(self.description)
if doc:
code += indent(doc, 4) + "\n"
for enum_member in self.enum:
snake_name = snake_case(enum_member).upper()
enum_code = f'{snake_name} = "{enum_member}"\n'
code += indent(enum_code, 4)
code += "\n" + indent(def_to_json, 4)
code += "\n\n" + indent(def_from_json, 4)
return code
def generate_class_code(self) -> str:
"""
Generate a class type.
Top-level types that are defined as a CDP ``object`` are turned into Python
dataclasses.
"""
# children = set()
code = dedent(
f"""\
@dataclass
class {self.id}:\n"""
)
doc = docstring(self.description)
if doc:
code += indent(doc, 4) + "\n"
# Emit property declarations. These are sorted so that optional
# properties come after required properties, which is required to make
# the dataclass constructor work.
props = list(self.properties)
props.sort(key=operator.attrgetter("optional"))
code += "\n\n".join(indent(p.generate_decl(), 4) for p in props)
code += "\n\n"
# Emit to_json() method. The properties are sorted in the same order as
# above for readability.
def_to_json = dedent(
"""\
def to_json(self) -> T_JSON_DICT:
json: T_JSON_DICT = dict()
"""
)
assigns = (p.generate_to_json(dict_="json") for p in props)
def_to_json += indent("\n".join(assigns), 4)
def_to_json += "\n"
def_to_json += indent("return json", 4)
code += indent(def_to_json, 4) + "\n\n"
# Emit from_json() method. The properties are sorted in the same order
# as above for readability.
def_from_json = dedent(
f"""\
@classmethod
def from_json(cls, json: T_JSON_DICT) -> {self.id}:
return cls(
"""
)
from_jsons = list()
for p in props:
from_json = p.generate_from_json(dict_="json")
from_jsons.append(f"{p.py_name}={from_json},")
def_from_json += indent("\n".join(from_jsons), 8)
def_from_json += "\n"
def_from_json += indent(")", 4)
code += indent(def_from_json, 4)
return code
def get_refs(self):
"""Return all refs for this type."""
refs = set()
if self.enum:
# Enum types don't have refs.
pass
elif self.properties:
# Enumerate refs for a class type.
for prop in self.properties:
if prop.items and prop.items.ref:
refs.add(prop.items.ref)
elif prop.ref:
refs.add(prop.ref)
else:
# A primitive type can't have a direct ref, but it can have an items
# which contains a ref.
if self.items and self.items.ref:
refs.add(self.items.ref)
return refs
class CdpParameter(CdpProperty):
"""A parameter to a CDP command."""
def generate_code(self) -> str:
"""Generate the code for a parameter in a function call."""
if self.items:
if self.items.ref:
nested_type = ref_to_python(self.items.ref)
py_type = f"typing.List[{nested_type}]"
else:
nested_type = CdpPrimitiveType.get_annotation(self.items.type)
py_type = f"typing.List[{nested_type}]"
else:
if self.ref:
py_type = "{}".format(ref_to_python(self.ref))
else:
py_type = CdpPrimitiveType.get_annotation(typing.cast(str, self.type))
if self.optional:
py_type = f"typing.Optional[{py_type}]"
code = f"{self.py_name}: {py_type}"
if self.optional:
code += " = None"
return code
def generate_decl(self) -> str:
"""Generate the declaration for this parameter."""
if self.description:
code = inline_doc(self.description)
code += "\n"
else:
code = ""
code += f"{self.py_name}: {self.py_annotation}"
return code
def generate_doc(self) -> str:
"""Generate the docstring for this parameter."""
doc = f":param {self.py_name}:"
if self.deprecated:
doc += f" **(DEPRECATED)**"
if self.experimental:
doc += f" **(EXPERIMENTAL)**"
if self.optional:
doc += f" *(Optional)*"
if self.description:
desc = self.description.replace("`", "``").replace("\n", " ")
doc += f" {desc}"
return doc
def generate_from_json(self, dict_) -> str:
"""
Generate the code to instantiate this parameter from a JSON dict.
"""
code = super().generate_from_json(dict_)
return f"{self.py_name}={code}"
class CdpReturn(CdpProperty):
"""A return value from a CDP command."""
@property
def py_annotation(self):
"""Return the Python type annotation for this return."""
if self.items:
if self.items.ref:
py_ref = ref_to_python(self.items.ref)
ann = f"typing.List[{py_ref}]"
else:
py_type = CdpPrimitiveType.get_annotation(self.items.type)
ann = f"typing.List[{py_type}]"
else:
if self.ref:
py_ref = ref_to_python(self.ref)
ann = f"{py_ref}"
else:
ann = CdpPrimitiveType.get_annotation(self.type)
if self.optional:
ann = f"typing.Optional[{ann}]"
return ann
def generate_doc(self):
"""Generate the docstring for this return."""
if self.description:
doc = self.description.replace("\n", " ")
if self.optional:
doc = f"*(Optional)* {doc}"
else:
doc = ""
return doc
def generate_return(self, dict_):
"""Generate code for returning this value."""
return super().generate_from_json(dict_)
@dataclass
class CdpCommand:
"""A CDP command."""
name: str
description: str
experimental: bool
deprecated: bool
parameters: typing.List[CdpParameter]
returns: typing.List[CdpReturn]
domain: str
@property
def py_name(self):
"""Get a Python name for this command."""
return snake_case(self.name)
@classmethod
def from_json(cls, command, domain) -> "CdpCommand":
"""Instantiate a CDP command from a JSON object."""
parameters = command.get("parameters", list())
returns = command.get("returns", list())
return cls(
command["name"],
command.get("description"),
command.get("experimental", False),
command.get("deprecated", False),
[
typing.cast(CdpParameter, CdpParameter.from_json(p, domain))
for p in parameters
],
[typing.cast(CdpReturn, CdpReturn.from_json(r, domain)) for r in returns],
domain,
)
def generate_code(self) -> str:
"""Generate code for a CDP command."""
global current_version
# Generate the function header
if len(self.returns) == 0:
ret_type = "None"
elif len(self.returns) == 1:
ret_type = self.returns[0].py_annotation
else:
nested_types = ", ".join(r.py_annotation for r in self.returns)
ret_type = f"typing.Tuple[{nested_types}]"
ret_type = f"typing.Generator[T_JSON_DICT,T_JSON_DICT,{ret_type}]"
code = ""
if self.deprecated:
code += f'@deprecated(version="{current_version}")\n'
code += f"def {self.py_name}("
ret = f") -> {ret_type}:\n"
if self.parameters:
sorted_params = sorted(
self.parameters, key=lambda param: 1 if param.optional else 0
)
code += "\n"
code += indent(",\n".join(p.generate_code() for p in sorted_params), 8)
code += "\n"
code += indent(ret, 4)
else:
code += ret
# Generate the docstring
doc = ""
if self.description:
doc = self.description
if self.deprecated:
doc += f"\n\n.. deprecated:: {current_version}"
if self.experimental:
doc += f"\n\n**EXPERIMENTAL**"
if self.parameters and doc:
doc += "\n\n"
elif not self.parameters and self.returns:
doc += "\n"
doc += "\n".join(p.generate_doc() for p in self.parameters)
if len(self.returns) == 1:
doc += "\n"
ret_doc = self.returns[0].generate_doc()
doc += f":returns: {ret_doc}"
elif len(self.returns) > 1:
doc += "\n"
doc += ":returns: A tuple with the following items:\n\n"
ret_docs = "\n".join(
f"{i}. **{r.name}** - {r.generate_doc()}"
for i, r in enumerate(self.returns)
)
doc += indent(ret_docs, 4)
if doc:
code += indent(docstring(doc), 4)
# Generate the function body
if self.parameters:
code += "\n"
code += indent("params: T_JSON_DICT = dict()", 4)
code += "\n"
assigns = (
p.generate_to_json(dict_="params", use_self=False) for p in self.parameters
)
code += indent("\n".join(assigns), 4)
code += "\n"
code += indent("cmd_dict: T_JSON_DICT = {\n", 4)
code += indent(f"'method': '{self.domain}.{self.name}',\n", 8)
if self.parameters:
code += indent("'params': params,\n", 8)
code += indent("}\n", 4)
code += indent("json = yield cmd_dict", 4)
if len(self.returns) == 0:
pass
elif len(self.returns) == 1:
ret = self.returns[0].generate_return(dict_="json")
code += indent(f"\nreturn {ret}", 4)
else:
ret = "\nreturn (\n"
expr = ",\n".join(r.generate_return(dict_="json") for r in self.returns)
ret += indent(expr, 4)
ret += "\n)"
code += indent(ret, 4)
return code
def get_refs(self):
"""Get all refs for this command."""
refs = set()
for type_ in itertools.chain(self.parameters, self.returns):
if type_.items and type_.items.ref:
refs.add(type_.items.ref)
elif type_.ref:
refs.add(type_.ref)
return refs
@dataclass
class CdpEvent:
"""A CDP event object."""
name: str
description: typing.Optional[str]
deprecated: bool
experimental: bool
parameters: typing.List[CdpParameter]
domain: str
@property
def py_name(self):
"""Return the Python class name for this event."""
return inflection.camelize(self.name, uppercase_first_letter=True)
@classmethod
def from_json(cls, json: dict, domain: str):
"""Create a new CDP event instance from a JSON dict."""
return cls(
json["name"],
json.get("description"),
json.get("deprecated", False),
json.get("experimental", False),
[
typing.cast(CdpParameter, CdpParameter.from_json(p, domain))
for p in json.get("parameters", list())
],
domain,
)
def generate_code(self) -> str:
"""Generate code for a CDP event."""
global current_version
code = dedent(
f"""\
@event_class('{self.domain}.{self.name}')
@dataclass
class {self.py_name}:"""
)
if self.deprecated:
code = f'@deprecated(version="{current_version}")\n' + code
code += "\n"
desc = ""
if self.description or self.experimental:
if self.experimental:
desc += "**EXPERIMENTAL**\n\n"
if self.description:
desc += self.description
code += indent(docstring(desc), 4)
code += "\n"
code += indent("\n".join(p.generate_decl() for p in self.parameters), 4)
code += "\n\n"
def_from_json = dedent(
f"""\
@classmethod
def from_json(cls, json: T_JSON_DICT) -> {self.py_name}:
return cls(
"""
)
code += indent(def_from_json, 4)
from_json = ",\n".join(
p.generate_from_json(dict_="json") for p in self.parameters
)
code += indent(from_json, 12)
code += "\n"
code += indent(")", 8)
return code
def get_refs(self):
"""Get all refs for this event."""
refs = set()
for param in self.parameters:
if param.items and param.items.ref:
refs.add(param.items.ref)
elif param.ref:
refs.add(param.ref)
return refs
@dataclass
class CdpDomain:
"""A CDP domain contains metadata, types, commands, and events."""
domain: str
description: typing.Optional[str]
experimental: bool
dependencies: typing.List[str]
types: typing.List[CdpType]
commands: typing.List[CdpCommand]
events: typing.List[CdpEvent]
@property
def module(self):
"""The name of the Python module for this CDP domain."""
return snake_case(self.domain)
@classmethod
def from_json(cls, domain: dict):
"""Instantiate a CDP domain from a JSON object."""
types = domain.get("types", list())
commands = domain.get("commands", list())
events = domain.get("events", list())
domain_name = domain["domain"]
return cls(
domain_name,
domain.get("description"),
domain.get("experimental", False),
domain.get("dependencies", list()),
[CdpType.from_json(type, domain_name) for type in types],
[CdpCommand.from_json(command, domain_name) for command in commands],
[CdpEvent.from_json(event, domain_name) for event in events],
)
def generate_code(self) -> str:
"""Generate the Python module code for a given CDP domain."""
exp = " (experimental)" if self.experimental else ""
code = MODULE_HEADER.format(self.domain, exp)
import_code = self.generate_imports()
if import_code:
code += import_code
code += "\n\n"
code += "\n"
item_iter_t = typing.Union[CdpEvent, CdpCommand, CdpType]
item_iter: typing.Iterator[item_iter_t] = itertools.chain(
iter(self.types),
iter(self.commands),
iter(self.events),
)
code += "\n\n\n".join(item.generate_code() for item in item_iter)
code += "\n"
return code
def generate_imports(self):
"""
Determine which modules this module depends on and emit the code to
import those modules.
Notice that CDP defines a ``dependencies`` field for each domain, but
these dependencies are a subset of the modules that we actually need to
import to make our Python code work correctly and type safe. So we
ignore the CDP's declared dependencies and compute them ourselves.
"""
refs = set()
needs_deprecation = False
for type_ in self.types:
refs |= type_.get_refs()
for command in self.commands:
refs |= command.get_refs()
if command.deprecated:
needs_deprecation = True
for event in self.events:
refs |= event.get_refs()
if event.deprecated:
needs_deprecation = True
dependencies = set()
for ref in refs:
try:
domain, _ = ref.split(".")
except ValueError:
continue
if domain != self.domain:
dependencies.add(snake_case(domain))
code = "\n".join(f"from . import {d}" for d in sorted(dependencies))
if needs_deprecation:
code += "\nfrom deprecated.sphinx import deprecated # type: ignore"
return code
def generate_sphinx(self) -> str:
"""
Generate a Sphinx document for this domain.
"""
docs = self.domain + "\n"
docs += "=" * len(self.domain) + "\n\n"
if self.description:
docs += f"{self.description}\n\n"
if self.experimental:
docs += "*This CDP domain is experimental.*\n\n"
docs += f".. module:: nodriver.cdp.{self.module}\n\n"
docs += "* Types_\n* Commands_\n* Events_\n\n"
docs += "Types\n-----\n\n"
if self.types:
docs += dedent(
"""\
Generally, you do not need to instantiate CDP types
yourself. Instead, the API creates objects for you as return
values from commands, and then you can use those objects as
arguments to other commands.
"""
)
else:
docs += "*There are no types in this module.*\n"
for type in self.types:
docs += f"\n.. autoclass:: {type.id}\n"
docs += " :members:\n"
docs += " :undoc-members:\n"
docs += " :exclude-members: from_json, to_json\n"
docs += "\nCommands\n--------\n\n"
if self.commands:
docs += dedent(
"""\
Each command is a generator function. The return
type ``Generator[x, y, z]`` indicates that the generator
*yields* arguments of type ``x``, it must be resumed with
an argument of type ``y``, and it returns type ``z``. In
this library, types ``x`` and ``y`` are the same for all
commands, and ``z`` is the return type you should pay attention
to. For more information, see
:ref:`Getting Started: Commands <getting-started-commands>`.
"""
)
else:
docs += "*There are no types in this module.*\n"
for command in sorted(self.commands, key=operator.attrgetter("py_name")):
docs += f"\n.. autofunction:: {command.py_name}\n"
docs += "\nEvents\n------\n\n"
if self.events:
docs += dedent(
"""\
Generally, you do not need to instantiate CDP events
yourself. Instead, the API creates events for you and then
you use the event\'s attributes.
"""
)
else:
docs += "*There are no events in this module.*\n"
for event in self.events:
docs += f"\n.. autoclass:: {event.py_name}\n"
docs += " :members:\n"
docs += " :undoc-members:\n"
docs += " :exclude-members: from_json, to_json\n"
return docs
def parse(json_path, output_path):
"""
Parse JSON protocol description and return domain objects.
:param Path json_path: path to a JSON CDP schema
:param Path output_path: a directory path to create the modules in
:returns: a list of CDP domain objects
"""
global current_version
with json_path.open() as json_file:
schema = json.load(json_file)
version = schema["version"]
assert (version["major"], version["minor"]) == ("1", "3")
current_version = f'{version["major"]}.{version["minor"]}'
domains = list()
for domain in schema["domains"]:
domains.append(CdpDomain.from_json(domain))
return domains
def generate_init(init_path, domains):
"""
Generate an ``__init__.py`` that exports the specified modules.
:param Path init_path: a file path to create the init file in
:param list[tuple] modules: a list of modules each represented as tuples
of (name, list_of_exported_symbols)
"""
with init_path.open("w") as init_file:
init_file.write(INIT_HEADER)