generic ¶
Classes:
-
ClipLengthError
–Raised when a generic clip length error occurs.
-
FormatsMismatchError
–Raised when clips with different formats are given.
-
FormatsRefClipMismatchError
–Raised when a ref clip and the main clip have different formats.
-
FramePropError
–Raised when there is an error with the frame props.
-
FramerateMismatchError
–Raised when clips with a different framerate are given.
-
FramerateRefClipMismatchError
–Raised when a ref clip and the main clip have a different framerate.
-
FramesLengthError
– -
InvalidColorFamilyError
–Raised when the given clip uses an invalid format.
-
InvalidFramerateError
–Raised when the given clip has an invalid framerate.
-
InvalidSubsamplingError
–Raised when the given clip has invalid subsampling.
-
InvalidTimecodeVersionError
–Raised when an invalid timecode version is passed.
-
InvalidVideoFormatError
–Raised when the given clip has an invalid format.
-
LengthMismatchError
–Raised when clips with a different number of total frames are given.
-
LengthRefClipMismatchError
–Raised when a ref clip and the main clip have a different number of total frames.
-
ResolutionsMismatchError
–Raised when clips with different resolutions are given.
-
ResolutionsRefClipMismatchError
–Raised when a ref clip and the main clip have different resolutions.
-
TopFieldFirstError
–Raised when the user must pass a TFF argument.
-
UnsupportedColorFamilyError
–Raised when an undefined color family value is passed.
-
UnsupportedSubsamplingError
–Raised when an undefined subsampling value is passed.
-
UnsupportedVideoFormatError
–Raised when an undefined video format value is passed.
-
VariableFormatError
–Raised when clip is of a variable format.
-
VariableResolutionError
–Raised when clip is of a variable resolution.
ClipLengthError ¶
Bases: CustomOverflowError
Raised when a generic clip length error occurs.
FormatsMismatchError ¶
FormatsMismatchError(
func: FuncExcept,
formats: Iterable[VideoFormatLike | HoldsVideoFormat],
message: SupportsString = "All specified formats must be equal!",
**kwargs: Any
)
Bases: MismatchError
Raised when clips with different formats are given.
Methods:
-
check
–
Source code in vstools/exceptions/generic.py
222 223 224 225 226 227 228 229 |
|
check classmethod
¶
check(
func: FuncExcept,
/,
*formats: VideoFormatLike | HoldsVideoFormat,
**kwargs: Any,
) -> None
Source code in vstools/exceptions/generic.py
233 234 |
|
FormatsRefClipMismatchError ¶
FormatsRefClipMismatchError(
func: FuncExcept,
clip: VideoFormatLike | HoldsVideoFormat,
ref: VideoFormatLike | HoldsVideoFormat,
message: SupportsString = "The format of ref and main clip must be equal!",
**kwargs: Any
)
Bases: MismatchRefError
, FormatsMismatchError
Raised when a ref clip and the main clip have different formats.
Methods:
-
check
–
Source code in vstools/exceptions/generic.py
242 243 244 245 246 247 248 249 250 |
|
check classmethod
¶
check(
func: FuncExcept,
clip: VideoFormatLike | HoldsVideoFormat,
ref: VideoFormatLike | HoldsVideoFormat,
/,
**kwargs: Any,
) -> None
Source code in vstools/exceptions/generic.py
254 255 256 257 258 259 260 261 262 |
|
FramePropError ¶
FramePropError(
func: FuncExcept,
key: str,
message: SupportsString = 'Error while trying to get frame prop "{key}"!',
**kwargs: Any
)
Bases: CustomKeyError
Raised when there is an error with the frame props.
Source code in vstools/exceptions/generic.py
422 423 424 425 426 427 428 429 |
|
FramerateMismatchError ¶
FramerateMismatchError(
func: FuncExcept,
framerates: Iterable[VideoNode | Fraction | tuple[int, int] | float],
message: SupportsString = "All the framerates must be equal!",
**kwargs: Any
)
Bases: MismatchError
Raised when clips with a different framerate are given.
Methods:
-
check
–
Source code in vstools/exceptions/generic.py
372 373 374 375 376 377 378 379 |
|
check classmethod
¶
check(
func: FuncExcept,
/,
*framerates: VideoNode | Fraction | tuple[int, int] | float,
**kwargs: Any,
) -> None
Source code in vstools/exceptions/generic.py
383 384 385 386 |
|
FramerateRefClipMismatchError ¶
FramerateRefClipMismatchError(
func: FuncExcept,
clip: VideoNode | Fraction | tuple[int, int] | float,
ref: VideoNode | Fraction | tuple[int, int] | float,
message: SupportsString = "The framerate of the ref and main clip must be equal!",
**kwargs: Any
)
Bases: MismatchRefError
, FramerateMismatchError
Raised when a ref clip and the main clip have a different framerate.
Methods:
-
check
–
Source code in vstools/exceptions/generic.py
394 395 396 397 398 399 400 401 402 |
|
check classmethod
¶
check(
func: FuncExcept,
clip: VideoNode | Fraction | tuple[int, int] | float,
ref: VideoNode | Fraction | tuple[int, int] | float,
/,
**kwargs: Any,
) -> None
Source code in vstools/exceptions/generic.py
406 407 408 409 410 411 412 413 414 |
|
FramesLengthError ¶
FramesLengthError(
func: FuncExcept,
var_name: str,
message: SupportsString = '"{var_name}" can\'t be greater than the clip length!',
**kwargs: Any
)
Bases: CustomOverflowError
Source code in vstools/exceptions/generic.py
52 53 54 55 56 57 58 59 |
|
InvalidColorFamilyError ¶
InvalidColorFamilyError(
func: FuncExcept | None,
wrong: VideoFormatLike | HoldsVideoFormat | ColorFamily,
correct: (
VideoFormatLike
| HoldsVideoFormat
| ColorFamily
| Iterable[VideoFormatLike | HoldsVideoFormat | ColorFamily]
) = YUV,
message: SupportsString = "Input clip must be of {correct} color family, not {wrong}!",
**kwargs: Any
)
Bases: CustomValueError
Raised when the given clip uses an invalid format.
Methods:
-
check
–Check whether the given values are correct, and if not, throw this exception.
Source code in vstools/exceptions/generic.py
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
|
check staticmethod
¶
check(
to_check: VideoFormatLike | HoldsVideoFormat | ColorFamily,
correct: (
VideoFormatLike
| HoldsVideoFormat
| ColorFamily
| Iterable[VideoFormatLike | HoldsVideoFormat | ColorFamily]
),
func: FuncExcept | None = None,
message: SupportsString | None = None,
**kwargs: Any
) -> None
Check whether the given values are correct, and if not, throw this exception.
Parameters:
-
to_check
¶VideoFormatLike | HoldsVideoFormat | ColorFamily
) –Value to check. Must be either a ColorFamily value, or a value a ColorFamily can be derived from such as VideoFormat.
-
correct
¶VideoFormatLike | HoldsVideoFormat | ColorFamily | Iterable[VideoFormatLike | HoldsVideoFormat | ColorFamily]
) –A correct value or an array of correct color families.
-
func
¶FuncExcept | None
, default:None
) –Function returned for custom error handling. This should only be set by VS package developers.
-
message
¶SupportsString | None
, default:None
) –Message to print when throwing the exception. The message will be formatted to display the correct and wrong values (
{correct}
and{wrong}
respectively). -
**kwargs
¶Any
, default:{}
) –Keyword arguments to pass on to the exception.
Raises:
-
InvalidColorFamilyError
–Given color family is not in list of correct color families.
Source code in vstools/exceptions/generic.py
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
|
InvalidFramerateError ¶
InvalidFramerateError(
func: FuncExcept,
clip: VideoNode | Fraction,
message: SupportsString = "{fps} clips are not allowed!",
**kwargs: Any
)
Bases: CustomValueError
Raised when the given clip has an invalid framerate.
Methods:
-
check
–Check whether the given values are correct, and if not, throw this exception.
Source code in vstools/exceptions/generic.py
448 449 450 451 452 453 454 455 |
|
check staticmethod
¶
check(
func: FuncExcept,
to_check: VideoNode | Fraction | tuple[int, int] | float,
correct: (
VideoNode
| Fraction
| tuple[int, int]
| float
| Iterable[VideoNode | Fraction | tuple[int, int] | float]
),
message: SupportsString = "Input clip must have {correct} framerate, not {wrong}!",
**kwargs: Any
) -> None
Check whether the given values are correct, and if not, throw this exception.
Parameters:
-
to_check
¶VideoNode | Fraction | tuple[int, int] | float
) –Value to check. Must be either a VideoNode holding the correct framerate, a Fraction, a tuple representing a fraction, or a float.
-
correct
¶VideoNode | Fraction | tuple[int, int] | float | Iterable[VideoNode | Fraction | tuple[int, int] | float]
) –A correct value or an array of correct values.
-
func
¶FuncExcept
) –Function returned for custom error handling. This should only be set by VS package developers.
-
message
¶SupportsString
, default:'Input clip must have {correct} framerate, not {wrong}!'
) –Message to print when throwing the exception. The message will be formatted to display the correct and wrong values (
{correct}
and{wrong}
respectively). -
**kwargs
¶Any
, default:{}
) –Keyword arguments to pass on to the exception.
Raises:
-
InvalidFramerateError
–Given framerate is not in list of correct framerates.
Source code in vstools/exceptions/generic.py
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 |
|
InvalidSubsamplingError ¶
InvalidSubsamplingError(
func: FuncExcept,
subsampling: str | VideoFormatLike | HoldsVideoFormat,
message: SupportsString = "The subsampling {subsampling} is not supported!",
**kwargs: Any
)
Bases: CustomValueError
Raised when the given clip has invalid subsampling.
Source code in vstools/exceptions/generic.py
197 198 199 200 201 202 203 204 205 206 207 208 |
|
InvalidTimecodeVersionError ¶
InvalidTimecodeVersionError(
func: FuncExcept,
version: int,
message: SupportsString = "{version} is not a valid timecodes version!",
**kwargs: Any
)
Bases: CustomValueError
Raised when an invalid timecode version is passed.
Methods:
-
check
–Check whether the given values are correct, and if not, throw this exception.
Source code in vstools/exceptions/generic.py
508 509 510 511 512 513 514 515 |
|
check staticmethod
¶
check(
func: FuncExcept,
to_check: int,
correct: int | Iterable[int] = [1, 2],
message: SupportsString = "Timecodes version be in {correct}, not {wrong}!",
**kwargs: Any
) -> None
Check whether the given values are correct, and if not, throw this exception.
Parameters:
-
func
¶FuncExcept
) –Function returned for custom error handling. This should only be set by VS package developers.
-
to_check
¶int
) –Value to check. Must be an integer representing the timecodes version.
-
correct
¶int | Iterable[int]
, default:[1, 2]
) –A correct value or an array of correct values. Defaults to [1, 2] (V1, V2).
-
message
¶SupportsString
, default:'Timecodes version be in {correct}, not {wrong}!'
) –Message to print when throwing the exception. The message will be formatted to display the correct and wrong values (
{correct}
and{wrong}
respectively). -
**kwargs
¶Any
, default:{}
) –Keyword arguments to pass on to the exception.
Raises:
-
InvalidTimecodeVersionError
–Given timecodes version is not in list of correct versions.
Source code in vstools/exceptions/generic.py
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
|
InvalidVideoFormatError ¶
InvalidVideoFormatError(
func: FuncExcept,
format: VideoFormatLike | HoldsVideoFormat,
message: SupportsString = "The format {format.name} is not supported!",
**kwargs: Any
)
Bases: CustomValueError
Raised when the given clip has an invalid format.
Source code in vstools/exceptions/generic.py
101 102 103 104 105 106 107 108 109 110 |
|
LengthMismatchError ¶
LengthMismatchError(
func: FuncExcept,
lengths: Iterable[int | Sized],
message: SupportsString = "All the lengths must be equal!",
**kwargs: Any
)
Bases: MismatchError
Raised when clips with a different number of total frames are given.
Methods:
-
check
–
Source code in vstools/exceptions/generic.py
323 324 325 326 327 328 329 330 |
|
LengthRefClipMismatchError ¶
LengthRefClipMismatchError(
func: FuncExcept,
clip: int | RawNode,
ref: int | RawNode,
message: SupportsString = "The main clip and ref clip length must be equal!",
**kwargs: Any
)
Bases: MismatchRefError
, LengthMismatchError
Raised when a ref clip and the main clip have a different number of total frames.
Methods:
-
check
–
Source code in vstools/exceptions/generic.py
343 344 345 346 347 348 349 350 351 |
|
check classmethod
¶
Source code in vstools/exceptions/generic.py
355 356 357 358 |
|
ResolutionsMismatchError ¶
ResolutionsMismatchError(
func: FuncExcept,
resolutions: Iterable[Resolution | VideoNode],
message: SupportsString = "All the resolutions must be equal!",
**kwargs: Any
)
Bases: MismatchError
Raised when clips with different resolutions are given.
Methods:
-
check
–
Source code in vstools/exceptions/generic.py
276 277 278 279 280 281 282 283 |
|
check classmethod
¶
check(
func: FuncExcept, /, *resolutions: Resolution | VideoNode, **kwargs: Any
) -> None
Source code in vstools/exceptions/generic.py
287 288 |
|
ResolutionsRefClipMismatchError ¶
ResolutionsRefClipMismatchError(
func: FuncExcept,
clip: Resolution | VideoNode,
ref: Resolution | VideoNode,
message: SupportsString = "The resolution of ref and main clip must be equal!",
**kwargs: Any
)
Bases: MismatchRefError
, ResolutionsMismatchError
Raised when a ref clip and the main clip have different resolutions.
Methods:
-
check
–
Source code in vstools/exceptions/generic.py
296 297 298 299 300 301 302 303 304 |
|
check classmethod
¶
check(
func: FuncExcept,
clip: Resolution | VideoNode,
ref: Resolution | VideoNode,
/,
**kwargs: Any,
) -> None
Source code in vstools/exceptions/generic.py
308 309 310 311 |
|
TopFieldFirstError ¶
TopFieldFirstError(
func: FuncExcept,
message: SupportsString = "You must set `tff` for this clip!",
**kwargs: Any
)
Bases: CustomValueError
Raised when the user must pass a TFF argument.
Source code in vstools/exceptions/generic.py
437 438 439 440 |
|
UnsupportedColorFamilyError ¶
Bases: CustomValueError
Raised when an undefined color family value is passed.
UnsupportedSubsamplingError ¶
Bases: CustomValueError
Raised when an undefined subsampling value is passed.
UnsupportedVideoFormatError ¶
Bases: CustomValueError
Raised when an undefined video format value is passed.
VariableFormatError ¶
VariableFormatError(
func: FuncExcept,
message: SupportsString = "Variable-format clips not supported!",
**kwargs: Any
)
Bases: CustomValueError
Raised when clip is of a variable format.
Source code in vstools/exceptions/generic.py
73 74 75 76 |
|
VariableResolutionError ¶
VariableResolutionError(
func: FuncExcept,
message: SupportsString = "Variable-resolution clips not supported!",
**kwargs: Any
)
Bases: CustomValueError
Raised when clip is of a variable resolution.
Source code in vstools/exceptions/generic.py
84 85 86 87 |
|