Don't generate symbols that shadow built-ins (fixes #13)

When generating Python names, we now check to see if that name exists in
the `builtins` module. If it does, then we append an underscore. Tests
are updated and I *think* they are passing but I also have some test
failures from a merged branch.

Author: mehaase

generator/generate.py

@@ -1,3 +1,4 @@
+import builtins
 from dataclasses import dataclass
 from enum import Enum
 import itertools
@@ -41,10 +42,12 @@
 
 current_version = ''
 
+
 def indent(s: str, n: int):
     ''' A shortcut for ``textwrap.indent`` that always uses spaces. '''
     return tw_indent(s, n * ' ')
 
+
 def clear_dirs(package_path: Path):
     ''' Remove generated code. '''
     def rmdir(path):
@@ -82,6 +85,24 @@ def docstring(description: typing.Optional[str]) -> str:
     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.
@@ -90,7 +111,7 @@ def ref_to_python(ref: str) -> str:
     '''
     if '.' in ref:
         domain, subtype = ref.split('.')
-        ref = '{}.{}'.format(inflection.underscore(domain), subtype)
+        ref = '{}.{}'.format(snake_case(domain), subtype)
     return f"{ref}"
 
 
@@ -148,7 +169,7 @@ class CdpProperty:
     @property
     def py_name(self) -> str:
         ''' Get this property's Python name. '''
-        return inflection.underscore(self.name)
+        return snake_case(self.name)
 
     @property
     def py_annotation(self) -> str:
@@ -333,8 +354,8 @@ def from_json(cls, json: str) -> {self.id}:
         if doc:
             code += indent(doc, 4) + '\n'
         for enum_member in self.enum:
-            snake_case = inflection.underscore(enum_member).upper()
-            enum_code = f'{snake_case} = "{enum_member}"\n'
+            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)
@@ -526,7 +547,7 @@ class CdpCommand:
     @property
     def py_name(self):
         ''' Get a Python name for this command. '''
-        return inflection.underscore(self.name)
+        return snake_case(self.name)
 
     @classmethod
     def from_json(cls, command, domain) -> 'CdpCommand':
@@ -686,7 +707,7 @@ class {self.py_name}:''')
 
             if self.description:
                 desc += self.description
-            
+
             code += indent(docstring(desc), 4)
             code += '\n'
         code += indent(
@@ -729,7 +750,7 @@ class CdpDomain:
     @property
     def module(self):
         ''' The name of the Python module for this CDP domain. '''
-        return inflection.underscore(self.domain)
+        return snake_case(self.domain)
 
     @classmethod
     def from_json(cls, domain: dict):
@@ -797,7 +818,7 @@ def generate_imports(self):
             except ValueError:
                 continue
             if domain != self.domain:
-                dependencies.add(inflection.underscore(domain))
+                dependencies.add(snake_case(domain))
         code = '\n'.join(f'from . import {d}' for d in sorted(dependencies))
 
         if needs_deprecation:

generator/test_generate.py

@@ -34,8 +34,6 @@ def test_docstring():
         - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
         '''""")
     actual = docstring(description)
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -62,8 +60,6 @@ def __repr__(self):
 
     type = CdpType.from_json(json_type)
     actual = type.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -93,8 +89,6 @@ def __repr__(self):
 
     type = CdpType.from_json(json_type)
     actual = type.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -133,8 +127,6 @@ def from_json(cls, json: str) -> AXValueSourceType:
 
     type = CdpType.from_json(json_type)
     actual = type.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -182,7 +174,7 @@ 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
@@ -195,7 +187,7 @@ class AXValue:
 
             def to_json(self) -> T_JSON_DICT:
                 json: T_JSON_DICT = dict()
-                json['type'] = self.type.to_json()
+                json['type'] = self.type_.to_json()
                 if self.value is not None:
                     json['value'] = self.value
                 if self.related_nodes is not None:
@@ -207,16 +199,14 @@ def to_json(self) -> T_JSON_DICT:
             @classmethod
             def from_json(cls, json: T_JSON_DICT) -> AXValue:
                 return cls(
-                    type=AXValueType.from_json(json['type']),
+                    type_=AXValueType.from_json(json['type']),
                     value=json['value'] if 'value' in json else None,
                     related_nodes=[AXRelatedNode.from_json(i) for i in json['relatedNodes']] if 'relatedNodes' in json else None,
                     sources=[AXValueSource.from_json(i) for i in json['sources']] if 'sources' in json else None,
                 )""")
 
     type = CdpType.from_json(json_type)
     actual = type.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -297,8 +287,6 @@ def get_partial_ax_tree(
 
     cmd = CdpCommand.from_json(json_cmd, 'Accessibility')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -319,8 +307,6 @@ def disable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
 
     cmd = CdpCommand.from_json(json_cmd, 'Accessibility')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -345,16 +331,16 @@ def test_cdp_command_return_primitive():
     }
     expected = dedent("""\
         def get_current_time(
-                id: str
+                id_: str
             ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,float]:
             '''
             Returns the current time of the an animation.
 
-            :param id: Id of animation.
+            :param id_: Id of animation.
             :returns: Current time of the page.
             '''
             params: T_JSON_DICT = dict()
-            params['id'] = id
+            params['id'] = id_
             cmd_dict: T_JSON_DICT = {
                 'method': 'Animation.getCurrentTime',
                 'params': params,
@@ -364,8 +350,6 @@ def get_current_time(
 
     cmd = CdpCommand.from_json(json_cmd, 'Animation')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -401,8 +385,6 @@ def get_browser_command_line() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typin
 
     cmd = CdpCommand.from_json(json_cmd, 'Browser')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -440,8 +422,6 @@ def release_animations(
 
     cmd = CdpCommand.from_json(json_cmd, 'Animation')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -485,8 +465,6 @@ def resolve_animation(
 
     cmd = CdpCommand.from_json(json_cmd, 'Animation')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -582,8 +560,6 @@ def get_encoded_response(
 
     cmd = CdpCommand.from_json(json_cmd, 'Audits')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -638,8 +614,6 @@ def grant_permissions(
 
     cmd = CdpCommand.from_json(json_cmd, 'Browser')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -677,8 +651,6 @@ def from_json(cls, json: T_JSON_DICT) -> RecordingStateChanged:
 
     cmd = CdpEvent.from_json(json_event, 'BackgroundService')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -740,8 +712,6 @@ def from_json(cls, json: T_JSON_DICT) -> WindowOpen:
 
     cmd = CdpEvent.from_json(json_event, 'Page')
     actual = cmd.generate_code()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
 
 
@@ -846,6 +816,30 @@ def test_cdp_domain_imports():
 
     domain = CdpDomain.from_json(json_domain)
     actual = domain.generate_imports()
-    print('EXPECTED:', expected)
-    print('ACTUAL:', actual)
     assert expected == actual
+
+
+def test_domain_shadows_builtin():
+    ''' If a domain name shadows a Python builtin, it should have an underscore
+    appended to the module name. '''
+    input_domain = {
+        "domain": "Input",
+        "types": [],
+        "commands": [],
+        "events": [],
+    }
+    domain = CdpDomain.from_json(input_domain)
+    assert domain.module == 'input_'
+
+
+def test_domain_shadows_builtin():
+    ''' If a domain name shadows a Python builtin, it should have an underscore
+    appended to the module name. '''
+    input_domain = {
+        "domain": "Input",
+        "types": [],
+        "commands": [],
+        "events": [],
+    }
+    domain = CdpDomain.from_json(input_domain)
+    assert domain.module == 'input_'