Module pygrocy.data_models.meal_items

Classes

class MealPlanItem (response: MealPlanResponse)

Expand source code

class MealPlanItem(DataModel):
    def __init__(self, response: MealPlanResponse):
        self._id = response.id
        self._day = response.day
        self._recipe = None
        self._recipe_id = response.recipe_id
        self._recipe_servings = response.recipe_servings
        self._note = response.note
        self._section_id = response.section_id
        self._type = MealPlanItemType(response.type)
        self._product_id = response.product_id

    @property
    def id(self) -> int:
        return self._id

    @property
    def day(self) -> datetime.date:
        return self._day

    @property
    def recipe_id(self) -> int:
        return self._recipe_id

    @property
    def recipe_servings(self) -> int:
        return self._recipe_servings

    @property
    def note(self) -> str:
        return self._note

    @property
    def recipe(self) -> RecipeItem:
        return self._recipe

    @property
    def section_id(self) -> int:
        return self._section_id

    @property
    def section(self) -> MealPlanSection:
        return self._section

    @property
    def type(self) -> MealPlanItemType:
        return self._type

    @property
    def product_id(self) -> int:
        return self._product_id

    def get_details(self, api_client: GrocyApiClient):
        if self.recipe_id:
            recipe = api_client.get_recipe(self.recipe_id)
            if recipe:
                self._recipe = RecipeItem(recipe)
        if self.section_id:
            section = api_client.get_meal_plan_section(self.section_id)
            if section:
                self._section = MealPlanSection(section)

Ancestors

• DataModel

Instance variables

var day : 

Expand source code

@property
def day(self) -> datetime.date:
    return self._day

var id : int

Expand source code

@property
def id(self) -> int:
    return self._id

var note : str

Expand source code

@property
def note(self) -> str:
    return self._note

var product_id : int

Expand source code

@property
def product_id(self) -> int:
    return self._product_id

var recipe : RecipeItem

Expand source code

@property
def recipe(self) -> RecipeItem:
    return self._recipe

var recipe_id : int

Expand source code

@property
def recipe_id(self) -> int:
    return self._recipe_id

var recipe_servings : int

Expand source code

@property
def recipe_servings(self) -> int:
    return self._recipe_servings

var section : MealPlanSection

Expand source code

@property
def section(self) -> MealPlanSection:
    return self._section

var section_id : int

Expand source code

@property
def section_id(self) -> int:
    return self._section_id

var type : MealPlanItemType

Expand source code

@property
def type(self) -> MealPlanItemType:
    return self._type

Methods

def get_details(self, api_client: GrocyApiClient)

Expand source code

def get_details(self, api_client: GrocyApiClient):
    if self.recipe_id:
        recipe = api_client.get_recipe(self.recipe_id)
        if recipe:
            self._recipe = RecipeItem(recipe)
    if self.section_id:
        section = api_client.get_meal_plan_section(self.section_id)
        if section:
            self._section = MealPlanSection(section)

class MealPlanItemType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class MealPlanItemType(str, Enum):
    NOTE = "note"
    PRODUCT = "product"
    RECIPE = "recipe"

Ancestors

• builtins.str
• enum.Enum

Class variables

var NOTE

var PRODUCT

var RECIPE

class MealPlanSection (response: MealPlanSectionResponse)

Expand source code

class MealPlanSection(DataModel):
    def __init__(self, response: MealPlanSectionResponse):
        self._id = response.id
        self._name = response.name
        self._sort_number = response.sort_number
        self._row_created_timestamp = response.row_created_timestamp

    @property
    def id(self) -> int:
        return self._id

    @property
    def name(self) -> str:
        return self._name

    @property
    def sort_number(self) -> int:
        return self._sort_number

    @property
    def row_created_timestamp(self) -> datetime:
        return self._row_created_timestamp

Ancestors

• DataModel

Instance variables

var id : int

Expand source code

@property
def id(self) -> int:
    return self._id

var name : str

Expand source code

@property
def name(self) -> str:
    return self._name

var row_created_timestamp : datetime.datetime

Expand source code

@property
def row_created_timestamp(self) -> datetime:
    return self._row_created_timestamp

var sort_number : int

Expand source code

@property
def sort_number(self) -> int:
    return self._sort_number

class RecipeItem (response: RecipeDetailsResponse)

Expand source code

class RecipeItem(DataModel):
    def __init__(self, response: RecipeDetailsResponse):
        self._id = response.id
        self._name = response.name
        self._description = response.description
        self._base_servings = response.base_servings
        self._desired_servings = response.desired_servings
        self._picture_file_name = response.picture_file_name

    @property
    def id(self) -> int:
        return self._id

    @property
    def name(self) -> str:
        return self._name

    @property
    def description(self) -> str:
        return self._description

    @property
    def base_servings(self) -> int:
        return self._base_servings

    @property
    def desired_servings(self) -> int:
        return self._desired_servings

    @property
    def picture_file_name(self) -> str:
        return self._picture_file_name

    def get_picture_url_path(self, width: int = 400):
        if self.picture_file_name:
            b64name = base64.b64encode(self.picture_file_name.encode("ascii"))
            path = "files/recipepictures/" + str(b64name, "utf-8")

            return f"{path}?force_serve_as=picture&best_fit_width={width}"

Ancestors

• DataModel

Instance variables

var base_servings : int

Expand source code

@property
def base_servings(self) -> int:
    return self._base_servings

var description : str

Expand source code

@property
def description(self) -> str:
    return self._description

var desired_servings : int

Expand source code

@property
def desired_servings(self) -> int:
    return self._desired_servings

var id : int

Expand source code

@property
def id(self) -> int:
    return self._id

var name : str

Expand source code

@property
def name(self) -> str:
    return self._name

var picture_file_name : str

Expand source code

@property
def picture_file_name(self) -> str:
    return self._picture_file_name

Methods

def get_picture_url_path(self, width: int = 400)

Expand source code

def get_picture_url_path(self, width: int = 400):
    if self.picture_file_name:
        b64name = base64.b64encode(self.picture_file_name.encode("ascii"))
        path = "files/recipepictures/" + str(b64name, "utf-8")

        return f"{path}?force_serve_as=picture&best_fit_width={width}"