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
  • 9 years ago
  • 14 minutes ago
  • 11 years ago

Installs

  • Total 2K
  • Win 749
  • Mac 559
  • Linux 455
Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14
Windows 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 0
Mac 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 0
Linux 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 0

Readme

Source
raw.​githubusercontent.​com

Sublime Text 3 - Python Import Magic

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