Merge pull request #97 from Zuehlke/docs/mypy

Add mypy issues to docs
Zuehlke · Jun 11, 2024 · 4e01ab7 · 4e01ab7
2 parents 6223e8b + b7bc105
commit 4e01ab7
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/source/usage/mypy.rst b/docs/source/usage/mypy.rst
@@ -0,0 +1,15 @@
+ConfZ and MyPy
+==============
+
+ConfZ heavily relies on Metaclasses for its lazy loading and singleton design. Unfortunately, MyPy has limited support
+for them so far (see `docs <https://mypy.readthedocs.io/en/stable/metaclasses.html>`_). Thus, it is likely that you
+will get an error similar to this::
+
+    Metaclass conflict: the metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its bases
+
+So far, the only solution is to ignore these errors::
+
+    class MyConfig(BaseConfig):  # type: ignore
+        my_variable: bool
+
+Future versions of MyPy might be able to correctly check ConfZ classes.
diff --git a/docs/source/usage/usage.rst b/docs/source/usage/usage.rst
@@ -12,3 +12,4 @@ This part of the documentation contains user guides explaining all aspects of Co
    context_manager
    listeners
    extensions
+   mypy