Merge pull request #516 from jdegenstein/polylines

change Polyline and FilletPolyline to accept 2 pts as minimum
gumyr · Jan 31, 2024 · d52b600 · d52b600
2 parents 8cd3567 + 0676565
commit d52b600
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/src/build123d/objects_curve.py b/src/build123d/objects_curve.py
@@ -354,13 +354,13 @@ class FilletPolyline(BaseLineObject):
     are filleted to a given radius.
 
     Args:
-        pts (Union[VectorLike, Iterable[VectorLike]]): sequence of three or more points
+        pts (Union[VectorLike, Iterable[VectorLike]]): sequence of two or more points
         radius (float): radius of filleted corners
         close (bool, optional): close by generating an extra Edge. Defaults to False.
         mode (Mode, optional): combination mode. Defaults to Mode.ADD.
 
     Raises:
-        ValueError: Three or more points not provided
+        ValueError: Two or more points not provided
         ValueError: radius must be positive
     """
 
@@ -378,8 +378,8 @@ def __init__(
 
         pts = flatten_sequence(*pts)
 
-        if len(pts) < 3:
-            raise ValueError("filletpolyline requires three or more pts")
+        if len(pts) < 2:
+            raise ValueError("FilletPolyline requires two or more pts")
         if radius <= 0:
             raise ValueError("radius must be positive")
 
@@ -643,12 +643,12 @@ class Polyline(BaseLineObject):
     Add a sequence of straight lines defined by successive point pairs.
 
     Args:
-        pts (Union[VectorLike, Iterable[VectorLike]]): sequence of three or more points
+        pts (Union[VectorLike, Iterable[VectorLike]]): sequence of two or more points
         close (bool, optional): close by generating an extra Edge. Defaults to False.
         mode (Mode, optional): combination mode. Defaults to Mode.ADD.
 
     Raises:
-        ValueError: Three or more points not provided
+        ValueError: Two or more points not provided
     """
 
     _applies_to = [BuildLine._tag]
@@ -663,8 +663,8 @@ def __init__(
         validate_inputs(context, self)
 
         pts = flatten_sequence(*pts)
-        if len(pts) < 3:
-            raise ValueError("polyline requires three or more pts")
+        if len(pts) < 2:
+            raise ValueError("Polyline requires two or more pts")
 
         lines_pts = WorkplaneList.localize(*pts)
 

diff --git a/tests/test_build_line.py b/tests/test_build_line.py
@@ -145,7 +145,7 @@ def test_filletpolyline(self):
         self.assertEqual(len(p.edges().filter_by(GeomType.LINE)), 4)
 
         with self.assertRaises(ValueError):
-            FilletPolyline((0, 0), (1, 0), radius=0.1)
+            FilletPolyline((0, 0), radius=0.1)
         with self.assertRaises(ValueError):
             FilletPolyline((0, 0), (1, 0), (1, 1), radius=-1)
 
@@ -308,7 +308,7 @@ def test_error_conditions(self):
                 Line((0, 0))  # Need two points
         with self.assertRaises(ValueError):
             with BuildLine():
-                Polyline((0, 0), (1, 1))  # Need three points
+                Polyline((0, 0))  # Need two points
         with self.assertRaises(ValueError):
             with BuildLine():
                 RadiusArc((0, 0), (1, 0), 0.1)  # Radius too small