| Name | autoflake JSON |
| Version |
2.3.1
JSON |
| download |
| home_page | |
| Summary | Removes unused imports and unused variables |
| upload_time | 2024-03-13 03:41:28 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
automatic
clean
fix
import
unused
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# autoflake
[](https://github.com/PyCQA/autoflake/actions/workflows/main.yaml)
## Introduction
_autoflake_ removes unused imports and unused variables from Python code. It
makes use of [pyflakes](https://pypi.org/pypi/pyflakes) to do this.
By default, autoflake only removes unused imports for modules that are part of
the standard library. (Other modules may have side effects that make them
unsafe to remove automatically.) Removal of unused variables is also disabled
by default.
autoflake also removes useless ``pass`` statements by default.
## Example
Running autoflake on the below example
```
$ autoflake --in-place --remove-unused-variables example.py
```
```python
import math
import re
import os
import random
import multiprocessing
import grp, pwd, platform
import subprocess, sys
def foo():
from abc import ABCMeta, WeakSet
try:
import multiprocessing
print(multiprocessing.cpu_count())
except ImportError as exception:
print(sys.version)
return math.pi
```
results in
```python
import math
import sys
def foo():
try:
import multiprocessing
print(multiprocessing.cpu_count())
except ImportError:
print(sys.version)
return math.pi
```
## Installation
```
$ pip install --upgrade autoflake
```
## Advanced usage
To allow autoflake to remove additional unused imports (other than
than those from the standard library), use the ``--imports`` option. It
accepts a comma-separated list of names:
```
$ autoflake --imports=django,requests,urllib3 <filename>
```
To remove all unused imports (whether or not they are from the standard
library), use the ``--remove-all-unused-imports`` option.
To remove unused variables, use the ``--remove-unused-variables`` option.
Below is the full listing of options:
```
usage: autoflake [-h] [-c | -cd] [-r] [-j n] [--exclude globs] [--imports IMPORTS] [--expand-star-imports] [--remove-all-unused-imports] [--ignore-init-module-imports] [--remove-duplicate-keys] [--remove-unused-variables]
[--remove-rhs-for-unused-variables] [--ignore-pass-statements] [--ignore-pass-after-docstring] [--version] [--quiet] [-v] [--stdin-display-name STDIN_DISPLAY_NAME] [--config CONFIG_FILE] [-i | -s]
files [files ...]
Removes unused imports and unused variables as reported by pyflakes.
positional arguments:
files files to format
options:
-h, --help show this help message and exit
-c, --check return error code if changes are needed
-cd, --check-diff return error code if changes are needed, also display file diffs
-r, --recursive drill down directories recursively
-j n, --jobs n number of parallel jobs; match CPU count if value is 0 (default: 0)
--exclude globs exclude file/directory names that match these comma-separated globs
--imports IMPORTS by default, only unused standard library imports are removed; specify a comma-separated list of additional modules/packages
--expand-star-imports
expand wildcard star imports with undefined names; this only triggers if there is only one star import in the file; this is skipped if there are any uses of `__all__` or `del` in the file
--remove-all-unused-imports
remove all unused imports (not just those from the standard library)
--ignore-init-module-imports
exclude __init__.py when removing unused imports
--remove-duplicate-keys
remove all duplicate keys in objects
--remove-unused-variables
remove unused variables
--remove-rhs-for-unused-variables
remove RHS of statements when removing unused variables (unsafe)
--ignore-pass-statements
ignore all pass statements
--ignore-pass-after-docstring
ignore pass statements after a newline ending on '"""'
--version show program's version number and exit
--quiet Suppress output if there are no issues
-v, --verbose print more verbose logs (you can repeat `-v` to make it more verbose)
--stdin-display-name STDIN_DISPLAY_NAME
the name used when processing input from stdin
--config CONFIG_FILE Explicitly set the config file instead of auto determining based on file location
-i, --in-place make changes to files instead of printing diffs
-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: skip_file
import os
```
## Configuration
Configure default arguments using a `pyproject.toml` file:
```toml
[tool.autoflake]
check = true
imports = ["django", "requests", "urllib3"]
```
Or a `setup.cfg` file:
```ini
[autoflake]
check=true
imports=django,requests,urllib3
```
The name of the configuration parameters match the flags (e.g. use the
parameter `expand-star-imports` for the flag `--expand-star-imports`).
## Tests
To run the unit tests::
```
$ ./test_autoflake.py
```
There is also a fuzz test, which runs against any collection of given Python
files. It tests autoflake against the files and checks how well it does by
running pyflakes on the file before and after. The test fails if the pyflakes
results change for the worse. (This is done in memory. The actual files are
left untouched.)::
```
$ ./test_fuzz.py --verbose
```
## Excluding specific lines
It might be the case that you have some imports for their side effects, even
if you are not using them directly in that file.
That is common, for example, in Flask based applications. In where you import
Python modules (files) that imported a main ``app``, to have them included in
the routes.
For example:
```python
from .endpoints import role, token, user, utils
```
As those imports are not being used directly, if you are using the option
``--remove-all-unused-imports``, they would be removed.
To prevent that, without having to exclude the entire file, you can add a
``# noqa`` comment at the end of the line, like:
```python
from .endpoints import role, token, user, utils # noqa
```
That line will instruct ``autoflake`` to let that specific line as is.
## Using [pre-commit](https://pre-commit.com) hooks
Add the following to your `.pre-commit-config.yaml`
```yaml
- repo: https://github.com/PyCQA/autoflake
rev: v2.3.1
hooks:
- id: autoflake
```
When customizing the arguments, make sure you include `--in-place` in the list
of arguments:
```yaml
- repo: https://github.com/PyCQA/autoflake
rev: v2.2.1
hooks:
- id: autoflake
args: [--remove-all-unused-imports, --in-place]
```
Raw data
{
"_id": null,
"home_page": "",
"name": "autoflake",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "automatic,clean,fix,import,unused",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/2a/cb/486f912d6171bc5748c311a2984a301f4e2d054833a1da78485866c71522/autoflake-2.3.1.tar.gz",
"platform": null,
"description": "# autoflake\n\n[](https://github.com/PyCQA/autoflake/actions/workflows/main.yaml)\n\n## Introduction\n\n_autoflake_ removes unused imports and unused variables from Python code. It\nmakes use of [pyflakes](https://pypi.org/pypi/pyflakes) to do this.\n\nBy default, autoflake only removes unused imports for modules that are part of\nthe standard library. (Other modules may have side effects that make them\nunsafe to remove automatically.) Removal of unused variables is also disabled\nby default.\n\nautoflake also removes useless ``pass`` statements by default.\n\n## Example\n\nRunning autoflake on the below example\n\n```\n$ autoflake --in-place --remove-unused-variables example.py\n```\n\n```python\nimport math\nimport re\nimport os\nimport random\nimport multiprocessing\nimport grp, pwd, platform\nimport subprocess, sys\n\n\ndef foo():\n from abc import ABCMeta, WeakSet\n try:\n import multiprocessing\n print(multiprocessing.cpu_count())\n except ImportError as exception:\n print(sys.version)\n return math.pi\n```\n\nresults in\n\n```python\nimport math\nimport sys\n\n\ndef foo():\n try:\n import multiprocessing\n print(multiprocessing.cpu_count())\n except ImportError:\n print(sys.version)\n return math.pi\n```\n\n\n## Installation\n\n```\n$ pip install --upgrade autoflake\n```\n\n\n## Advanced usage\n\nTo allow autoflake to remove additional unused imports (other than\nthan those from the standard library), use the ``--imports`` option. It\naccepts a comma-separated list of names:\n\n```\n$ autoflake --imports=django,requests,urllib3 <filename>\n```\n\nTo remove all unused imports (whether or not they are from the standard\nlibrary), use the ``--remove-all-unused-imports`` option.\n\nTo remove unused variables, use the ``--remove-unused-variables`` option.\n\nBelow is the full listing of options:\n\n```\nusage: autoflake [-h] [-c | -cd] [-r] [-j n] [--exclude globs] [--imports IMPORTS] [--expand-star-imports] [--remove-all-unused-imports] [--ignore-init-module-imports] [--remove-duplicate-keys] [--remove-unused-variables]\n [--remove-rhs-for-unused-variables] [--ignore-pass-statements] [--ignore-pass-after-docstring] [--version] [--quiet] [-v] [--stdin-display-name STDIN_DISPLAY_NAME] [--config CONFIG_FILE] [-i | -s]\n files [files ...]\n\nRemoves unused imports and unused variables as reported by pyflakes.\n\npositional arguments:\n files files to format\n\noptions:\n -h, --help show this help message and exit\n -c, --check return error code if changes are needed\n -cd, --check-diff return error code if changes are needed, also display file diffs\n -r, --recursive drill down directories recursively\n -j n, --jobs n number of parallel jobs; match CPU count if value is 0 (default: 0)\n --exclude globs exclude file/directory names that match these comma-separated globs\n --imports IMPORTS by default, only unused standard library imports are removed; specify a comma-separated list of additional modules/packages\n --expand-star-imports\n expand wildcard star imports with undefined names; this only triggers if there is only one star import in the file; this is skipped if there are any uses of `__all__` or `del` in the file\n --remove-all-unused-imports\n remove all unused imports (not just those from the standard library)\n --ignore-init-module-imports\n exclude __init__.py when removing unused imports\n --remove-duplicate-keys\n remove all duplicate keys in objects\n --remove-unused-variables\n remove unused variables\n --remove-rhs-for-unused-variables\n remove RHS of statements when removing unused variables (unsafe)\n --ignore-pass-statements\n ignore all pass statements\n --ignore-pass-after-docstring\n ignore pass statements after a newline ending on '\"\"\"'\n --version show program's version number and exit\n --quiet Suppress output if there are no issues\n -v, --verbose print more verbose logs (you can repeat `-v` to make it more verbose)\n --stdin-display-name STDIN_DISPLAY_NAME\n the name used when processing input from stdin\n --config CONFIG_FILE Explicitly set the config file instead of auto determining based on file location\n -i, --in-place make changes to files instead of printing diffs\n -s, --stdout print changed text to stdout. defaults to true when formatting stdin, or to false otherwise\n```\n\nTo ignore the file, you can also add a comment to the top of the file:\n```python\n# autoflake: skip_file\nimport os\n```\n\n## Configuration\n\nConfigure default arguments using a `pyproject.toml` file:\n\n```toml\n[tool.autoflake]\ncheck = true\nimports = [\"django\", \"requests\", \"urllib3\"]\n```\n\nOr a `setup.cfg` file:\n\n```ini\n[autoflake]\ncheck=true\nimports=django,requests,urllib3\n```\n\nThe name of the configuration parameters match the flags (e.g. use the\nparameter `expand-star-imports` for the flag `--expand-star-imports`).\n\n## Tests\n\nTo run the unit tests::\n\n```\n$ ./test_autoflake.py\n```\n\nThere is also a fuzz test, which runs against any collection of given Python\nfiles. It tests autoflake against the files and checks how well it does by\nrunning pyflakes on the file before and after. The test fails if the pyflakes\nresults change for the worse. (This is done in memory. The actual files are\nleft untouched.)::\n\n```\n$ ./test_fuzz.py --verbose\n```\n\n## Excluding specific lines\n\nIt might be the case that you have some imports for their side effects, even\nif you are not using them directly in that file.\n\nThat is common, for example, in Flask based applications. In where you import\nPython modules (files) that imported a main ``app``, to have them included in\nthe routes.\n\nFor example:\n\n```python\nfrom .endpoints import role, token, user, utils\n```\n\nAs those imports are not being used directly, if you are using the option\n``--remove-all-unused-imports``, they would be removed.\n\nTo prevent that, without having to exclude the entire file, you can add a\n``# noqa`` comment at the end of the line, like:\n\n```python\nfrom .endpoints import role, token, user, utils # noqa\n```\n\nThat line will instruct ``autoflake`` to let that specific line as is.\n\n\n## Using [pre-commit](https://pre-commit.com) hooks\n\nAdd the following to your `.pre-commit-config.yaml`\n\n```yaml\n- repo: https://github.com/PyCQA/autoflake\n rev: v2.3.1\n hooks:\n - id: autoflake\n```\n\nWhen customizing the arguments, make sure you include `--in-place` in the list\nof arguments:\n\n```yaml\n- repo: https://github.com/PyCQA/autoflake\n rev: v2.2.1\n hooks:\n - id: autoflake\n args: [--remove-all-unused-imports, --in-place]\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Removes unused imports and unused variables",
"version": "2.3.1",
"project_urls": {
"Homepage": "https://www.github.com/PyCQA/autoflake"
},
"split_keywords": [
"automatic",
"clean",
"fix",
"import",
"unused"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2ee3fd29bf416eb4f1c5579cf12bf393ae954099258abd7bde03c4f9716ef6b",
"md5": "4a83eec4bd4d1b158661a5406766dbf6",
"sha256": "3ae7495db9084b7b32818b4140e6dc4fc280b712fb414f5b8fe57b0a8e85a840"
},
"downloads": -1,
"filename": "autoflake-2.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4a83eec4bd4d1b158661a5406766dbf6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 32483,
"upload_time": "2024-03-13T03:41:26",
"upload_time_iso_8601": "2024-03-13T03:41:26.969049Z",
"url": "https://files.pythonhosted.org/packages/a2/ee/3fd29bf416eb4f1c5579cf12bf393ae954099258abd7bde03c4f9716ef6b/autoflake-2.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2acb486f912d6171bc5748c311a2984a301f4e2d054833a1da78485866c71522",
"md5": "ed3551eefbbb8608d1b323f8ac368509",
"sha256": "c98b75dc5b0a86459c4f01a1d32ac7eb4338ec4317a4469515ff1e687ecd909e"
},
"downloads": -1,
"filename": "autoflake-2.3.1.tar.gz",
"has_sig": false,
"md5_digest": "ed3551eefbbb8608d1b323f8ac368509",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27642,
"upload_time": "2024-03-13T03:41:28",
"upload_time_iso_8601": "2024-03-13T03:41:28.977510Z",
"url": "https://files.pythonhosted.org/packages/2a/cb/486f912d6171bc5748c311a2984a301f4e2d054833a1da78485866c71522/autoflake-2.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 03:41:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PyCQA",
"github_project": "autoflake",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "autoflake"
}
