warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Use new BOMKey type alias for get_bom_index() target argument

Browse Source 
Replace the get_bom_index() part argument with the target key argument
to prepare for quering any BOM entry that matches the target key.
This commit is contained in:
KV 2021-03-25 21:00:32 +01:00
parent 2c99e83d52
commit 55760acafc
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/wireviz/wv_bom.py
View File

@ -9,6 +9,7 @@ from wireviz.DataClasses import AdditionalComponent, Connector, Cable
from wireviz.wv_gv_html import html_line_breaks from wireviz.wv_gv_html import html_line_breaks
from wireviz.wv_helper import clean_whitespace from wireviz.wv_helper import clean_whitespace
BOMKey = Tuple[str, ...]
BOMColumn = str # = Literal['id', 'description', 'qty', 'unit', 'designators', 'pn', 'manufacturer', 'mpn'] BOMColumn = str # = Literal['id', 'description', 'qty', 'unit', 'designators', 'pn', 'manufacturer', 'mpn']
BOMEntry = Dict[BOMColumn, Union[str, int, float, List[str], None]] BOMEntry = Dict[BOMColumn, Union[str, int, float, List[str], None]]
@ -27,7 +28,7 @@ def get_additional_component_table(harness: "Harness", component: Union[Connecto
'unit': part.unit, 'unit': part.unit,
} }
if harness.mini_bom_mode: if harness.mini_bom_mode:
id = get_bom_index(harness.bom(), part) id = get_bom_index(harness.bom(), bom_types_group({**asdict(part), 'description': part.description}))
rows.append(component_table_entry(f'#{id} ({part.type.rstrip()})', **common_args)) rows.append(component_table_entry(f'#{id} ({part.type.rstrip()})', **common_args))
else: else:
rows.append(component_table_entry(part.description, **common_args, **optional_fields(part))) rows.append(component_table_entry(part.description, **common_args, **optional_fields(part)))
@ -46,9 +47,9 @@ def get_additional_component_bom(component: Union[Connector, Cable]) -> List[BOM
}) })
return bom_entries return bom_entries
def bom_types_group(entry: BOMEntry) -> Tuple[str, ...]: def bom_types_group(entry: BOMEntry) -> BOMKey:
"""Return a tuple of string values from the dict that must be equal to join BOM entries.""" """Return a tuple of string values from the dict that must be equal to join BOM entries."""
return tuple(make_str(entry.get(key)) for key in ('description', 'unit', 'manufacturer', 'mpn', 'pn')) return tuple(clean_whitespace(make_str(entry.get(key))) for key in ('description', 'unit', 'manufacturer', 'mpn', 'pn'))
def generate_bom(harness: "Harness") -> List[BOMEntry]: def generate_bom(harness: "Harness") -> List[BOMEntry]:
"""Return a list of BOM entries generated from the harness.""" """Return a list of BOM entries generated from the harness."""
@ -117,10 +118,8 @@ def generate_bom(harness: "Harness") -> List[BOMEntry]:
# add an incrementing id to each bom entry # add an incrementing id to each bom entry
return [{**entry, 'id': index} for index, entry in enumerate(bom, 1)] return [{**entry, 'id': index} for index, entry in enumerate(bom, 1)]
def get_bom_index(bom: List[BOMEntry], part: AdditionalComponent) -> int: def get_bom_index(bom: List[BOMEntry], target: BOMKey) -> int:
"""Return id of BOM entry or raise exception if not found.""" """Return id of BOM entry or raise exception if not found."""
# Remove linebreaks and clean whitespace of values in search
target = tuple(clean_whitespace(v) for v in bom_types_group({**asdict(part), 'description': part.description}))
for entry in bom: for entry in bom:
if bom_types_group(entry) == target: if bom_types_group(entry) == target:
return entry['id'] return entry['id']