Python Fix Imports

Python Fix Imports is a Sublime Text 3 plugin that can automatically reorganize the import statements of your Python script. Please read the "Rationale" section for more information.

This plugin comes from a script that has been written for the Buildbot project, in order to help developers ensuring they properly organize their import statements in their Python files.

Rationale

The beginning of each Python script is the part of the code that is likely to evolve the most over the lifetime of the file. Imports statements gets added, removed, reorganized all over the time.

Thanks to distributed versioning systems such as Git, several persons can easily work on the same time on the same file. And the management of the import statements is likely to cause conflict when each developer adds his modifications.

We really started having the need for an automatic reorganization script when we have set up an automatic merge of several branches alltogether. Most of the time, the conflicts were found to be on the import lines.

Here are the rules this fiximports script enforces:

Rule 1

Each import statement only imports one method, class or module.

Yes:

from abc import dce
from abc import fgh

No:

from abc import dce, fgh
from abc import (dce,
                 fgh)
from abc import dce, \
                fgh

fiximports automatically splits import statements that use a comma. \ and parenthesis are not supported.

Bonus: let's say you want where and how an object "object_name" is imported. This rules ensures you will always find the import occurences of the following search pattern: import object_name. No need to do regex, only ``import `` + what you are looking for.

Rule 2

Import statements are organized in blocks, separated by an empty line. Each block is alphabetically sorted.

This removes any ambiguity in the placement of an import line in a given block. When two developers on two different branches want to add the same import in the same file, the location of this line will be the same and so the merge if any will be obvious.

Yes:

from abc import aaaa
from abc import bbbb
from abc import cccc

No:

from abc import bbbb
from abc import aaaa
from abc import cccc

Sorting only occurs on a given block, if for any reason an import statement needs to be placed after another one, just add an empty line.

fiximports can sort all import statements at once (preserving the 'group' splitting).

In some project, I tend to enforce the ordering of the groups themself:

• first the standard library imports:

  import json
  import login
  import os
  

• Standart libraries in the form from ... import:

  from textwrap import dedent
  from twisted.internet import defer
  

• Project modules with their complete name (always uses from __future__ import absolute_import)

  from myproject.the.module.name import ClassName
  from myproject.the.other.module.name import TheOtherClassName
  

Example

Let's look at the following code:

import datetime
import collections

from io import BytesIO, UnsupportedOperation
from .hooks import default_hooks
from .structures import CaseInsensitiveDict

from .auth import HTTPBasicAuth
from .cookies import cookiejar_from_dict, get_cookie_header
from .packages.urllib3.fields import RequestField
from .packages.urllib3.filepost import encode_multipart_formdata
from .packages.urllib3.util import parse_url
from .packages.urllib3.exceptions import DecodeError, ReadTimeoutError, ProtocolError, LocationParseError
from .exceptions import HTTPError, MissingSchema, InvalidURL, ChunkedEncodingError, ContentDecodingError, ConnectionError, StreamConsumedError
from .utils import guess_filename, get_auth_from_url, requote_uri, stream_decode_response_unicode, to_key_val_list, parse_header_links, iter_slices, guess_json_utf, super_len, to_native_string
from .compat import cookielib, urlunparse, urlsplit, urlencode, str, bytes, StringIO, is_py2, chardet, json, builtin_str, basestring
from .status_codes import codes

This automatically becomes with this plugin:

import collections
import datetime

from .hooks import default_hooks
from .structures import CaseInsensitiveDict
from io import BytesIO
from io import UnsupportedOperation

from .auth import HTTPBasicAuth
from .compat import StringIO
from .compat import basestring
from .compat import builtin_str
from .compat import bytes
from .compat import chardet
from .compat import cookielib
from .compat import is_py2
from .compat import json
from .compat import str
from .compat import urlencode
from .compat import urlsplit
from .compat import urlunparse
from .cookies import cookiejar_from_dict
from .cookies import get_cookie_header
from .exceptions import ChunkedEncodingError
from .exceptions import ConnectionError
from .exceptions import ContentDecodingError
from .exceptions import HTTPError
from .exceptions import InvalidURL
from .exceptions import MissingSchema
from .exceptions import StreamConsumedError
from .packages.urllib3.exceptions import DecodeError
from .packages.urllib3.exceptions import LocationParseError
from .packages.urllib3.exceptions import ProtocolError
from .packages.urllib3.exceptions import ReadTimeoutError
from .packages.urllib3.fields import RequestField
from .packages.urllib3.filepost import encode_multipart_formdata
from .packages.urllib3.util import parse_url
from .status_codes import codes
from .utils import get_auth_from_url
from .utils import guess_filename
from .utils import guess_json_utf
from .utils import iter_slices
from .utils import parse_header_links
from .utils import requote_uri
from .utils import stream_decode_response_unicode
from .utils import super_len
from .utils import to_key_val_list
from .utils import to_native_string

Indeed, the beginning of the file is much more verbose, but merges will be easier (since when we switched to this paradigm, we almost have not conflict on these lines).

Installation

To avoid dependencies, all necessary modules are included within the package.

Using Sublime Package Control

• Use cmd+shift+P shortcut then Package Control: Install Package
• Look for Python Fix Imports and install it.

Using Git repository on GitHub:

• Open a terminal, move to Packages directory (refers to the folder that opens when you use the Preferences > Browse Packages... menu).

• Then type in terminal:

  git clone https://github.com/Stibbons/python-fiximports python_fiximports
  

Settings

Global Settings

You'll find settings in Preferences menu (Preferences -> Package Settings -> Python Fix Imports).

{
    // Automatically fix the imports on save
    "autofix_on_save": false,

    // Enable or disabl split of every imports in own line (one object import per line)
    "split_import_statements": true,

    // Enable or disabl sorting or import in its own group
    "sort_import_statements": true,
}

By editing User settings, your personal liking will be kept safe over plugin upgrades.

Per-project settings

{
    "settings": {
        "python_fiximports": {
            "autofix_on_save": true
        }
    }
}

Usage

Formatting is applied on the whole document.

Using keyboard:

• GNU/Linux: ctrl+alt+shift+i
• Windows: ctrl+alt+shift+i
• OSX: ctrl+command+shift+i

SideBar

Right click on the file(s) or folder(s)

On Save

Imports are reorganized automatically on save if the following setting is set: autofix_on_save.

Command Palette

Bring up the Command Palette and select one of the following options:

Python Fix Imports: Execute Fix imports in the current file immediately.

Enable Python Fix Imports (until restart): Toggle the general settings autofix_on_save to Enabled until Sublime restart (overwrite the project and global settings).

Disable Python Fix Imports (until restart): Toggle the general settings autofix_on_save to Disabled until Sublime restart (overwrite the project and global settings).

Disable Python Fix Imports for this file (until restart): Disable the automatic fix of the import statements in the current file, independently of the global setting autofix_on_save.

Enable Python Fix Imports for this file (until restart): Enable the automatic fix of the import statements in the current file, independently of the global setting autofix_on_save.

Hint: open Command Palette (ctrl+shift+P) and type Fix... up to highlight full caption.

License

Copyright 2015 Semet Gaetan <gaetan@xeberon.net>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.