naming pattern, type hints and changelog

Author: Licini

CHANGELOG.md

@@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added `inheritance` field to `__jsondump__` of `compas.datastructures.Datastructure` to allow for deserialization to closest available superclass of custom datastructures.
 * Added `compas.scene.Scene.get_sceneobject_node` to get the TreeNode that corresponds to a scene object.
-* Added `compas.scene.SceneObjectFactory` method to create appropriate scene objects from data.
+* Added `compas.scene.sceneobject_factory` method to create appropriate scene objects from data.
 
 ### Changed
 
@@ -20,7 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-* Removed `compas.scene.SceneObject.__new__` method, explicitly use `compas.scene.SceneObjectFactory` instead.
+* Removed `compas.scene.SceneObject.__new__` method, explicitly use `compas.scene.sceneobject_factory` instead.
+* Removed `frame` kwarg from `compas.scene.SceneObject` constructor, since it is now computed from the `worldtransformation` attribute.
 
 
 ## [2.11.0] 2025-04-22

src/compas/scene/__init__.py

@@ -10,7 +10,7 @@
 
 from .exceptions import SceneObjectNotRegisteredError
 from .sceneobject import SceneObject
-from .sceneobject import SceneObjectFactory
+from .sceneobject import sceneobject_factory
 from .meshobject import MeshObject
 from .graphobject import GraphObject
 from .geometryobject import GeometryObject
@@ -44,7 +44,7 @@ def register_scene_objects_base():
 __all__ = [
     "SceneObjectNotRegisteredError",
     "SceneObject",
-    "SceneObjectFactory",
+    "sceneobject_factory",
     "MeshObject",
     "GraphObject",
     "GeometryObject",

src/compas/scene/scene.py

@@ -10,7 +10,7 @@
 from .context import clear
 from .context import detect_current_context
 from .sceneobject import SceneObject
-from .sceneobject import SceneObjectFactory
+from .sceneobject import sceneobject_factory
 
 
 class Scene(Datastructure):
@@ -88,7 +88,7 @@ def objects(self):
 
     @property
     def context_objects(self):
-        # type: () -> list[SceneObject]
+        # type: () -> list
         guids = []
         for obj in self.objects:
             guids += obj.guids
@@ -119,7 +119,7 @@ def add(self, item, parent=None, **kwargs):
             del kwargs["context"]  # otherwist the SceneObject receives "context" twice, which results in an error
 
         # Create a corresponding new scene object
-        sceneobject = SceneObjectFactory(item=item, context=self.context, scene=self, **kwargs)
+        sceneobject = sceneobject_factory(item=item, context=self.context, scene=self, **kwargs)
 
         # Add the scene object and item to the data store
         self.objectstore[str(sceneobject.guid)] = sceneobject
@@ -251,7 +251,7 @@ def redraw(self):
         self.draw()
 
     def find_by_name(self, name):
-        # type: (str) -> SceneObject
+        # type: (str) -> SceneObject | None
         """Find the first scene object with the given name.
 
         Parameters
@@ -261,7 +261,7 @@ def find_by_name(self, name):
 
         Returns
         -------
-        :class:`SceneObject`
+        :class:`SceneObject` | None
 
         """
         return next((obj for obj in self.objects if obj.name == name), None)
@@ -277,7 +277,7 @@ def find_by_itemtype(self, itemtype):
 
         Returns
         -------
-        :class:`SceneObject` or None
+        :class:`SceneObject` | None
 
         """
         for obj in self.objects:

src/compas/scene/sceneobject.py

@@ -21,7 +21,7 @@
 from .descriptors.protocol import DescriptorProtocol
 
 
-def SceneObjectFactory(item=None, scene=None, context=None, **kwargs):
+def sceneobject_factory(item=None, scene=None, context=None, **kwargs):
     """Create appropriate SceneObject instance based on item type.
 
     Parameters
@@ -190,7 +190,9 @@ def item(self):
     @property
     def node(self):
         # type: () -> compas.datastructures.TreeNode
-        return self.scene.get_sceneobject_node(self)
+        if self._node is None:
+            self._node = self.scene.get_sceneobject_node(self)
+        return self._node
 
     @property
     def is_root(self):

src/compas_ghpython/components/Compas_ToRhinoGeometry/code.py

@@ -4,12 +4,12 @@
 
 from ghpythonlib.componentbase import executingcomponent as component
 
-from compas.scene import SceneObject
+from compas.scene import sceneobject_factory
 
 
 class CompasToRhinoGeometry(component):
     def RunScript(self, cg):
         if not cg:
             return None
 
-        return SceneObject(item=cg).draw()
+        return sceneobject_factory(item=cg).draw()

src/compas_ghpython/components_cpython/Compas_ToRhinoGeometry/code.py

@@ -7,12 +7,12 @@
 
 import Grasshopper
 
-from compas.scene import SceneObject
+from compas.scene import sceneobject_factory
 
 
 class CompasToRhinoGeometry(Grasshopper.Kernel.GH_ScriptInstance):
     def RunScript(self, cg: Any):
         if not cg:
             return None
 
-        return SceneObject(item=cg).draw()
+        return sceneobject_factory(item=cg).draw()

tests/compas/scene/test_scene.py

@@ -7,7 +7,7 @@
     from compas.scene import register
     from compas.scene import Scene
     from compas.scene import SceneObject
-    from compas.scene import SceneObjectFactory
+    from compas.scene import sceneobject_factory
     from compas.scene import SceneObjectNotRegisteredError
     from compas.data import Data
     from compas.geometry import Box
@@ -50,29 +50,29 @@ def test_get_sceneobject_cls_with_orderly_registration():
         register(FakeItem, FakeSceneObject, context="fake")
         register(FakeSubItem, FakeSubSceneObject, context="fake")
         item = FakeItem()
-        sceneobject = SceneObjectFactory(item=item, context="fake")
+        sceneobject = sceneobject_factory(item=item, context="fake")
         assert isinstance(sceneobject, FakeSceneObject)
 
         item = FakeSubItem()
-        sceneobject = SceneObjectFactory(item=item, context="fake")
+        sceneobject = sceneobject_factory(item=item, context="fake")
         assert isinstance(sceneobject, FakeSubSceneObject)
 
     def test_get_sceneobject_cls_with_out_of_order_registration():
         register(FakeSubItem, FakeSubSceneObject, context="fake")
         register(FakeItem, FakeSceneObject, context="fake")
         item = FakeItem()
-        sceneobject = SceneObjectFactory(item=item, context="fake")
+        sceneobject = sceneobject_factory(item=item, context="fake")
         assert isinstance(sceneobject, FakeSceneObject)
 
         item = FakeSubItem()
-        sceneobject = SceneObjectFactory(item=item, context="fake")
+        sceneobject = sceneobject_factory(item=item, context="fake")
         assert isinstance(sceneobject, FakeSubSceneObject)
 
         def test_sceneobject_auto_context_discovery(mocker):
             register_fake_context()
 
             item = FakeItem()
-            sceneobject = SceneObjectFactory(item=item)
+            sceneobject = sceneobject_factory(item=item)
 
             assert isinstance(sceneobject, FakeSceneObject)
 
@@ -82,7 +82,7 @@ def test_sceneobject_auto_context_discovery_no_context(mocker):
 
             with pytest.raises(SceneObjectNotRegisteredError):
                 item = FakeSubItem()
-                _ = SceneObjectFactory(item=item)
+                _ = sceneobject_factory(item=item)
 
     def test_sceneobject_transform():
         scene = Scene()