Simplify BOM code #197
Simplify BOM code #197
Conversation
|
Nice! I will merge #196 tonight (squashing the commits, since the overall amount of lines changed is rather small, and adding everyone as a co-author). Then this PR could seamlessly follow afterwards :) Let me know what you think. |
kvid
force-pushed
the
simplify-BOM-code
branch
from
0ebf547 to
e04058c
Compare
kvid
force-pushed
the
simplify-BOM-code
branch
from
233c497 to
9cdc9df
Compare
kvid
force-pushed
the
simplify-BOM-code
branch
from
9cdc9df to
d15eeb1
Compare
kvid
force-pushed
the
simplify-BOM-code
branch
from
6a0c39c to
183a943
Compare
|
I haven't merged this PR since I have seen some more activity on it since you removed the draft status. If, as per your comment, you think it is ready, I can have a look and integrate it soon :) |
That's true. I've added a few commits the last months, but I guess it might be time for a review so other PRs can benefit from these changes soon (if they are accepted).
The currently last commit about "Group common function arguments into a dict" might not look like a simplification, but my goal is to simplify later attribute extensions, like e.g. one of the commits in #219. The same goal is also my motivation behind the preceeding commit in this PR about |
- 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.
- 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 wireviz#115 review, but had too many issues to be implemented then.
This reverts commit 96d393d. However, raising an exception if failing the BOM index search is still wanted, so a custom exception is raised instead of returning None.
Replace the get_bom_index() part argument with the target key argument to prepare for quering any BOM entry that matches the target key.
Co-authored-by: kvid <[email protected]>
There was a problem hiding this comment.
I've tested the output of this PR and it looks good.
Admittedly, I cannot currently dive deep into every single line of the code, but overall it looks like a good simplification, and I don't want to keep this open much longer than it has to. Anyways, small tweaks and fixes are always possible later.
I will squash-merge to keep the dev branch simple. The detailed history will be preserved in the PR branch for anyone to check.
Currently, this PR does not change any output generated by
build_examples.py. Consider implementing the TODO about using 'Description' in BOM heading. However, if this TODO is considered controversial or otherwise might delay merging the PR, then please ignore it for now.