Added metadata handling to Assembly.add method (#1327)

* Added metadata handling to Assembly.add method * Remove one overload * Update assembly metadata test --------- Co-authored-by: AU <[email protected]> Co-authored-by: Lorenz Neureuter <[email protected]>
CadQuery · May 14, 2023 · 0fc683c · 0fc683c
1 parent 95f37fd
commit 0fc683c
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/cadquery/assembly.py b/cadquery/assembly.py
@@ -184,6 +184,7 @@ def add(
  loc: Optional[Location] = None,
  name: Optional[str] = None,
  color: Optional[Color] = None,
+ metadata: Optional[Dict[str, Any]] = None,
  ) -> "Assembly":
  """
  Add a subassembly to the current assembly with explicit location and name.
@@ -194,6 +195,7 @@ def add(
  :param name: unique name of the root object (default: None, resulting in an UUID being
  generated)
  :param color: color of the added object (default: None)
+ :param metadata: a store for user-defined metadata (default: None)
  """
  ...
 
@@ -214,6 +216,9 @@ def add(self, arg, **kwargs):
  subassy.loc = kwargs["loc"] if kwargs.get("loc") else arg.loc
  subassy.name = kwargs["name"] if kwargs.get("name") else arg.name
  subassy.color = kwargs["color"] if kwargs.get("color") else arg.color
+ subassy.metadata = (
+ kwargs["metadata"] if kwargs.get("metadata") else arg.metadata
+ )
  subassy.parent = self
 
  self.children.append(subassy)

diff --git a/tests/test_assembly.py b/tests/test_assembly.py
@@ -132,6 +132,17 @@ def metadata_assy():
  )
  assy.add(sub_assy)
 
+ sub_assy2 = cq.Assembly(name="sub2", metadata={"mykey": "sub2-data"})
+ sub_assy2.add(
+ b1, name="sub2-0", loc=cq.Location((1, 0, 0)), metadata={"mykey": "sub2-0-data"}
+ )
+ sub_assy2.add(
+ b1, name="sub2-1", loc=cq.Location((2, 0, 0)), metadata={"mykey": "sub2-1-data"}
+ )
+ assy.add(
+ sub_assy2, metadata={"mykey": "sub2-data-add"}
+ ) # override metadata mykey:sub2-data
+
  return assy
 
 
@@ -488,6 +499,9 @@ def test_metadata(metadata_assy):
  assert len(metadata_assy.metadata) == 2
  # Test that metadata was copied by _copy() during the processing of adding the subassembly
  assert metadata_assy.children[0].metadata["b2"] == "sub-data"
+ assert metadata_assy.children[1].metadata["mykey"] == "sub2-data-add"
+ assert metadata_assy.children[1].children[0].metadata["mykey"] == "sub2-0-data"
+ assert metadata_assy.children[1].children[1].metadata["mykey"] == "sub2-1-data"
 
 
 def solve_result_check(solve_result: dict) -> bool: