Fix imports and default value for function arg #1216
Merged
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
MVrachev
changed the title
MVrachev
force-pushed
the
fix-imports-and-default
branch
from
3a169f4
to
d8d68e7
Compare
jku
approved these changes
Nov 19, 2020
MVrachev
force-pushed
the
fix-imports-and-default
branch
from
d8d68e7
to
7957582
Compare
This quote from the Google Python style guide made me realize why empty list as a default value for an argument could be dangerous: "Default arguments are evaluated once at module load time. This may cause problems if the argument is a mutable object such as a list or a dictionary. If the function modifies the object (e.g., by appending an item to a list), the default value is modified." Read more here: https://google.github.io/styleguide/pyguide.html#2123-cons Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
Currently, we are importing the "utils" module in tests/utils with "import utils". This could become a problem when there is another module with the same general name "utils" and could lead to import mistakes. Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
MVrachev
force-pushed
the
fix-imports-and-default
branch
from
7957582
to
028d1bc
Compare
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.
Description of the changes being introduced by the pull request:
This quote from the Google Python style guide made me realize
why empty list as a default value for an argument could be
dangerous:
Default arguments are evaluated once at module load time. This may cause problems if the argument is a mutable object such as a list or a dictionary. If the function modifies the object (e.g., by appending an item to a list), the default value is modified.Read more here:
https://google.github.io/styleguide/pyguide.html#2123-cons
Also, currently, we are importing the "utils" module in tests/utils
with "import utils".
This could become a problem when there is another module with
the same general name "utils" and could lead to import mistakes.
Please verify and check that the pull request fulfills the following
requirements: