Merge pull request #121 from mulkieran/monkeytype

Add a monkeytype configuration file and a type rewriter

Author: mulkieran

.github/workflows/main.yml

@@ -22,6 +22,7 @@ jobs:
             task: make -f Makefile yamllint
           - dependencies: >
               bandit
+              monkeytype
               pylint
               python3-dbus
               python3-dbus-signature-pyparsing

Makefile

@@ -9,9 +9,11 @@ MONKEYTYPE_MODULES = into_dbus_python._signature
 .PHONY: lint
 lint:
 	pylint setup.py
+	pylint monkeytype_config.py
 	pylint src/into_dbus_python
 	pylint tests
 	bandit setup.py
+	bandit monkeytype_config.py
 	# Ignore B101 errors. We do not distribute optimized code, i.e., .pyo
 	# files in Fedora, so we do not need to have concerns that assertions
 	# are removed by optimization.
@@ -31,7 +33,7 @@ coverage:
 
 .PHONY: fmt
 fmt:
-	isort setup.py src tests
+	isort setup.py src tests monkeytype_config.py
 	black .
 
 .PHONY: fmt-travis

monkeytype_config.py

@@ -0,0 +1,79 @@
+"""
+Monkeytype Configuration File
+"""
+
+# isort: STDLIB
+from typing import Any, Union
+
+# isort: THIRDPARTY
+from monkeytype.config import DefaultConfig
+from monkeytype.typing import (
+    ChainedRewriter,
+    RemoveEmptyContainers,
+    RewriteConfigDict,
+    RewriteGenerator,
+    RewriteLargeUnion,
+    TypeRewriter,
+)
+
+
+class CanonicalizeUnionElementOrder(TypeRewriter):
+    """
+    Monkeytype type rewriter to sort union elements in canonical order.
+    """
+
+    @staticmethod
+    def type_order(typ) -> str:
+        """
+        Return a value to be used as a key for sorting.
+        """
+
+        print(f"BIG: {typ}", flush=True)
+        if typ is Any:
+            return "Any"
+
+        try:
+            under_name = typ._name  # pylint: disable=protected-access
+        except AttributeError:
+            under_name = None
+
+        try:
+            dunder_name = typ.__name__
+        except AttributeError:
+            dunder_name = None
+
+        return (
+            under_name
+            if under_name is not None
+            else (dunder_name if dunder_name is not None else "")
+        )
+
+    def rewrite_Union(self, union):
+        return Union[
+            tuple(
+                sorted(
+                    list(union.__args__),
+                    key=CanonicalizeUnionElementOrder.type_order,
+                )
+            )
+        ]
+
+
+class MyConfig(DefaultConfig):
+    """
+    Monkeytype configuration for this project
+    """
+
+    def type_rewriter(self):
+        return ChainedRewriter(
+            (
+                RemoveEmptyContainers(),
+                RewriteConfigDict(),
+                RewriteLargeUnion(),
+                RewriteGenerator(),
+                CanonicalizeUnionElementOrder(),
+            )
+        )
+
+
+CONFIG = MyConfig()

src/into_dbus_python/_xformer.py

@@ -299,7 +299,7 @@ def __init__(self):
 _XFORMER = _ToDbusXformer()
 
 
-def xformers(sig: str) -> List[Union[Tuple[Callable, str], Any]]:
+def xformers(sig: str) -> List[Union[Any, Tuple[Callable, str]]]:
     """
     Get the list of xformer functions for the given signature.