d15eeb1f9f
Build output string in component_table_entry() as the similar strings in generate_bom(). Repeating a couple of minor if-expressions is small cost to obtain a more compact and readable main expression.
180 lines
9.1 KiB
Python
180 lines
9.1 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
from dataclasses import asdict
|
|
from itertools import groupby
|
|
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
|
|
from wireviz.DataClasses import AdditionalComponent, Connector, Cable
|
|
from wireviz.wv_gv_html import html_line_breaks
|
|
from wireviz.wv_helper import clean_whitespace
|
|
|
|
BOMEntry = Dict[str, Union[str, int, float, List[str], None]]
|
|
|
|
def get_additional_component_table(harness: "Harness", component: Union[Connector, Cable]) -> List[str]:
|
|
"""Return a list of diagram node table row strings with additional components."""
|
|
rows = []
|
|
if component.additional_components:
|
|
rows.append(["Additional components"])
|
|
for part in component.additional_components:
|
|
qty = part.qty * component.get_qty_multiplier(part.qty_multiplier)
|
|
if harness.mini_bom_mode:
|
|
id = get_bom_index(harness.bom(), part)
|
|
rows.append(component_table_entry(f'#{id} ({part.type.rstrip()})', qty, part.unit))
|
|
else:
|
|
rows.append(component_table_entry(part.description, qty, part.unit, part.pn, part.manufacturer, part.mpn))
|
|
return rows
|
|
|
|
def get_additional_component_bom(component: Union[Connector, Cable]) -> List[BOMEntry]:
|
|
"""Return a list of BOM entries with additional components."""
|
|
bom_entries = []
|
|
for part in component.additional_components:
|
|
qty = part.qty * component.get_qty_multiplier(part.qty_multiplier)
|
|
bom_entries.append({
|
|
'item': part.description,
|
|
'qty': qty,
|
|
'unit': part.unit,
|
|
'manufacturer': part.manufacturer,
|
|
'mpn': part.mpn,
|
|
'pn': part.pn,
|
|
'designators': component.name if component.show_name else None
|
|
})
|
|
return bom_entries
|
|
|
|
def bom_types_group(entry: BOMEntry) -> Tuple[str, ...]:
|
|
"""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 ('item', 'unit', 'manufacturer', 'mpn', 'pn'))
|
|
|
|
def generate_bom(harness: "Harness") -> List[BOMEntry]:
|
|
"""Return a list of BOM entries generated from the harness."""
|
|
from wireviz.Harness import Harness # Local import to avoid circular imports
|
|
bom_entries = []
|
|
# connectors
|
|
for connector in harness.connectors.values():
|
|
if not connector.ignore_in_bom:
|
|
description = ('Connector'
|
|
+ (f', {connector.type}' if connector.type else '')
|
|
+ (f', {connector.subtype}' if connector.subtype else '')
|
|
+ (f', {connector.pincount} pins' if connector.show_pincount else '')
|
|
+ (f', {connector.color}' if connector.color else ''))
|
|
bom_entries.append({
|
|
'item': description, 'qty': 1, 'unit': None, 'designators': connector.name if connector.show_name else None,
|
|
'manufacturer': connector.manufacturer, 'mpn': connector.mpn, 'pn': connector.pn
|
|
})
|
|
|
|
# add connectors aditional components to bom
|
|
bom_entries.extend(get_additional_component_bom(connector))
|
|
|
|
# cables
|
|
# TODO: If category can have other non-empty values than 'bundle', maybe it should be part of item name?
|
|
for cable in harness.cables.values():
|
|
if not cable.ignore_in_bom:
|
|
if cable.category != 'bundle':
|
|
# process cable as a single entity
|
|
description = ('Cable'
|
|
+ (f', {cable.type}' if cable.type else '')
|
|
+ (f', {cable.wirecount}')
|
|
+ (f' x {cable.gauge} {cable.gauge_unit}' if cable.gauge else ' wires')
|
|
+ (' shielded' if cable.shield else ''))
|
|
bom_entries.append({
|
|
'item': description, 'qty': cable.length, 'unit': cable.length_unit, 'designators': cable.name if cable.show_name else None,
|
|
'manufacturer': cable.manufacturer, 'mpn': cable.mpn, 'pn': cable.pn
|
|
})
|
|
else:
|
|
# add each wire from the bundle to the bom
|
|
for index, color in enumerate(cable.colors):
|
|
description = ('Wire'
|
|
+ (f', {cable.type}' if cable.type else '')
|
|
+ (f', {cable.gauge} {cable.gauge_unit}' if cable.gauge else '')
|
|
+ (f', {color}' if color else ''))
|
|
bom_entries.append({
|
|
'item': description, 'qty': cable.length, 'unit': cable.length_unit, 'designators': cable.name if cable.show_name else None,
|
|
'manufacturer': index_if_list(cable.manufacturer, index),
|
|
'mpn': index_if_list(cable.mpn, index), 'pn': index_if_list(cable.pn, index)
|
|
})
|
|
|
|
# add cable/bundles aditional components to bom
|
|
bom_entries.extend(get_additional_component_bom(cable))
|
|
|
|
for item in harness.additional_bom_items:
|
|
bom_entries.append({
|
|
'item': item.get('description', ''), 'qty': item.get('qty', 1), 'unit': item.get('unit'), 'designators': item.get('designators'),
|
|
'manufacturer': item.get('manufacturer'), 'mpn': item.get('mpn'), 'pn': item.get('pn')
|
|
})
|
|
|
|
# remove line breaks if present and cleanup any resulting whitespace issues
|
|
bom_entries = [{k: clean_whitespace(v) for k, v in entry.items()} for entry in bom_entries]
|
|
|
|
# deduplicate bom
|
|
bom = []
|
|
for _, group in groupby(sorted(bom_entries, key=bom_types_group), key=bom_types_group):
|
|
group_entries = list(group)
|
|
designators = sum((make_list(entry.get('designators')) for entry in group_entries), [])
|
|
total_qty = sum(entry['qty'] for entry in group_entries)
|
|
bom.append({**group_entries[0], 'qty': round(total_qty, 3), 'designators': sorted(set(designators))})
|
|
|
|
# add an incrementing id to each bom item
|
|
return [{**entry, 'id': index} for index, entry in enumerate(bom, 1)]
|
|
|
|
def get_bom_index(bom: List[BOMEntry], part: AdditionalComponent) -> int:
|
|
"""Return id of BOM entry or raise StopIteration 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), 'item': part.description}))
|
|
return next(entry['id'] for entry in bom if bom_types_group(entry) == target)
|
|
|
|
def bom_list(bom: List[BOMEntry]) -> List[List[str]]:
|
|
"""Return list of BOM rows as lists of column strings with headings in top row."""
|
|
keys = ['id', 'item', 'qty', 'unit', 'designators'] # these BOM columns will always be included
|
|
for fieldname in ['pn', 'manufacturer', 'mpn']: # these optional BOM columns will only be included if at least one BOM item actually uses them
|
|
if any(entry.get(fieldname) for entry in bom):
|
|
keys.append(fieldname)
|
|
# list of staic bom header names, headers not specified here are generated by capitilising the internal name
|
|
bom_headings = {
|
|
"pn": "P/N",
|
|
"mpn": "MPN"
|
|
}
|
|
return ([[bom_headings.get(k, k.capitalize()) for k in keys]] + # Create header row with key names
|
|
[[make_str(entry.get(k)) for k in keys] for entry in bom]) # Create string list for each entry row
|
|
|
|
def component_table_entry(
|
|
type: str,
|
|
qty: Union[int, float],
|
|
unit: Optional[str] = None,
|
|
pn: Optional[str] = None,
|
|
manufacturer: Optional[str] = None,
|
|
mpn: Optional[str] = None,
|
|
) -> str:
|
|
"""Return a diagram node table row string with an additional component."""
|
|
manufacturer_str = manufacturer_info_field(manufacturer, mpn)
|
|
output = (f'{qty}'
|
|
+ (f' {unit}' if unit else '')
|
|
+ f' x {type}'
|
|
+ ('<br/>' if pn or manufacturer_str else '')
|
|
+ (f'P/N: {pn}' if pn else '')
|
|
+ (', ' if pn and manufacturer_str else '')
|
|
+ (manufacturer_str or ''))
|
|
# format the above output as left aligned text in a single visible cell
|
|
# indent is set to two to match the indent in the generated html table
|
|
return f'''<table border="0" cellspacing="0" cellpadding="3" cellborder="1"><tr>
|
|
<td align="left" balign="left">{html_line_breaks(output)}</td>
|
|
</tr></table>'''
|
|
|
|
def manufacturer_info_field(manufacturer: Optional[str], mpn: Optional[str]) -> Optional[str]:
|
|
"""Return the manufacturer and/or the mpn in one single string or None otherwise."""
|
|
if manufacturer or mpn:
|
|
return f'{manufacturer if manufacturer else "MPN"}{": " + str(mpn) if mpn else ""}'
|
|
else:
|
|
return None
|
|
|
|
def index_if_list(value: Any, index: int) -> Any:
|
|
"""Return the value indexed if it is a list, or simply the value otherwise."""
|
|
return value[index] if isinstance(value, list) else value
|
|
|
|
def make_list(value: Any) -> list:
|
|
"""Return value if a list, empty list if None, or single element list otherwise."""
|
|
return value if isinstance(value, list) else [] if value is None else [value]
|
|
|
|
def make_str(value: Any) -> str:
|
|
"""Return comma separated elements if a list, empty string if None, or value as a string otherwise."""
|
|
return ', '.join(str(element) for element in make_list(value))
|