Module src.models.deleteMealItem

Classes

class DeleteMealItem (credentialsItem: CredentialsItem, year: int, month: int, day: int, mealType: str)

Model used to wrap the details for deleting a meal sent to the API to use globally.

Attributes

credentialsItem : CredentialsItem
The credentials of the user.
year : int
The year of the meal entry to delete.
month : int
The month of the meal entry to delete.
day : int
The day of the meal entry to delete.
mealType : str
The type of meal (e.g., "breakfast", "lunch", "dinner", "snacks").

Initializes the DeleteMealItem with credentials, year, month, day, and mealType.

Args

credentialsItem : CredentialsItem
The credentials of the user.
year : int
The year of the meal entry to delete.
month : int
The month of the meal entry to delete.
day : int
The day of the meal entry to delete.
mealType : str
The type of meal (e.g., "breakfast", "lunch", "dinner", "snacks").
Expand source code 
class DeleteMealItem:
    """
    Model used to wrap the details for deleting a meal sent to the API to use globally.

    Attributes:
        credentialsItem (CredentialsItem): The credentials of the user.
        year (int): The year of the meal entry to delete.
        month (int): The month of the meal entry to delete.
        day (int): The day of the meal entry to delete.
        mealType (str): The type of meal (e.g., "breakfast", "lunch", "dinner", "snacks").
    """

    def __init__(self, credentialsItem: CredentialsItem, year: int, month: int, day: int, mealType: str):
        """
        Initializes the DeleteMealItem with credentials, year, month, day, and mealType.

        Args:
            credentialsItem (CredentialsItem): The credentials of the user.
            year (int): The year of the meal entry to delete.
            month (int): The month of the meal entry to delete.
            day (int): The day of the meal entry to delete.
            mealType (str): The type of meal (e.g., "breakfast", "lunch", "dinner", "snacks").
        """
        self.credentialsItem = credentialsItem
        self.year = year
        self.month = month
        self.day = day
        self.mealType = mealType

    def __str__(self) -> str:
        """
        Returns a string representation of the DeleteMealItem.

        Returns:
            str: A formatted string representation of the DeleteMealItem.
        """
        class_as_string = 'DeleteMealItem{'
        class_as_string += f'"credentials": "{self.credentialsItem}", '
        class_as_string += f'"year": {self.year}, '
        class_as_string += f'"month": {self.month}, '
        class_as_string += f'"day": {self.day}, '
        class_as_string += f'"mealType": "{self.mealType}"'
        class_as_string += '}'

        return class_as_string