Zeebe Worker

A simple Zeebe worker wrapper to let developers focus on what matters.

Install

pip install zeebe-worker or use your preferred package manager. See https://pypi.org/project/zeebe-worker/#history for available versions.

Usage

from zeebe_worker import ZeebeWorker
from extensions import zeebe_stub
from config import worker_name

class MyWorker(ZeebeWorker):

    def my_task_type_handler(self, job):
        """Handling my_task_type
        """
        variables = json.loads(job.variables)
        if something_fails:
            # This will trigger a FailJobRequest with the exception
            raise Exception
        return variables

    def another_task_type_handler(self, job):
        """Handles another task
        """
        # This will always succeed as an exception will never be raised
        pass


# Create your own class instance with your own configuration
my_worker = MyWorker(zeebe_stub, worker_name)

# Subscribe to a task type (uses threading.Thread for concurrency)
my_worker.subscribe('my_task_type', 'my_task_type_handler')
my_worker.subscribe('my-task-typo', 'my_task_type_handler')
my_worker.subscribe('another_task_type', 'another_task_type_handler')

API

ZeebeWorker.__init__

Initiates the worker class with the set defaults.

ZeebeWorker.subscribe

Subscribes the target to the task type concurrently.

Target functions

Your own target function must accept one argument, preferably called job. This will be provided as Zeebe's ActivatedJob (ref). Extract the variables using variables = json.loads(job.variables).

Fail a job

Raising any exception in the function will send a FailJobRequest to zeebe with the raised exception.

Complete a job

A CompleteJobRequest will be sent for the job if the function excecutes without raising an exception.

Setting variables

When the function returns a dict, it will send this dict as variables with the CompleteJobRequest.

Compatability