Merge pull request #353 from cwapi3d/feature/enhance-stubs-iterable-objects

Feature/enhance stubs iterable objects

Author: Brunner246

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cwapi3d"
-version = "32.443.6"
+version = "32.443.7"
 authors = [{ name = "Cadwork", email = "it@cadwork.ca" }]
 requires-python = ">= 3.12"
 description = 'Python bindings for CwAPI3D'

src/cadwork/edge_list.pyi

@@ -1,7 +1,9 @@
+from typing import Iterator
+
 from cadwork import point_3d
 
 class edge_list:
-    
+
     def count(self) -> int:
         """count
 
@@ -19,3 +21,9 @@ class edge_list:
             point_3d
         """
 
+    def __len__(self) -> int: ...
+
+    def __iter__(self) -> Iterator[point_3d]: ...
+
+    def __getitem__(self, index: int) -> point_3d: ...
+

src/cadwork/facet_list.pyi

@@ -1,3 +1,5 @@
+from typing import Iterator
+
 from cadwork import point_3d
 from cadwork import polygon_list
 from cadwork import vertex_list
@@ -82,3 +84,9 @@ class facet_list:
             float
         """
 
+    def __len__(self) -> int: ...
+
+    def __iter__(self) -> Iterator[vertex_list]: ...
+
+    def __getitem__(self, index: int) -> vertex_list: ...
+

src/cadwork/polygon_list.pyi

@@ -1,3 +1,5 @@
+from typing import Iterator
+
 from cadwork import vertex_list
 
 
@@ -18,3 +20,9 @@ class polygon_list:
         Returns:
             vertex_list: The ordered vertices defining the polygon.
         """
+
+    def __len__(self) -> int: ...
+
+    def __iter__(self) -> Iterator[vertex_list]: ...
+
+    def __getitem__(self, index: int) -> vertex_list: ...

src/cadwork/vertex_list.pyi

@@ -1,7 +1,9 @@
+from typing import Iterator
+
 from cadwork import point_3d
 
 class vertex_list:
-    
+
     def count(self) -> int:
         """count
 
@@ -29,3 +31,9 @@ class vertex_list:
             None
         """
 
+    def __len__(self) -> int: ...
+
+    def __iter__(self) -> Iterator[point_3d]: ...
+
+    def __getitem__(self, index: int) -> point_3d: ...
+