functions/lego_classes.py

-'''
-File consists of several classes for the different elements of a device.
-'''
-from __future__ import annotations
-import uuid
-from typing import Any, Union, Literal, TypedDict, TypeVar, Type, List, Optional, Dict
-
-# TODO
-# - Parents direkt setzen
-# - Alle gemeinsamen JSON attribute im LegoItem constructor
-# - enforce uuid
-# - Docstrings
-# - Beschreibung von Teilen (-> properties)
-# - Gute String Darstellung
-# - Minimalbeispiel für KPIs
-# - Klassen analog zur deutschen Aufgabenstellung umbenennen (assembly, component) #13 #17
-# - Export als JSON
-# - Export als GraphViz
-# - AggregationsEbene enum (system, assembly, subassembly, component)
-
-
-class LegoItem:
-    def __init__(self, item_number: int, mass: float, delivery_time: int, **kwargs) -> None:
-        # , *args, **kwargs not handling additional/optional specs right now
-        self.id: uuid.UUID = uuid.uuid4()
-        self.properties: dict = kwargs
-        self.item_number: int = item_number
-        self.mass: float = mass
-        self.delivery_time: int = delivery_time
-        # TODO: Set parent directly and not via id? This would allow for easier traversal of the tree
-        #   Currently there is no way to search for parts and components in tree by id.
-        self.parent_id = None  # This will be set when added to a component
-
-    def __str__(self):
-        return (
-            f"Item(id={self.id}, item_number={self.item_number}, "
-            f"mass={self.mass}, delivery_time={self.delivery_time}, "
-            f"parent_id={self.parent_id})"
-        )
-
-    def __repr__(self):
-        return f"Lego Item [{self.id}]"
-
-
-class LegoComponent:
-    def __init__(self, **kwargs) -> None:
-        self.id: uuid.UUID = uuid.uuid4()
-        self.properties: dict = kwargs
-        self.items: List[LegoItem] = []
-        self.components: List[LegoComponent] = []
-        self.parent_id: None | uuid.UUID = None
-
-    def add_item(self, item: LegoItem) -> None:
-        if not isinstance(item, LegoItem):
-            raise TypeError(f"'item' should be of type LegoPart, got {type(item).__name__} instead.")
-        item.parent_id = self.id
-        self.items.append(item)
-
-    def add_component(self, component: LegoComponent) -> None:
-        if not isinstance(component, LegoComponent):
-            raise TypeError(f"'component' should be of type LegoComponent, got {type(component).__name__} instead.")
-        component.parent_id = self.id
-        self.components.append(component)
-
-    def children(self) -> Dict[str, List[LegoItem] | List[LegoComponent]]:
-        return {'items': self.items, 'components': self.components}
-
-    def get_item_list(self) -> List[LegoItem]:
-        item_list = []
-        item_list.extend(self.items)
-        for component in self.components:
-            item_list.extend(component.get_item_list())
-        return item_list
-
-    def __repr__(self):
-        return f"Lego Component [{self.id}]"
-
-# TODO: Adjust default output when printing an item or component
-
-def print_component_tree(root, level=0, is_last=False):
-    # print component
-    component_padding = ""
-    if level > 0:
-        component_padding += "│   " * (level - 1)
-        if is_last:
-            component_padding += "└── "
-        else:
-            component_padding += "├── "
-    print(f"{component_padding}{root}")
-    # recursively print child components
-    for i, component in enumerate(root.components):
-        is_last_ = i == len(root.components) - 1 and len(root.items) == 0
-        print_component_tree(component, level + 1, is_last_)
-    # print items
-    for i, item in enumerate(root.items):
-        item_padding = "│   " * level
-        item_padding += "├── " if i < len(root.items) - 1 else "└── "
-        print(f"{item_padding}{item}")

main_kpi.py

-'''
-FAIR Quality KPIs
-
-'''
-
-def main ():
-    print("Hello ;-)")
-    pass
-
-if __name__ == "__main__":
-    main()
\ No newline at end of file

requirements.txt

-pandas
-tables

test-legoclasses.ipynb

-%% Cell type:code id: tags:
-
-``` python
-# import functions.lego_classes as lego_classes
-from functions.lego_classes import LegoItem
-from functions.lego_classes import LegoComponent
-```
-
-%% Cell type:code id: tags:
-
-``` python
-# Test manually creating some item and components
-
-item1 = LegoItem(1,0.10,10)
-item2 = LegoItem(3,0.30,30)
-item3 = LegoItem(2, 0.2,20)
-
-
-
-component1 = LegoComponent()
-# component1.add_item(item1)
-component2 = LegoComponent(item2)
-
-componentall = LegoComponent([component1,component2]) # This will be saved as items for some reasaon
-# component3 = LegoComponent(item3,component1)
-# component3.add(item2) # Can't really use an item twice
-# component3.add(component2)
-print(componentall.items)
-```
-
-%% Output
-
-    [<functions.lego_classes.LegoComponent object at 0x000002720F4BF7F0>, <functions.lego_classes.LegoComponent object at 0x000002720F4BF790>]
-
-%% Cell type:code id: tags:
-
-``` python
-```
-
-%% Cell type:code id: tags:
-
-``` python
-## Let's test the json stuff
-import json
-# import tkinter as tk
-```
-
-%% Cell type:code id: tags:
-
-``` python
-# First level list handling
-
-def read_json(file_path):
-    with open(file_path, 'r') as f:
-        data = json.load(f)
-    return data
-json_list_data = read_json('example_item_data_list.json')
-# that produces a list, we'd prefer a dict
-
-# Clever way to just create an item for each listed element
-def create_all_items(data):
-    items = []
-    for item_data in data:
-        item_number = item_data.get('item_number')
-        mass = item_data.get('mass')
-        delivery_time = item_data.get('delivery_time')
-        # specific_data = item_data.get('specific_data', {})
-        item = LegoItem(item_number, mass, delivery_time)
-        items.append(item)
-    return items
-
-all_items = create_all_items(json_list_data)
-
-# How to get entries for a specific item
-def get_item_by_number(data, item_number):
-    datasheet = [item for item in data if item['item_number' ] == item_number]
-    return datasheet
-
-sheet1 = get_item_by_number(json_list_data, 2) # this is a list? meh
-
-```
-
-%% Cell type:code id: tags:
-
-``` python
-# vs first level dict handling
-
-with open('example_item_data_dict.json') as json_file:
-    json_dict = json.load(json_file)
-    print(type(json_dict))
-    print(json_dict["1"])
-
-sheet2_from_dict = json_dict["2"]
-# Create an item for this:
-def create_item_from_sheet(dict):
-    item_number = dict["item_number"]
-    mass = dict["mass"]
-    delivery_time =["delivery_time"]
-    item = LegoItem(item_number, mass, delivery_time)
-    return item
-
-itemfromdict = create_item_from_sheet(sheet2_from_dict)
-
-```
-
-%% Output
-
-    <class 'dict'>
-    {'item_number': 1, 'mass': 10, 'delivery_time': 1}

test-legoclasses.py

-
-# import functions.lego_classes as lego_classes
-from functions.lego_classes import LegoItem
-from functions.lego_classes import LegoComponent
-
-# Test manually creating some item and components
-
-item1 = LegoItem(1,0.10,10)
-item2 = LegoItem(3,0.30,30)
-item3 = LegoItem(2, 0.2,20)
-
-
-
-component1 = LegoComponent()
-# component1.add_item(item1)
-component2 = LegoComponent(item2)
-
-componentall = LegoComponent([item1,item2],[])  # Some combinations might result in errors
-# component3 = LegoComponent(item3,component1)
-# component3.add(item2) # Can't really use an item twice
-# component3.add(component2)
-print(componentall.items)
-x = componentall.children()
-print(x)
-
-print(type(x))
-alist = ["abc","def"]