BPY Stub Generator
The main usage of the program is to create Python API stubs from the documentation generated during the build process of Blender or UPBGE so that an IDE can provide autocompletion support and type hints for relevant modules like
There are already a number of tools created with a similar goal in mind, notably fake-bpy-module which can be a good alternative to this project.
However, bpystubgen has a few advantages over the others:
- It's very fast - Some of those tools may take over an hour to generate the entire stubs for Blender. But bpystubgen can do it under a minute (1,593 source documents).
- The generated stub modules preserve most of the source documentation, so you can use them as a manual as well.
- It generates PEP-561 compliant stub modules, so it's safe to include them in your runtime module path.
- Along with its fast execution speed, the project also provides well-organised API and test suites to make it easier to fix bugs or improve the output quality.
The library can be installed using
pip as follows:
$ pip install bpystubgen
If you want to generate the API stubs yourself, you can use
bpystubgen module which can be invoked with the following options:
$ python -m bpystubgen -h
usage: bpystubgen [-h] [--verbose] [--quiet] input output
Generate Python API stubs from Blender documentation.
input Source directory where *.rst files are located
output Output directory where generated modules will be saved
-h, --help show this help message and exit
--verbose Print debug messages
--quiet Print only error messages
If you just want to use the API stubs, you can install them from PyPI without having to generate them yourself.
There are two variants of the API stubs, one for Blender and the other for UPBGE. For Blender, you can install
blender-stubs module with appropriate version qualifier as follows:
$ pip install blender-stubs==2.93.*
This will install the latest module for Blender 2.93, and for now stubs are provided for Blender 2.80 and onwards. You can also specify the next unreleased version as
3.0.* to get the latest snapshot of the module.
As for UPBGE, stubs are available for the upcoming 0.3 release, which you can install as follows:
$ pip install upbge-stubs==0.3.*
You can also install it using
Pipenv. Note that it is required to set
allow_preleases option in case the target application has no stable release (i.e. UPBGE 0.3 branch). You can use the following content as a template for your
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true
"upbge-stubs" = "==0.3.*"
python_version = "3.9"
allow_prereleases = true
Also, it would be more correct to use
[dev-packages] instead of
[packages], in which case you can install or update the stubs using the
-d flag like
pipenv update -d.