feat: support Pydantic descriptions

Author: atzander_a

pdoc/_pydantic.py

@@ -47,6 +47,13 @@ def default_value(parent: ClassOrModule, name: str, obj: Any) -> Any:
     return obj
 
 
+def get_computed_field_docstring(parent: ClassOrModule, field_name: str) -> str | None:
+    if is_pydantic_model(parent):
+        if field := parent.__pydantic_computed_fields__.get(field_name, None):
+            return field.description
+    return None
+
+
 def get_field_docstring(parent: ClassOrModule, field_name: str) -> str | None:
     if is_pydantic_model(parent):
         if field := parent.__pydantic_fields__.get(field_name, None):

pdoc/doc.py

@@ -327,8 +327,19 @@ def members(self) -> dict[str, Doc]:
                     taken_from=taken_from,
                 )
 
-            if _doc := _pydantic.get_field_docstring(cast(type, self.obj), name):
+            ## Try get docstring from Pydantic field.
+            if _doc := _pydantic.get_field_docstring(
+                cast(type, self.obj),
+                name,
+            ):
+                doc.docstring = _doc
+            ## Try get docstring from Pydantic computed field.
+            elif _doc := _pydantic.get_computed_field_docstring(
+                cast(type, self.obj),
+                name,
+            ):
                 doc.docstring = _doc
+
             elif self._var_docstrings.get(name):
                 doc.docstring = self._var_docstrings[name]
             elif self._func_docstrings.get(name) and not doc.docstring:

test/test__pydantic.py

@@ -16,10 +16,18 @@ class ExampleModel(pydantic.BaseModel):
     id: int
     name: str = pydantic.Field(description="desc", default="Jane Doe")
 
+    @pydantic.computed_field(description="computed")
+    @property
+    def computed(self) -> str:
+        return "computed_value"
+
 
 def test_with_pydantic(monkeypatch):
     assert _pydantic.is_pydantic_model(ExampleModel)
     assert _pydantic.get_field_docstring(ExampleModel, "name") == "desc"
+    assert (
+        _pydantic.get_computed_field_docstring(ExampleModel, "computed") == "computed"
+    )
     assert _pydantic.default_value(ExampleModel, "name", None) == "Jane Doe"
 
     assert not _pydantic.is_pydantic_model(pdoc.doc.Module)