PythonPartTools

This is a VS code extension supporting the creation of Allplan PythonParts.

Features

• support intellisense functionality for the PythonPart parameters.
• add the xxxBuildingElement import to the py file
• create/modify a Python function documentation
• switch between the py and pyp file

Support intellisense functionality for the PythonPart parameters

The PythonPart parameters are defined in the pyp file and are dynamically inserted into the BuildingElement class when the PythonPart is loaded. So they are not directly available when the BuildingElement class is used in the py file.

Using this extension, a xxxBuildingElement.pyi stub file is now created when the xxx.pyp file is opened and saved or the py file is opened. This file can be imported into the py file, which makes the parameters for the Intellisense available.

Add the xxxBuildingElement import to the py file

From the context menu the command "Insert xxxBuildingElement import" can be used to add the needed import of the stub file to the py file.

Create/modify a Python function documentation

From the context menu the command "Create/modify Python function documentation" can be used to create or modify the documentation of a Python function whithin the py file.

Switch between the py and pyp file

From the context menu the command "Switch between the py and pyp file" can be used to switch between the py and pyp within the editor. If the targe file is not open in the editor, it will be opened when switching.