Skip to content

publish_plugins

CollectPalettesPlugin

Bases: BaseSettingsModel

Set regular expressions to filter triggering on specific task names. '.*' means on all.

Source code in server/settings/publish_plugins.py
 4
 5
 6
 7
 8
 9
10
class CollectPalettesPlugin(BaseSettingsModel):
    """Set regular expressions to filter triggering on specific task names. '.*' means on all."""  # noqa

    allowed_tasks: list[str] = SettingsField(
        default_factory=list,
        title="Allowed tasks"
    )

ExtractConvertToEXRModel

Bases: BaseSettingsModel

WARNING: This plugin does not work on MacOS (using OIIO tool).

Source code in server/settings/publish_plugins.py
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
class ExtractConvertToEXRModel(BaseSettingsModel):
    """WARNING: This plugin does not work on MacOS (using OIIO tool)."""
    enabled: bool = False
    replace_pngs: bool = SettingsField(
        True,
        title="Replace original PNG files",
        description="Remove original PNG files after transcoding to EXR",
    )
    auto_trim: bool = SettingsField(
        True,
        title="Auto Trim",
    )
    exr_compression: str = SettingsField(
        "ZIP",
        enum_resolver=compression_enum,
        title="EXR Compression"
    )
    multichannel_exr: bool = SettingsField(
        False,
        title="Create multichannel EXR",
        description="Merge render passes into a render layer EXR files",
    )
    keep_passes: bool = SettingsField(
        False,
        title="Keep render passes",
        description=(
            "Keep render passes even though multichannel EXR is enabled"
        ),
    )
    user_overrides: list[str] = SettingsField(
        default_factory=list,
        title="User overrides",
        description="Allow user to change the plugin functionality",
        enum_resolver=user_exr_choices,
    )

ValidateAudioPlugin

Bases: BaseSettingsModel

Check if scene contains audio track.

Source code in server/settings/publish_plugins.py
13
14
15
16
17
18
class ValidateAudioPlugin(BaseSettingsModel):
    """Check if scene contains audio track."""  #
    _isGroup = True
    enabled: bool = True
    optional: bool = SettingsField(True, title="Optional")
    active: bool = SettingsField(True, title="Active")

ValidateInstancePlugin

Bases: BaseSettingsModel

Validate if instance folder is the current folder.

Source code in server/settings/publish_plugins.py
46
47
48
49
50
class ValidateInstancePlugin(BaseSettingsModel):
    """Validate if instance folder is the current folder."""
    enabled: bool = True
    optional: bool = SettingsField(False, title="Optional")
    active: bool = SettingsField(True, title="Active")

ValidateSceneSettingsPlugin

Bases: BaseSettingsModel

Validate if FrameStart, FrameEnd and Resolution match shot data in DB. Use regular expressions to limit validations only on particular folder or task names.

Source code in server/settings/publish_plugins.py
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class ValidateSceneSettingsPlugin(BaseSettingsModel):
    """Validate if FrameStart, FrameEnd and Resolution match shot data in DB.
       Use regular expressions to limit validations only on particular folder
       or task names."""
    _isGroup = True
    enabled: bool = True
    optional: bool = SettingsField(False, title="Optional")
    active: bool = SettingsField(True, title="Active")

    frame_check_filter: list[str] = SettingsField(
        default_factory=list,
        title="Skip Frame check for Folder Paths with name containing"
    )

    skip_resolution_check: list[str] = SettingsField(
        default_factory=list,
        title="Skip Resolution Check for Tasks"
    )

    skip_timelines_check: list[str] = SettingsField(
        default_factory=list,
        title="Skip Timeline Check for Tasks"
    )