Warn if fields or exclude are not defined on DjangoObjectType
#981
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
radekwlsk
force-pushed
the
topic-710
branch
2 times, most recently
from
9d7fb3b
to
d318119
Compare
* all examples have fields or exclude set * mention that if neither fields nor exclude is used, warning will be raised
|
@jkimbo let me know if the tests and docs changes are expected here or if I should just leave it throwing warnings and don't mention in docs until it is |
|
@radekwlsk thanks, this is great. Mentioning it in the docs is great too. Thinking about it though maybe we should raise |
|
@jkimbo sure, with major release it would be too bad. Especially if it is mentioned in the v2 to v3 migration notes. I will change it tomorrow then. |
* as it is a major release 3, start right away from DeprecationWarning for ObjectTypes missing fields or exclude option * updated docs information to be more forbidding
|
@jkimbo Warning level bumped to |
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.
To make use of Django-Graphene more familiar to folks using DRF
PendingDeprecationWarningDeprecationWarning(edit: changed in 805480) is issued whenDjangoObjectTypehas neitherfieldsnorexcludeoption set.Current deprecations of
exclude_fieldsandonly_fieldsare taken into account as this check happens after they are copied over tofieldsorexclude.All tests, examples and docs are also updated so that they won't issue this warning. Documentation mentions that warning in docs/queries.rst#specifying-which-fields-to-include and instructs how to avoid it.
Change is part of v3 release discussed in #705.
Closes #710