Exceptions
zenml.exceptions
ZenML specific exception definitions.
Classes
ArtifactStoreInterfaceError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raises exception when interacting with the Artifact Store interface in an unsupported way.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
AuthorizationException(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when an authorization error occurred while trying to access a ZenML resource .
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
BackupSecretsStoreNotConfiguredError
Bases: NotImplementedError
Raised when a backup secrets store is not configured.
CredentialsNotValid(message: Optional[str] = None, url: Optional[str] = None)
Bases: AuthorizationException
Raised when the credentials provided are invalid.
This is a subclass of AuthorizationException and should only be raised when the authentication credentials are invalid (e.g. expired API token, invalid username/password, invalid signature). If caught by the ZenML client, it will trigger an invalidation of the currently cached API token and a re-authentication flow.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
CustomFlavorImportError
Bases: ImportError
Raised when failing to import a custom flavor.
DoesNotExistException(message: str)
Bases: ZenMLBaseException
Raises exception when the entity does not exist in the system but an action is being done that requires it to be present.
Initializes the exception.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message
|
str
|
Message with details of exception. |
required |
Source code in src/zenml/exceptions.py
64 65 66 67 68 69 70 |
|
Functions
EntityCreationError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
, RuntimeError
Raised when failing to create an entity.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
EntityExistsError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when trying to register an entity that already exists.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
GitNotFoundError
Bases: ImportError
Raised when ZenML CLI is used to interact with examples on a machine with no git installation.
HydrationError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when the model hydration failed.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
IllegalOperationError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when an illegal operation is attempted.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
InitializationException(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when an error occurred during initialization of a ZenML repository.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
InputResolutionError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when step input resolving failed.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
IntegrationError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raises exceptions when a requested integration can not be activated.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
MaterializerInterfaceError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raises exception when interacting with the Materializer interface in an unsupported way.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
MaxConcurrentTasksError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when the maximum number of concurrent tasks is reached.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
MethodNotAllowedError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when the server does not allow a request method.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
OAuthError(error: str, status_code: int = 400, error_description: Optional[str] = None, error_uri: Optional[str] = None)
Bases: ValueError
OAuth2 error.
Initializes the OAuthError.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
status_code
|
int
|
HTTP status code. |
400
|
error
|
str
|
Error code. |
required |
error_description
|
Optional[str]
|
Error description. |
None
|
error_uri
|
Optional[str]
|
Error URI. |
None
|
Source code in src/zenml/exceptions.py
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
|
Functions
to_dict() -> Dict[str, Optional[str]]
Returns the OAuthError as a dictionary.
Returns:
Type | Description |
---|---|
Dict[str, Optional[str]]
|
The OAuthError as a dictionary. |
Source code in src/zenml/exceptions.py
188 189 190 191 192 193 194 195 196 197 198 |
|
SecretsStoreNotConfiguredError
Bases: NotImplementedError
Raised when a secrets store is not configured.
SettingsResolvingError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when resolving settings failed.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
StackComponentInterfaceError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raises exception when interacting with the stack components in an unsupported way.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
StackValidationError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when a stack configuration is not valid.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
StepContextError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raises exception when interacting with a StepContext in an unsupported way.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
StepInterfaceError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raises exception when interacting with the Step interface in an unsupported way.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
SubscriptionUpgradeRequiredError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when user tries to perform an action outside their current subscription tier.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
ValidationError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when the Model passed to the ZenStore.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
WebhookInactiveError(message: Optional[str] = None, url: Optional[str] = None)
Bases: ZenMLBaseException
Raised when source is inactive.
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|
ZenKeyError(message: str)
Bases: KeyError
Specialized key error which allows error messages with line breaks.
Initialization.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message
|
str
|
str, the error message |
required |
Source code in src/zenml/exceptions.py
148 149 150 151 152 153 154 |
|
Functions
ZenMLBaseException(message: Optional[str] = None, url: Optional[str] = None)
Bases: Exception
Base exception for all ZenML Exceptions.
The BaseException used to format messages displayed to the user.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message
|
Optional[str]
|
Message with details of exception. This message
will be appended with another message directing user to
|
None
|
url
|
Optional[str]
|
URL to point to in exception message. If |
None
|
Source code in src/zenml/exceptions.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
|