Update annotations (fixes #11)

Annotations are no longer quoted. Instead we use from __future__ import
annotations. Tests are updated to match and all tests pass.

Author: mehaase

generator/generate.py

@@ -31,6 +31,7 @@
 CDP {{}} Domain{{}}
 \'\'\'
 
+from __future__ import annotations
 from cdp.util import event_class, T_JSON_DICT
 from dataclasses import dataclass
 import enum
@@ -153,14 +154,14 @@ def py_annotation(self) -> str:
         if self.items:
             if self.items.ref:
                 py_ref = ref_to_python(self.items.ref)
-                ann = "typing.List['{}']".format(py_ref)
+                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(self.ref)
-                ann = f"'{py_ref}'"
+                ann = py_ref
             else:
                 ann = CdpPrimitiveType.get_annotation(
                     typing.cast(str, self.type))
@@ -216,7 +217,7 @@ def generate_to_json(self, dict_: str, use_self: bool=True) -> str:
 
     def generate_from_json(self, dict_) -> str:
         ''' Generate the code that creates an instance from a JSON dict named
-        ``json``. '''
+        ``dict_``. '''
         if self.items:
             if self.items.ref:
                 py_ref = ref_to_python(self.items.ref)
@@ -273,10 +274,9 @@ def generate_primitive_code(self) -> str:
         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}]'
+            py_type = f'typing.List[{nested_type}]'
             superclass = 'list'
         else:
             # A primitive type cannot have a ref, so there is no branch here.
@@ -295,7 +295,7 @@ def to_json(self) -> {py_type}:
 
         def_from_json = dedent(f'''\
             @classmethod
-            def from_json(cls, json: {py_type}) -> '{self.id}':
+            def from_json(cls, json: {py_type}) -> {self.id}:
                 return cls(json)''')
         code += '\n\n' + indent(def_from_json, 4)
 
@@ -321,7 +321,7 @@ def to_json(self) -> str:
 
         def_from_json = dedent(f'''\
             @classmethod
-            def from_json(cls, json: str) -> '{self.id}':
+            def from_json(cls, json: str) -> {self.id}:
                 return cls(json)''')
 
         code = f'class {self.id}(enum.Enum):\n'
@@ -376,7 +376,7 @@ def to_json(self) -> T_JSON_DICT:
         # as above for readability.
         def_from_json = dedent(f'''\
             @classmethod
-            def from_json(cls, json: T_JSON_DICT) -> '{self.id}':
+            def from_json(cls, json: T_JSON_DICT) -> {self.id}:
                 return cls(
         ''')
         from_jsons = list()
@@ -418,13 +418,13 @@ def generate_code(self) -> str:
         if self.items:
             if self.items.ref:
                 nested_type = ref_to_python(self.items.ref)
-                py_type = f"typing.List['{nested_type}']"
+                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))
+                py_type = "{}".format(ref_to_python(self.ref))
             else:
                 py_type = CdpPrimitiveType.get_annotation(
                     typing.cast(str, self.type))
@@ -469,14 +469,14 @@ def py_annotation(self):
         if self.items:
             if self.items.ref:
                 py_ref = ref_to_python(self.items.ref)
-                ann = f"typing.List['{py_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}'"
+                ann = f"{py_ref}"
             else:
                 ann = CdpPrimitiveType.get_annotation(self.type)
         if self.optional:
@@ -660,7 +660,7 @@ class {self.py_name}:''')
 
         if self.deprecated:
             code = f'@deprecated(version="{current_version}")\n' + code
-        
+
         code += '\n'
         if self.description:
             code += indent(docstring(self.description), 4)
@@ -670,7 +670,7 @@ class {self.py_name}:''')
         code += '\n\n'
         def_from_json = dedent(f'''\
             @classmethod
-            def from_json(cls, json: T_JSON_DICT) -> '{self.py_name}':
+            def from_json(cls, json: T_JSON_DICT) -> {self.py_name}:
                 return cls(
         ''')
         code += indent(def_from_json, 4)

generator/test_generate.py

@@ -54,7 +54,7 @@ def to_json(self) -> str:
                 return self
 
             @classmethod
-            def from_json(cls, json: str) -> 'AXNodeId':
+            def from_json(cls, json: str) -> AXNodeId:
                 return cls(json)
 
             def __repr__(self):
@@ -81,11 +81,11 @@ class ArrayOfStrings(list):
             '''
             Index of the string in the strings table.
             '''
-            def to_json(self) -> typing.List['StringIndex']:
+            def to_json(self) -> typing.List[StringIndex]:
                 return self
 
             @classmethod
-            def from_json(cls, json: typing.List['StringIndex']) -> 'ArrayOfStrings':
+            def from_json(cls, json: typing.List[StringIndex]) -> ArrayOfStrings:
                 return cls(json)
 
             def __repr__(self):
@@ -128,7 +128,7 @@ def to_json(self) -> str:
                 return self.value
 
             @classmethod
-            def from_json(cls, json: str) -> 'AXValueSourceType':
+            def from_json(cls, json: str) -> AXValueSourceType:
                 return cls(json)""")
 
     type = CdpType.from_json(json_type)
@@ -182,16 +182,16 @@ class AXValue:
             A single computed AX property.
             '''
             #: The type of this value.
-            type: 'AXValueType'
+            type: AXValueType
 
             #: The computed value of this property.
             value: typing.Optional[typing.Any] = None
 
             #: One or more related nodes, if applicable.
-            related_nodes: typing.Optional[typing.List['AXRelatedNode']] = None
+            related_nodes: typing.Optional[typing.List[AXRelatedNode]] = None
 
             #: The sources which contributed to the computation of this property.
-            sources: typing.Optional[typing.List['AXValueSource']] = None
+            sources: typing.Optional[typing.List[AXValueSource]] = None
 
             def to_json(self) -> T_JSON_DICT:
                 json: T_JSON_DICT = dict()
@@ -205,7 +205,7 @@ def to_json(self) -> T_JSON_DICT:
                 return json
 
             @classmethod
-            def from_json(cls, json: T_JSON_DICT) -> 'AXValue':
+            def from_json(cls, json: T_JSON_DICT) -> AXValue:
                 return cls(
                     type=AXValueType.from_json(json['type']),
                     value=json['value'] if 'value' in json else None,
@@ -264,11 +264,11 @@ def test_cdp_command():
     }
     expected = dedent("""\
         def get_partial_ax_tree(
-                node_id: typing.Optional['dom.NodeId'] = None,
-                backend_node_id: typing.Optional['dom.BackendNodeId'] = None,
-                object_id: typing.Optional['runtime.RemoteObjectId'] = None,
+                node_id: typing.Optional[dom.NodeId] = None,
+                backend_node_id: typing.Optional[dom.BackendNodeId] = None,
+                object_id: typing.Optional[runtime.RemoteObjectId] = None,
                 fetch_relatives: typing.Optional[bool] = None
-            ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List['AXNode']]:
+            ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[AXNode]]:
             '''
             Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
 
@@ -467,7 +467,7 @@ def test_cdp_command_ref_parameter():
     expected = dedent("""\
         def resolve_animation(
                 animation_id: str
-            ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,'runtime.RemoteObject']:
+            ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,runtime.RemoteObject]:
             '''
             Gets the remote object of the Animation.
 
@@ -544,7 +544,7 @@ def test_cdp_command_multiple_return():
     }
     expected = dedent("""\
         def get_encoded_response(
-                request_id: 'network.RequestId',
+                request_id: network.RequestId,
                 encoding: str,
                 quality: typing.Optional[float] = None,
                 size_only: typing.Optional[bool] = None
@@ -615,8 +615,8 @@ def test_cdp_command_array_of_ref_parameter():
     expected = dedent("""\
         def grant_permissions(
                 origin: str,
-                permissions: typing.List['PermissionType'],
-                browser_context_id: typing.Optional['target.BrowserContextID'] = None
+                permissions: typing.List[PermissionType],
+                browser_context_id: typing.Optional[target.BrowserContextID] = None
             ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
             '''
             Grant specific permissions to the given origin and reject all others.
@@ -666,10 +666,10 @@ class RecordingStateChanged:
             Called when the recording state for the service has been updated.
             '''
             is_recording: bool
-            service: 'ServiceName'
+            service: ServiceName
 
             @classmethod
-            def from_json(cls, json: T_JSON_DICT) -> 'RecordingStateChanged':
+            def from_json(cls, json: T_JSON_DICT) -> RecordingStateChanged:
                 return cls(
                     is_recording=bool(json['isRecording']),
                     service=ServiceName.from_json(json['service'])
@@ -730,7 +730,7 @@ class WindowOpen:
             user_gesture: bool
 
             @classmethod
-            def from_json(cls, json: T_JSON_DICT) -> 'WindowOpen':
+            def from_json(cls, json: T_JSON_DICT) -> WindowOpen:
                 return cls(
                     url=str(json['url']),
                     window_name=str(json['windowName']),

mypy.ini

@@ -0,0 +1,2 @@
+[mypy]
+disallow_any_decorated=False