Python stubs for FreeCAD
Project description
freecad-stubs
Python stubs generated from FreeCAD source code.
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 for 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
)
Install stubs
You can install all stubs for freeCAD packages by running:
python -m pip install freecad-stubs
Adding stubs to python path
There are a lot of possible methods. This is only example:
-
Copy stubs from a desired branch from this repository.
Checkout to desired branch and copy folder/freecad_stubs
. -
(Optional) Or generate stubs manually. Copy/move generated stubs 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"
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/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
.
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,
- property getter type,
- property setter type,
- add comment "This class can be imported" for importable classes,
- 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.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 989fb9ce1c5ede7a3662558c89852f23891907bd7e73e8f08012a733d1981b5c |
|
MD5 | 279e8275dcb8da4e00a2dcb28621125a |
|
BLAKE2b-256 | 6b41236e78034413d66ca5016e897cdee1931345a06382e36e1117043c2e7f30 |