Stop using mutable types for default arg values #1213
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
Using mutable types for default args is typically a no-no unless their surprising behavior is being explicitly abused, for an explanation see: http://effbot.org/zone/default-values.htm Fix #1212
jeffwidman
commented
Sep 12, 2017
| @@ -22,7 +22,7 @@ | |||
|
|
|||
| @pytest.fixture | |||
| def client(mocker): | |||
| return mocker.Mock(spec=KafkaClient(bootstrap_servers=[], api_version=(0, 9))) | |||
| return mocker.Mock(spec=KafkaClient(bootstrap_servers=(), api_version=(0, 9))) | |||
There was a problem hiding this comment.
Should this argument instead be omitted altogether?
| @@ -19,7 +19,7 @@ | |||
|
|
|||
| @pytest.fixture | |||
| def client(mocker): | |||
| _cli = mocker.Mock(spec=KafkaClient(bootstrap_servers=[], api_version=(0, 9))) | |||
| _cli = mocker.Mock(spec=KafkaClient(bootstrap_servers=(), api_version=(0, 9))) | |||
There was a problem hiding this comment.
Should this argument instead be omitted altogether?
| @@ -398,7 +398,7 @@ def test_send_produce_request_raises_when_topic_unknown(self, protocol, conn): | |||
| def test_correlation_rollover(self): | |||
| with patch.object(SimpleClient, 'load_metadata_for_topics'): | |||
| big_num = 2**31 - 3 | |||
| client = SimpleClient(hosts=[], correlation_id=big_num) | |||
| client = SimpleClient(hosts=(), correlation_id=big_num) | |||
There was a problem hiding this comment.
Should this argument instead be omitted altogether?
|
LGTM. I'd leave the arguments, as it's more explicit. |
tvoinarovskyi
approved these changes
Sep 13, 2017
dpkp
approved these changes
Sep 13, 2017
tvoinarovskyi
deleted the
1212-stop-using-mutable-types-for-default-arg-values
branch
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.
Using mutable types for default args is typically a no-no unless their
surprising behavior is being explicitly abused, for an explanation see:
http://effbot.org/zone/default-values.htm
Note to reviewers: This is just a find-and-replace of
=[]with=()to see if the tests pass.Possibly some of these arguments aren't actually used and could simply be removed, for example
the test files. If you notice any of these, please comment and I will update the PR.
Fix #1212