Add support of ignore comment on the top of the file #291
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
fsouza
reviewed
Feb 12, 2024
README.md
Outdated
| @@ -127,6 +127,11 @@ options: | |||
| -s, --stdout print changed text to stdout. defaults to true when formatting stdin, or to false otherwise | |||
| ``` | |||
|
|
|||
| To ignore the file, you can also add a comment to the top of the file: | |||
| ```python | |||
| # autoflake: ignore | |||
There was a problem hiding this comment.
can you make it skip_file instead?
It's more explicit. ignore can be a bit vague (is it ignoring the next line? the whole file?)
There was a problem hiding this comment.
Replaced with skip_file, thank you!
autoflake.py
Outdated
| @@ -904,6 +906,9 @@ def fix_code( | |||
| if not source: | |||
| return source | |||
|
|
|||
| if source.lstrip().startswith(IGNORE_COMMENT): | |||
There was a problem hiding this comment.
can you please make sure this works with shebangs too?
There was a problem hiding this comment.
sorry, what do you mean by shebangs?
There was a problem hiding this comment.
Something like:
#!/usr/bin/env python3
# autoflake: skip_file
...
bp72
force-pushed
the
ignore-file-comment
branch
from
3f2ec11
to
ba134f9
Compare
bp72
force-pushed
the
ignore-file-comment
branch
from
ba134f9
to
adeed89
Compare
fsouza
approved these changes
Feb 19, 2024
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.
Autoflake can now ignore files with the
# autoflake: ignorecomment on top.Closes #97