Sybren A. Stüvel 4ef5373756 Add-on: add support for the use_all_linked_data_direct option
Add support for Blender's `use_all_linked_data_direct` experimental
option. This is a workaround for an issue with BAT, for which a quick
solution is required by the Blender Studio (production crunch).

Flamenco writes the `.flamenco.blend` file with
`preferences.experimental.use_all_linked_data_direct` set to `True`, so
that BAT has an easier time finding linked assets.
2022-12-02 14:31:23 +01: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.