Skip to main content

Refactor modules to move import statements to the header

Project description


A script to move imports to the top of the module. Suppose a module with inline import like this

import requests
from math import sin
import datetime as dt

    # Accounts


def foo():
    from math import (
        sin, cos as cos_
    return sin(1), cos_(0)

def bar():
    from math import tan
    return tan(1)


$ move-imports path/ --isort --rewrite

will produce

import datetime as dt
from math import cos as cos_, sin, tan

import requests

    # Accounts


def foo():
    return sin(1), cos_(0)

def bar():
    return tan(1)


$ pip --user install move-imports

or the development version, directly from the git repo

$ pip --user install git+

Skip cases

To keep an inline import you could add a comment in the same line or above the stament with "avoid circular import" or "noqa".

  def foo():
    # avoid circular import
    import baz
  def foo():
    import baz  # noqa

Incremental refactoring

Sometimes inline imports statements are there for a reason. Circular imports, optional dependendencies, etc.

To manage this, it's useful to go step by step, checking a changed module is ok before to move to the next one.

With a combination of --start-from-last and --limit-to LIMIT_TO arguments you could incrementally refactor a whole package.

For instance, calling repeteadly the following command

$ move-imports --isort --rewrite --start-from-last --limit-to=1 tests/billing/**/*.py

will recursively traverse tests/billing/ refactoring one module at a time. Thus, the worflow would be:

  • run,
  • test,
  • optionally revert and skip problematic imports or modify manually
  • repeat

Running tests

Clone the repo and install pytest

$ pytest

Command line interface

$ move-imports --help
usage: move-imports [-h] [--start-from-last] [--limit-to LIMIT_TO] [--debug]
                    [--show-only] [--safe] [--isort]
                    [paths [paths ...]]

positional arguments:
  paths                Path/s to refactor. Glob supported enclosed in quotes

optional arguments:
  -h, --help           show this help message and exit
  --start-from-last    Incremental refactor
  --limit-to LIMIT_TO  Stop processing after N files. Use with --start-from-
  --debug              Make verbose output
  --show-only          write the result to stdin
  --safe               Only move stdlib or thirdparty imports
  --isort              Apply isort


Thanks to Shiphero for give me the time to do this.

Project details

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

move_imports-0.4-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

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