Skip to main content

Removes unused imports.

Project description

Build status Test coverage status

Introduction

autoflake removes unused imports 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.)

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 option.

Below is the full listing of options:

usage: autoflake [-h] [-i] [-r] [--imports IMPORTS] [--remove-all] [--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       remove all unused imports (not just those from the
                     standard library
  --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.3.3.tar.gz (6.7 kB view hashes)

Uploaded Source

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