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

Continue work on BOM handling (WIP)

Browse Source
This commit is contained in:
Daniel Rojas 2024-04-26 09:38:55 +02:00
parent cc18c62f3e
commit 1da0b0fc56
4 changed files with 135 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
src/wireviz/wv_dataclasses.py
View File

@ -190,7 +190,7 @@ class Component:
supplier: str = None supplier: str = None
spn: str = None spn: str = None
# BOM info # BOM info
qty: NumberAndUnit = NumberAndUnit(1, None) qty: Optional[Union[None, int, float]] = None
amount: Optional[NumberAndUnit] = None amount: Optional[NumberAndUnit] = None
sum_amounts_in_bom: bool = True sum_amounts_in_bom: bool = True
ignore_in_bom: bool = False ignore_in_bom: bool = False
@ -201,44 +201,31 @@ class Component:
partnos = [remove_links(entry) for entry in partnos] partnos = [remove_links(entry) for entry in partnos]
partnos = tuple(partnos) partnos = tuple(partnos)
self.partnumbers = PartNumberInfo(*partnos) self.partnumbers = PartNumberInfo(*partnos)
self.qty = parse_number_and_unit(self.qty, None)
self.amount = parse_number_and_unit(self.amount, None) self.amount = parse_number_and_unit(self.amount, None)
@property @property
def bom_hash(self) -> BomHash: def bom_hash(self) -> BomHash:
if isinstance(self, AdditionalComponent):
_amount = self.amount_computed
else:
_amount = self.amount
if self.sum_amounts_in_bom: if self.sum_amounts_in_bom:
_hash = BomHash( _hash = BomHash(
description=self.description, description=self.description,
qty_unit=self.amount.unit if self.amount else None, qty_unit=_amount.unit if _amount else None,
amount=None, amount=None,
partnumbers=self.partnumbers, partnumbers=self.partnumbers,
) )
else: else:
_hash = BomHash( _hash = BomHash(
description=self.description, description=self.description,
qty_unit=self.qty.unit, qty_unit=None,
amount=self.amount, amount=_amount,
partnumbers=self.partnumbers, partnumbers=self.partnumbers,
) )
return _hash return _hash
@property
def bom_qty(self) -> float:
if self.sum_amounts_in_bom:
if self.amount:
return self.qty.number * self.amount.number
else:
return self.qty.number
else:
return self.qty.number
def bom_amount(self) -> NumberAndUnit:
if self.sum_amounts_in_bom:
return NumberAndUnit(None, None)
else:
return self.amount
@property @property
def has_pn_info(self) -> bool: def has_pn_info(self) -> bool:
return any([self.pn, self.manufacturer, self.mpn, self.supplier, self.spn]) return any([self.pn, self.manufacturer, self.mpn, self.supplier, self.spn])
@ -272,7 +259,9 @@ class GraphicalComponent(Component): # abstract class
@dataclass @dataclass
class AdditionalComponent(GraphicalComponent): class AdditionalComponent(GraphicalComponent):
qty_multiplier: Union[QtyMultiplierConnector, QtyMultiplierCable, int] = 1 qty_multiplier: Union[QtyMultiplierConnector, QtyMultiplierCable, int] = 1
_qty_multiplier_computed: Union[int, float] = 1 qty_computed: Optional[int] = None
explicit_qty: bool = True
amount_computed: Optional[NumberAndUnit] = None
note: str = None note: str = None
def __post_init__(self): def __post_init__(self):
@ -291,9 +280,13 @@ class AdditionalComponent(GraphicalComponent):
else: else:
raise Exception(f"Unknown qty multiplier: {self.qty_multiplier}") raise Exception(f"Unknown qty multiplier: {self.qty_multiplier}")
@property if self.qty is None and self.qty_multiplier in [
def bom_qty(self): QtyMultiplierCable.TOTAL_LENGTH,
return self.qty.number * self._qty_multiplier_computed QtyMultiplierCable.LENGTH,
1,
]: # simplify add.comp. table in parent node for implicit qty 1
self.qty = 1
self.explicit_qty = False
@dataclass @dataclass
@ -357,13 +350,12 @@ class Connector(TopLevelGraphicalComponent):
self.color = MultiColor(self.color) self.color = MultiColor(self.color)
# connectors do not support custom qty or amount # connectors do not support custom qty or amount
if self.qty != NumberAndUnit(1, None): if self.qty is None:
self.qty = 1
if self.qty != 1:
raise Exception("Connector qty != 1 not supported") raise Exception("Connector qty != 1 not supported")
if self.amount is not None: if self.amount is not None:
raise Exception("Connector amount not supported") raise Exception("Connector amount not supported")
# TODO: Delete next two assignments if tests above is sufficient. Please verify!
self.qty = NumberAndUnit(1, None)
self.amount = None
if isinstance(self.image, dict): if isinstance(self.image, dict):
self.image = Image(**self.image) self.image = Image(**self.image)
@ -467,7 +459,12 @@ class Connector(TopLevelGraphicalComponent):
raise Exception("Used a cable multiplier in a connector!") raise Exception("Used a cable multiplier in a connector!")
else: # int or float else: # int or float
computed_factor = subitem.qty_multiplier computed_factor = subitem.qty_multiplier
subitem._qty_multiplier_computed = computed_factor
if subitem.qty is not None:
subitem.qty_computed = subitem.qty * computed_factor
else:
subitem.qty_computed = computed_factor
subitem.amount_computed = subitem.amount
@dataclass @dataclass
@ -602,14 +599,17 @@ class Cable(TopLevelGraphicalComponent):
@property @property
def bom_hash(self): def bom_hash(self):
if self.category == "bundle": if self.category == "bundle":
raise Exception("Do this at the wire level!") # TODO # This line should never be reached, since caller checks
# whether item is a bundle and if so, calls bom_hash
# for each individual wire instead
raise Exception("Do this at the wire level!")
else: else:
return super().bom_hash return super().bom_hash
@property @property
def description(self) -> str: def description(self) -> str:
if self.category == "bundle": if self.category == "bundle":
raise Exception("Do this at the wire level!") # TODO raise Exception("Do this at the wire level!")
else: else:
substrs = [ substrs = [
("", "Cable"), ("", "Cable"),
@ -647,6 +647,12 @@ class Cable(TopLevelGraphicalComponent):
self.bgcolor_title = SingleColor(self.bgcolor_title) self.bgcolor_title = SingleColor(self.bgcolor_title)
self.color = MultiColor(self.color) self.color = MultiColor(self.color)
# cables do not support custom qty or amount
if self.qty is None:
self.qty = 1
if self.qty != 1:
raise Exception("Cable qty != 1 not supported")
if isinstance(self.image, dict): if isinstance(self.image, dict):
self.image = Image(**self.image) self.image = Image(**self.image)
@ -770,27 +776,40 @@ class Cable(TopLevelGraphicalComponent):
) )
qty_multipliers_computed = { qty_multipliers_computed = {
"WIRECOUNT": len(self.wire_objects), "WIRECOUNT": len(self.wire_objects),
"TERMINATIONS": 999, # TODO # "TERMINATIONS": ___, # TODO
"LENGTH": self.length.number if self.length else 0, "LENGTH": self.length.number if self.length else 0,
"TOTAL_LENGTH": total_length, "TOTAL_LENGTH": total_length,
} }
for subitem in self.additional_components: for subitem in self.additional_components:
if isinstance(subitem.qty_multiplier, QtyMultiplierCable): if isinstance(subitem.qty_multiplier, QtyMultiplierCable):
computed_factor = qty_multipliers_computed[subitem.qty_multiplier.name] computed_factor = qty_multipliers_computed[subitem.qty_multiplier.name]
# inherit component's length unit if appropriate
if subitem.qty_multiplier.name in ["LENGTH", "TOTAL_LENGTH"]: if subitem.qty_multiplier.name in ["LENGTH", "TOTAL_LENGTH"]:
if subitem.qty.unit is not None: # since length can have a unit, use amount fields to hold
if subitem.amount is not None:
raise Exception( raise Exception(
f"No unit may be specified when using" f"No amount may be specified when using "
f"{subitem.qty_multiplier} as a multiplier" f"{subitem.qty_multiplier.name} as a multiplier."
) )
subitem.qty = NumberAndUnit(subitem.qty.number, self.length.unit) subitem.qty_computed = subitem.qty if subitem.qty else 1
subitem.amount_computed = NumberAndUnit(
computed_factor, self.length.unit
)
else:
# multiplier unrelated to length, therefore no unit
if subitem.qty is not None:
subitem.qty_computed = subitem.qty * computed_factor
else:
subitem.qty_computed = computed_factor
subitem.amount_computed = subitem.amount
elif isinstance(subitem.qty_multiplier, QtyMultiplierConnector): elif isinstance(subitem.qty_multiplier, QtyMultiplierConnector):
raise Exception("Used a connector multiplier in a cable!") raise Exception("Used a connector multiplier in a cable!")
else: # int or float else: # int or float
computed_factor = subitem.qty_multiplier if subitem.qty is not None:
subitem._qty_multiplier_computed = computed_factor subitem.qty_computed = subitem.qty * subitem.qty_multiplier
else:
subitem.qty_computed = subitem.qty_multiplier
subitem.amount_computed = subitem.amount
@dataclass @dataclass

31
src/wireviz/wv_graphviz.py
View File

@ -114,11 +114,28 @@ def gv_additional_component_table(component):
rows = [] rows = []
for subitem in component.additional_components: for subitem in component.additional_components:
if subitem.explicit_qty:
text_qty, unit_qty = subitem.qty_computed, "x"
if subitem.amount_computed is not None:
text_desc = f"{subitem.amount_computed.number} {subitem.amount_computed.unit} {subitem.description}"
else:
text_desc = f"{subitem.description}"
else:
if subitem.amount_computed is not None:
text_qty, unit_qty = (
subitem.amount_computed.number,
subitem.amount_computed.unit,
)
else:
text_qty, unit_qty = "1", "x"
text_desc = subitem.description
firstline = [ firstline = [
Td(bom_bubble(subitem.bom_id)), Td(bom_bubble(subitem.bom_id)),
Td(f"{subitem.bom_qty}", align="right"), Td(text_qty, align="right"),
Td(f"{subitem.qty.unit if subitem.qty.unit else 'x'}", align="left"), Td(unit_qty, align="left"),
Td(f"{subitem.description}", align="left"), Td(text_desc, align="left"),
Td(f"{subitem.note if subitem.note else ''}", align="left"), Td(f"{subitem.note if subitem.note else ''}", align="left"),
] ]
rows.append(Tr(firstline)) rows.append(Tr(firstline))
@ -584,7 +601,9 @@ def apply_dot_tweaks(dot, tweak):
if n_subs < 1: if n_subs < 1:
warnings.warn(f"tweak: {attr} not found in {keyword}!") warnings.warn(f"tweak: {attr} not found in {keyword}!")
elif n_subs > 1: elif n_subs > 1:
warnings.warn(f"tweak: {attr} removed {n_subs} times in {keyword}!") warnings.warn(
f"tweak: {attr} removed {n_subs} times in {keyword}!"
)
continue continue
if len(value) == 0 or " " in value: if len(value) == 0 or " " in value:
@ -597,7 +616,9 @@ def apply_dot_tweaks(dot, tweak):
# If attr not found, then append it # If attr not found, then append it
entry = re.sub(r"\]$", f" {attr}={value}]", entry) entry = re.sub(r"\]$", f" {attr}={value}]", entry)
elif n_subs > 1: elif n_subs > 1:
warnings.warn(f"tweak: {attr} overridden {n_subs} times in {keyword}!") warnings.warn(
f"tweak: {attr} overridden {n_subs} times in {keyword}!"
)
dot.body[i] = entry dot.body[i] = entry

30
src/wireviz/wv_harness.py
View File

@ -86,7 +86,7 @@ class Harness:
arrow = Arrow(direction=parse_arrow_str(arrow_str), weight=ArrowWeight.SINGLE) arrow = Arrow(direction=parse_arrow_str(arrow_str), weight=ArrowWeight.SINGLE)
self.mates.append(MateComponent(from_name, to_name, arrow)) self.mates.append(MateComponent(from_name, to_name, arrow))
def populate_bom(self): def populate_bom(self): # called once harness creation is complete
# helper lists # helper lists
all_toplevel_items = ( all_toplevel_items = (
list(self.connectors.values()) list(self.connectors.values())
@ -131,12 +131,10 @@ class Harness:
if item.ignore_in_bom: if item.ignore_in_bom:
continue continue
if not item.bom_hash in self.bom: if not item.bom_hash in self.bom:
print(f"{item}'s hash' not found in BOM dict.") print(f"{item}'s hash' not found in BOM dict.") # Should not happen
continue continue
item.bom_id = self.bom[item.bom_hash]["id"] item.bom_id = self.bom[item.bom_hash]["id"]
# print_bom_table(self.bom) # for debugging
def _add_to_internal_bom(self, item: Component): def _add_to_internal_bom(self, item: Component):
if item.ignore_in_bom: if item.ignore_in_bom:
return return
@ -173,38 +171,50 @@ class Harness:
cat = "" cat = ""
if item.category == "bundle": if item.category == "bundle":
# wires of a bundle are added as individual BOM entries
for subitem in item.wire_objects.values(): for subitem in item.wire_objects.values():
_add( _add(
hash=subitem.bom_hash, hash=subitem.bom_hash,
qty=item.bom_qty, # should be 1 qty=item.qty, # should be 1
designator=item.designator, # inherit from parent item designator=item.designator, # inherit from parent item
category=cat, category=cat,
) )
else: else:
_add( _add(
hash=item.bom_hash, hash=item.bom_hash,
qty=item.bom_qty, qty=item.qty, # should be 1
designator=item.designator, designator=item.designator,
category=cat, category=cat,
) )
if item.additional_components: if item.additional_components:
if item.category == "bundle":
pass # TODO
item.compute_qty_multipliers() item.compute_qty_multipliers()
for comp in item.additional_components: for comp in item.additional_components:
if comp.ignore_in_bom: if comp.ignore_in_bom:
continue continue
if comp.sum_amounts_in_bom:
if comp.amount_computed:
total_qty = comp.qty_computed * comp.amount_computed.number
else:
total_qty = comp.qty_computed
else:
total_qty = comp.qty_computed
_add( _add(
hash=comp.bom_hash, hash=comp.bom_hash,
designator=item.designator, designator=item.designator,
qty=comp.bom_qty, qty=total_qty,
# no explicit qty specified; assume qty = 1
# used to simplify add.comp. table within parent node
# e.g. show "10 mm Heatshrink" instead of "1x 10 mm Heatshrink"
category=BomCategory.ADDITIONAL_INSIDE, category=BomCategory.ADDITIONAL_INSIDE,
) )
elif isinstance(item, AdditionalBomItem): elif isinstance(item, AdditionalBomItem):
cat = BomCategory.ADDITIONAL_OUTSIDE cat = BomCategory.ADDITIONAL_OUTSIDE
_add( _add(
hash=item.bom_hash, hash=item.bom_hash,
qty=item.bom_qty, qty=item.qty,
designator=None, designator=None,
category=cat, category=cat,
) )

48
tests/bom/bomqty.yml
View File

@ -7,21 +7,16 @@ connectors:
type: Contains additional components type: Contains additional components
pincount: 6 pincount: 6
additional_components: additional_components:
- - type: One, no unit
type: One, no unit - type: Two kilometers
- amount: 2 km
type: Two kilometers - type: Takes pincount times seven
qty: 2 km
-
type: Takes pincount times seven
qty: 7 qty: 7
qty_multiplier: pincount qty_multiplier: pincount
- - type: Takes 10 mm per populated pin
type: Takes 10 mm per populated pin amount: 10 mm
qty: 10 mm
qty_multiplier: populated qty_multiplier: populated
- - type: Takes number of connections
type: Takes number of connections
qty_multiplier: connections qty_multiplier: connections
cables: cables:
@ -31,22 +26,19 @@ cables:
length: 1.5 length: 1.5
color_code: DIN color_code: DIN
additional_components: additional_components:
- - type: One
type: One - type: Three centimeters
- amount: 3 cm
type: Three centimeters - type: Takes wirecount times two
qty: 3 cm
-
type: Takes wirecount times two
qty: 2 qty: 2
qty_multiplier: wirecount qty_multiplier: wirecount
- - type: Takes length times three
type: Takes length times three qty: 3
qty: 3 # adding unit here should cause error because the length already has a unit # adding amount here should cause error because the length already has a unit
qty_multiplier: length qty_multiplier: length
- - type: Takes total length times three
type: Takes total length times three qty: 2
qty: 2 # adding unit here should cause error because the length already has a unit # adding amount here should cause error because the length already has a unit
qty_multiplier: total_length qty_multiplier: total_length
W2: W2:
@ -55,11 +47,9 @@ cables:
colors: [tomato, skyblue] colors: [tomato, skyblue]
connections: connections:
- - - X1: [1-3]
- X1: [1-3]
- C1: [1-3] - C1: [1-3]
- X2: [1-3] - X2: [1-3]
- - - X1: [3, 4]
- X1: [3,4]
- W2: [1, 2] - W2: [1, 2]
- X2: [3, 4] - X2: [3, 4]