Allow passing a base_schema to load_config()
#1103
Merged
Conversation
This file contains hidden or 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
llucax
requested review from
ela-kotulska-frequenz
and removed request for
a team
github-actions
bot
added
part:docs
llucax
added
the
scope:breaking-change
src/frequenz/sdk/config/_util.py
Outdated
Comment on lines
25
to
43
| dictionary using [`marshmallow.Schema.load`][] (which in turn uses the | ||
| [`marshmallow.Schema.load`][] method to do the validation and deserialization). |
There was a problem hiding this comment.
using [
marshmallow.Schema.load][] (which in turn uses the [marshmallow.Schema.load]
Wrong name?
There was a problem hiding this comment.
Yes, the first one should be class_schema. Will update.
llucax
force-pushed
the
config-base-schema
branch
from
e89fa91 to
13ab089
Compare
Make it more explicit that this is just a wrapper to external libraries so users should read their documentation in full and which functions are used exactly. Signed-off-by: Leandro Lucarella <[email protected]>
`marshmallow_dataclass.dataclass` is intended to be used only when using `my_dataclass.Schema` to get the schema. But using this is not very convenient when using type hints as they are not well supported by `marshmallow`, as the `load()` function can't have hints. This is actually why `load_config()` exists in the first place, so we are using `class_schema()` instead, so we don't really need that our types are decorated with `marshmallow_dataclass`, we can use the built-in `dataclass` instead, we just need to add the appropriate metadata if we want more complex validation. Using `class_shema()` is also necessary to be able to pass a `base_schema`, which we'll need when we want to use schemas with custom fields, like the ones provided by `frequenz.quantities`. Because of this, we just drop support for `marshmallow_dataclass.dataclass` and we'll require that built-in dataclasses are used in the future. Signed-off-by: Leandro Lucarella <[email protected]>
This is necessary to use custom fields when loading configurations. Signed-off-by: Leandro Lucarella <[email protected]>
This is just the last step to be able to enforce via the type system that only built-in dataclasses are used. Signed-off-by: Leandro Lucarella <[email protected]>
llucax
force-pushed
the
config-base-schema
branch
from
13ab089 to
1be3d2c
Compare
|
Updated. |
ela-kotulska-frequenz
approved these changes
Nov 15, 2024
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 adds a new argument to
load_config()to allow passing abase_schemato be used when loading the configuration. This is necessary to be able to use custom fields in the schema, like the ones provided byfrequenz.quantities.It also drops support for using
marshmallow_dataclas.dataclassdirectly.marshmallow_dataclass.dataclassis intended to be used only when usingmy_dataclass.Schemato get the schema. But using this is not very convenient when using type hints as they are not well-supported bymarshmallow, as theload()function can't have hints.This is actually why
load_config()exists in the first place, so we are usingclass_schema()instead, so we don't really need that our types are decorated withmarshmallow_dataclass, we can use the built-indataclassinstead, we just need to add the appropriate metadata if we want more complex validation.Using
class_shema()is also necessary to be able to pass abase_schema, which we'll need when we want to use schemas with custom fields, like the ones provided byfrequenz.quantities.Finally, it improves
load_configdocumentation to make it more explicit that this is just a wrapper to external libraries, so users should read their documentation in full and which functions are used exactly.