acf721c6d8
When Flamenco 3 was just released, it was important to indicate the difference between the Flamenco 2 panel (which was just labeled "Flamenco"), and the new Flamenco 3 panel. The release of v3.0 was almost two years ago, so it's time to remove the "3" from the titles and just name things "Flamenco".
32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
# Flamenco Blender add-on
|
|
|
|
## Setting up development environment
|
|
|
|
```
|
|
~/workspace/blender-git/build_linux/bin/3.1/python/bin/python3.9 -m venv --upgrade-deps venv
|
|
. ./venv/bin/activate
|
|
pip install poetry
|
|
poetry install
|
|
```
|
|
|
|
## Generating the OpenAPI client
|
|
|
|
1. Make sure Java is installed (so `java --version` shows something sensible).
|
|
2. In the root directory of the repository, run `make generate-py`
|
|
|
|
|
|
## Type annotations and lazy imports
|
|
|
|
This add-on tries to only load Python packages from wheel files when necessary. Loading things from wheels is tricky, as they basically pollute the `sys.modules` dictionary and thus can "leak" to other add-ons. This can cause conflicts when, for example, another add-on is using a different version of the same package.
|
|
|
|
The result is that sometimes there are some strange hoops to jump through. The most obvious one is for type annotations. This is why you'll see code like:
|
|
|
|
```
|
|
if TYPE_CHECKING:
|
|
from .bat_interface import _PackThread
|
|
else:
|
|
_PackThread = object
|
|
```
|
|
|
|
This makes it possible to declare a function with `def func() -> _PackThread`, without having to load `bat_interface` immediately at import time.
|