Add named_model function and raise warning for factories using generic models
#167
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
It will be helpful when using SubFactory and RelatedFactory for generic types like dict, str, etc.
skarzi
reviewed
Jun 7, 2022
|
|
||
| def test_generic_model_with_custom_name_no_warning(testdir): | ||
| testdir.makepyfile( | ||
| """ |
There was a problem hiding this comment.
NIP: let's indent whole string content or just this line to make code more readable
Co-authored-by: Łukasz Skarżyński <skarzynski_lukasz@protonmail.com>
skarzi
reviewed
Jun 11, 2022
Comment on lines
+40
to
+42
| with warnings.catch_warnings(): | ||
| warnings.simplefilter("error") | ||
| assert get_model_name(ModelFactory) == "foo" |
There was a problem hiding this comment.
NIP: to make this test more explicit and obvious we can check emitted warnings in an assert statement explicitly:
with pytest.warns(None) as recorded_warnings:
assert get_model_name(ModelFactory) == "foo"
assert not recorded_warningsWe can also pass the exact warning class (UserWarning in our case) instead of None.
There was a problem hiding this comment.
this is the way that pytest suggests: https://docs.pytest.org/en/stable/how-to/capture-warnings.html#:~:text=To%20ensure%20that%20no%20warnings%20are%20emitted%2C%20use%3A
There was a problem hiding this comment.
Oh nice, somehow I missed it in their docs, thanks!
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.
Implementing the idea previously described in #163 (comment).
We add a helper function,
named_model, that makes sure the user uses a model with a specific name, rather than a generic dict, list, etc.This way we avoid problems that arises when SubFactory and RelatedFactory are used with factories for generic models. See the tests for examples.