Python Completion and GotoDefinition plugin using Rope

[jeberius]

Hello everyone,

I started porting my TextMate bundle RopeMate to ST2. It integrates the python refactoring/completion library Rope (http://rope.sourceforge.net/) into ST2 to enable python auto-completion and Goto-Definition. Testers welcome!

https://github.com/JulianEberius/SublimeRope

Just unzip/git clone the folder SublimeRope into the Packages directory. Single-file completion works instantly, for project-wide completion you need minimal configuration (see README for details).

I'm looking forward to feedback!

p.s.: Don't despair if the first completion on a new project takes long, just wait a moment. Rope indexes the project and stores the information, so subsequent completions should be fast.

Edit:
The package has been updated. Apart from various fixes to completion and GotoDefinition it also has new features:
- "Rope: New Project" command added to the command palette to help with project setup
- "Rope: Show Documentation" command, which shows the docstring of the word under the cursor
- "Rope Refactor: Rename" command now works quite well (project-wide renaming)

[squ1b3r]

Hi, it's great idea!

I used Rope when I used emacs.

Keep it up!

[rspeer]

This sounds great. However, when I have SublimeRope in my packages directory, pressing ctrl+spacebar makes Sublime hang. Endless spinning beachball.

I may be doing something unexpected, in that I use Sublime to open individual files from the command line, not projects. I assumed the point of the .ropeproject was so that it could find the project root anyway. Does whether I'm in a project affect anything?

[erix]

Good luck. Looking forward to next release.

[ggayan]

Any plans on doing something with pysmell?

I think that it works better than rope in terms of autocompletion (using django).

Maybe I could help developing a plugin for pysmell based on yours.

Great work anyway!

Cheers

[jeberius]

@ggayan:
I played around with it, but I still like Rope better (don't have to update tags, refactoring options etc.)
I attach my version of "SublimeSmell" so you can improve it if you want. I'll stick with Rope.
Concerning Django: for me it works with Django. Remember that Sublime Text 2 may not use the same Python version as you (e.g. on OSX, it uses the system 2.6), so you may have to add your Django installation to the python_path in .ropeproject/config.py.
As written in the documentation, in my case I add

Code: Select all

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

So that ST2 picks up my 2.7 packages.
Then I add the parent dir of my project dir, because the imports in Django include the root package of the project (they don't use relative imports).
Basically, just make sure that everything you want to see completed is on the python path using config.py.

E.g.

Code: Select all

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

Then Rope completes everything for me, both Django and my Django code.

@rspeer
I think its a performance problem with Rope. If there are a lot of packages Rope will have to index them all, which takes a long time. I also had the same problem when working with "from X import *" on big modules, e.g., PyObjc. Every completion would take ~12 seconds, as Rope would always index the complete Objective-C/Cocoa API and not cache anything (for some reason). In the current version I disabled star imports in Rope, so it works for me.
In your case, try to use it in some project dir, not in your package dir and see if the problem persists.

edit: I have updated the documentation on GitHub to explain the issues with Rope and the Python path.

[ggayan]

great, thanks!

probably i didn't made the right configuration with rope; I'll give it another change.

I'll be glad to contribute if you need to, my github user is ggayan

Keep up the good work!

[jeberius]

The package has been updated. Apart from various fixes to completion and GotoDefinition it also has new features:

- "Rope: New Project" command added to the command palette to help with project setup
- "Rope: Show Documentation" command, which shows the docstring of the word under the cursor
- "Rope Refactor: Rename" command now works quite well (project-wide renaming)

With ShowDocumentation, GoToDefinition and Rename (+completions) Sublime Text almost becomes a Python IDE

[ask]

Great, many thanks, with rope power, sublime becomes really useful for me.

[pakeha]

Hey! I am new to ST2. I just installed this plugin and it seems very useful so far.

Question: why is it that this plugin works when I place it in my 'Packages' directory (relative to the ST2 directory), but not when I put it in 'Packages/User' ? I suspect that this question applies more generally to ST2 rather than just this plugin; in saying that, I've otherwise been fine installing packages to 'Packages/User'. Mac OS X Lion.

Thanks.