Monkeytype

.github/workflows/push.yml

@@ -0,0 +1,63 @@
+---
+name: on push
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches: [master]
+
+  pull_request:
+    branches: [master]
+
+  workflow_dispatch:
+
+jobs:
+  monkeytype:
+    runs-on: ubuntu-24.04
+    container:
+      image: fedora:41  # CURRENT DEVELOPMENT ENVIRONMENT
+    steps:
+      - name: Install dependencies for Fedora
+        run: >
+          dnf install -y
+          bandit
+          black
+          git
+          make
+          monkeytype
+          pip
+          pylint
+          python3-dbus
+          python3-dbus-signature-pyparsing
+          python3-hypothesis
+          python3-isort
+      - name: Install hs-dbus-signature
+        run: pip install --user hs-dbus-signature
+      - uses: actions/checkout@v4
+        with:
+          path: into-dbus-python
+      - name: Run with monkeytype
+        run: >
+          MONKEYTYPE=1
+          PYTHONPATH=./src:/github/home/.local/lib/python3.13/site-packages
+          make test
+        # tests may fail due to timeouts, call traces should be fine
+        continue-on-error: true
+        working-directory: into-dbus-python
+      - name: Apply annotations
+        run: PYTHONPATH=./src make apply
+        working-directory: into-dbus-python
+      - name: Format result
+        run: make fmt
+        working-directory: into-dbus-python
+      - name: Install pyright
+        run: pip install --user pyright
+      - name: Lint result
+        run: >
+          PATH=${PATH}:/github/home/.local/bin
+          PYTHONPATH=./src make -f Makefile lint
+        working-directory: into-dbus-python
+        continue-on-error: true
+      - name: Diff the result
+        run: git diff --exit-code
+        working-directory: into-dbus-python

.gitignore

@@ -15,3 +15,6 @@ dist
 # vim
 *.swo
 *.swp
+
+# monkeytype output
+monkeytype.sqlite3

Makefile

@@ -1,3 +1,11 @@
+ifeq ($(origin MONKEYTYPE), undefined)
+  PYTHON = python3
+else
+  PYTHON = MONKEYTYPE_TRACE_MODULES=into_dbus_python monkeytype run
+endif
+
+MONKEYTYPE_MODULES = into_dbus_python._signature
+
 .PHONY: lint
 lint:
 	pylint setup.py
@@ -13,7 +21,7 @@ lint:
 
 .PHONY: test
 test:
-	python3 -m unittest discover --verbose tests
+	${PYTHON} -m unittest discover --verbose tests
 
 .PHONY: coverage
 coverage:
@@ -47,3 +55,13 @@ package:
 legacy-package:
 	python3 setup.py build
 	python3 setup.py install
+
+.PHONY: apply
+apply:
+	@echo "Modules traced:"
+	@monkeytype list-modules
+	@echo
+	@echo "Annotating:"
+	@for module in ${MONKEYTYPE_MODULES}; do \
+	  monkeytype --verbose apply  --sample-count --ignore-existing-annotations $${module} > /dev/null; \
+	done

src/into_dbus_python/_errors.py

@@ -14,6 +14,11 @@
 """
 Error hierarchy for xformer generator.
 """
+# isort: STDLIB
+from typing import Any, Union
+
+# isort: THIRDPARTY
+from dbus import Array
 
 
 class IntoDPError(Exception):
@@ -47,7 +52,7 @@ class IntoDPUnexpectedValueError(IntoDPRuntimeError):
     transformation.
     """
 
-    def __init__(self, message, value):
+    def __init__(self, message: str, value: Any):
         """
         Initializer.
 
@@ -82,7 +87,7 @@ class IntoDPSignatureError(IntoDPError):
     Exception raised when a value does not seem to have a valid signature.
     """
 
-    def __init__(self, message, value):
+    def __init__(self, message: str, value: Union[str, Array]):
         """
         Initializer.
 

src/into_dbus_python/_signature.py

@@ -15,13 +15,16 @@
 Definition of signature method.
 """
 
+# isort: STDLIB
+from typing import Any
+
 # isort: THIRDPARTY
 import dbus
 
 from ._errors import IntoDPSignatureError
 
 
-def signature(dbus_object, *, unpack=False):
+def signature(dbus_object: Any, *, unpack=False) -> str:
     """
     Get the signature of a dbus object.
 

src/into_dbus_python/_xformer.py

@@ -18,7 +18,7 @@
 # isort: STDLIB
 import functools
 from collections.abc import Sequence
-from typing import Any
+from typing import Any, Callable, List, Tuple, Union
 
 # isort: THIRDPARTY
 import dbus
@@ -34,7 +34,7 @@
 )
 
 
-def _wrapper(func):
+def _wrapper(func: Callable) -> Callable:
     """
     Wraps a generated function so that it catches all unexpected errors and
     raises IntoDPSurprisingErrors.
@@ -80,7 +80,7 @@ class _ToDbusXformer(Parser):
 
     # pylint: disable=too-few-public-methods
 
-    def _handle_variant(self):
+    def _handle_variant(self) -> Tuple[Callable, str]:
         """
         Generate the correct function for a variant signature.
 
@@ -114,7 +114,7 @@ def the_func(a_tuple, *, variant=0):
         return (the_func, "v")
 
     @staticmethod
-    def _handle_array(toks):
+    def _handle_array(toks) -> Tuple[Callable, str]:
         """
         Generate the correct function for an array signature.
 
@@ -177,7 +177,7 @@ def the_array_func(a_list: Sequence[Any], *, variant=0):
         )  # pragma: no cover
 
     @staticmethod
-    def _handle_struct(toks):
+    def _handle_struct(toks) -> Tuple[Callable, str]:
         """
         Generate the correct function for a struct signature.
 
@@ -220,7 +220,7 @@ def the_func(a_list: Sequence[Any], *, variant=0):
         return (the_func, "(" + signature + ")")
 
     @staticmethod
-    def _handle_base_case(klass, symbol):
+    def _handle_base_case(klass: Any, symbol: str) -> Callable:
         """
         Handle a base case.
 
@@ -299,7 +299,7 @@ def __init__(self):
 _XFORMER = _ToDbusXformer()
 
 
-def xformers(sig):
+def xformers(sig: str) -> List[Union[Tuple[Callable, str], Any]]:
     """
     Get the list of xformer functions for the given signature.
 
@@ -312,7 +312,7 @@ def xformers(sig):
     ]
 
 
-def xformer(signature):
+def xformer(signature: str) -> Callable:
     """
     Returns a transformer function for the given signature.