8000 📝 Add docstrings for `functional_serializers.py` by Kludex · Pull Request #6092 · pydantic/pydantic · GitHub
[go: up one dir, main page]
Skip to content

📝 Add docstrings for functional_serializers.py #6092

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
Kludex merged 1 commit into from
Jun 12, 2023
Merged

📝 Add docstrings for functional_serializers.py #6092

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
12 changes: 6 additions & 6 deletions pydantic/functional_serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
"""This module contains related classes and functions for serialization."""
from __future__ import annotations

from functools import partialmethod
Expand Down Expand Up @@ -56,8 +57,8 @@ class WrapSerializer:

Attributes:
func: The function to be wrapped.
return_type: Optional return type for the function, if omitted it will be inferred from the type annotation.
when_used: Determines the serializer will be used for serialization. Accepts a string with values `'always'`,
return_type: The return type for the function, if omitted it will be inferred from the type annotation.
when_used: Determines when this serializer should be used. Accepts a string with values `'always'`,
`'unless-none'`, `'json'`, and `'json-unless-none'`. Defaults to 'always'.
"""

Expand Down Expand Up @@ -203,15 +204,14 @@ def model_serializer(
) -> Callable[[Any], Any]:
"""Decorate a function which will be called to serialize the model.

(`when_used` is not permitted here since it makes no sense.)

Args:
__f: The function to be decorated.
mode: The serialization mode. `'plain'` means the function will be called
instead of the default serialization logic, `'wrap'` means the function will be called with an argument
to optionally call the default serialization logic.
when_used: Determines the serializer will be be used for serialization.
return_type: Optional return type for the function, if omitted it will be inferred from the type annotation.
when_used: Determines when this serializer should be used. Accepts a string with values `'always'`,
`'unless-none'`, `'json'`, `'json-unless-none'`. Defaults to `'always'`.
return_type: The return type for the function, if omitted it will be inferred from the type annotation.

Returns:
A decorator that can be used to decorate a function to be used as a model serializer.
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,6 @@ convention = "google"
'pydantic/deprecated/*' = ['D']
'pydantic/fields.py' = ['D']
'pydantic/functional_validators.py' = ['D']
'pydantic/functional_serializers.py' = ['D']
'pydantic/json_schema.py' = ['D']
'pydantic/main.py' = ['D']
'pydantic/mypy.py' = ['D']
Expand Down
0