editorial_creators

class RepresentationAdvancedItemModel(BaseSettingsModel):
    """Representation advanced settings.

    Configuration used for filtering rules so files in folder are converted to
    publishable representations with correct data definitions.
    """

    name: str = SettingsField(title="Name", default="")
    content_type: str = SettingsField(
        "video",
        title="Content type",
        enum_resolver=get_content_type_enum,
    )
    extensions: list[str] = SettingsField(
        title="Filter by extensions",
        default_factory=list,
        description=(
            "Only files with these extensions will be published. "
            "following are accepted: .ext, ext, EXT, .EXT"
        ),
        section="Filtering options",
    )
    patterns: list[str] = SettingsField(
        title="Filter by patterns",
        default_factory=list,
        description=(
            "Regular expression patterns to filter files. "
            "Search in filenames for matching files."
        ),
    )
    tags: list[str] = SettingsField(
        default_factory=list,
        title="Tags",
        description=(
            "Tags that will be added to the created representation."
            "\nAdd *review* tag to create review from the transcoded"
            " representation instead of the original."
        ),
        section="Representation options",
    )
    custom_tags: list[str] = SettingsField(
        title="Custom tags",
        default_factory=list,
        description=(
            "Additional custom tags can be used for advanced filtering "
            "in Extract Review output presets."
        ),
    )

class ShotHierarchySubmodel(BaseSettingsModel):
    """Shot Hierarchy Info

    Shot Hierarchy defines the folder path where each shot will be added.
    It uses the `Folder path template` to compute each path.
    The `Folder path template` supports tokens defined in the `folder path template tokens` setting.

    - Each token in the `Folder path template` represents a folder in the hierarchy.
    - Each token's value supports both the available
    [template keys](https://ayon.ynput.io/docs/admin_settings_project_anatomy#available-template-keys)
    and tokens defined under `Clip Name Tokenizer`.
    """
    enabled: bool = True
    parents_path: str = SettingsField(
        "",
        title="Folder path template"
    )
    parents: list[TokenToParentConvertorItem] = SettingsField(
        default_factory=TokenToParentConvertorItem,
        title="Folder path template tokens"
    )

class ShotRenameSubmodel(BaseSettingsModel):
    """Shot Rename Info

    When enabled, any discovered shots will be renamed based on the `shot rename template`.

    The template supports both the available
    [template keys](https://ayon.ynput.io/docs/admin_settings_project_anatomy#available-template-keys)
    and tokens defined under `Clip Name Tokenizer`.
    """
    enabled: bool = True
    shot_rename_template: str = SettingsField(
        "",
        title="Shot rename template"
    )