Skip to main content

Removes unused imports and unused variables.

Project description

Build status Test coverage status

Introduction

autoflake removes unused imports and unused variables from Python code. It makes use of 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.

Example

Running autoflake on the below example:

$ autoflake --in-place example.py
import math
import re
import os
import random
import multiprocessing
import grp, pwd, platform
import subprocess, sys

def foo():
    if True:
        from abc import ABCMeta, WeakSet
    else:
        print(sys.version)
    return math.pi

results in

import math
import sys

def foo():
    if True:
        pass
    else:
        print(sys.version)
    return math.pi

Installation

$ pip install --upgrade autoflake

Advanced usage

To prevent autoflake from removing certain lines, add noqa as an inline comment.

import math  # noqa

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] [-i] [-r] [--imports IMPORTS]
                 [--remove-all-unused-imports] [--remove-unused-variables]
                 [--version]
                 files [files ...]

Removes unused imports as reported by pyflakes.

positional arguments:
  files                 files to format

optional arguments:
  -h, --help            show this help message and exit
  -i, --in-place        make changes to files instead of printing diffs
  -r, --recursive       drill down directories recursively
  --imports IMPORTS     by default, only unused standard library imports are
                        removed; specify a comma-separated list of additional
                        modules/packages
  --remove-all-unused-imports
                        remove all unused imports (not just those from the
                        standard library
  --remove-unused-variables
                        remove unused variables
  --version             show program's version number and exit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autoflake-0.4.1.tar.gz (7.4 kB view details)

Uploaded Source

File details

Details for the file autoflake-0.4.1.tar.gz.

File metadata

  • Download URL: autoflake-0.4.1.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for autoflake-0.4.1.tar.gz
Algorithm Hash digest
SHA256 b0196a5766349ed76be3ef94f8381606ec39e51fae7ae9b2fdb6c87d359e2ea7
MD5 89fb65bab1edd4ec3306ee59af56ab5a
BLAKE2b-256 92fbc7b4e60437f281e41921de873cac3d1a6b0e44ded5199591a38a2de51202

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page