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

Sublime​Python​IDE

by JulianEberius ST3

ST3 only: A rewrite of SublimeRope for ST3, uses the Rope library to add python completions and refactoring to ST3

Details

Installs

  • Total 75K
  • Win 37K
  • OS X 16K
  • Linux 23K
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 Mar 12 Mar 11
Windows 19 14 15 18 11 18 9 13 21 19 20 8 9 12 11 18 16 9 21 12 12 17 16 20 15 20 8 17 12 14 22 16 7 9 19 13 17 24 19 10 9 16 12 23 15 12
OS X 0 2 4 0 4 5 7 5 4 3 2 3 2 0 8 4 3 3 2 2 2 4 3 7 3 3 0 4 4 4 2 1 4 1 6 4 2 9 4 2 3 4 3 5 6 2
Linux 8 9 5 10 3 12 8 2 4 4 5 3 3 5 12 9 4 10 9 4 4 11 8 7 6 3 4 5 11 6 6 6 3 7 6 6 5 13 3 11 4 6 7 5 2 11

Readme

Source
raw.​githubusercontent.​com

SublimePythonIDE

This plugin adds Python completions and some IDE-like functions to Sublime Text 3, through the use of the Rope library. It is a complete rewrite of SublimeRope for ST2. It should be a lot faster and easier to use than SublimeRope was.

In contrast to SublimeRope, it does use the built in Python only for UI-related functions, the completions and refactorings are calculated using the exact same python interpreter you use for your project (e.g. the one in your virtualenv). This eliminates a lot of small and big problems that SublimeRope had, e.g., not recognizing dict comprehensions because Python2.6 is used in ST2, or not recognizing some of your libraries because you did not configure all the paths etc.. Everything your projects interpreter sees, should be visible to SublimePython -> easier configuration.

I also added a lot caching throughout the underlying Rope library which improved completion performance by several orders of magnitude. I hope no functionality breaks because of this ;-)

Configuration

Python location

The only necessary configuration is pointing SublimePythonIDE at the correct Python interpreter to use. There are four mechanisms for detecting Python that are used in the following order:

  • Checking the option “python_interpreter” in project settings (see below)
  • Auto-detecting a virtual environment (in “venv” or $WORKON_HOME for virtualenvwrapper)
  • Reading a #! (shebang) line in the active file
  • Auto-detecting the system Python from $PATH

The option “python_interpreter” can be set in the projects settings (Project->Edit Project). Example:

{
    "folders": [
        {
           "path": "XYZ"
        },
        {
            "path": "ABC"
        }
    ],
    "settings": {
        "python_interpreter": "/path/to/some/virtualenv/bin/python"
    }
}

This is also the way to select a virtualenv (point it to the interpreter in the venv) and thus get the completions/definitions for you project working.

To suppress the “Could not find Python dialog”, save the following setting:

"suppress_python_not_found_error": false,

Imports location

SublimePythonIDE will also look up imports relative to the project root directory (the top directory of your project).

In cases where the project directory is outside of your root python module, you may optionally set a custom source root directory in the project settings:

{
    "folders": [
        {
           "path": "XYZ"
        },
    ],
    "settings": {
        "src_root": "XYZ/THE_ACTUAL_SRC"
        "python_interpreter": "/path/to/some/virtualenv/bin/python",
    }
}

See Packages/SublimePythonIDE/SublimePython.sublime-settings for other options. As with all ST packages, copy this file into your Packages/User folder and editing the copy there.

Copyright © 2013 Julian Eberius

License:

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Have a look at “LICENSE.txt” file for more information.

EXTERNAL LICENSES

This project uses code from other open source projects (Rope) which may include licenses of their own.