Refactor/task builder

.github/workflows/test-python-package.yml

@@ -2,9 +2,8 @@ name: Test pyzeebe
 
 on:
   push:
-    branches: [ master, development, feature/*, bugfix/*, maintenance/*, pre-release/* ]
   pull_request:
-    branches: [ master, development, feature/*, bugfix/*, maintenance/*, pre-release/* ]
+    branches: [ master, development ]
 
 jobs:
   build:

.github/workflows/test-zeebe-integration.yml

@@ -2,9 +2,8 @@ name: Integration test pyzeebe
 
 on:
   push:
-    branches: [ master, development, feature/*, bugfix/*, maintenance/*, pre-release/* ]
   pull_request:
-    branches: [ master, development, feature/*, bugfix/*, maintenance/*, pre-release/* ]
+    branches: [ master, development ]
 
 jobs:
   test:

docs/exceptions.rst

@@ -1,43 +1,43 @@
 ==========
-Exceptions
+errors
 ==========
 
-All ``pyzeebe`` exceptions inherit from :py:class:`PyZeebeException`
+All ``pyzeebe`` exceptions inherit from :py:class:`PyZeebeError`
 
-.. autoexception:: pyzeebe.exceptions.PyZeebeException
+.. autoexception:: pyzeebe.errors.PyZeebeError
 
-.. autoexception:: pyzeebe.exceptions.TaskNotFound
+.. autoexception:: pyzeebe.errors.TaskNotFoundError
 
-.. autoexception:: pyzeebe.exceptions.NoVariableNameGiven
+.. autoexception:: pyzeebe.errors.NoVariableNameGivenError
 
-.. autoexception:: pyzeebe.exceptions.NoZeebeAdapter
+.. autoexception:: pyzeebe.errors.NoZeebeAdapterError
 
-.. autoexception:: pyzeebe.exceptions.DuplicateTaskType
+.. autoexception:: pyzeebe.errors.DuplicateTaskTypeError
 
-.. autoexception:: pyzeebe.exceptions.ActivateJobsRequestInvalid
+.. autoexception:: pyzeebe.errors.ActivateJobsRequestInvalidError
 
-.. autoexception:: pyzeebe.exceptions.JobAlreadyDeactivated
+.. autoexception:: pyzeebe.errors.JobAlreadyDeactivatedError
 
-.. autoexception:: pyzeebe.exceptions.JobNotFound
+.. autoexception:: pyzeebe.errors.JobNotFoundError
 
-.. autoexception:: pyzeebe.exceptions.MessageAlreadyExists
+.. autoexception:: pyzeebe.errors.MessageAlreadyExistsError
 
-.. autoexception:: pyzeebe.exceptions.WorkflowNotFound
+.. autoexception:: pyzeebe.errors.WorkflowNotFoundError
 
-.. autoexception:: pyzeebe.exceptions.WorkflowInstanceNotFound
+.. autoexception:: pyzeebe.errors.WorkflowInstanceNotFoundError
 
-.. autoexception:: pyzeebe.exceptions.WorkflowHasNoStartEvent
+.. autoexception:: pyzeebe.errors.WorkflowHasNoStartEventError
 
-.. autoexception:: pyzeebe.exceptions.WorkflowInvalid
+.. autoexception:: pyzeebe.errors.WorkflowInvalidError
 
-.. autoexception:: pyzeebe.exceptions.InvalidJSON
+.. autoexception:: pyzeebe.errors.InvalidJSONError
 
-.. autoexception:: pyzeebe.exceptions.ZeebeBackPressure
+.. autoexception:: pyzeebe.errors.ZeebeBackPressureError
 
-.. autoexception:: pyzeebe.exceptions.ZeebeGatewayUnavailable
+.. autoexception:: pyzeebe.errors.ZeebeGatewayUnavailableError
 
-.. autoexception:: pyzeebe.exceptions.ZeebeInternalError
+.. autoexception:: pyzeebe.errors.ZeebeInternalError
 
-.. autoexception:: pyzeebe.exceptions.InvalidOAuthCredentials
+.. autoexception:: pyzeebe.errors.InvalidOAuthCredentialsError
 
-.. autoexception:: pyzeebe.exceptions.InvalidCamundaCloudCredentials
+.. autoexception:: pyzeebe.errors.InvalidCamundaCloudCredentialsError

docs/worker_reference.rst

@@ -2,9 +2,10 @@
 Worker Reference
 ================
 
-The :py:class:`ZeebeTaskHandler` class from which both :py:class:`ZeebeWorker` and :py:class:`ZeebeTaskRouter` inherit.
+The :py:class:`ZeebeWorker` class inherits from :py:class:`ZeebeTaskRouter` class.
+This means that all methods that :py:class:`ZeebeTaskRouter` has will also appear in :py:class:`ZeebeWorker`.
 
-.. autoclass:: pyzeebe.worker.task_handler.ZeebeTaskHandler
+.. autoclass:: pyzeebe.ZeebeTaskRouter
    :members:
    :undoc-members:
 
@@ -13,9 +14,6 @@ The :py:class:`ZeebeTaskHandler` class from which both :py:class:`ZeebeWorker` a
    :members:
    :undoc-members:
 
-.. autoclass:: pyzeebe.ZeebeTaskRouter
-   :members:
-   :undoc-members:
 
 .. autoclass:: pyzeebe.Job
    :members:

pyzeebe/__init__.py

@@ -1,12 +1,13 @@
 __version__ = "2.3.1"
 
-from pyzeebe import exceptions
+from pyzeebe import errors
 from pyzeebe.client.client import ZeebeClient
 from pyzeebe.credentials.camunda_cloud_credentials import CamundaCloudCredentials
 from pyzeebe.credentials.oauth_credentials import OAuthCredentials
 from pyzeebe.job.job import Job
 from pyzeebe.job.job_status import JobStatus
 from pyzeebe.task.exception_handler import ExceptionHandler
-from pyzeebe.task.task_decorator import TaskDecorator
-from pyzeebe.worker.task_router import ZeebeTaskRouter
+from pyzeebe.task.task_config import TaskConfig
+from pyzeebe.task.types import TaskDecorator
+from pyzeebe.worker.task_router import ZeebeTaskRouter, default_exception_handler
 from pyzeebe.worker.worker import ZeebeWorker

pyzeebe/client/client.py

@@ -35,11 +35,11 @@ def run_workflow(self, bpmn_process_id: str, variables: Dict = None, version: in
             int: workflow_instance_key, the unique id of the running workflow generated by Zeebe.
 
         Raises:
-            WorkflowNotFound: No workflow with bpmn_process_id exists
-            InvalidJSON: variables is not JSONable
-            WorkflowHasNoStartEvent: The specified workflow does not have a start event
-            ZeebeBackPressure: If Zeebe is currently in back pressure (too many requests)
-            ZeebeGatewayUnavailable: If the Zeebe gateway is unavailable
+            WorkflowNotFoundError: No workflow with bpmn_process_id exists
+            InvalidJSONError: variables is not JSONable
+            WorkflowHasNoStartEventError: The specified workflow does not have a start event
+            ZeebeBackPressureError: If Zeebe is currently in back pressure (too many requests)
+            ZeebeGatewayUnavailableError: If the Zeebe gateway is unavailable
             ZeebeInternalError: If Zeebe experiences an internal error
 
         """
@@ -62,11 +62,11 @@ def run_workflow_with_result(self, bpmn_process_id: str, variables: Dict = None,
             tuple: (The workflow instance key, A dictionary of the end state of the workflow instance)
 
         Raises:
-            WorkflowNotFound: No workflow with bpmn_process_id exists
-            InvalidJSON: variables is not JSONable
-            WorkflowHasNoStartEvent: The specified workflow does not have a start event
-            ZeebeBackPressure: If Zeebe is currently in back pressure (too many requests)
-            ZeebeGatewayUnavailable: If the Zeebe gateway is unavailable
+            WorkflowNotFoundError: No workflow with bpmn_process_id exists
+            InvalidJSONError: variables is not JSONable
+            WorkflowHasNoStartEventError: The specified workflow does not have a start event
+            ZeebeBackPressureError: If Zeebe is currently in back pressure (too many requests)
+            ZeebeGatewayUnavailableError: If the Zeebe gateway is unavailable
             ZeebeInternalError: If Zeebe experiences an internal error
 
         """
@@ -86,9 +86,9 @@ def cancel_workflow_instance(self, workflow_instance_key: int) -> int:
             int: The workflow_instance_key
 
         Raises:
-            WorkflowInstanceNotFound: If no workflow instance with workflow_instance_key exists
-            ZeebeBackPressure: If Zeebe is currently in back pressure (too many requests)
-            ZeebeGatewayUnavailable: If the Zeebe gateway is unavailable
+            WorkflowInstanceNotFoundError: If no workflow instance with workflow_instance_key exists
+            ZeebeBackPressureError: If Zeebe is currently in back pressure (too many requests)
+            ZeebeGatewayUnavailableError: If the Zeebe gateway is unavailable
             ZeebeInternalError: If Zeebe experiences an internal error
 
         """
@@ -103,9 +103,9 @@ def deploy_workflow(self, *workflow_file_path: str) -> None:
             workflow_file_path (str): The file path to a workflow definition file (bpmn/yaml)
 
         Raises:
-            WorkflowInvalid: If one of the workflow file definitions is invalid
-            ZeebeBackPressure: If Zeebe is currently in back pressure (too many requests)
-            ZeebeGatewayUnavailable: If the Zeebe gateway is unavailable
+            WorkflowInvalidError: If one of the workflow file definitions is invalid
+            ZeebeBackPressureError: If Zeebe is currently in back pressure (too many requests)
+            ZeebeGatewayUnavailableError: If the Zeebe gateway is unavailable
             ZeebeInternalError: If Zeebe experiences an internal error
 
         """
@@ -125,9 +125,9 @@ def publish_message(self, name: str, correlation_key: str, variables: Dict = Non
                                 active, a MessageAlreadyExists will be raised.
 
         Raises:
-            MessageAlreadyExist: If a message with message_id already exists
-            ZeebeBackPressure: If Zeebe is currently in back pressure (too many requests)
-            ZeebeGatewayUnavailable: If the Zeebe gateway is unavailable
+            MessageAlreadyExistError: If a message with message_id already exists
+            ZeebeBackPressureError: If Zeebe is currently in back pressure (too many requests)
+            ZeebeGatewayUnavailableError: If the Zeebe gateway is unavailable
             ZeebeInternalError: If Zeebe experiences an internal error
 
         """

pyzeebe/credentials/camunda_cloud_credentials.py

@@ -1,14 +1,14 @@
 from pyzeebe.credentials.oauth_credentials import OAuthCredentials
-from pyzeebe.exceptions import InvalidOAuthCredentials, InvalidCamundaCloudCredentials
+from pyzeebe.errors import InvalidOAuthCredentialsError, InvalidCamundaCloudCredentialsError
 
 
 class CamundaCloudCredentials(OAuthCredentials):
     def __init__(self, client_id: str, client_secret: str, cluster_id: str):
         try:
             super().__init__(url="https://login.cloud.camunda.io/oauth/token", client_id=client_id,
                              client_secret=client_secret, audience=f"{cluster_id}.zeebe.camunda.io")
-        except InvalidOAuthCredentials:
-            raise InvalidCamundaCloudCredentials(client_id=client_id, cluster_id=cluster_id)
+        except InvalidOAuthCredentialsError:
+            raise InvalidCamundaCloudCredentialsError(client_id=client_id, cluster_id=cluster_id)
 
     def get_connection_uri(self) -> str:
         return f"{self.audience}:443"

pyzeebe/credentials/oauth_credentials.py

@@ -4,7 +4,7 @@
 from requests_oauthlib import OAuth2Session
 
 from pyzeebe.credentials.base_credentials import BaseCredentials
-from pyzeebe.exceptions import InvalidOAuthCredentials
+from pyzeebe.errors import InvalidOAuthCredentialsError
 
 
 class OAuthCredentials(BaseCredentials):
@@ -34,7 +34,7 @@ def get_access_token(url: str, client_id: str, client_secret: str, audience: str
                 response.raise_for_status()
                 return response.json()["access_token"]
         except HTTPError:
-            raise InvalidOAuthCredentials(url=url, client_id=client_id, audience=audience)
+            raise InvalidOAuthCredentialsError(url=url, client_id=client_id, audience=audience)
 
     def get_connection_uri(self) -> str:
         return None

pyzeebe/errors/__init__.py

@@ -0,0 +1,6 @@
+from .credentials_errors import *
+from .job_errors import *
+from .message_errors import *
+from .pyzeebe_errors import *
+from .workflow_errors import *
+from .zeebe_errors import *

pyzeebe/exceptions/credentials_exceptions.py → pyzeebe/errors/credentials_errors.py

@@ -1,12 +1,12 @@
-from pyzeebe.exceptions.pyzeebe_exceptions import PyZeebeException
+from pyzeebe.errors.pyzeebe_errors import PyZeebeError
 
 
-class InvalidOAuthCredentials(PyZeebeException):
+class InvalidOAuthCredentialsError(PyZeebeError):
     def __init__(self, url: str, client_id: str, audience: str):
         super().__init__(
             f"Invalid OAuth credentials supplied for {url} with audience {audience} and client id {client_id}")
 
 
-class InvalidCamundaCloudCredentials(PyZeebeException):
+class InvalidCamundaCloudCredentialsError(PyZeebeError):
     def __init__(self, client_id: str, cluster_id: str):
         super().__init__(f"Invalid credentials supplied for cluster {cluster_id} with client {client_id}")

pyzeebe/exceptions/job_exceptions.py → pyzeebe/errors/job_errors.py

@@ -1,7 +1,7 @@
-from pyzeebe.exceptions.pyzeebe_exceptions import PyZeebeException
+from pyzeebe.errors.pyzeebe_errors import PyZeebeError
 
 
-class ActivateJobsRequestInvalid(PyZeebeException):
+class ActivateJobsRequestInvalidError(PyZeebeError):
     def __init__(self, task_type: str, worker: str, timeout: int, max_jobs_to_activate: int):
         msg = "Failed to activate jobs. Reasons:"
         if task_type == "" or task_type is None:
@@ -16,13 +16,13 @@ def __init__(self, task_type: str, worker: str, timeout: int, max_jobs_to_activa
         super().__init__(msg)
 
 
-class JobAlreadyDeactivated(PyZeebeException):
+class JobAlreadyDeactivatedError(PyZeebeError):
     def __init__(self, job_key: int):
         super().__init__(f"Job {job_key} was already stopped (Completed/Failed/Error)")
         self.job_key = job_key
 
 
-class JobNotFound(PyZeebeException):
+class JobNotFoundError(PyZeebeError):
     def __init__(self, job_key: int):
         super().__init__(f"Job {job_key} not found")
         self.job_key = job_key

pyzeebe/errors/message_errors.py

@@ -0,0 +1,5 @@
+from pyzeebe.errors.pyzeebe_errors import PyZeebeError
+
+
+class MessageAlreadyExistsError(PyZeebeError):
+    pass

pyzeebe/exceptions/pyzeebe_exceptions.py → pyzeebe/errors/pyzeebe_errors.py

@@ -1,25 +1,26 @@
-class PyZeebeException(Exception):
+class PyZeebeError(Exception):
     pass
 
 
-class TaskNotFound(PyZeebeException):
+class TaskNotFoundError(PyZeebeError):
     pass
 
 
-class NoVariableNameGiven(PyZeebeException):
+class NoVariableNameGivenError(PyZeebeError):
     def __init__(self, task_type: str):
         super().__init__(f"No variable name given for single_value task {task_type}")
         self.task_type = task_type
 
 
-class NoZeebeAdapter(PyZeebeException):
+class NoZeebeAdapterError(PyZeebeError):
     pass
 
 
-class DuplicateTaskType(PyZeebeException):
+class DuplicateTaskTypeError(PyZeebeError):
     def __init__(self, task_type: str):
         super().__init__(f"Task with type {task_type} already exists")
         self.task_type = task_type
 
-class MaxConsecutiveTaskThreadError(PyZeebeException):
+
+class MaxConsecutiveTaskThreadError(PyZeebeError):
     pass

pyzeebe/exceptions/workflow_exceptions.py → pyzeebe/errors/workflow_errors.py

@@ -1,29 +1,29 @@
-from pyzeebe.exceptions.pyzeebe_exceptions import PyZeebeException
+from pyzeebe.errors.pyzeebe_errors import PyZeebeError
 
 
-class WorkflowNotFound(PyZeebeException):
+class WorkflowNotFoundError(PyZeebeError):
     def __init__(self, bpmn_process_id: str, version: int):
         super().__init__(
             f"Workflow definition: {bpmn_process_id}  with {version} was not found")
         self.bpmn_process_id = bpmn_process_id
         self.version = version
 
 
-class WorkflowInstanceNotFound(PyZeebeException):
+class WorkflowInstanceNotFoundError(PyZeebeError):
     def __init__(self, workflow_instance_key: int):
         super().__init__(f"Workflow instance key: {workflow_instance_key} was not found")
         self.workflow_instance_key = workflow_instance_key
 
 
-class WorkflowHasNoStartEvent(PyZeebeException):
+class WorkflowHasNoStartEventError(PyZeebeError):
     def __init__(self, bpmn_process_id: str):
         super().__init__(f"Workflow {bpmn_process_id} has no start event that can be called manually")
         self.bpmn_process_id = bpmn_process_id
 
 
-class WorkflowInvalid(PyZeebeException):
+class WorkflowInvalidError(PyZeebeError):
     pass
 
 
-class InvalidJSON(PyZeebeException):
+class InvalidJSONError(PyZeebeError):
     pass

pyzeebe/errors/zeebe_errors.py

@@ -0,0 +1,13 @@
+from pyzeebe.errors.pyzeebe_errors import PyZeebeError
+
+
+class ZeebeBackPressureError(PyZeebeError):
+    pass
+
+
+class ZeebeGatewayUnavailableError(PyZeebeError):
+    pass
+
+
+class ZeebeInternalError(PyZeebeError):
+    pass