#!/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, bom_bubble from wireviz.wv_helper import clean_whitespace BOMColumn = str # = Literal['id', 'description', 'qty', 'unit', 'designators', 'pn', 'manufacturer', 'mpn'] BOMEntry = Dict[BOMColumn, Union[str, int, float, List[str], None]] def optional_fields(part: Union[Connector, Cable, AdditionalComponent]) -> BOMEntry: """Return part field values for the optional BOM columns as a dict.""" return {'pn': part.pn, 'manufacturer': part.manufacturer, 'mpn': part.mpn} 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: common_args = { 'qty': part.qty * component.get_qty_multiplier(part.qty_multiplier), 'unit': part.unit, } # if True: # id = get_bom_index(harness.bom(), part) # rows.append(component_table_entry(f'#{id} ({part.type.rstrip()})', **common_args)) # else: # rows.append(component_table_entry(part.description, **common_args, **optional_fields(part))) id = get_bom_index(harness.bom(), part) manufacturer_str = manufacturer_info_field(part.manufacturer, part.mpn) columns = [] if harness.show_bom_item_numbers: columns.append(bom_bubble(id)) columns.append(f'{part.qty * component.get_qty_multiplier(part.qty_multiplier)}' + (f' {part.unit}' if part.unit else ' x')) columns.append(f'{part.type}') if harness.show_part_numbers: columns.append(f'P/N: {part.pn}' if part.pn else '') columns.append(f'{manufacturer_str}' if manufacturer_str else '') columns.append(f'{part.note}' if part.note else '') rowstr = '' + ''.join([f'{col}' for col in columns]) + '' rows.append(rowstr) print(rows) pre = '' post = '
' if len(rows) > 0: tbl = pre + ''.join(rows) + post else: return None return tbl 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: bom_entries.append({ 'description': part.description, 'qty': part.qty * component.get_qty_multiplier(part.qty_multiplier), 'unit': part.unit, 'designators': component.name if component.show_name else None, **optional_fields(part), }) 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 ('description', '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({ 'description': description, 'designators': connector.name if connector.show_name else None, **optional_fields(connector), }) # 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 description? 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({ 'description': description, 'qty': cable.length, 'unit': cable.length_unit, 'designators': cable.name if cable.show_name else None, **optional_fields(cable), }) 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({ 'description': description, 'qty': cable.length, 'unit': cable.length_unit, 'designators': cable.name if cable.show_name else None, **{k: index_if_list(v, index) for k, v in optional_fields(cable).items()}, }) # add cable/bundles aditional components to bom bom_entries.extend(get_additional_component_bom(cable)) # add harness aditional components to bom directly, as they both are List[BOMEntry] bom_entries.extend(harness.additional_bom_items) # 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.get('qty', 1) 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 entry 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), 'description': 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', 'description', '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 entry 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 = { "description": "Item", # TODO: Remove this line to use 'Description' in BOM heading. "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}' + ('
' 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''' {html_line_breaks(output)} ''' 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))