py_mcai_worker_sdk 1.1.3

AMQP Worker to listen and provide trait to process message
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

import json
import time

def get_name():
    return "My python Worker"


def get_short_description():
    return "My python Worker"


def get_description():
    return """This is my long description
	over multilines
	"""


def get_version():
    return "0.0.3"


def get_parameters():
    return [
        {
            "identifier": "source_path",
            "label": "My parameter",
            "kind": ["string"],
            "required": True,
        },
        {
            "identifier": "destination_path",
            "label": "My array parameter",
            "kind": ["string"],
            "required": False,
        }
    ]


def init():
    '''
    Optional worker initialization function.
    '''

    print("Initialise Python worker...")


def process(handle_callback, parameters, job_id):
    '''
    Standard worker process function.
    '''
    print("Job ID: ", job_id)
    print("Parameters: ", parameters)

    assert parameters["action"] == "completed"
    assert parameters["number"] == 123
    assert parameters["array of strings"] == ["value_1", "value_2"]
    assert parameters["array of integers"] == [0, 1, 2, 3, 4, 5, 6]

    assert parameters["source_path"] is not None
    assert parameters["destination_path"] is not None

    assert parameters["requirements"] == parameters["source_path"]

    # do some stuff here
    for i in range(0, 25):

        if handle_callback.is_stopped():
            # Set job status to stop and return
            handle_callback.set_job_status("stopped")
            return { "destination_paths": ["/path/to/generated/file.ext"] }

        time.sleep(1)

        # notify the progression (between 0 and 100)
        handle_callback.publish_job_progression(i * 4)

    # By default, the job status is set to "completed" if the process returns properly. If an error is raised,
    # the job status is set to "error" and the error message is returned as a response.
    # However, the job status can be overwritten by calling:
    #
    #     handle_callback.set_job_status("stopped")
    #
    # This function return whether the status has been correctly set.
    # Possible job status values are: "completed", "stopped" and "error".

    return {
        "destination_paths": ["/path/to/generated/file.ext"]
    }