Setup mypy

Author: pfouque

.mypy.ini

@@ -0,0 +1,38 @@
+[mypy]
+# Start off with these
+; warn_unused_configs = True
+; warn_redundant_casts = True
+; warn_unused_ignores = True
+
+# Getting these passing should be easy
+; strict_equality = True
+; extra_checks = True
+
+# Strongly recommend enabling this one as soon as you can
+; check_untyped_defs = True
+
+# These shouldn't be too much additional work, but may be tricky to
+# get passing if you use a lot of untyped libraries
+; disallow_subclassing_any = True
+; disallow_untyped_decorators = True
+; disallow_any_generics = True
+
+# These next few are various gradations of forcing use of type annotations
+; disallow_untyped_calls = True
+; disallow_incomplete_defs = True
+; disallow_untyped_defs = True
+
+# This one isn't too hard to get passing, but return on investment is lower
+; no_implicit_reexport = True
+
+# This one can be tricky to get passing if you use a lot of untyped libraries
+; warn_return_any = True
+
+[mypy-tests.*]
+ignore_errors = True
+
+[mypy-django_fsm.tests.*]
+ignore_errors = True
+
+[mypy-django_fsm.management.commands.graph_transitions]
+ignore_errors = True

.pre-commit-config.yaml

@@ -48,3 +48,10 @@ repos:
     hooks:
       - id: ruff-format
       - id: ruff
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.7.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - django-stubs==4.2.6

django_fsm/__init__.py

@@ -347,10 +347,10 @@ def get_all_transitions(self, instance_cls):
             for transition in meta.transitions.values():
                 yield transition
 
-    def contribute_to_class(self, cls, name, **kwargs):
+    def contribute_to_class(self, cls, name, private_only=False, **kwargs):
         self.base_cls = cls
 
-        super().contribute_to_class(cls, name, **kwargs)
+        super().contribute_to_class(cls, name, private_only=private_only, **kwargs)
         setattr(cls, self.name, self.descriptor_class(self))
         setattr(cls, f"get_all_{self.name}_transitions", partialmethod(get_all_FIELD_transitions, field=self))
         setattr(cls, f"get_available_{self.name}_transitions", partialmethod(get_available_FIELD_transitions, field=self))