Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add flake8-builtins to pre-commit and fix errors #7105

Merged
merged 20 commits into from
Oct 13, 2022
Merged

Add flake8-builtins to pre-commit and fix errors #7105

merged 20 commits into from
Oct 13, 2022

Conversation

CaedenPH
Copy link
Contributor

Describe your change:

Implements #7104

  • 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}.

@algorithms-keeper algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass labels Oct 13, 2022
cclauss
cclauss reviewed Oct 13, 2022
View reviewed changes
cclauss
cclauss reviewed Oct 13, 2022
View reviewed changes
cclauss
cclauss requested changes Oct 13, 2022
View reviewed changes
@algorithms-keeper algorithms-keeper bot added awaiting changes A maintainer has requested changes to this PR and removed awaiting reviews This PR is ready to be reviewed labels Oct 13, 2022
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed awaiting changes A maintainer has requested changes to this PR labels Oct 13, 2022
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 13, 2022
CaedenPH and others added 2 commits October 13, 2022 12:58
@CaedenPH @cclauss
Update graphs/prim.py
eb5524b 
Co-authored-by: Christian Clauss <[email protected]>
@CaedenPH @cclauss
Update hashes/djb2.py
89a4005 
Co-authored-by: Christian Clauss <[email protected]>
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 13, 2022
@CaedenPH
Copy link
Contributor Author

@cclauss
I believe I have changed all _builtin variable names to builtin_

cclauss
cclauss approved these changes Oct 13, 2022
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

AWESOME!!!

@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 13, 2022
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed awaiting changes A maintainer has requested changes to this PR labels Oct 13, 2022
@CaedenPH
Copy link
Contributor Author

@dhruvmanila
Made all the variable changes you requested, just not sure about the function names. Should we add a noqa or rename. I personally vouch for rename because they make more sense and are more descriptive

@CaedenPH CaedenPH requested review from dhruvmanila and removed request for Kush1101 October 13, 2022 13:45
dhruvmanila
dhruvmanila requested changes Oct 13, 2022
View reviewed changes
@CaedenPH CaedenPH requested a review from dhruvmanila October 13, 2022 14:12
@cclauss
Copy link
Member

cclauss commented Oct 13, 2022

@dhruvmanila I have approved. Please merge when you feel that it is ready.

@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 13, 2022
@dhruvmanila dhruvmanila merged commit d5a9f64 into TheAlgorithms:master Oct 13, 2022
@cclauss
Copy link
Member

cclauss commented Oct 13, 2022

The addition of these two naming tools is a great step forward for this repo. Thank you for doing this!!

@CaedenPH
Copy link
Contributor Author

The addition of these two naming tools is a great step forward for this repo. Thank you for doing this!!

No problem. I'm thinking of another one for unused variable. What's your opinion on this?

@cclauss
Copy link
Member

cclauss commented Oct 13, 2022 •
edited
Loading

Flake8 has unused variable bulitin... F841 | local variable name is assigned to but never used

@CaedenPH
Copy link
Contributor Author

Apparently not when it comes to things such as for i in range(...) and i is unused

@cclauss
Copy link
Member

cclauss commented Oct 13, 2022 •
edited
Loading

Oh... You want https://github.com/PyCQA/flake8-bugbear for that but we need to be careful not to go overboard and make contributors too angry to fix all the nits.

@CaedenPH
Copy link
Contributor Author

Do you think we should implement it? If you think it will be too annoying then that's fine

@cclauss
Copy link
Member

cclauss commented Oct 13, 2022

How many of our current files would need to change if we enabled bugbear?

@CaedenPH
Copy link
Contributor Author

How many of our current files would need to change if we enabled bugbear?

I'll get you a statistic, one second

@CaedenPH
Copy link
Contributor Author

How many of our current files would need to change if we enabled bugbear?

around 50 it seems

@cclauss
Copy link
Member

cclauss commented Oct 13, 2022

@dhruvmanila You thoughts?

  • Also like flake8-2020, flake8-comprehensions, flake8-return, flake8-simplify

@dhruvmanila
Copy link
Member

I haven't looked at them so not so sure. We could open an issue with all the available tools and take the discussion over there.

@dhruvmanila dhruvmanila mentioned this pull request Nov 2, 2022
Merged
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss approved these changes

@dhruvmanila dhruvmanila dhruvmanila approved these changes

Assignees
No one assigned
Labels
enhancement This PR modified some existing files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@CaedenPH @cclauss @dhruvmanila