Skip to content

Avoid mutable default arguments #4691

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

Merged
merged 1 commit into from
Aug 31, 2021

Conversation

cclauss
Copy link
Member

@cclauss cclauss commented Aug 30, 2021

Describe your change:

https://docs.python-guide.org/writing/gotchas/

flake8-bugbear B006 Do not use mutable data structures for argument defaults. They are created during function definition time. All calls to the function reuse this one instance of that data structure, persisting changes between them.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@cclauss cclauss requested a review from dhruvmanila August 30, 2021 16:11
@cclauss cclauss requested a review from Kush1101 as a code owner August 30, 2021 16:11
@ghost ghost added awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files labels Aug 30, 2021
@cclauss cclauss mentioned this pull request Aug 30, 2021
14 tasks
@cclauss cclauss force-pushed the mutable-default-arguments branch from b3447e0 to 389d64a Compare August 30, 2021 16:17
Copy link
Member

@dhruvmanila dhruvmanila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense! LGTM!

@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Aug 31, 2021
@cclauss cclauss merged commit 097f830 into TheAlgorithms:master Aug 31, 2021
@cclauss cclauss deleted the mutable-default-arguments branch August 31, 2021 04:56
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This PR modified some existing files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants