Sybren A. Stüvel 242ed119ab Eval-on-submit job settings: improve GUI in the add-on
Improve the usability of the 'eval-on-submit' toggle button:

- Add a placeholder text that can be shown instead of the input field. This
  can be used to describe what the evaluated Python code will do. In the
  case of the 'Simple Blender Render' job, this is set to 'Scene frame
  range'.
- Change the way in which the job type has to declare this, both for
  clarity and to add the extra placeholder string
2023-07-13 14:44:24 +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.