correct typing of scene objects

Author: tomvanmele

src/compas/scene/graphobject.py

@@ -49,9 +49,18 @@ class GraphObject(SceneObject):
     nodecolor = ColorDictAttribute()
     edgecolor = ColorDictAttribute()
 
-    def __init__(self, show_nodes=True, show_edges=True, nodecolor=None, edgecolor=None, nodesize=1.0, edgewidth=1.0, **kwargs):
-        # type: (bool | list, bool | list, dict | compas.colors.Color | None, dict | compas.colors.Color | None, float, float, dict) -> None
-        super(GraphObject, self).__init__(**kwargs)
+    def __init__(
+        self,
+        show_nodes=True,  # type: bool | list
+        show_edges=True,  # type: bool | list
+        nodecolor=None,  # type: dict | compas.colors.Color | None
+        edgecolor=None,  # type: dict | compas.colors.Color | None
+        nodesize=1.0,  # type: float
+        edgewidth=1.0,  # type: float
+        **kwargs  # type: dict
+    ):  # fmt: skip
+        # type: (...) -> None
+        super(GraphObject, self).__init__(**kwargs)  # type: ignore
         self._node_xyz = None
         self.show_nodes = show_nodes
         self.show_edges = show_edges
@@ -75,7 +84,7 @@ def settings(self):
     @property
     def graph(self):
         # type: () -> compas.datastructures.Graph
-        return self.item
+        return self.item  # type: ignore
 
     @graph.setter
     def graph(self, graph):
@@ -97,16 +106,17 @@ def transformation(self, transformation):
 
     @property
     def node_xyz(self):
-        # type: () -> dict[int | str | tuple, list[float]]
-        if self._node_xyz is None:
-            points = self.graph.nodes_attributes("xyz")
-            points = transform_points(points, self.worldtransformation)
-            self._node_xyz = dict(zip(self.graph.nodes(), points))
-        return self._node_xyz
+        # type: () -> dict[int | str, list[float]]
+        if self.graph:
+            if self._node_xyz is None:
+                points = self.graph.nodes_attributes("xyz")
+                points = transform_points(points, self.worldtransformation)
+                self._node_xyz = dict(zip(self.graph.nodes(), points))
+        return self._node_xyz  # type: ignore
 
     @node_xyz.setter
     def node_xyz(self, node_xyz):
-        # type: (dict[int | str | tuple, list[float]]) -> None
+        # type: (dict[int | str, list[float]]) -> None
         self._node_xyz = node_xyz
 
     def draw_nodes(self):

src/compas/scene/meshobject.py

@@ -57,9 +57,20 @@ class MeshObject(SceneObject):
     edgecolor = ColorDictAttribute()
     facecolor = ColorDictAttribute()
 
-    def __init__(self, show_vertices=False, show_edges=False, show_faces=True, vertexcolor=None, edgecolor=None, facecolor=None, vertexsize=1.0, edgewidth=1.0, **kwargs):
-        # type: (bool | list, bool | list, bool | list, dict | compas.colors.Color | None, dict | compas.colors.Color | None, dict | compas.colors.Color | None, float, float, dict) -> None
-        super(MeshObject, self).__init__(**kwargs)
+    def __init__(
+        self,
+        show_vertices=False,  # type: bool | list
+        show_edges=False,  # type: bool | list
+        show_faces=True,  # type: bool | list
+        vertexcolor=None,  # type: dict | compas.colors.Color | None
+        edgecolor=None,  # type: dict | compas.colors.Color | None
+        facecolor=None,  # type: dict | compas.colors.Color | None
+        vertexsize=1.0,  # type: float
+        edgewidth=1.0,  # type: float
+        **kwargs  # dict
+    ):  # fmt: skip
+        # type: (...) -> None
+        super(MeshObject, self).__init__(**kwargs)  # type: ignore
         self._vertex_xyz = None
         self.show_vertices = show_vertices
         self.show_edges = show_edges
@@ -89,7 +100,7 @@ def settings(self):
     @property
     def mesh(self):
         # type: () -> compas.datastructures.Mesh
-        return self.item
+        return self.item  # type: ignore
 
     @mesh.setter
     def mesh(self, mesh):
@@ -112,11 +123,12 @@ def transformation(self, transformation):
     @property
     def vertex_xyz(self):
         # type: () -> dict[int, list[float]]
-        if self._vertex_xyz is None:
-            points = self.mesh.vertices_attributes("xyz")
-            points = transform_points(points, self.worldtransformation)
-            self._vertex_xyz = dict(zip(self.mesh.vertices(), points))
-        return self._vertex_xyz
+        if self.mesh:
+            if self._vertex_xyz is None:
+                points = self.mesh.vertices_attributes("xyz")
+                points = transform_points(points, self.worldtransformation)
+                self._vertex_xyz = dict(zip(self.mesh.vertices(), points))
+        return self._vertex_xyz  # type: ignore
 
     @vertex_xyz.setter
     def vertex_xyz(self, vertex_xyz):

src/compas/scene/scene.py

@@ -66,7 +66,7 @@ def add(node, parent, items):
         return scene
 
     def __init__(self, name="Scene", context=None):
-        # type: (str | "Scene", str | None) -> None
+        # type: (str, str | None) -> None
         super(Scene, self).__init__(name=name)
         super(Scene, self).add(TreeNode(name="ROOT"))
         self.context = context or detect_current_context()
@@ -113,7 +113,6 @@ def add(self, item, parent=None, **kwargs):
     def clear(self):
         # type: () -> None
         """Clear everything from the current context of the scene."""
-        clear()
 
     def clear_objects(self):
         # type: () -> None

src/compas/scene/sceneobject.py

@@ -9,6 +9,7 @@
 import compas.data  # noqa: F401
 import compas.datastructures  # noqa: F401
 import compas.geometry  # noqa: F401
+import compas.scene  # noqa: F401
 from compas.colors import Color
 from compas.data import Data
 from compas.datastructures import TreeNode
@@ -87,9 +88,23 @@ def __new__(cls, item=None, **kwargs):
         sceneobject_cls = get_sceneobject_cls(item, **kwargs)
         return super(SceneObject, cls).__new__(sceneobject_cls)
 
-    def __init__(self, item=None, name=None, color=None, opacity=1.0, show=True, frame=None, transformation=None, context=None, **kwargs):  # fmt: skip
-        # type: (compas.data.Data | None, str | None, compas.colors.Color | None, float, bool, compas.geometry.Frame | None, compas.geometry.Transformation | None, str | None, dict) -> None
-        name = item.name if isinstance(item, Data) and name is None else name
+    def __init__(
+        self,
+        item=None,  # type: compas.data.Data | None
+        name=None,  # type: str | None
+        color=None,  # type: compas.colors.Color | None
+        opacity=1.0,  # type: float
+        show=True,  # type: bool
+        frame=None,  # type: compas.geometry.Frame | None
+        transformation=None,  # type: compas.geometry.Transformation | None
+        context=None,  # type: str | None
+        **kwargs  # type: dict
+    ):  # fmt: skip
+        # type: (...) -> None
+        if not isinstance(item, Data):
+            raise ValueError("The item assigned to this scene object should be a data object: {}".format(type(item)))
+
+        name = name or item.name
         super(SceneObject, self).__init__(name=name, **kwargs)
         # the scene object needs to store the context
         # because it has no access to the tree and/or the scene before it is added
@@ -125,12 +140,12 @@ def __repr__(self):
 
     @property
     def scene(self):
-        # type: () -> compas.scene.Scene
+        # type: () -> compas.scene.Scene | None
         return self.tree
 
     @property
     def item(self):
-        # type: () -> compas.geometry.Geometry | compas.datastructures.Datastructure
+        # type: () -> compas.data.Data
         return self._item
 
     @property
@@ -180,7 +195,7 @@ def worldtransformation(self):
 
     @property
     def contrastcolor(self):
-        # type: () -> compas.colors.Color
+        # type: () -> compas.colors.Color | None
         if not self._contrastcolor:
             if self.color:
                 if self.color.is_light:

src/compas/scene/volmeshobject.py

@@ -2,6 +2,7 @@
 from __future__ import division
 from __future__ import print_function
 
+import compas.colors  # noqa: F401
 import compas.datastructures  # noqa: F401
 import compas.geometry  # noqa: F401
 from compas.geometry import transform_points
@@ -68,20 +69,20 @@ class VolMeshObject(SceneObject):
 
     def __init__(
         self,
-        show_vertices=False,
-        show_edges=True,
-        show_faces=False,
-        show_cells=True,
-        vertexcolor=None,
-        edgecolor=None,
-        facecolor=None,
-        cellcolor=None,
-        vertexsize=1.0,
-        edgewidth=1.0,
-        **kwargs,  # fmt: skip
-    ):
-        # type: (bool | list, bool | list, bool | list, bool | list, compas.colors.Color | dict, compas.colors.Color | dict, compas.colors.Color | dict, compas.colors.Color | dict, float | dict, float | dict, dict) -> None
-        super(VolMeshObject, self).__init__(**kwargs)
+        show_vertices=False,  # type: bool | list
+        show_edges=True,  # type: bool | list
+        show_faces=False,  # type: bool | list
+        show_cells=True,  # type: bool | list
+        vertexcolor=None,  # type: compas.colors.Color | dict | None
+        edgecolor=None,  # type: compas.colors.Color | dict | None
+        facecolor=None,  # type: compas.colors.Color | dict | None
+        cellcolor=None,  # type: compas.colors.Color | dict | None
+        vertexsize=1.0,  # type: float
+        edgewidth=1.0,  # type: float
+        **kwargs  # type: dict
+    ):  # fmt: skip
+        # type: (...) -> None
+        super(VolMeshObject, self).__init__(**kwargs)  # type: ignore
         self._vertex_xyz = None
         self.show_vertices = show_vertices
         self.show_edges = show_edges
@@ -111,7 +112,7 @@ def settings(self):
     @property
     def volmesh(self):
         # type: () -> compas.datastructures.VolMesh
-        return self.item
+        return self.item  # type: ignore
 
     @volmesh.setter
     def volmesh(self, volmesh):
@@ -138,7 +139,7 @@ def vertex_xyz(self):
             points = self.volmesh.vertices_attributes("xyz")  # type: ignore
             points = transform_points(points, self.worldtransformation)
             self._vertex_xyz = dict(zip(self.volmesh.vertices(), points))  # type: ignore
-        return self._vertex_xyz
+        return self._vertex_xyz  # type: ignore
 
     @vertex_xyz.setter
     def vertex_xyz(self, vertex_xyz):