Python stubs for FreeCAD
Project description
freecad-stubs
Python stubs generated from FreeCAD source code.
Install stubs
You can install all stubs for freeCAD packages by running:
python -m pip install freecad-stubs
If you installed this package,
then you probably develop some FreeCAD components/scripts.
You should remember to set up your IDE by adding path to the real FreeCAD libraries,
especially for modules written mainly in python (ex. Draft
),
because this package does not provide stubs for that module :confused:
(yet - you may contribute).
Also note that App
or Gui
are only aliases available in FreeCAD.
To fully use advantage of stubs
you should always import a module you are referencing
(ex. import FreeCADGui as Gui
).
Generating stubs manually
Package on pypi always has stubs generated for the newest freecad (master branch). If you need older version you may try to install specific version from pypi or manually run a tool from this repository to generate stubs.
Stub source
Stubs are generated based on several available info:
*Py.xml
files - mainly docstrings, argument names, properties.- corresponding
*PyImp.cpp
file - argument types are extracted from C code. - other
*.cpp
files - functions or modules.
Unfortunately not all typing information may be generated.
For example some objects are added dynamically.
There are also many special cases
therefore not all object are correctly mapped.
Moreover, some of C function has errors - invalid types, missing arguments
(you can see more these errors if you change logger flag in configuration file freecad-stubs/lib/freecad_stub_gen/config.py
)
Stub Generation
-
Clone freecad repository.
git clone https://github.com/FreeCAD/FreeCAD.git
Warning: FreeCAD repository has over
1.29 GB
You may download only these required folders:
- /src/App
- /src/Base
- /src/Gui
- /src/Main
- /src/Mod
-
Clone this repository
git clone https://github.com/ostr00000/freecad-stubs
-
Configure paths
In the filefreecad-stubs/lib/freecad_stub_gen/config.py
set desired configuration:SOURCE_DIR
-src
folder from FreeCAD repository,TARGET_DIR
- target folder where stubs should be generated.Warning:
TARGET_DIR
folder and its content may be removed when generating stubs.
-
Run the main file from this project in Python
pytohn freecad-stubs/lib/freecad_stub_gen/__main__.py
Required python version:
>=3.10
.
Adding stubs to python path
At this point stubs must be already generated. There are a lot of possible methods. This is only example:
-
Copy stubs from
TARGET_DIR
to location of your choice. For example:.cp -r ./freecad_stubs "$HOME/.local/lib/python3.9/freecad_stubs"
-
Add location with stubs to python search path. For example:
echo "$HOME/.local/lib/python3.9/freecad_stubs" > "$HOME/.local/lib/python3.9/site-packages/freecad_stubs.pth"
Implementation progress
Stub source
- generate class stub (xml files):
- property in xml,
- dynamic property added in cpp,
- method (+ static/class method),
- rich comparison (ex.
__eq__
method), - number protocol (ex.
__add__
method),
- generate class stub (cpp files):
- dynamically added in
init_type()
,
- dynamically added in
- generate functions stub (cpp files):
- declared in
PyMethodDef
array, - dynamically added in module constructor (subclass
Py::ExtensionModule
),
- declared in
Stub quality
- found class/function/method name,
- copy docstring (+ generate property docstring),
- guess argument names from docstrings,
- found function/method argument types based on c-api,
- function/method return type,
- raised exception in docstrings,
- property getter type,
- property setter type,
- add comment "This class can be imported" for importable classes,
- dynamically generated exceptions,
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for freecad_stubs-1.0.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 273852c91561b622f8110f990c467878f773faa9425efe2616fcd8b6a9281b45 |
|
MD5 | d9d797e81e45c68f964377477e410ff0 |
|
BLAKE2b-256 | c6f7b8b62547a9731a61f9be5a5d58664ca1f955b74f4a7e7c4bd178d379d7d5 |