Flamenco/addon
Sybren A. Stüvel 11a352968a Fix T99434: Two-way Variables
Two-way variable implementation in the job submission end-point. Where
Flamenco v2 did the variable replacement in the add-on, this has now
been moved to the Manager itself. The only thing the add-on needs to
pass is its platform, so that the right values can be recognised.

This also implements two-way replacement when tasks are handed out, such
that the `{jobs}` value gets replaced to a value suitable for the
Worker's platform as well.
2022-07-22 11:58:35 +02:00
..
flamenco Fix T99434: Two-way Variables 2022-07-22 11:58:35 +02:00
.openapi-generator-ignore Addon: start of framework for API communication 2022-03-01 17:28:24 +01:00
mypy.ini Addon: Upgrade Python version to 3.10 2022-03-25 14:10:26 +01:00
openapi-generator-cli.jar Proof of concept to test a generated Python OpenAPI client 2022-03-01 17:28:24 +01:00
poetry.lock Addon: Upgrade Python version to 3.10 2022-03-25 14:10:26 +01:00
pyproject.toml Addon: Upgrade Python version to 3.10 2022-03-25 14:10:26 +01:00
README.md Addon: cleanup, prefix TYPE_CHECKING imports with underscores 2022-03-14 16:35:21 +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.