Add dataclass_metadata
parameter to mapped_column
and friends.
#12619
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.
Description
Field.metadata
in python dataclasses is an extension mechanism.It's used by some serialization libraries like
xsdata
anddesert
.See #10674 and this discussion for more context.
This PR adds the parameter
dataclass_metadata
tomapped_column()
,column_property()
,composite()
,relationship()
,synonym()
,deferred()
, andquery_expressions
.Updates nessescary property and mapping tests.
Adds a new test
DCTransformsTest.test_dataclass_metadata
.The parameter name,
dataclass_metadata
, was suggested in #10674.The name in
_AttributeOptions
,dataclasses_dataclass_metadata
, was chosen to match the other parameters, as well as what tests expect.Checklist
This pull request is:
must include a complete example of the issue. one line code fixes without an
issue and demonstration will not be accepted.
Fixes: #<issue number>
in the commit messageinclude a complete example of how the feature would look.
Fixes: #<issue number>
in the commit messageHave a nice day!