Skip to content

exceptions ¤

ONE_TIMESTAMP_MODE_ERROR module-attribute ¤

ONE_TIMESTAMP_MODE_ERROR = (
    "exactly one of 'start' or 'frame_timestamps' must be provided"
)

ExtractorError ¤

Bases: NominalError

Raised when the extractor contract is violated (missing input, wrong output count, ...).

Exported as nominal.experimental.extractor.ExtractorError, which is where authors meet it.

HeaderConflictError ¤

Bases: NominalError

A header provider attempted to override an explicit request header.

LegacyVideoDeprecationWarning ¤

Bases: DeprecationWarning

Emitted by the legacy standalone-video API, superseded by video channels on a dataset.

Subclasses DeprecationWarning so it can be filtered on its own without muting every other deprecation, e.g. warnings.filterwarnings("ignore", category=LegacyVideoDeprecationWarning).

NominalAlreadyExistsError ¤

Bases: NominalError

The resource being created already exists (e.g. a container image tag already registered).

NominalAuthenticationError ¤

Bases: NominalError

The request was not authenticated (missing, expired, or invalid credentials).

NominalChecklistNotPublishedError ¤

Bases: NominalError, ValueError

The requested checklist version has not been published.

Also a ValueError so pre-existing except ValueError callers keep working.

NominalComputeError ¤

Bases: NominalError

An error occurred during a compute request.

NominalConfigError ¤

Bases: NominalError

An error occurred reading or writing the configuration.

NominalContainerImageError ¤

Bases: NominalError

A containerized extractor's container image is in a failed or unusable state.

NominalError ¤

Bases: Exception

Base class for Nominal exceptions.

NominalIngestError ¤

Bases: NominalError

An error occurred during ingest.

NominalIngestFailed ¤

Bases: NominalIngestError

The ingest failed.

NominalIngestMultiError ¤

NominalIngestMultiError(
    rids_to_errors: Mapping[str, NominalIngestError],
)

Bases: NominalError

Error(s) occurred during ingest.

errors: A mapping of dataset RIDs to the errors that occurred during ingest.

errors instance-attribute ¤

errors = rids_to_errors

NominalIngestTimeout ¤

Bases: NominalIngestError

Ingest did not reach a terminal state before the caller's deadline.

NominalIngestUploadFailed ¤

Bases: NominalError, ExceptionGroup

One or more files in an ingest batch failed to upload; nothing was ingested.

Each member exception names the file it belongs to and carries the underlying failure as its __cause__.

NominalInvalidArgumentError ¤

Bases: NominalError

The server rejected the request as malformed or invalid.

NominalMethodRemovedError ¤

NominalMethodRemovedError(
    original_method: str, instructions: str | None = None
)

Bases: NominalError

An error raised when a method has been deprecated and now removed. Error informs users of the new method to use instead.

NominalMultipartUploadError ¤

Bases: NominalError

A single failed multipart upload attempt.

NominalMultipartUploadFailed ¤

Bases: NominalError, ExceptionGroup

The multipart upload failed after retries.

NominalNotFoundError ¤

Bases: NominalError

The requested resource does not exist.

NominalParameterRemovedError ¤

NominalParameterRemovedError(
    method_name: str,
    parameter_name: str,
    instructions: str | None = None,
)

Bases: NominalError

An error raised when an parameter has been deprecated and now removed.

NominalPermissionDeniedError ¤

Bases: NominalError

The caller is authenticated but not authorized for the requested resource.

NominalRequestThrottledError ¤

Bases: NominalError

The server throttled a request for longer than the caller's retry budget allowed.

NominalVideoFileMetadataError ¤

Bases: NominalError, ValueError

A video file lacks the segment metadata needed to re-ingest it elsewhere.

Also a ValueError so pre-existing except ValueError callers keep working.

NominalVideoScaleModeError ¤

NominalVideoScaleModeError(
    message: str = "Expected at most one of 'ending_timestamp', 'true_frame_rate', and 'scale_factor' to be present",
)

Bases: NominalError, ValueError

More than one way of scaling a video's playback rate was given; at most one is allowed.

ending_timestamp, true_frame_rate, and scale_factor express the same quantity three ways. Also a ValueError, which is what this raised before the type existed.

NominalVideoStreamError ¤

Bases: NominalError

An error occurred during live video streaming.

NominalVideoStreamNotOpenError ¤

NominalVideoStreamNotOpenError()

Bases: NominalVideoStreamError

The video stream is not open. Call open() first or use as a context manager.

NominalVideoTimestampModeError ¤

NominalVideoTimestampModeError(message: str = ONE_TIMESTAMP_MODE_ERROR)

Bases: NominalError, ValueError

Neither or both of a video's timestamp modes were provided; exactly one is required.

Also a ValueError, which is what these call sites raised before this type existed, so except ValueError keeps working.

The default message names the two modes every video surface offers. The one surface that accepts a third, _build_video_file_timestamp_manifest, passes its own.