Adds required keys report for python

Author: spacether

analyze_required_keys.py

@@ -0,0 +1,54 @@
+from extracted_key_data_v3specs import required_key_to_qty as required_key_to_qty_module
+from language_info import python, mapping_key_language_info
+
+from analyzer import report
+
+
+def write_python_report(language_info: mapping_key_language_info.MappingKeyLanguagInfo):
+    general_info = report.TableInfo(
+        title='Key Information',
+        table_headers=('Metric', 'Qty'),
+        table_data=tuple({
+            'qty_keys': language_info.unique_keys,
+            'case_insensitieve_collisions_qty': len(language_info.case_insensitieve_collisions),
+            'invalid_identifiers_qty': len(language_info.invalid_identifiers),
+        }.items())
+    )
+    case_insensitieve_collisions_info = report.TableInfo(
+        title='Reserved Word Identifiers Info',
+        table_headers=('Original Key', 'Reserved Word'),
+        table_data=tuple(language_info.case_insensitieve_collisions.items())
+    )
+    invalid_identifiers_info = report.TableInfo(
+        title='Invalid Identifiers Info',
+        table_headers=('Original Key', 'Fixed Identifier'),
+        table_data=tuple(language_info.invalid_identifiers.items())
+    )
+
+    this_report = report.ReportInfo(
+        title='Required Keyword Naming Info',
+        description='Checks if mapping required keys are reserved words or would ave invalid getter names',
+        table_infos={
+            'general_info': general_info,
+            'case_insensitieve_collisions_info': case_insensitieve_collisions_info,
+            'invalid_identifiers_info': invalid_identifiers_info,
+        }
+    )
+    with open('reports/required_keys_python_report.md', 'wt') as stream:
+        this_report.write(stream)
+
+if __name__ == '__main__':
+    required_key_to_qty = required_key_to_qty_module.data
+    qty_key_usages = 0
+
+    language_info = mapping_key_language_info.MappingKeyLanguagInfo(
+        unique_keys=len(required_key_to_qty)
+    )
+    for key, usage_qty in required_key_to_qty.items():
+        qty_key_usages += usage_qty
+
+        getter_method = python.get_getter_method(key, language_info)        
+        python.check_identifier(getter_method)
+
+    print(language_info)
+    write_python_report(language_info)

extracted_key_data_v3specs/__init__.py

@@ -0,0 +1,8 @@
+import dataclasses
+import typing
+
+@dataclasses.dataclass
+class MappingKeyLanguagInfo:
+    unique_keys: int
+    case_insensitieve_collisions: typing.Dict[str, str] = dataclasses.field(default_factory=lambda: {})
+    invalid_identifiers: typing.Dict[str, str] = dataclasses.field(default_factory=lambda: {})

extracted_key_data_v3specs/required_key_to_qty.json

@@ -0,0 +1,71 @@
+from . import mapping_key_language_info
+
+reserved_words = {
+    "property",  # decorator
+    "and", "del", "from", "not", "while", "as", "elif", "global", "or", "with", # python reserved words
+    "assert", "else", "if", "pass", "yield", "break", "except", "import",
+    "print", "class", "exec", "in", "raise", "continue", "finally", "is",
+    "return", "def", "for", "lambda", "try", "self", "nonlocal", "None", "True",
+    "False", "async", "await",
+    "float", "int", "str", "bool", "dict", "immutabledict", "list", "tuple"  # types
+}
+
+def get_getter_method(key: str, language_info: mapping_key_language_info.MappingKeyLanguagInfo):
+    if key.lower() in reserved_words:
+        print(key)
+        language_info.case_insensitieve_collisions[key] = key.lower()
+
+    updated_key = "get_" + key.lower()
+    if updated_key.isidentifier():
+        return updated_key
+
+
+    final_key = ''
+    for char in updated_key:
+        if char.isidentifier():
+            final_key += char
+            continue
+        # not valid identifier
+        if char.isdigit():
+            final_key += char
+            continue
+        final_key += '_'
+    language_info.invalid_identifiers[key] = final_key
+    print(f"{key} -> {final_key}")
+    return final_key
+
+
+def check_identifier(identifier: str):
+    if not identifier.isidentifier():
+        raise ValueError('{!r} is not a valid parameter name'.format(identifier))
+
+
+"""
+Note: the get_ prefx + lower case fixes these colisions
+
+Reserved words that are used:
+('self', 609)
+('list', 34)
+('from', 629)
+('Self', 4)
+('class', 8)
+('continue', 3)
+('yield', 2)
+('break', 2)
+('int', 1)
+('From', 11)
+('in', 2)
+('return', 1)
+('global', 2)
+('Property', 2)
+('property', 4)
+('Lambda', 1)
+('List', 2)
+--------
+Python Reserved Work Collision?
+17 out of 21,431 required keys
+- can be fixed with get_ prefix
+
+Invalid method name in python?
+293 out of 21,431 -> 1.3%
+"""