Skip to content

data

GeneralDataModel

Bases: BaseModel

Represents a general data model with a collection of items and the total count of items.

This class is used to encapsulate a collection of items along with their total count in a data structure. It serves as a general-purpose representation of data collections and is flexible in handling any type of items within the list.

Attributes:

Name Type Description
items list[Any]

A list of items representing the data collection.
totalCount int

The total number of items in the collection.
Source code in backend/app/data/model.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
class GeneralDataModel(BaseModel):
    """
    Represents a general data model with a collection of items and the total count of items.

    This class is used to encapsulate a collection of items along with their total count in a
    data structure. It serves as a general-purpose representation of data collections and is
    flexible in handling any type of items within the list.

    :ivar items: A list of items representing the data collection.
    :type items: list[Any]
    :ivar totalCount: The total number of items in the collection.
    :type totalCount: Int
    """
    items: list[Any] = Field(..., description="A list of items representing the data collection.")
    totalCount: int = Field(..., description="The total number of items in the collection.")