SublimeRope

Adds Python completions and some IDE-like functions to Sublime Text 2, through the use of the Rope library.

I have tested it on the latest dev build. It seems to work equally well on OSX, Linux and Windows, though I mostly test on OSX. No guarantees here!

Copyright (C) 2011 Julian Eberius

Basic Usage

Just unzip / git clone the folder SublimeRope into ST2's Packages folder. Basic completion should work (for more, see below) and all the commands should be reachable through the Command Palette. You can also use package_control to install this plugin.

IMPORTANT: For Rope to find all the definitions and offer you the best completion proposals, you need to configure a Rope project. To do so, call the command "Rope: New Project" from the command palette. This will ask you for the project root directory and for the root of the virtualenv. Leave the second one empty if you don't use virtualenv. You should also setup global module completion, as described below.

Available Commands:

• Completions, which hook into Sublime's normal completion system (Ctrl+Space and as-you-type)
• Go to Definition
• Show Documentation
• Refactor->Rename
• Refactor->Extract Method
• Refactor->Extract Variable
• Refactor->Inline Variable
• Refactor->Restructure
• Jump to Global: Shows a list of project globals in a quickview and allows to jump to them.
• Import assist: Looks for possible imports from the project starting with the prefix under the cursor. Will automatically insert the "from X import Z" statement.

Global completion (Important for getting all completions to work)

You can also get completions, auto_import, jump_to_globals, documentation, etc. for modules not under your project root. Simply add them to the list of "autoimport_modules" in your SublimeRope.sublime-settings. Then run the regenerate_modules_cache command from command palette or using your key bindings. Take care, there is also another command, regenerate_cache, which rebuilds the cache just for your project.

NOTICE: Non-trivial / nested modules like numpy will have to be added in the form "numpy.*" or Rope will not index them correctly.

Completions types

ST2 offers three types of completions:

• Word completions (complete from words present on the current buffer)
• Explicit completions (those that you can define in syntax-specific files, such as "Python.sublime-completions")
• Autocompletions from plugins.

Some people prefer to disable the default word and/or explicit completions that ST2 offers while using SublimeRope. This can be achieved by setting either of the following settings to true in SublimeRope.sublime_settings, after copying the settings file to your User directory.

* "suppress_word_completions"
* "suppress_explicit_completions"

The default settings shows SublimeRope and both word and explicit completions.

SublimeRope provides completion suggestions based on the rope library, but also offers a fall-back method if rope suggest nothing. It is called the "simple_module_completion". Albeit it is sometimes useful, it is disabled by default because some people feel that it slows down the plugin too much. If you want to try it, you can enable it by setting "use_simple_completion" to true in the SublimeRope.sublime_settings file.

Simple Completion

This is another, non-Rope-driven, form of completion that can help in some edge cases, but might also slow SublimeRope down. It is disabled by default, but you can enable it your SublimeRope.sublime-settings to see if the performance is ok for you.

Key Bindings

SublimeRope provides no default keybindings at the moment, so you need to set them yourself. The bindings I use:

{ "keys": ["ctrl+r", "ctrl+d"], "command": "goto_python_definition", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python" }
    ]
},
{ "keys": ["ctrl+r", "ctrl+h"], "command": "python_get_documentation", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python" }
    ]
},
{ "keys": ["ctrl+r", "ctrl+r"], "command": "python_refactor_rename", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python" }
    ]
},
{ "keys": ["ctrl+r", "ctrl+e"], "command": "python_refactor_extract_method", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python" }
    ]
},
{ "keys": ["ctrl+r", "ctrl+v"], "command": "python_refactor_extract_variable", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python" }
    ]
},
{ "keys": ["ctrl+r", "ctrl+n"], "command": "python_refactor_inline_variable", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python" }
    ]
},
{ "keys": ["ctrl+r", "ctrl+j"], "command": "python_jump_to_global", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python" }
    ]
},
{ "keys": ["ctrl+r", "ctrl+i"], "command": "python_auto_import", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python" }
    ]
},
{ "keys": ["ctrl+r", "ctrl+c"], "command": "python_regenerate_cache", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python" }
    ]
},
{
    "keys": ["ctrl+r", "ctrl+f"], "command": "python_refactor_restructure", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python"}
    ]
},
{
    "keys": ["ctrl+r", "ctrl+m"], "command": "python_generate_modules_cache", "context":
    [
        { "key": "selector", "operator": "equal", "operand": "source.python"}
    ]
}

Getting all completions to work

NOTICE: The global module cache (autoimport_modules) mechanism described above as "Global completions" is might be a better way to get all completions to work than the PYTHONPATH-driven one described here.

Basically, anything you want completions for has to be on Rope's python path, which you can extend in <PROJECT_DIR>/.ropeproject/config.py.

If you are using virtualenv for your project, add the path to the virtualenv in .ropeproject/config.py (there should be a commented-out line already in the file in set_prefs). UPDATE: the "Rope: New Project" command should do this for you.

prefs.add('python_path', '/Users/ebi/dev/project/lib/python2.7/site-packages/')

Also, if you are not using the same Python as ST2 (e.g. using a custom Python on OSX), add your site-packages, so that ST2 picks them up

prefs.add('python_path', '/usr/local/Cellar/python/2.7.1/lib/python2.7/site-packages')

A special case are Django projects, which use global imports and not relative ones, e.g., in views.py they use "import Project.App.models" and not just "import models". In this case, you project has to be on the Python path as well. Add the parent dir of your project:

prefs.add('python_path', '/Users/ebi/my_django_projects')

Donations

Here you go:

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.