ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Python Import Magic

by alecthomas ST2

This Sublime Text 2 plugin attempts to automatically manage Python imports.

Details

  • 2016.03.16.23.30.19
  • github.​com
  • github.​com
  • 2 years ago
  • 1 hour ago
  • 4 years ago

Installs

  • Total 2K
  • Win 733
  • OS X 549
  • Linux 448
Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6 Apr 5 Apr 4 Apr 3 Apr 2 Apr 1 Mar 31 Mar 30 Mar 29 Mar 28 Mar 27 Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13
Windows 0 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1
OS X 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 2 0 0 1 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

Sublime Text 3 - Python Import Magic image

This plugin attempts to automatically manage Python imports.

WARNING: This is a relatively complex plugin and thus may contain bugs. It may remove imports that you need. It may add imports that you don't. Use at your own risk.

It can:

  • Detect and add imports for unknown symbols.
  • Remove unused imports.
  • Order imports according to PEP8.

It currently does NOT (but support is planned):

  • Detect changes to files and update its index automatically. The current workaround is to use the command palette Python Import Magic: Reset Index.

Example

Example of Import Magic at work

Usage

There are three ways of invoking the auto-importer:

  • The hotkey: ⌘⇧I on OSX and ^⇧I on Windows and Linux.
  • Via the command palette: Python Import Magic: Update Imports.
  • Setting update_imports_on_save to true in the user settings for the package. I would not encourage use of this setting at this stage, but if you're feeling particularly brave…

Configuration

eg.

{
    "update_imports_on_save": true,
    "python_path": {
        "/Library/Python/2.7/site-packages": "S",
        "/Users/alec/Projects/SublimePythonImportMagic/.venv/lib/python2.7/site-packages": "L"
    }
}

update_imports_on_save = false

If true, update imports on each save. WARNING: This might not be a good idea.

index_filename = ".importmagic.idx"

Name of file to store index in.

python_path = {<path>: <classification>}

NOTE: Not implemented yet

Keys are the paths to search for Python modules. Values are how the path should be classified.

Paths will also be looked up in the default Sublime configuration under the key python_import_magic_python_path.

<classification> is from the following table:

Key Classification
3 Third party
S System
L Local