Suppress griffe logging related to return type (#606)

Author: dmontagu

pydantic_ai_slim/pydantic_ai/_griffe.py

@@ -1,6 +1,8 @@
 from __future__ import annotations as _annotations
 
+import logging
 import re
+from contextlib import contextmanager
 from inspect import Signature
 from typing import Any, Callable, Literal, cast
 
@@ -25,7 +27,8 @@ def doc_descriptions(
     parent = cast(GriffeObject, sig)
 
     docstring = Docstring(doc, lineno=1, parser=style or _infer_docstring_style(doc), parent=parent)
-    sections = docstring.parse()
+    with _disable_griffe_logging():
+        sections = docstring.parse()
 
     params = {}
     if parameters := next((p for p in sections if p.kind == DocstringSectionKind.parameters), None):
@@ -125,3 +128,12 @@ def _infer_docstring_style(doc: str) -> DocstringStyle:
         'numpy',
     ),
 ]
+
+
+@contextmanager
+def _disable_griffe_logging():
+    # Hacky, but suggested here: https://github.com/mkdocstrings/griffe/issues/293#issuecomment-2167668117
+    old_level = logging.root.getEffectiveLevel()
+    logging.root.setLevel(logging.ERROR)
+    yield
+    logging.root.setLevel(old_level)

tests/test_tools.py

@@ -4,6 +4,7 @@
 
 import pydantic_core
 import pytest
+from _pytest.logging import LogCaptureFixture
 from inline_snapshot import snapshot
 from pydantic import BaseModel, Field
 from pydantic_core import PydanticSerializationError
@@ -532,3 +533,36 @@ def ctx_tool(ctx: RunContext[int], x: int) -> int:
     """)
     result = mod.agent.run_sync('foobar', deps=5)
     assert result.data == snapshot('{"ctx_tool":5}')
+
+
+async def tool_without_return_annotation_in_docstring() -> str:  # pragma: no cover
+    """A tool that documents what it returns but doesn't have a return annotation in the docstring.
+
+    Returns:
+        A value.
+    """
+
+    return ''
+
+
+def test_suppress_griffe_logging(set_event_loop: None, caplog: LogCaptureFixture):
+    # This would cause griffe to emit a warning log if we didn't suppress the griffe logging.
+
+    agent = Agent(FunctionModel(get_json_schema))
+    agent.tool_plain(tool_without_return_annotation_in_docstring)
+
+    result = agent.run_sync('')
+    json_schema = json.loads(result.data)
+    assert json_schema == snapshot(
+        {
+            'description': "A tool that documents what it returns but doesn't have a "
+            'return annotation in the docstring.',
+            'name': 'tool_without_return_annotation_in_docstring',
+            'outer_typed_dict_key': None,
+            'parameters_json_schema': {'additionalProperties': False, 'properties': {}, 'type': 'object'},
+        }
+    )
+
+    # Without suppressing griffe logging, we get:
+    # assert caplog.messages == snapshot(['<module>:4: No type or annotation for returned value 1'])
+    assert caplog.messages == snapshot([])