fix: Don't label ClassVar-annotated attributes as Pydantic fields

Issue-18: #18 PR-25: #25 Co-authored-by: Timothée Mazzucotelli <[email protected]>
mkdocstrings · Feb 17, 2025 · 0dbf958 · 0dbf958
1 parent 93cdc21
commit 0dbf958
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/griffe_pydantic/static.py b/src/griffe_pydantic/static.py
@@ -72,6 +72,11 @@ def process_attribute(attr: Attribute, cls: Class, *, processed: set[str]) -> No
         return
     processed.add(attr.canonical_path)
 
+    # Presence of `class-attribute` label and absence of `instance-attribute` label
+    # indicates that the attribute is annotated with `ClassVar` and should be ignored.
+    if "class-attribute" in attr.labels and "instance-attribute" not in attr.labels:
+        return
+
     kwargs = {}
     if isinstance(attr.value, ExprCall):
         kwargs = {
@@ -93,7 +98,9 @@ def process_attribute(attr: Attribute, cls: Class, *, processed: set[str]) -> No
         cls.extra[common.self_namespace]["config"] = kwargs
         return
 
-    attr.labels = {"pydantic-field"}
+    attr.labels.add("pydantic-field")
+    attr.labels.remove("instance-attribute")
+
     attr.value = kwargs.get("default", None)
     constraints = {kwarg: value for kwarg, value in kwargs.items() if kwarg not in {"default", "description"}}
     attr.extra[common.self_namespace]["constraints"] = constraints