GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — sdk-python/temporalio/exceptions.py at main · temporalio/sdk-python Expand file tree/ Copy pathexceptions.pyMore file actions 504 lines (407 loc) · 15.2 KB / Copy pathexceptions.pyFile metadata and controls504 lines (407 loc) · 15.2 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 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 501 502 503 504 """Common Temporal exceptions.""" import asyncio from collections.abc import Sequence from datetime import timedelta from enum import IntEnum from typing import Any import temporalio.api.enums.v1 import temporalio.api.failure.v1 class TemporalError(Exception): """Base for all Temporal exceptions.""" @property def cause(self) -> BaseException | None: """Cause of the exception. This is the same as ``Exception.__cause__``. """ return self.__cause__ class FailureError(TemporalError): """Base for runtime failures during workflow/activity execution.""" def __init__( self, message: str, *, failure: temporalio.api.failure.v1.Failure | None = None, exc_args: tuple | None = None, ) -> None: """Initialize a failure error.""" if exc_args is None: exc_args = (message,) super().__init__(*exc_args) self._message = message self._failure = failure @property def message(self) -> str: """Message.""" return self._message @property def failure(self) -> temporalio.api.failure.v1.Failure | None: """Underlying protobuf failure object.""" return self._failure class WorkflowAlreadyStartedError(FailureError): """Thrown by a client or workflow when a workflow execution has already started. Attributes: workflow_id: ID of the already-started workflow. workflow_type: Workflow type name of the already-started workflow. run_id: Run ID of the already-started workflow if this was raised by the client. first_run_id: First execution run ID of the already-started workflow if this was raised by the client and provided by the server. """ def __init__( self, workflow_id: str, workflow_type: str, *, run_id: str | None = None, first_run_id: str | None = None, ) -> None: """Initialize a workflow already started error.""" super().__init__("Workflow execution already started") self.workflow_id = workflow_id self.workflow_type = workflow_type self.run_id = run_id self.first_run_id = first_run_id class InvalidVersioningOverrideError(FailureError): """Thrown by a workflow when a child cannot start because its versioning override is invalid. """ def __init__(self) -> None: """Initialize an invalid versioning override error.""" super().__init__("Invalid versioning override") class ActivityAlreadyStartedError(FailureError): """Thrown by a client when an activity execution has already started. Attributes: activity_id: ID of the already-started activity. activity_type: Activity type name of the already-started activity. run_id: Run ID of the already-started activity if this was raised by the client. """ def __init__( self, activity_id: str, activity_type: str, *, run_id: str | None = None ) -> None: """Initialize an activity already started error.""" super().__init__("Activity execution already started") self.activity_id = activity_id self.activity_type = activity_type self.run_id = run_id class NexusOperationAlreadyStartedError(FailureError): """Thrown by a client when a Nexus operation execution has already started. .. warning:: This API is experimental and unstable. Attributes: operation_id: ID of the already-started operation. run_id: Run ID of the already-started operation if available. """ def __init__(self, operation_id: str, *, run_id: str | None = None) -> None: """Initialize a Nexus operation already started error.""" super().__init__("Nexus operation execution already started") self.operation_id = operation_id self.run_id = run_id class ApplicationErrorCategory(IntEnum): """Severity category for your application error. Maps to corresponding client-side logging/metrics behaviors""" UNSPECIFIED = int( temporalio.api.enums.v1.ApplicationErrorCategory.APPLICATION_ERROR_CATEGORY_UNSPECIFIED ) BENIGN = int( temporalio.api.enums.v1.ApplicationErrorCategory.APPLICATION_ERROR_CATEGORY_BENIGN ) """BENIGN category errors emit DEBUG level logs and do not record metrics""" class ApplicationError(FailureError): """Error raised during workflow/activity execution.""" def __init__( self, message: str, *details: Any, type: str | None = None, non_retryable: bool = False, next_retry_delay: timedelta | None = None, category: ApplicationErrorCategory = ApplicationErrorCategory.UNSPECIFIED, ) -> None: """Initialize an application error.""" super().__init__( message, # If there is a type, prepend it to the message on the string repr exc_args=(message if not type else f"{type}: {message}",), ) self._details = details self._type = type self._non_retryable = non_retryable self._next_retry_delay = next_retry_delay self._category = category @property def details(self) -> Sequence[Any]: """User-defined details on the error.""" return self._details @property def type(self) -> str | None: """General error type.""" return self._type @property def non_retryable(self) -> bool: """Whether the error was set as non-retryable when created. Note: This is not whether the error is non-retryable via other means such as retry policy. This is just whether the error was marked non-retryable upon creation by the user. """ return self._non_retryable @property def next_retry_delay(self) -> timedelta | None: """Delay before the next activity retry attempt. User activity code may set this when raising ApplicationError to specify a delay before the next activity retry. """ return self._next_retry_delay @property def category(self) -> ApplicationErrorCategory: """Severity category of the application error""" return self._category class CancelledError(FailureError): """Error raised on workflow/activity cancellation.""" def __init__(self, message: str = "Cancelled", *details: Any) -> None: """Initialize a cancelled error.""" super().__init__(message) self._details = details @property def details(self) -> Sequence[Any]: """User-defined details on the error.""" return self._details class TerminatedError(FailureError): """Error raised on workflow cancellation.""" def __init__(self, message: str, *details: Any) -> None: """Initialize a terminated error.""" super().__init__(message) self._details = details @property def details(self) -> Sequence[Any]: """User-defined details on the error.""" return self._details class TimeoutType(IntEnum): """Type of timeout for :py:class:`TimeoutError`.""" START_TO_CLOSE = int( temporalio.api.enums.v1.TimeoutType.TIMEOUT_TYPE_START_TO_CLOSE ) SCHEDULE_TO_START = int( temporalio.api.enums.v1.TimeoutType.TIMEOUT_TYPE_SCHEDULE_TO_START ) SCHEDULE_TO_CLOSE = int( temporalio.api.enums.v1.TimeoutType.TIMEOUT_TYPE_SCHEDULE_TO_CLOSE ) HEARTBEAT = int(temporalio.api.enums.v1.TimeoutType.TIMEOUT_TYPE_HEARTBEAT) class TimeoutError(FailureError): """Error raised on workflow/activity timeout.""" def __init__( self, message: str, *, type: TimeoutType | None, last_heartbeat_details: Sequence[Any], ) -> None: """Initialize a timeout error.""" super().__init__(message) self._type = type self._last_heartbeat_details = last_heartbeat_details @property def type(self) -> TimeoutType | None: """Type of timeout error.""" return self._type @property def last_heartbeat_details(self) -> Sequence[Any]: """Last heartbeat details if this is for an activity heartbeat.""" return self._last_heartbeat_details class ServerError(FailureError): """Error originating in the Temporal server.""" def __init__(self, message: str, *, non_retryable: bool = False) -> None: """Initialize a server error.""" super().__init__(message) self._non_retryable = non_retryable @property def non_retryable(self) -> bool: """Whether this error is non-retryable.""" return self._non_retryable class RetryState(IntEnum): """Current retry state of the workflow/activity during error.""" IN_PROGRESS = int(temporalio.api.enums.v1.RetryState.RETRY_STATE_IN_PROGRESS) NON_RETRYABLE_FAILURE = int( temporalio.api.enums.v1.RetryState.RETRY_STATE_NON_RETRYABLE_FAILURE ) TIMEOUT = int(temporalio.api.enums.v1.RetryState.RETRY_STATE_TIMEOUT) MAXIMUM_ATTEMPTS_REACHED = int( temporalio.api.enums.v1.RetryState.RETRY_STATE_MAXIMUM_ATTEMPTS_REACHED ) RETRY_POLICY_NOT_SET = int( temporalio.api.enums.v1.RetryState.RETRY_STATE_RETRY_POLICY_NOT_SET ) INTERNAL_SERVER_ERROR = int( temporalio.api.enums.v1.RetryState.RETRY_STATE_INTERNAL_SERVER_ERROR ) CANCEL_REQUESTED = int( temporalio.api.enums.v1.RetryState.RETRY_STATE_CANCEL_REQUESTED ) class ActivityError(FailureError): """Error raised on activity failure.""" def __init__( self, message: str, *, scheduled_event_id: int, started_event_id: int, identity: str, activity_type: str, activity_id: str, retry_state: RetryState | None, ) -> None: """Initialize an activity error.""" super().__init__(message) self._scheduled_event_id = scheduled_event_id self._started_event_id = started_event_id self._identity = identity self._activity_type = activity_type self._activity_id = activity_id self._retry_state = retry_state @property def scheduled_event_id(self) -> int: """Scheduled event ID for this error.""" return self._scheduled_event_id @property def started_event_id(self) -> int: """Started event ID for this error.""" return self._started_event_id @property def identity(self) -> str: """Identity for this error.""" return self._identity @property def activity_type(self) -> str: """Activity type for this error.""" return self._activity_type @property def activity_id(self) -> str: """Activity ID for this error.""" return self._activity_id @property def retry_state(self) -> RetryState | None: """Retry state for this error.""" return self._retry_state class ChildWorkflowError(FailureError): """Error raised on child workflow failure.""" def __init__( self, message: str, *, namespace: str, workflow_id: str, run_id: str, workflow_type: str, initiated_event_id: int, started_event_id: int, retry_state: RetryState | None, ) -> None: """Initialize a child workflow error.""" super().__init__(message) self._namespace = namespace self._workflow_id = workflow_id self._run_id = run_id self._workflow_type = workflow_type self._initiated_event_id = initiated_event_id self._started_event_id = started_event_id self._retry_state = retry_state @property def namespace(self) -> str: """Namespace for this error.""" return self._namespace @property def workflow_id(self) -> str: """Workflow ID for this error.""" return self._workflow_id @property def run_id(self) -> str: """Run ID for this error.""" return self._run_id @property def workflow_type(self) -> str: """Workflow type for this error.""" return self._workflow_type @property def initiated_event_id(self) -> int: """Initiated event ID for this error.""" return self._initiated_event_id @property def started_event_id(self) -> int: """Started event ID for this error.""" return self._started_event_id @property def retry_state(self) -> RetryState | None: """Retry state for this error.""" return self._retry_state class NexusOperationError(FailureError): """Error raised on Nexus operation failure inside a Workflow.""" def __init__( self, message: str, *, scheduled_event_id: int, endpoint: str, service: str, operation: str, operation_token: str, ): """Initialize a Nexus operation error. Args: message: The error message. scheduled_event_id: The NexusOperationScheduled event ID for the failed operation. endpoint: The endpoint name for the failed operation. service: The service name for the failed operation. operation: The name of the failed operation. operation_token: The operation token returned by the failed operation. """ super().__init__(message) self._scheduled_event_id = scheduled_event_id self._endpoint = endpoint self._service = service self._operation = operation self._operation_token = operation_token @property def scheduled_event_id(self) -> int: """The NexusOperationScheduled event ID for the failed operation.""" return self._scheduled_event_id @property def endpoint(self) -> str: """The endpoint name for the failed operation.""" return self._endpoint @property def service(self) -> str: """The service name for the failed operation.""" return self._service @property def operation(self) -> str: """The name of the failed operation.""" return self._operation @property def operation_token(self) -> str: """The operation token returned by the failed operation.""" return self._operation_token def is_cancelled_exception(exception: BaseException) -> bool: """Check whether the given exception is considered a cancellation exception according to Temporal. This is often used in a conditional of a catch clause to check whether a cancel occurred inside of a workflow. This can occur from :py:class:`asyncio.CancelledError` or :py:class:`CancelledError` or either :py:class:`ActivityError` or :py:class:`ChildWorkflowError` if either of those latter two have a :py:class:`CancelledError` cause. Args: exception: Exception to check. Returns: True if a cancelled exception, false if not. """ return ( isinstance(exception, asyncio.CancelledError) or isinstance(exception, CancelledError) or ( ( isinstance(exception, ActivityError) or isinstance(exception, ChildWorkflowError) or isinstance(exception, NexusOperationError) ) and isinstance(exception.cause, CancelledError) ) ) |
| You are visitor 01402520 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |