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 60K
  • Win 28K
  • OS X 13K
  • Linux 19K
Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3
Windows 10 26 24 25 18 20 25 15 22 19 20 21 15 14 13 10 32 16 28 19 15 36 29 33 18 18 25 23 29 35 37 26 31 32 36 32 10 11 8 17 15 19 16 11 13 9
OS X 3 3 7 7 9 3 11 6 8 3 3 3 5 3 5 6 4 7 3 5 12 12 9 11 7 7 8 12 7 16 8 10 7 12 9 9 9 3 1 3 5 4 6 2 4 3
Linux 3 14 10 5 10 16 12 8 20 8 5 10 6 15 10 10 18 7 9 8 13 13 19 13 7 14 9 6 13 12 7 10 9 22 23 10 15 3 7 12 11 8 8 10 11 8

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.