PathSettings

Qualified name: algan.settings.path\_settings.PathSettings

class PathSettings(cache_directory='/home/runner/.algan/cache', output_root=<factory>, output_directory='algan_outputs', output_filename=<factory>, ffmpeg_binary=None)

Bases: Settings

Runtime-adjustable content-cache and output paths.

Output resolution is output_root / output_directory / name for a bare filename; a path with a directory in it is used exactly as supplied.

ALGAN_HOME and the Taichi offline-cache path are initialization-only environment configuration. cache_directory remains public because Algan’s content caches are consulted lazily and can safely move at runtime.

Parameters:

• cache_directory (str)

• output_root (str)

• output_directory (str)

• output_filename (str)

• ffmpeg_binary (str | None)

ffmpeg_binary

Path to the FFmpeg executable video encoding runs. Defaults to None, meaning Algan picks one: the FFMPEG_BINARY environment variable if set, else moviepy’s configured binary (often imageio-ffmpeg’s static build, which carries no NVENC encoders), else ffmpeg on the PATH. Setting it pins that choice – useful when the build moviepy found lacks a codec the system FFmpeg has.

Type:

str | None

Methods

set_cache_directory	Set 'cache_directory', or return a modified preset copy.
set_ffmpeg_binary	Set 'ffmpeg_binary', or return a modified preset copy.
set_output_directory	Set 'output_directory', or return a modified preset copy.
set_output_filename	Set 'output_filename', or return a modified preset copy.
set_output_root	Set 'output_root', or return a modified preset copy.

Attributes

cache_directory
ffmpeg_binary
is_preset
output_directory
output_root
output_filename

set_cache_directory(value)

Set ‘cache_directory’, or return a modified preset copy.

set_ffmpeg_binary(value)

Set ‘ffmpeg_binary’, or return a modified preset copy.

set_output_directory(value)

Set ‘output_directory’, or return a modified preset copy.

set_output_filename(value)

Set ‘output_filename’, or return a modified preset copy.

set_output_root(value)

Set ‘output_root’, or return a modified preset copy.