Skip to content

Allow RunContext to not be documented when require_parameter_descriptions=True as it's not passed to the model anyway #1750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion pydantic_ai_slim/pydantic_ai/_pydantic.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,15 @@ def function_schema( # noqa: C901
description, field_descriptions = doc_descriptions(function, sig, docstring_format=docstring_format)

if require_parameter_descriptions:
if len(field_descriptions) != len(sig.parameters):
if takes_ctx:
parameters_without_ctx = set(
name for name in sig.parameters if not _is_call_ctx(sig.parameters[name].annotation)
)
missing_params = parameters_without_ctx - set(field_descriptions)
else:
missing_params = set(sig.parameters) - set(field_descriptions)

if missing_params:
errors.append(f'Missing parameter descriptions for {", ".join(missing_params)}')

for index, (name, p) in enumerate(sig.parameters.items()):
Expand Down
14 changes: 14 additions & 0 deletions tests/test_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -785,6 +785,20 @@ def test_enforce_parameter_descriptions() -> None:
assert all(err_part in error_reason for err_part in error_parts)


def test_enforce_parameter_descriptions_noraise() -> None:
async def complete_parameter_descriptions_docstring(ctx: RunContext, foo: int) -> str: # pragma: no cover
"""Describes function ops, but missing ctx description and contains non-existent parameter description.

:param foo: The foo thing.
:param bar: The bar thing.
"""
return f'{foo}'

agent = Agent(FunctionModel(get_json_schema))

agent.tool(require_parameter_descriptions=True)(complete_parameter_descriptions_docstring)


def test_json_schema_required_parameters(set_event_loop: None):
agent = Agent(FunctionModel(get_json_schema))

Expand Down