-
-
Notifications
You must be signed in to change notification settings - Fork 631
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.
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
Warnings and errors for incompatible use of schema instance and many in fields.Nested #1983
Open
mmulqueen
wants to merge
1
commit into
marshmallow-code:dev
Choose a base branch
from
mmulqueen:nested-instance-error
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,9 +25,10 @@ | |
ValidationError, | ||
StringNotCollectionError, | ||
FieldInstanceResolutionError, | ||
FieldConfigurationError, | ||
) | ||
from marshmallow.validate import And, Length | ||
from marshmallow.warnings import RemovedInMarshmallow4Warning | ||
from marshmallow.warnings import RemovedInMarshmallow4Warning, FieldConfigurationWarning | ||
|
||
__all__ = [ | ||
"Field", | ||
|
@@ -551,6 +552,11 @@ def __init__( | |
"Use `Nested(lambda: MySchema(...))` instead.", | ||
RemovedInMarshmallow4Warning, | ||
) | ||
if isinstance(nested, SchemaABC) and many: | ||
warnings.warn( | ||
'Passing "many" is ignored if using an instance of a schema. Consider fields.List(fields.Nested(...)) instead.', | ||
FieldConfigurationWarning, | ||
) | ||
self.nested = nested | ||
self.only = only | ||
self.exclude = exclude | ||
|
@@ -634,9 +640,14 @@ def _serialize(self, nested_obj, attr, obj, **kwargs): | |
return schema.dump(nested_obj, many=many) | ||
|
||
def _test_collection(self, value): | ||
if self.many and not self.schema.many: | ||
raise FieldConfigurationError( | ||
'"many" may not be used in conjunction with an instance in a nested field.' | ||
) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd remove this test. This should be coverered by the init warning you added above, right? |
||
many = self.schema.many or self.many | ||
if many and not utils.is_collection(value): | ||
raise self.make_error("type", input=value, type=value.__class__.__name__) | ||
# Check whether many on the nested field and the schema are in conflict. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I guess this comment was meant for the change above? |
||
|
||
def _load(self, value, data, partial=None): | ||
try: | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,6 @@ | ||
class RemovedInMarshmallow4Warning(DeprecationWarning): | ||
pass | ||
|
||
|
||
class FieldConfigurationWarning(Warning): | ||
pass |
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd remove the suggestion.