EDU-3995: Update Python docs: Pydantic support #3364
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brianmacdonald-temporal
changed the title
jsundai
reviewed
Feb 21, 2025
| Data Converters convert raw Temporal payloads to/from actual Python types. | ||
| A custom Data Converter of type `temporalio.converter.DataConverter` can be set via the `data_converter` client parameter. | ||
| Data converters convert raw Temporal payloads to/from actual Python types. | ||
| A custom Data Converter of type `temporalio.converter.DataConverter` can be set via the `data_converter` parameter of the `Client` constructor. |
There was a problem hiding this comment.
via -> 'through' or 'with'. We try to avoid latin terms.
| A custom Data Converter of type `temporalio.converter.DataConverter` can be set via the `data_converter` client parameter. | ||
| Data converters convert raw Temporal payloads to/from actual Python types. | ||
| A custom Data Converter of type `temporalio.converter.DataConverter` can be set via the `data_converter` parameter of the `Client` constructor. | ||
| Data converters are a combination of payload converters, payload codecs, and failure converters. |
There was a problem hiding this comment.
Any words in the glossary, we generally try to capitalize. Data Converter, Payload Codecs, and Failure Converters.
| A custom Data Converter of type `temporalio.converter.DataConverter` can be set via the `data_converter` parameter of the `Client` constructor. | ||
| Data converters are a combination of payload converters, payload codecs, and failure converters. | ||
| Payload converters convert Python values to/from serialized bytes. | ||
| Payload codecs convert bytes to bytes (e.g. for compression or encryption). |
There was a problem hiding this comment.
e.g -> For example. We avoid latin terms so it's clearer for more internationalization of the docs and it's a bit more translation friendly.
|
|
||
| Although Workflows, Updates, Signals, and Queries can all be defined with multiple input parameters, users are strongly | ||
| encouraged to use a single `dataclass` or Pydantic model parameter, so that fields with defaults can be easily added | ||
| without breaking compatibility. Similar advice applies to return values. |
There was a problem hiding this comment.
We generally have every sentence on one line as a style so it's easier to comment on specific lines of text.
|
|
||
| This Data Converter supports conversion of all types supported by Pydantic to and from JSON. | ||
|
|
||
| In addition to Pydantic models, these include all `json.dump`-able types, various non-`json.dump`-able standard library |
There was a problem hiding this comment.
Could this sentence be made more clearer or broken up so it's more direct?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the Python docs to cover the new Pydantic support.
This section was previously taken verbatim from the Python README (modulo Vale-isms) and this PR does the same.