This repository was archived by the owner on Nov 16, 2023. It is now read-only.
Add isort import style linter #217
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
c-w
force-pushed
the
isort
branch
3 times, most recently
from
9192306 to
e6a6425
Compare
For some reason this doesn't work if the option is set in setup.cfg, likely because the special characters in the template path confuse the isort tool.
sayar
approved these changes
Jan 30, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
As discussed in #212 (comment), this pull request adds the isort linter to ensure that all the import styles are always consistent.
The linter is configured to follow the PEP-8 import style such as having separate blocks for standard library, third party and own imports, etc. Additionally, the linter is configured to force imports to be one per line to ensure that diffs are clean (e.g. adding or removing an import will be an easily visible full line diff instead of intermingled with other imports).
Editor plugins to automatically run isort are also available.
All Submissions:
Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
Does your PR follow our Code of Conduct?
Have you added an explanation of what your changes do and why you'd like us to include them?
Does each method or function "do one thing well"? Reviewers may recommend methods be split up for maintainability and testability. Not applicable: linting change
Is this code designed to be testable? Not applicable: linting change
Is the code documented well? Not applicable: linting change
Does your submission pass existing tests (or update existing tests with documentation regarding the change)?
Have you added tests to cover your changes? Not applicable: linting change
Have you linted your code prior to submission?
Have you updated the documentation and README? Not applicable: linting change
Is PII treated correctly? In particular, make sure the code is not logging objects or strings that might contain PII (e.g. request headers). Not applicable: linting change
Have secrets been stripped before committing? Not applicable: linting change