Skip to content

fix: pydantic specification extractor #132

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.

Sign up for GitHub

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
dapper91 merged 1 commit into from
Nov 7, 2025
Merged

fix: pydantic specification extractor #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions pjrpc/server/specs/extractors/pydantic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ def extract_response_schema(
title=error.__name__,
json_schema_extra=dict(description=f'**{error.CODE}** {error.MESSAGE}'),
),
) for error in errors or []
) for error in sorted(errors or [], key=lambda err: (err.CODE < 0, abs(err.CODE)))
)

response_model = pd.create_model(
Expand Down Expand Up @@ -186,7 +186,7 @@ def extract_error_response_schema(
title=error.__name__,
json_schema_extra=dict(description=f'**{error.CODE}** {error.MESSAGE}'),
),
) for error in errors or []
) for error in sorted(errors or [], key=lambda err: (err.CODE < 0, abs(err.CODE)))
)

response_model = pd.create_model(
Expand Down
8 changes: 4 additions & 4 deletions pjrpc/server/specs/extractors/pydantic_v1.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,13 +136,13 @@ def extract_response_schema(
return_model = self._build_result_model(method_name, method)

error_models: list[type[pd.BaseModel]] = []
for error in errors or []:
for error in sorted(errors or [], key=lambda err: (err.CODE < 0, abs(err.CODE))):
class ErrorModel(pydantic.BaseModel):
Config = pydantic.config.get_config(
dict(
self._config_args,
title=error.__name__,
json_schema_extra=dict(description=f'**{error.CODE}** {error.MESSAGE}'),
schema_extra=dict(description=f'**{error.CODE}** {error.MESSAGE}'),
),
)
__root__: JsonRpcResponseError[JsonRpcError[Literal[error.CODE], Any]] # type: ignore[name-defined]
Expand Down Expand Up @@ -171,13 +171,13 @@ def extract_error_response_schema(
errors: Optional[Iterable[type[exceptions.TypedError]]] = None,
) -> tuple[dict[str, Any], dict[str, dict[str, Any]]]:
error_models: list[type[pd.BaseModel]] = []
for error in errors or []:
for error in sorted(errors or [], key=lambda err: (err.CODE < 0, abs(err.CODE))):
class ErrorModel(pydantic.BaseModel):
Config = pydantic.config.get_config(
dict(
self._config_args,
title=error.__name__,
json_schema_extra=dict(description=f'**{error.CODE}** {error.MESSAGE}'),
schema_extra=dict(description=f'**{error.CODE}** {error.MESSAGE}'),
),
)
__root__: JsonRpcResponseError[JsonRpcError[Literal[error.CODE], Any]] # type: ignore[name-defined]
Expand Down
6 changes: 3 additions & 3 deletions tests/server/test_openapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1876,13 +1876,13 @@ def test_method():
},
),
'500': response_schema(
description='* **-32603** Internal error\n* **-32000** Server error',
description='* **-32000** Server error\n* **-32603** Internal error',
schema={
'title': 'TestMethodResponse',
'description': '* **-32603** Internal error\n* **-32000** Server error',
'description': '* **-32000** Server error\n* **-32603** Internal error',
'anyOf': [
{'$ref': '#/components/schemas/test_openapi_InternalError'},
{'$ref': '#/components/schemas/test_openapi_ServerError'},
{'$ref': '#/components/schemas/test_openapi_InternalError'},
],
},
),
Expand Down