Warning

This documentation is actively being updated as the project evolves and may not be complete in all areas.

Exceptions

API Reference

exception jumpstarter.common.exceptions.ArgumentError(message: str)

Raised when a cli argument is not valid.

exception jumpstarter.common.exceptions.ConfigurationError(message: str)

Raised when a configuration error exists.

exception jumpstarter.common.exceptions.ConnectionError(message: str)

Raised when a connection to a jumpstarter server fails.

exception jumpstarter.common.exceptions.EnvironmentVariableNotSetError(message: str)

Raised when a environment variable is not set.

exception jumpstarter.common.exceptions.FileAccessError(message: str)

Raised when a file access error occurs.

exception jumpstarter.common.exceptions.FileNotFoundError(message: str)

Raised when a file is not found.

exception jumpstarter.common.exceptions.JumpstarterException(message: str)

Base class for jumpstarter-specific errors.

This class should not be raised directly, but should be used as a base class for all jumpstarter-specific errors. It handles the __cause__ attribute so the jumpstarter errors could be raised as

raise SomeError("message") from original_exception

exception jumpstarter.common.exceptions.MissingDriverError(message: str, class_path: str)

Raised when a driver module is not found but should be handled gracefully.

This exception is raised when a driver client class cannot be imported, but the connection should continue with a stub client instead of failing.

exception jumpstarter.common.exceptions.ReauthenticationFailed(message: str)

Raised when a re-authentication fails.