Class CropValue

scenedetect/_cli/config.py:150–194

Validator for crop region defined as X0 Y0 X1 Y1.

class CropValue(ValidatedValue):
    """Validator for crop region defined as X0 Y0 X1 Y1."""

    _IGNORE_CHARS = (",", "/", "(", ")")
    """Characters to ignore."""

    def __init__(self, value: "str | tuple[int, int, int, int] | CropValue | None" = None):
        self._crop: tuple[int, int, int, int] | None = None
        if isinstance(value, CropValue):
            self._crop = value._crop
        elif value is None:
            return
        else:
            crop: tuple[int, ...] = ()
            if isinstance(value, str):
                translation_table = str.maketrans(
                    {char: " " for char in ScoreWeightsValue._IGNORE_CHARS}
                )
                values = value.translate(translation_table).split()
                crop = tuple(int(val) for val in values)
            elif isinstance(value, tuple):
                crop = value
            if not len(crop) == 4:
                raise ValueError("Crop region must be four numbers of the form X0 Y0 X1 Y1!")
            if any(coordinate < 0 for coordinate in crop):
                raise ValueError("Crop coordinates must be >= 0")
            (x0, y0, x1, y1) = crop
            self._crop = (min(x0, x1), min(y0, y1), max(x0, x1), max(y0, y1))

    @property
    def value(self) -> tuple[int, int, int, int] | None:
        return self._crop

    def __str__(self) -> str:
        if self._crop is None:
            return "(none)"
        x0, y0, x1, y1 = self._crop
        return f"[{x0}, {y0}], [{x1}, {y1}]"

    @staticmethod
    def from_config(config_value: str, default: "CropValue") -> "CropValue":
        try:
            return CropValue(config_value)
        except ValueError as ex:
            raise OptionParseFailure(f"{ex}") from ex


class ScoreWeightsValue(ValidatedValue):