Support Pydantic model defaults + field descriptions

pdoc/doc.py

@@ -314,12 +314,19 @@ def members(self) -> dict[str, Doc]:
                     taken_from=taken_from,
                 )
             else:
+                try:
+                    default_value = self._member_objects["__pydantic_fields__"][
+                        name
+                    ].default
+                except KeyError:
+                    default_value = obj
+
                 doc = Variable(
                     self.modulename,
                     qualname,
                     docstring="",
                     annotation=self._var_annotations.get(name, empty),
-                    default_value=obj,
+                    default_value=default_value,
                     taken_from=taken_from,
                 )
             if self._var_docstrings.get(name):

pyproject.toml

@@ -51,6 +51,7 @@ dev-dependencies = [
     "pytest-timeout>=2.3.1",
     "hypothesis>=6.113.0",
     "pdoc-pyo3-sample-library>=1.0.11",
+    "pydantic>=2.11.4",
 ]
 
 [build-system]

test/test_doc.py

@@ -134,6 +134,34 @@ class Foo(metaclass=FooMeta):
         assert x.docstring == ""
 
 
+@pytest.mark.parametrize(
+    "member, defaults",
+    [
+        (
+            "Foo",
+            {
+                "a": "1",
+                "b": "2",
+            },
+        ),
+        (
+            "PydanticStyleDataclass",
+            {
+                "a": "1",
+            },
+        ),
+    ],
+)
+def test_with_pydantic(member, defaults):
+    m = Module.from_name("test.with_pydantic")
+    assert "Foo" in m.members
+
+    cls: Class = m.members[member]
+
+    for k, v in defaults.items():
+        assert cls.members[k].default_value_str == v
+
+
 def test_raising_submodules():
     f = here / "syntax_err" / "syntax_err.py"
     f.write_bytes(b"class")

test/with_pydantic/__init__.py

@@ -0,0 +1,14 @@
+import pydantic
+from pydantic.dataclasses import dataclass
+
+
+class Foo(pydantic.BaseModel):
+    a: int = pydantic.Field(default=1, description="Docstring for a")
+
+    b: int = 2
+    """Docstring for b."""
+
+
+@dataclass
+class PydanticStyleDataclass:
+    a: int = 1