Replace Element.from_guid() with Project#element() method

Author: josemmo

src/compas_cadwork/elements/element.py

@@ -5,7 +5,6 @@
 from typing import ClassVar
 from typing import Final
 from typing import Self
-from typing import final
 from uuid import UUID
 
 import attribute_controller as ac
@@ -119,32 +118,6 @@ class Element:
     attribute_names: ClassVar[_ElementAttributeNames] = _ElementAttributeNames()
     """User attribute names."""
 
-    @final
-    @classmethod
-    def from_guid(cls, guid: UUID) -> Element:
-        """Get element from Cadwork GUID.
-
-        Parameters
-        ----------
-        guid : UUID
-            Cadwork element GUID.
-
-        Returns
-        -------
-        Element
-            Cadwork element.
-
-        Raises
-        ------
-        ValueError
-            If the element does not exist.
-        """
-        raw_guid = "{" + str(guid).upper() + "}"
-        cadwork_id = ec.get_element_from_cadwork_guid(raw_guid)
-        if ec.get_element_cadwork_guid(cadwork_id) != raw_guid:
-            raise ValueError(f"Could not find a Cadwork element with GUID {raw_guid}")
-        return cls(cadwork_id)
-
     def __init__(self, cadwork_id: ElementId) -> None:
         """Create new instance wrapping an existing Cadwork element.
 

src/compas_cadwork/project.py

@@ -1,18 +1,28 @@
+from __future__ import annotations
+
 from datetime import date
 from datetime import datetime
 from functools import cached_property
+from typing import TYPE_CHECKING
 from typing import Generator
 from typing import Iterable
+from typing import overload
 from uuid import UUID
 
+import bim_controller as bc
 import element_controller as ec
 import utility_controller as uc
 
 from compas_cadwork.elements.element import Element
+from compas_cadwork.utils.ifc_uuid import IfcUUID
 from compas_cadwork.utils.storage import IterableKeyValueStorage
 from compas_cadwork.utils.storage import KeyValueStorage
 
 
+if TYPE_CHECKING:
+    from cadwork import ElementId
+
+
 def _is_empty_value(raw_value: str) -> bool:
     """Is empty value.
 
@@ -191,6 +201,93 @@ def data(self) -> _ProjectData:
         """Project data."""
         return _ProjectData()
 
+    @overload
+    def element(self, *, cadwork_id: ElementId) -> Element:
+        """Get element from Cadwork ID.
+
+        Parameters
+        ----------
+        cadwork_id : ElementId
+            Cadwork element ID.
+
+        Returns
+        -------
+        Element
+            Cadwork element.
+
+        Raises
+        ------
+        ValueError
+            If the element does not exist.
+        """
+
+    @overload
+    def element(self, *, guid: UUID) -> Element:
+        """Get element from Cadwork GUID.
+
+        Parameters
+        ----------
+        guid : UUID
+            Cadwork element GUID.
+
+        Returns
+        -------
+        Element
+            Cadwork element.
+
+        Raises
+        ------
+        ValueError
+            If the element does not exist.
+        """
+
+    @overload
+    def element(self, *, ifc_guid: IfcUUID) -> Element:
+        """Get element from IFC GUID.
+
+        Parameters
+        ----------
+        ifc_guid : IfcUUID
+            Element IFC GUID.
+
+        Returns
+        -------
+        Element
+            Cadwork element.
+
+        Raises
+        ------
+        ValueError
+            If the element does not exist.
+        """
+
+    def element(
+        self,
+        *,
+        cadwork_id: ElementId | None = None,
+        guid: UUID | None = None,
+        ifc_guid: IfcUUID | None = None,
+    ) -> Element:
+        # GUID to Cadwork ID
+        if guid is not None:
+            raw_guid = "{" + str(guid).upper() + "}"
+            cadwork_id = ec.get_element_from_cadwork_guid(raw_guid)
+            if ec.get_element_cadwork_guid(cadwork_id) != raw_guid:
+                raise ValueError(f"Could not find a Cadwork element with GUID {raw_guid!r}")
+
+        # IFC GUID to Cadwork ID
+        if ifc_guid is not None:
+            raw_guid = ifc_guid.base64
+            cadwork_id = bc.get_element_id_from_base64_ifc_guid(raw_guid)
+            if cadwork_id == 0:
+                raise ValueError(f"Could not find a Cadwork element with IFC GUID {raw_guid!r}")
+
+        # Cadwork ID to element
+        assert cadwork_id is not None
+        if not ec.check_element_id(cadwork_id):
+            raise ValueError(f"Could not find a Cadwork element with ID #{cadwork_id}")
+        return Element(cadwork_id)
+
     def elements(self) -> Generator[Element, None, None]:
         """Get all elements in the project.
 

tests/compas_cadwork/elements/test_element.py

@@ -10,22 +10,6 @@
 from compas_cadwork.utils.ifc_uuid import IfcUUID
 
 
-def test_creates_from_guid(cadwork) -> None:
-    cadwork.ec.get_element_from_cadwork_guid.return_value = 12345
-    cadwork.ec.get_element_cadwork_guid.return_value = "{2B21165D-9454-46A0-A992-6B4AA043D58D}"
-    element = Element.from_guid(UUID("2b21165d-9454-46a0-a992-6b4aa043d58d"))
-    cadwork.ec.get_element_from_cadwork_guid.assert_called_once_with("{2B21165D-9454-46A0-A992-6B4AA043D58D}")
-    cadwork.ec.get_element_cadwork_guid.assert_called_once_with(12345)
-    assert element.guid == UUID("2b21165d-9454-46a0-a992-6b4aa043d58d")
-    assert element.id == 12345
-
-
-def test_raises_on_unknown_guid(cadwork) -> None:
-    cadwork.ec.get_element_from_cadwork_guid.return_value = ""
-    with pytest.raises(ValueError, match=r"Could not find a Cadwork element with GUID .+"):
-        Element.from_guid(UUID("deadbeef-0000-0000-0000-000000000000"))
-
-
 def test_raises_on_deleted_element(cadwork) -> None:
     element = Element(123)
 

tests/compas_cadwork/test_project.py

@@ -4,6 +4,7 @@
 import pytest
 
 from compas_cadwork.project import Project
+from compas_cadwork.utils.ifc_uuid import IfcUUID
 
 
 def test_gets_guid(cadwork) -> None:
@@ -194,7 +195,62 @@ def test_sets_designer(cadwork) -> None:
     cadwork.uc.set_project_designer.assert_called_with("Test Value")
 
 
-def test_get_elements(cadwork) -> None:
+def test_gets_element_by_cadwork_id(cadwork) -> None:
+    project = Project()
+
+    # Without value
+    cadwork.ec.check_element_id.return_value = False
+    with pytest.raises(ValueError, match=r"Could not find a Cadwork element with ID #1000"):
+        _ = project.element(cadwork_id=1000)
+    cadwork.ec.check_element_id.assert_called_once_with(1000)
+
+    # With value
+    cadwork.ec.check_element_id.return_value = True
+    element = project.element(cadwork_id=12345)
+    cadwork.ec.check_element_id.assert_called_with(12345)
+    assert element.id == 12345
+
+
+def test_gets_element_by_guid(cadwork) -> None:
+    project = Project()
+
+    # Without value
+    cadwork.ec.get_element_from_cadwork_guid.return_value = 0
+    with pytest.raises(
+        ValueError,
+        match=r"Could not find a Cadwork element with GUID '{DEADBEEF-0000-0000-0000-000000000000}'",
+    ):
+        _ = project.element(guid=UUID("deadbeef-0000-0000-0000-000000000000"))
+
+    # With value
+    cadwork.ec.get_element_from_cadwork_guid.return_value = 12345
+    cadwork.ec.get_element_cadwork_guid.return_value = "{2B21165D-9454-46A0-A992-6B4AA043D58D}"
+    element = project.element(guid=UUID("2b21165d-9454-46a0-a992-6b4aa043d58d"))
+    cadwork.ec.get_element_from_cadwork_guid.assert_called_with("{2B21165D-9454-46A0-A992-6B4AA043D58D}")
+    cadwork.ec.get_element_cadwork_guid.assert_called_with(12345)
+    assert element.id == 12345
+    assert element.guid == UUID("2b21165d-9454-46a0-a992-6b4aa043d58d")
+
+
+def test_gets_element_by_ifc_guid(cadwork) -> None:
+    project = Project()
+
+    # Without value
+    cadwork.bc.get_element_id_from_base64_ifc_guid.return_value = 0
+    with pytest.raises(ValueError, match=r"Could not find a Cadwork element with IFC GUID '3UhRxl0000000000000000'"):
+        _ = project.element(ifc_guid=IfcUUID("deadbeef-0000-0000-0000-000000000000"))
+
+    # With value
+    cadwork.bc.get_element_id_from_base64_ifc_guid.return_value = 54321
+    element = project.element(ifc_guid=IfcUUID("921ab9eb-3b21-46c8-baa4-dfffc33b59be"))
+    cadwork.bc.get_element_id_from_base64_ifc_guid.assert_called_with("2I6hdhEo56oBgat$$3Erc_")
+    assert element.id == 54321
+    cadwork.bc.get_ifc_guid.return_value = "{921AB9EB-3B21-46C8-BAA4-DFFFC33B59BE}"
+    assert element.ifc_guid == IfcUUID("921ab9eb-3b21-46c8-baa4-dfffc33b59be")
+    cadwork.bc.get_ifc_guid.assert_called_with(54321)
+
+
+def test_gets_elements(cadwork) -> None:
     project = Project()
 
     # Without elements
@@ -206,7 +262,7 @@ def test_get_elements(cadwork) -> None:
     assert [x.id for x in project.elements()] == [505, 404, 303, 202, 101]
 
 
-def test_get_selected_elements(cadwork) -> None:
+def test_gets_selected_elements(cadwork) -> None:
     project = Project()
 
     # Without elements