feature: Detect and show ClassVar in generated docs

ClassVar is shown as `pydantic-field` right now, this commit fixes it,
and shows `pydantic-classvar` instead of it.

Issue #18: feature: greater distinction for model `ClassVar`

Author: mmzeynalli

pyproject.toml

@@ -42,8 +42,8 @@ Discussions = "https://github.com/mkdocstrings/griffe-pydantic/discussions"
 Gitter = "https://gitter.im/mkdocstrings/griffe-pydantic"
 Funding = "https://github.com/sponsors/pawamoy"
 
-[project.entry-points."mkdocstrings.python.templates"] 
-griffe-pydantic = "griffe_pydantic:get_templates_path" 
+[project.entry-points."mkdocstrings.python.templates"]
+griffe-pydantic = "griffe_pydantic:get_templates_path"
 
 [tool.pdm]
 version = {source = "scm"}

src/griffe_pydantic/__init__.py

@@ -15,4 +15,4 @@ def get_templates_path() -> Path:
     return Path(__file__).parent / "templates"
 
 
-__all__: list[str] = ["get_templates_path", "PydanticExtension"]
+__all__: list[str] = ["PydanticExtension", "get_templates_path"]

src/griffe_pydantic/static.py

@@ -93,7 +93,10 @@ def process_attribute(attr: Attribute, cls: Class, *, processed: set[str]) -> No
         cls.extra[common.self_namespace]["config"] = kwargs
         return
 
-    attr.labels = {"pydantic-field"}
+    # If attr.labels is ONLY "class-attribute", then it is ClassVar
+    # otherwise attr.label == {"class-attribute", "instance-attribute"}
+    attr.labels = {"pydantic-field"} if {"class-attribute"} != attr.labels else {"pydantic-classvar"}
+
     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

tests/test_extension.py

@@ -5,12 +5,12 @@
 import logging
 from typing import TYPE_CHECKING
 
-import pytest
 from griffe import Extensions, temporary_visited_package
 
 from griffe_pydantic.extension import PydanticExtension
 
 if TYPE_CHECKING:
+    import pytest
     from mkdocstrings_handlers.python.handler import PythonHandler