Autocomplete while editing python scripts outside of Rhino

stevebaer · October 4, 2019, 11:39pm

@eirannejad do you have any experience with using the __all__ syntax in the pyi files? I’m looking to update the stubs with the latest set of RhinoCommon changes and was wondering if I should tackle this at the same time.

eirannejad · October 5, 2019, 12:43am

I have used __all__ in python modules but not in .pyi files. It should be fine tho. It basically controls what is exported from a module. Let’s add and test in VSCode.

@Willem Out of curiosity, does the auto-complete feel faster after the addition of __all__?

stevebaer · October 5, 2019, 2:02am

Sounds good, I’m tweaking the stubbler application to include __all__ when generating the stubs. I’m also adding some functionality to skip methods marked as Obsolete in .NET so you get a better autocomplete list.

stevebaer · October 5, 2019, 6:20am

Ok; I updated the packages on PyPi.org. See if these new ones work for you. If they don’t I can adjust and upload a different version

nathancoatney · October 12, 2019, 7:51pm

@stevebaer: I’m trying out visual studio code with this. I am trying to mimic importing scriptcontext as I haven’t found a way to do this with the stubb module alone, so I am making a scriptcontext.py living in the project folder. I’m mostly just after the doc object and it’s tables, so the file content is simple:

import Rhino

doc = Rhino.RhinoDoc()

Then in the script I can do the regular import:

import scriptcontext as sc

Which will also work when hosted in Rhino.

However, VSCode doesn’t seem to pick up the tables of the doc. In the __init__.py file, the Rhinodoc class has these as properties (the object table for example):

@property
def Objects(self) -> ObjectTable: ...

But (at least my) VSCode doesn’t know what an ObjectTable is so the return type is lost. I found that if I import Rhino at the top of __init__.py, and then put the return type as:

@property
def Objects(self) -> Rhino.DocObjects.Tables.ObjectTable: ...

Then VSCode is auto-completing the object table in my script.

Do you think this could be included in the stubb generator for all Rhinodoc tables (or maybe all Rhino return types, I don’t think VSCode knows what any of them are)?

Thanks.

Nathan

meowzeezee · November 7, 2019, 8:05am

Hi, there is a question that are there any ways to use pycharm for editing RhinoPython and keep pycharm and rhino interlocked?

dadandroid · April 17, 2021, 6:56pm

hi @stevebaer @eirannejad, It´s been a while since I use the stubs… are they supposed to work with the latest versions of python? I can´t manage to get any autocomplete in VS Code with ver 3.9. If not, which version do you recommend I use? Thanks!

stevebaer · April 18, 2021, 4:14pm

Hey David; I also haven’t touched this library for a long time. They should work with 3.9

matthias2 · April 19, 2021, 2:54pm

I can confirm that I cannot get autocompletion to work in VSCode. Current anaconda 3 (python 3.8.5), Rhino-Stubs installed but not working unfortunately.

edit: could it be that the stubs are not using the right syntax for VSCode ?
see List comprehension in __all__ definition hides module members · Issue #289 · microsoft/pylance-release · GitHub
by renaming the folder from “Rhino-Stubs” to “Rhino” and editing the __init__.pyi to include

from .Geometry import *
from .Collections import *
from .Commands import *
from .Display import *

etc…
before the line
__all__ = ['ApplicationSettings','Collections','Commands','Display','DocObjects','FileIO','Geometry','Input','NodeInCode','PlugIns','Render','Runtime','UI']

I got autocompletion to work. Seems like these files need to be updated or I don’t get it. I don’t know if this is a clean solution or not as I am literally just starting out using VSCode and Python.

Thanks for your help!

t.ho · May 18, 2021, 12:49am

@stevebaer I have successfully loaded Rhino/GH python stubs in VSCode by doing a few minor tweaks.
Check out branch: /fixed-stubs-for-vscode-RH_7.2.21012
Hope it helps everyone

Issues-Causes:

Empty classes cause an issue and prevent loading of the entire stub file
VS Code does not detect folders with postfix -stubs, as confirmed by @matthias2

Solution:

Add “pass” to empty classes

...
class SurfaceProxy(Surface):
    pass # added for empty classes


class SweepOneRail:
    def __init__(self): ...
...

Remove postfix in build script.
Once done, add those paths into “python.analysis.extraPaths”

"python.analysis.extraPaths": [
    "pythonstubs\\stubs\\Eto",
    "pythonstubs\\stubs\\GH_IO",
    "pythonstubs\\stubs\\GH_Util",
    "pythonstubs\\stubs\\Grasshopper",
    "pythonstubs\\stubs\\Rhino"
]

t.ho · May 18, 2021, 1:04am

Usually I import them individually to make the autocomplete work without modifying the stubs.
At least until the stubs files gets an update @stevebaer

import Rhino
import Rhino.Geometry # child namespace
import Rhino.Commands # child namespace
import Rhino.Display # child namespace
import Rhino.Collections # child namespace

I’m not sure what is the best solution to this, but the autocomplete doesn’t seem to pickup the namespaces inside __all__ in VS Code

I found that it works in VS Code by importing submodules in __init__.py files:

from . import <childnamespace>

stevebaer · May 22, 2021, 4:59am

Thanks Tony, I’ll try to take a look at your github pull request on this soon

kitjmv · May 22, 2021, 4:42pm

Hello,

It is possible to complete Rhino3dm’s PYI, more exactly all iterable objects break type annotations.
Such as File3dmObjectTable or Iterable[...]
jmv

Alexander_Jacobson · July 9, 2021, 1:19pm

@stevebaer I wanted to add to this thread to say that I’ve also successfully started using the stubs in Sublime Text 4. Thanks for making the stubs!

For anyone else who wants to use Sublime Text:
Steps are:

Install Sublime Text 4 (This is an amazing text editor, but it doesn’t have python autocomplete out of the box)
From inside Sublime text, install the Sublime Text Package Manager (This is an installation utility that allows you to acquire a package that does autocomplete)
Install the Sublime Text Anaconda Package (Anaconda has autocomplete for python… but don’t be confused. This is not the same thing as the Anaconda Python distribution).
Now test that autocomplete works for standard python. For example type the following:

testList = ['foo','ham','eggs']
test.a

You should see ‘append’ as a suggestion because testList is a list. You will not yet be able to get autocomplete for Rhino Common though…for this I needed to get the stubs Steve made.

Edit: Note, when setting this up on a new machine the autocomplete did not work until I had installed Python 2.7.16 and then restarted the machine. So, if the autocomplete is not working yet, just continue until step 3 in the following list!

To get the stubs:

Install python 2.7.16
Add C:\Python27 to the system path variable
Add C:\Python\Scripts to the system path variable
Open the command line
run ‘python -m pip install Rhino-stubs’ ( more info here Rhino-stubs · PyPI)
In the Sublime Text Menus, go to project / Add folder to project…
Select the folder that contains the Rhino stubs, for me this was:
C:\Python27\Lib\site-packages\Rhino-stubs

To get Rhino script syntax to autocomplete:

In the Sublime Text Menus, go to project / Add folder to project…
2.Add this folder, but you’ll need to change the username, and the number in parenthesis after IronPython will also change: C:\Users\Alexanderj\AppData\Roaming\McNeel\Rhinoceros\7.0\Plug-ins\IronPython (814d908a-e25c-493d-97e9-ee3861957f49)\settings\lib

Autocomplete is working for Rhino common:

Some notes on what didn’t work:
I tried to get this to work with Jedi alone because at first glance Jedi appeared to support Python 2.7:

However using Jedi 0.18.0 I got nothing but errors, mostly Lookup errors and type encoding errors that suggested the python versions weren’t compatible.

… then I spotted a note in the Anaconda python package for Sublime Text saying that Jedi is dropping support for Python 2.7.

(Anaconda turns your Sublime Text 3 in a full featured Python development IDE including autocompletion, code linting, IDE features, autopep8 formating, McCabe complexity checker Vagrant and Docker support for Sublime Text 3 using Jedi, PyFlakes, pep8, MyPy, PyLint, pep257 and McCabe that will never freeze your Sublime Text 3 Releases(v2.2.0)/ )) …

Next I realized Jedi is the autocomplete that ships with the Sublime Text Anaconda package. (Don’t be confused with the homonymous Anaconda python distribution, Anaconda is installed through the package manager in Sublime text.)

So, it looks like this solution will be deprecated after the next release of the Anaconda package, but at least it works for the moment.

Alexander_Jacobson · August 16, 2021, 5:41pm

Also, here is how to set up a Grasshopper canvas to run a python file created in Sublime. Just point the PathToPython file path to the python file on your disk by right-clicking the path and say ‘select one file’.

Note that the File component needs to be set to ‘Total File’, so leave ‘Per Line’ unchecked, as below:

Right-click on the ghPython component and select ‘Show Code Input Paramter’ to expose the correct input.

TestPythonRunCode.gh (8.7 KB)

t.ho · June 9, 2023, 6:30am

What issue are you having ?
I currently have it working with the version of the following:

Python 3.8
VS Code 1.79 - latest
Python (vscode extension) v2023.10.0 - latest
Rhino-stubs 7.7.21140 - latest

mondoleo · April 12, 2024, 1:26pm

Thank you!

pip install --user --upgrade Rhino-stubs

is what finally worked for me and it did take a long time of searching and experimenting to make autocomplete to work with VS Code. This also augments the coursera class:

University of Michigan - Design Computing: 3D Modeling in Rhinoceros with Python/Rhinoscript

The teacher does a great job of demonstrating and explaining Python / Rhinoscript; however, it does omit the use of VS Code, but the Rhino script editor is great on its own