Skip to content

Task

The attributes of a BPMN Parser instance is pretty simple. All them inherits Task class, and this class is an Abstract Interface have 2 abstract methods, the list and get.

Task

Bases: ABC

Source code in bpmn_parser/_task.py 
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
class Task(ABC):
    def __init__(self, root: _Element):
        self.root = root

        if not (match := re.search(r'{(?P<tag>.+)}', self.root.tag)):
            raise BPMNTagNotFound()

        self.bpmn_tag = match['tag']
        self.camunda_tag = 'http://camunda.org/schema/1.0/bpmn'
        self.xml_schema_tag = 'http://www.w3.org/2001/XMLSchema-instance'

    def _build_xml_schema_attrib(self, name: str):
        return '{' f'{self.xml_schema_tag}' '}' f'{name}'

    def _build_camunda_attrib(self, name: str):
        return '{' f'{self.camunda_tag}' '}' f'{name}'

    def _get_execution_listeners(self, element: _Element):
        """Get all execution listeners from the `element`."""
        return [
            ExecutionListener(
                expression=item.get('expression'),
                event=item.get('event'),
            )
            for item in element.xpath(
                './/camunda:executionListener', namespaces={'camunda': self.camunda_tag}
            )
        ]

    def get(self, id: str):
        return next((item for item in self.list if item.id == id), None)

    def __len__(self) -> int:
        """Returns the quantity of items that have the specific property."""
        return len(self.list)

    def __repr__(self) -> str:
        """Return a representation of the property, printing the quantity of items that
        have the specific property."""
        return f'{self.__class__.__name__}(items={self.__len__()})'

    @property
    @abstractmethod
    def list(self):  # pragma: no cover
        pass

__len__()

Returns the quantity of items that have the specific property.

Source code in bpmn_parser/_task.py 
75
76
77
def __len__(self) -> int:
    """Returns the quantity of items that have the specific property."""
    return len(self.list)

__repr__()

Return a representation of the property, printing the quantity of items that have the specific property.

Source code in bpmn_parser/_task.py 
79
80
81
82
def __repr__(self) -> str:
    """Return a representation of the property, printing the quantity of items that
    have the specific property."""
    return f'{self.__class__.__name__}(items={self.__len__()})'

ExecutionListener

Parse an execution listener from an element in BPMN.

Source code in bpmn_parser/_task.py 
10
11
12
13
14
15
@dataclass
class ExecutionListener:
    """Parse an execution listener from an element in BPMN."""

    expression: str
    event: str

TaskElement

Bases: BPMNElement

A base of all Task elements parsed by BPMN Parser.

Attributes:

Name Type Description
execution_listeners list[ExecutionListener]

list of Execution Listeners of this element.
Source code in bpmn_parser/_task.py 
31
32
33
34
35
36
37
38
39
40
@dataclass
class TaskElement(BPMNElement):
    """A base of all Task elements parsed by BPMN Parser.

    Attributes:
        execution_listeners (list[ExecutionListener]): list of Execution Listeners of
            this element.
    """

    execution_listeners: list[ExecutionListener]

BPMN Element

A base of all BPMN elements parsed by BPMN Parser.

Attributes:

Name Type Description
id str

ID of element in BPMN.
name str

name of element in BPMN.
Source code in bpmn_parser/_task.py 
18
19
20
21
22
23
24
25
26
27
28
@dataclass
class BPMNElement:
    """A base of all BPMN elements parsed by BPMN Parser.

    Attributes:
        id (str): ID of element in BPMN.
        name (str): name of element in BPMN.
    """

    id: str
    name: str