Sybren A. Stüvel 2215ed2d85 Add-on: load all BAT submodules in one go
Adjust the loading of BAT from a wheel file in such a way that all
submodules are loaded in one go. This ensures that they're still
isolated from the rest of Blender (so other add-ons won't find our BAT),
but not from each other (so that there is only one copy of each
submodule).

In practice, this solves an issue where calling
`blender_asset_tracer.blendfile.set_strict_pointer_mode(False)` had no
effect. This was caused by each loaded submodule having a different copy
of `blendfile`.

Also loaded modules are logged more explicitly (at INFO level) to aid in
debugging later on.
2022-07-12 17:30:18 +02:00
..
2022-03-25 14:10:26 +01:00

Flamenco 3 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.