Skip to content

model

Model implementation for a custom list.

CustomListEntryModel

Bases: BaseModel

A model class representing a custom list entry.

Source code in mlte/custom_list/model.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class CustomListEntryModel(BaseModel):
    """A model class representing a custom list entry."""

    name: str
    """A name to uniquely identify the entry."""

    description: str
    """A description of the the entry."""

    parent: str | None = None
    """ID of parent."""

    def __str__(self) -> str:
        if self.parent:
            return f"{self.name} (Parent: {self.parent}): {self.description}"
        else:
            return f"{self.name} (Parent: None): {self.description}"

description instance-attribute

A description of the the entry.

name instance-attribute

A name to uniquely identify the entry.

parent = None class-attribute instance-attribute

ID of parent.

CustomListModel

Bases: BaseModel

A model class representing a custom list.

Source code in mlte/custom_list/model.py 
 9
10
11
12
13
14
15
16
class CustomListModel(BaseModel):
    """A model class representing a custom list."""

    name: CustomListName
    """An name to uniquely identify the list."""

    entries: list[CustomListEntryModel] = []
    """A list of entries in the list."""

entries = [] class-attribute instance-attribute

A list of entries in the list.

name instance-attribute

An name to uniquely identify the list.