Module pygrocy.data_models.product

Classes

class Group (raw_product_group: LocationData)

Expand source code

class Group(DataModel):
    def __init__(self, raw_product_group: LocationData):
        self._id = raw_product_group.id
        self._name = raw_product_group.name
        self._description = raw_product_group.description

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

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

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

Ancestors

• DataModel

Instance variables

var description : str

Expand source code

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

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

class Product (data)

Expand source code

class Product(DataModel):
    def __init__(self, data):
        self._init_empty()
        if isinstance(data, CurrentStockResponse):
            self._init_from_CurrentStockResponse(data)
        elif isinstance(data, MissingProductResponse):
            self._init_from_MissingProductResponse(data)
        elif isinstance(data, ProductDetailsResponse):
            self._init_from_ProductDetailsResponse(data)
        elif isinstance(data, ProductData):
            self._init_from_ProductData(data)
        elif isinstance(data, StockLogResponse):
            self._init_from_StockLogResponse(data)

    def _init_empty(self):
        self._name = None
        self._id = None
        self._amount_missing = None
        self._is_partly_in_stock = None

        self._available_amount = None
        self._amount_aggregated = None
        self._amount_opened = None
        self._amount_opened_aggregated = None
        self._is_aggregated_amount = None
        self._best_before_date = None

        self._default_quantity_unit_purchase = None

        self._barcodes = []
        self._product_group_id = None

    def _init_from_CurrentStockResponse(self, response: CurrentStockResponse):
        self._id = response.product_id
        self._available_amount = response.amount
        self._amount_aggregated = response.amount_aggregated
        self._amount_opened = response.amount_opened
        self._amount_opened_aggregated = response.amount_opened_aggregated
        self._is_aggregated_amount = response.is_aggregated_amount
        self._best_before_date = response.best_before_date

        if response.product:
            self._init_from_ProductData(response.product)

    def _init_from_MissingProductResponse(self, response: MissingProductResponse):
        self._id = response.id
        self._name = response.name
        self._amount_missing = response.amount_missing
        self._is_partly_in_stock = response.is_partly_in_stock

    def _init_from_ProductDetailsResponse(self, response: ProductDetailsResponse):
        self._available_amount = response.stock_amount
        self._best_before_date = response.next_best_before_date
        self._barcodes = [ProductBarcode(data) for data in response.barcodes]
        self._default_quantity_unit_purchase = QuantityUnit(
            response.default_quantity_unit_purchase
        )

        if response.product:
            self._init_from_ProductData(response.product)

    def _init_from_ProductData(self, product: ProductData):
        self._id = product.id
        self._product_group_id = product.product_group_id
        self._name = product.name

    def _init_from_StockLogResponse(self, response: StockLogResponse):
        self._id = response.product_id

    def get_details(self, api_client: GrocyApiClient):
        details = api_client.get_product(self.id)
        if details:
            self._name = details.product.name
            self._barcodes = [ProductBarcode(barcode) for barcode in details.barcodes]
            self._product_group_id = details.product.product_group_id
            self._available_amount = details.stock_amount

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

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

    @property
    def product_group_id(self) -> int:
        return self._product_group_id

    @property
    def available_amount(self) -> float:
        return self._available_amount

    @property
    def amount_aggregated(self) -> float:
        return self._amount_aggregated

    @property
    def amount_opened(self) -> float:
        return self._amount_opened

    @property
    def amount_opened_aggregated(self) -> float:
        return self._amount_opened_aggregated

    @property
    def is_aggregated_amount(self) -> bool:
        return self._is_aggregated_amount

    @property
    def best_before_date(self) -> datetime.date:
        return self._best_before_date

    @property
    def barcodes(self) -> List[str]:
        return [barcode.barcode for barcode in self.product_barcodes]

    @property
    def product_barcodes(self) -> List[ProductBarcode]:
        return self._barcodes

    @property
    def amount_missing(self) -> float:
        return self._amount_missing

    @property
    def is_partly_in_stock(self) -> int:
        return self._is_partly_in_stock

    @property
    def default_quantity_unit_purchase(self) -> QuantityUnit:
        return self._default_quantity_unit_purchase

Ancestors

• DataModel

Instance variables

var amount_aggregated : float

Expand source code

@property
def amount_aggregated(self) -> float:
    return self._amount_aggregated

var amount_missing : float

Expand source code

@property
def amount_missing(self) -> float:
    return self._amount_missing

var amount_opened : float

Expand source code

@property
def amount_opened(self) -> float:
    return self._amount_opened

var amount_opened_aggregated : float

Expand source code

@property
def amount_opened_aggregated(self) -> float:
    return self._amount_opened_aggregated

var available_amount : float

Expand source code

@property
def available_amount(self) -> float:
    return self._available_amount

var barcodes : List[str]

Expand source code

@property
def barcodes(self) -> List[str]:
    return [barcode.barcode for barcode in self.product_barcodes]

var best_before_date : 

Expand source code

@property
def best_before_date(self) -> datetime.date:
    return self._best_before_date

var default_quantity_unit_purchase : QuantityUnit

Expand source code

@property
def default_quantity_unit_purchase(self) -> QuantityUnit:
    return self._default_quantity_unit_purchase

var id : int

Expand source code

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

var is_aggregated_amount : bool

Expand source code

@property
def is_aggregated_amount(self) -> bool:
    return self._is_aggregated_amount

var is_partly_in_stock : int

Expand source code

@property
def is_partly_in_stock(self) -> int:
    return self._is_partly_in_stock

var name : str

Expand source code

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

var product_barcodes : List[ProductBarcode]

Expand source code

@property
def product_barcodes(self) -> List[ProductBarcode]:
    return self._barcodes

var product_group_id : int

Expand source code

@property
def product_group_id(self) -> int:
    return self._product_group_id

Methods

def get_details(self, api_client: GrocyApiClient)

Expand source code

def get_details(self, api_client: GrocyApiClient):
    details = api_client.get_product(self.id)
    if details:
        self._name = details.product.name
        self._barcodes = [ProductBarcode(barcode) for barcode in details.barcodes]
        self._product_group_id = details.product.product_group_id
        self._available_amount = details.stock_amount

class ProductBarcode (data: ProductBarcodeData)

Expand source code

class ProductBarcode(DataModel):
    def __init__(self, data: ProductBarcodeData):
        self._barcode = data.barcode

    @property
    def barcode(self) -> str:
        return self._barcode

Ancestors

• DataModel

Instance variables

var barcode : str

Expand source code

@property
def barcode(self) -> str:
    return self._barcode

class QuantityUnit (data: QuantityUnitData)

Expand source code

class QuantityUnit(DataModel):
    def __init__(self, data: QuantityUnitData):
        self._id = data.id
        self._name = data.name
        self._name_plural = data.name_plural
        self._description = data.description

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

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

    @property
    def name_plural(self) -> str:
        return self._name_plural

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

Ancestors

• DataModel

Instance variables

var description : str

Expand source code

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

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 name_plural : str

Expand source code

@property
def name_plural(self) -> str:
    return self._name_plural

class ShoppingListProduct (raw_shopping_list: ShoppingListItem)

Expand source code

class ShoppingListProduct(DataModel):
    def __init__(self, raw_shopping_list: ShoppingListItem):
        self._id = raw_shopping_list.id
        self._product_id = raw_shopping_list.product_id
        self._note = raw_shopping_list.note
        self._amount = raw_shopping_list.amount
        self._product = None

    def get_details(self, api_client: GrocyApiClient):
        if self._product_id:
            self._product = Product(api_client.get_product(self._product_id))

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

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

    @property
    def amount(self) -> float:
        return self._amount

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

    @property
    def product(self) -> Product:
        return self._product

Ancestors

• DataModel

Instance variables

var amount : float

Expand source code

@property
def amount(self) -> float:
    return self._amount

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 : Product

Expand source code

@property
def product(self) -> Product:
    return self._product

var product_id : int

Expand source code

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

Methods

def get_details(self, api_client: GrocyApiClient)

Expand source code

def get_details(self, api_client: GrocyApiClient):
    if self._product_id:
        self._product = Product(api_client.get_product(self._product_id))