Move parse_number_and_unit() and NumberAndUnit definition to wv_utils.py

Remove unused attribute

Remove unused `&&` in GitHub workflow

Remove duplicate `category` attribute

Removed from `Connector` class since it is already defined in the `Component` superclass.

Remove unnecessary casting of `int` to `float`

#251 (comment)

Continue work on BOM handling (WIP)

Author: 17o2

.github/workflows/main.yml

@@ -10,23 +10,23 @@ jobs:
       matrix:
         python-version: ["3.8", "3.10"]
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Setup Graphviz
-      uses: ts-graphviz/setup-graphviz@v1
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install .
-    - name: Create Examples
-      run: PYTHONPATH=$(pwd)/src:$PYTHONPATH && python src/wireviz/tools/build_examples.py
-    - name: Upload examples, demos, and tutorials
-      uses: actions/upload-artifact@v2
-      with:
-        name: examples-and-tutorials
-        path: |
-          examples/
-          tutorial/
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Setup Graphviz
+        uses: ts-graphviz/setup-graphviz@v1
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+      - name: Create Examples
+        run: PYTHONPATH=$(pwd)/src:$PYTHONPATH python src/wireviz/tools/build_examples.py
+      - name: Upload examples, demos, and tutorials
+        uses: actions/upload-artifact@v2
+        with:
+          name: examples-and-tutorials
+          path: |
+            examples/
+            tutorial/

src/wireviz/wv_dataclasses.py

@@ -20,7 +20,14 @@
     SingleColor,
     get_color_by_colorcode_index,
 )
-from wireviz.wv_utils import aspect_ratio, awg_equiv, mm2_equiv, remove_links
+from wireviz.wv_utils import (
+    NumberAndUnit,
+    awg_equiv,
+    aspect_ratio,
+    mm2_equiv,
+    parse_number_and_unit,
+    remove_links,
+)
 
 # Each type alias have their legal values described in comments
 # - validation might be implemented in the future
@@ -54,7 +61,6 @@
 Side = Enum("Side", "LEFT RIGHT")
 ArrowDirection = Enum("ArrowDirection", "NONE BACK FORWARD BOTH")
 ArrowWeight = Enum("ArrowWeight", "SINGLE DOUBLE")
-NumberAndUnit = namedtuple("NumberAndUnit", "number unit")
 
 AUTOGENERATED_PREFIX = "AUTOGENERATED_"
 
@@ -184,7 +190,7 @@ class Component:
     supplier: str = None
     spn: str = None
     # BOM info
-    qty: NumberAndUnit = NumberAndUnit(1, None)
+    qty: Optional[Union[None, int, float]] = None
     amount: Optional[NumberAndUnit] = None
     sum_amounts_in_bom: bool = True
     ignore_in_bom: bool = False
@@ -195,70 +201,31 @@ def __post_init__(self):
         partnos = [remove_links(entry) for entry in partnos]
         partnos = tuple(partnos)
         self.partnumbers = PartNumberInfo(*partnos)
-
-        self.qty = self.parse_number_and_unit(self.qty, None)
-        self.amount = self.parse_number_and_unit(self.amount, None)
-
-    def parse_number_and_unit(
-        self,
-        inp: Optional[Union[NumberAndUnit, float, int, str]],
-        default_unit: Optional[str] = None,
-    ) -> Optional[NumberAndUnit]:
-        if inp is None:
-            return None
-        elif isinstance(inp, NumberAndUnit):
-            return inp
-        elif isinstance(inp, float) or isinstance(inp, int):
-            return NumberAndUnit(float(inp), default_unit)
-        elif isinstance(inp, str):
-            if " " in inp:
-                number, unit = inp.split(" ", 1)
-            else:
-                number, unit = inp, default_unit
-            try:
-                number = float(number)
-            except ValueError:
-                raise Exception(
-                    f"{inp} is not a valid number and unit.\n"
-                    "It must be a number, or a number and unit separated by a space."
-                )
-            else:
-                return NumberAndUnit(number, unit)
+        self.amount = parse_number_and_unit(self.amount, None)
 
     @property
     def bom_hash(self) -> BomHash:
+        if isinstance(self, AdditionalComponent):
+            _amount = self.amount_computed
+        else:
+            _amount = self.amount
+
         if self.sum_amounts_in_bom:
             _hash = BomHash(
                 description=self.description,
-                qty_unit=self.amount.unit if self.amount else None,
+                qty_unit=_amount.unit if _amount else None,
                 amount=None,
                 partnumbers=self.partnumbers,
             )
         else:
             _hash = BomHash(
                 description=self.description,
-                qty_unit=self.qty.unit,
-                amount=self.amount,
+                qty_unit=None,
+                amount=_amount,
                 partnumbers=self.partnumbers,
             )
         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
     def has_pn_info(self) -> bool:
         return any([self.pn, self.manufacturer, self.mpn, self.supplier, self.spn])
@@ -292,7 +259,9 @@ def __post_init__(self):
 @dataclass
 class AdditionalComponent(GraphicalComponent):
     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
 
     def __post_init__(self):
@@ -311,9 +280,13 @@ def __post_init__(self):
             else:
                 raise Exception(f"Unknown qty multiplier: {self.qty_multiplier}")
 
-    @property
-    def bom_qty(self):
-        return self.qty.number * self._qty_multiplier_computed
+        if self.qty is None and self.qty_multiplier in [
+            QtyMultiplierCable.TOTAL_LENGTH,
+            QtyMultiplierCable.LENGTH,
+            1,
+        ]:  # simplify add.comp. table in parent node for implicit qty 1
+            self.qty = 1
+            self.explicit_qty = False
 
 
 @dataclass
@@ -325,8 +298,6 @@ class TopLevelGraphicalComponent(GraphicalComponent):  # abstract class
     additional_parameters: Optional[Dict] = None
     additional_components: List[AdditionalComponent] = field(default_factory=list)
     notes: Optional[MultilineHypertext] = None
-    # BOM options
-    add_up_in_bom: Optional[bool] = None
     # rendering options
     bgcolor_title: Optional[SingleColor] = None
     show_name: Optional[bool] = None
@@ -336,7 +307,6 @@ class TopLevelGraphicalComponent(GraphicalComponent):  # abstract class
 class Connector(TopLevelGraphicalComponent):
     # connector-specific properties
     style: Optional[str] = None
-    category: Optional[str] = None
     loops: List[List[Pin]] = field(default_factory=list)
     # pin information in particular
     pincount: Optional[int] = None
@@ -380,13 +350,12 @@ def __post_init__(self) -> None:
         self.color = MultiColor(self.color)
 
         # 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")
         if self.amount is not None:
             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):
             self.image = Image(**self.image)
@@ -451,7 +420,9 @@ def __post_init__(self) -> None:
                 raise Exception("Loops must be between exactly two pins!")
             for pin in loop:
                 if pin not in self.pins:
-                    raise Exception(f'Unknown loop pin "{pin}" for connector "{self.name}"!')
+                    raise Exception(
+                        f'Unknown loop pin "{pin}" for connector "{self.name}"!'
+                    )
                 # Make sure loop connected pins are not hidden.
                 # side=None, determine side to show loops during rendering
                 self.activate_pin(pin, side=None, is_connection=True)
@@ -488,7 +459,12 @@ def compute_qty_multipliers(self):
                 raise Exception("Used a cable multiplier in a connector!")
             else:  # int or float
                 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
@@ -623,14 +599,17 @@ def length_str(self):
     @property
     def bom_hash(self):
         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:
             return super().bom_hash
 
     @property
     def description(self) -> str:
         if self.category == "bundle":
-            raise Exception("Do this at the wire level!")  # TODO
+            raise Exception("Do this at the wire level!")
         else:
             substrs = [
                 ("", "Cable"),
@@ -668,15 +647,21 @@ def __post_init__(self) -> None:
         self.bgcolor_title = SingleColor(self.bgcolor_title)
         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):
             self.image = Image(**self.image)
 
         # TODO:
         # allow gauge, length, and other fields to be lists too (like part numbers),
         # and assign them the same way to bundles.
 
-        self.gauge = self.parse_number_and_unit(self.gauge, "mm2")
-        self.length = self.parse_number_and_unit(self.length, "m")
+        self.gauge = parse_number_and_unit(self.gauge, "mm2")
+        self.length = parse_number_and_unit(self.length, "m")
         self.amount = self.length  # for BOM
 
         if self.wirecount:  # number of wires explicitly defined
@@ -753,9 +738,11 @@ def __post_init__(self) -> None:
                 index=index_offset,
                 id=id,
                 label="Shield",
-                color=MultiColor(self.shield)
-                if isinstance(self.shield, str)
-                else MultiColor(None),
+                color=(
+                    MultiColor(self.shield)
+                    if isinstance(self.shield, str)
+                    else MultiColor(None)
+                ),
                 parent=self.designator,
             )
 
@@ -789,27 +776,40 @@ def compute_qty_multipliers(self):
         )
         qty_multipliers_computed = {
             "WIRECOUNT": len(self.wire_objects),
-            "TERMINATIONS": 999,  # TODO
+            # "TERMINATIONS": ___,  # TODO
             "LENGTH": self.length.number if self.length else 0,
             "TOTAL_LENGTH": total_length,
         }
         for subitem in self.additional_components:
             if isinstance(subitem.qty_multiplier, QtyMultiplierCable):
                 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.unit is not None:
+                    # since length can have a unit, use amount fields to hold
+                    if subitem.amount is not None:
                         raise Exception(
-                            f"No unit may be specified when using"
-                            f"{subitem.qty_multiplier} as a multiplier"
+                            f"No amount may be specified when using "
+                            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):
                 raise Exception("Used a connector multiplier in a cable!")
             else:  # int or float
-                computed_factor = subitem.qty_multiplier
-            subitem._qty_multiplier_computed = computed_factor
+                if subitem.qty is not None:
+                    subitem.qty_computed = subitem.qty * subitem.qty_multiplier
+                else:
+                    subitem.qty_computed = subitem.qty_multiplier
+                subitem.amount_computed = subitem.amount
 
 
 @dataclass