Better additional component BOM table #226

formatc1702 · 2021-03-23T09:54:11Z

Closes #224.
Based on #197 (still unmerged).
Implements an additional note attribute for additional components as proposed in #222.
Implements additional_parameters (Dict) to be displayed in connector and cable nodes.
Will integrate #214 to allow the user to set show_part_numbers and show_bom_item_numbers from YAML.

Will rebase this branch onto dev once #197 and #214 are merged.

- Use the actual BOM as first parameter instead of the whole harness. - Use a whole AdditionalComponent as second parameter instead of each attribute separately.

Move the lambda declaration out of the function scope for common access from two different functions.

Assign input designators once to a temporary variable for easy reusage.

https://stackoverflow.com/questions/4978567/should-a-return-statement-have-parentheses

- Use one common entry loop to consume iterator only once. - Use same key function for sort() and groupby(), except replace None with empty string when sorting.

Seems to be the most popular search alternative: https://stackoverflow.com/questions/8653516/python-list-of-dictionaries-search Raising StopIteration if not found is better than returning None to detect such an internal error more easily.

Make a list from the group iterator for reusage in sum expressions and to pick first group entry. The expected group sizes are very small, so performance loss by creating a temporary list should be neglectable. Alternativly, itertools.tee(group, 3) could be called to triplicate the iterator, but it was not chosen for readability reasons.

This type alias describes the possible types of keys and values in the dict representing a BOM entry.

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.

This way, both BOM and harness.additional_bom_items uses the same set of keys in their dict entries. This was originally suggested in a #115 review, but had too many issues to be implemented then.

to simplyfy code

formatc1702 · 2021-03-23T11:45:52Z

Current state:

Source

connectors:
  X1:
    type: Plug
    pincount: 4
    pn: 123
    manufacturer: ACME
    mpn: ABC
    additional_components:
      -
        type: Crimp
        pn: 987
        manufacturer: ACME
        mpn: ZYX
        qty_multiplier: populated
      -
        type: Housing
        pn: 345
        manufacturer: OTHER
      -
        type: Label
        note: '"ABC-123"'

  X2:
    type: Receptacle
    pincount: 4
    pn: 234
    manufacturer: ACME
    mpn: DEF
    additional_components:
      -
        type: Crimp
        pn: 876
        manufacturer: ACME
        mpn: WVU


cables:
  W1:
    wirecount: 4
    gauge: 0.25
    length: 99
    color_code: DIN
    pn: qwerty
    mpn: uiop
    additional_components:
      -
        type: Sleeving
        qty: 5
        unit: m

connections:
  -
    - X1: [1-4]
    - W1: [1-4]
    - X2: [1-4]

The issue of retrieving BOM numbers for the major components is still open.

formatc1702 · 2021-03-23T12:08:51Z

@kvid @Tyler-Ward

I am open for suggestions as to how to extract the assigned BOM ID for cables and connectors (after deduplication etc.) and inserting it into the new bom_item_number attribute of each component, before rendering the graphical output.

as proposed in #222

formatc1702 · 2021-03-23T15:00:29Z

Using additional_parameters to add user-defined parameters to connectors and cables, as proposed in #222:

Source

connectors:
  X1:
    type: KK 254
    subtype: plug
    pincount: 4
    pinlabels: [QWE,RTY,UIO,P__]
    pn: 123
    manufacturer: ACME
    mpn: ABC
    additional_parameters:
      Sleeving removal: 15 mm
      Insulation removal: 2 mm
      Label: A01-5-10
      Tag: ABCDEFG
    additional_components:
      -
        type: Crimp
        pn: 987
        manufacturer: ACME
        mpn: ZYX
        qty_multiplier: populated
      -
        type: Housing
        pn: 345
        manufacturer: OTHER
      -
        type: Label
        note: '"ABC-123"'

  X2:
    type: KPPX
    subtype: Plug
    pincount: 4
    pn: 234
    manufacturer: ACME
    mpn: DEF
    additional_components:
      -
        type: Crimp
        pn: 876
        manufacturer: ACME
        mpn: WVU
        qty_multiplier: populated


cables:
  W1:
    wirecount: 4
    gauge: 0.25
    length: 99
    color_code: DIN
    pn: qwerty
    mpn: uiop
    additional_parameters:
      Twist pairs: (1+2) , (3+4)
      Twist rate: 5/mm
      Twist direction: CCW
    additional_components:
      -
        type: Heat shrink
        qty: 30
        unit: mm
        note: left
      -
        type: Heat shrink
        qty: 20
        unit: mm
        note: right

connections:
  -
    - X1: [1-4]
    - W1: [1-4]
    - X2: [1-4]

Harness.show_bom_item_numbers is set to False for this rendering.

zzz

kvid · 2021-03-24T02:59:30Z

@kvid @Tyler-Ward

I am open for suggestions as to how to extract the assigned BOM ID for cables and connectors (after deduplication etc.) and inserting it into the new bom_item_number attribute of each component, before rendering the graphical output.

Instead of storing the bom_item_number in main components, I suggest storing a new bom_key that is easily computed in generate_bom() by using the same BOMEntry dict that is appended to bom_entries also as input to bom_types_group() and store the returned key into bom_key. Then, after deduplication and BOM ID assignment, this bom_key can be used to search for BOM ID in a slightly simplified get_bom_index() that takes the key as input (called target today). The call to clean_whitespace() could be moved into bom_types_group(). By also storing such a new bom_key in AdditionalComponent the same way, it is easy to call the same get_bom_index() for all components. Create a new type alias for this key: BOMKey = Tuple[str, ...] (above the BOMEntry type alias).

Edit: I suggest defining a new helper function:

def add_bom_entry_get_key(entries: List[BOMEntry], entry: BOMEntry) -> BOMKey:
    entries.append(entry)
    return bom_types_group(entry)

Then call it for each component by only changing one line at each location, like this:

part.bom_key = add_bom_entry_get_key(bom_entries, {
    'description': part.description,
    ...
    **optional_fields(part),
})
...
connector.bom_key = add_bom_entry_get_key(bom_entries, {
    'description': description, ...
    **optional_fields(connector),
})

Edit2: I will add a few changes to #197 to prepare for this.

kvid and others added 30 commits December 30, 2020 08:46

Skip assignment and return expression directly

0f3b5e9

Simplify get_bom_index() parameters

6525537

- Use the actual BOM as first parameter instead of the whole harness. - Use a whole AdditionalComponent as second parameter instead of each attribute separately.

Use the same lambda in get_bom_index() as for deduplicating BOM

45b13ef

Move the lambda declaration out of the function scope for common access from two different functions.

Convert dataclass object to dict to use the same lambda

da453db

Redefine the common lambda to an ordinary function

347f1e3

Simplify BOM header row logic

6378b96

Simplify collecting designators for a joined BOM entry

d2f8034

Assign input designators once to a temporary variable for easy reusage.

Simplify deduplication and sorting of collected designators

e1d7bab

Remove parentheses around return expressions

74462cd

https://stackoverflow.com/questions/4978567/should-a-return-statement-have-parentheses

Move out code from inner loop into helper functions

10b1198

Move BOM sorting above grouping to use groupby()

cdca708

- Use one common entry loop to consume iterator only once. - Use same key function for sort() and groupby(), except replace None with empty string when sorting.

Make the BOM grouping function return string tuple for sorting

f13f8a7

Add function type hints and doc strings

12e570f

Add BOMEntry type alias

c22c42e

This type alias describes the possible types of keys and values in the dict representing a BOM entry.

Rename extra variable to part for consistency

d6d0d2a

Build output string in one big expression

d15eeb1

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.

Move default qty value=1 to BOM deduplication

2e24498

Eliminate local variable

8e7c48d

Rename the 'item' key to 'description' in all BOMEntry dicts

30dbd95

This way, both BOM and harness.additional_bom_items uses the same set of keys in their dict entries. This was originally suggested in a #115 review, but had too many issues to be implemented then.

Move repeated code into new optional_fields() function

183a943

Group common function arguments into a dict

523d0c6

New addit. compo. BOM table proof of concept

8c26c8f

Create bom_bubble() function

e61d14b

Add note attribute to additional components

53fefa8

Correctly determine qty

0dc02fe

remove component_table_entry() as separate func.

9a93d86

to simplyfy code

Remove header row for additional components

4338b7a

Improve GraphViz output, remove debug print

7e168ea

formatc1702 added 3 commits March 23, 2021 11:50

Add BOM bubble cell to cables

f928bc7

Remove vertical separators in BOM table

aaf88d7

Remove unused columns in BOM table

6aa53f6

Add new bom_item_number property to components

09d5496

formatc1702 added 2 commits March 23, 2021 15:15

Fix rendering bug for empty add.comp. table

1f86c97

Implement additional parameter table

b4a0ae5

as proposed in #222

formatc1702 added 2 commits March 23, 2021 18:09

Allow line breaks in additional parameters

37bf530

Update demo02 to showcase more features

9821ca3

zzz

formatc1702 force-pushed the feature/bom-bubbles branch from 010b5c9 to 9821ca3 Compare March 23, 2021 17:09

kvid mentioned this pull request Mar 26, 2021

Simplify BOM code #197

Merged

formatc1702 changed the base branch from feature/simplify-BOM-code to dev August 22, 2021 18:48

formatc1702 mentioned this pull request Aug 27, 2021

[feature] Add supplier / SPN info #240

Closed

formatc1702 mentioned this pull request Oct 25, 2021

Large scale refactoring #251

Open

5 tasks

formatc1702 mentioned this pull request Nov 4, 2022

Is there a stripping length parameter ? #296

Open

kvid mentioned this pull request Jul 22, 2023

[meta] Project maintainer wanted #316

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Better additional component BOM table #226

Better additional component BOM table #226

formatc1702 commented Mar 23, 2021 •

edited

Loading

formatc1702 commented Mar 23, 2021

formatc1702 commented Mar 23, 2021 •

edited

Loading

formatc1702 commented Mar 23, 2021 •

edited

Loading

kvid commented Mar 24, 2021 •

edited

Loading

Better additional component BOM table #226

Are you sure you want to change the base?

Better additional component BOM table #226

Conversation

formatc1702 commented Mar 23, 2021 • edited Loading

formatc1702 commented Mar 23, 2021

formatc1702 commented Mar 23, 2021 • edited Loading

formatc1702 commented Mar 23, 2021 • edited Loading

kvid commented Mar 24, 2021 • edited Loading

formatc1702 commented Mar 23, 2021 •

edited

Loading

formatc1702 commented Mar 23, 2021 •

edited

Loading

formatc1702 commented Mar 23, 2021 •

edited

Loading

kvid commented Mar 24, 2021 •

edited

Loading