Changed Query info shape properties to never have a None. #279

Author: viblo

CHANGELOG.rst

@@ -12,10 +12,12 @@ Changelog
    Changed body.constraints to return a KeysView of the Constraints attached to the body. Note that its still weak references to the Constraints. 
    Reversed the dependency between bodies and shapes. Now the Body owns the connection, and the Shape only keeps a weak ref to the Body. That means that if you remove a Body, then any shapes not referenced anywhere else will also be removed. 
    Changed body.shapes to return a KeysView instead of a set of the shapes.
+   Changed Space.segment_query to return None in case the query did not hit the shape.
 
    Added default do_nothing and always_collide callback functions to the CollisionHandler, so that its clear how to reset and align with other callbacks.
    If in old code you did handler.begin = None, you should now instead to handler.begin = CollisionHandler.always_collide etc.
 
+   Changed type of PointQueryInfo.shape, SegmentQueryInfo.shape and ShapeQueryInfo.shape to not be Optional, they will always have a shape.
    New feature: ShapeFilter.rejects_collision()
    New feature: Added Vec2d.polar_tuple
    Optimized Vec2d.angle and Vec2d.angle_degrees (note that the optimized versions treat 0 length vectors with x and/or y equal to -0 slightly differently.)

pymunk/_callbacks.py

@@ -22,8 +22,9 @@ def ext_cpSpacePointQueryFunc(
     gradient: ffi.CData,
     data: ffi.CData,
 ) -> None:
-    self, query_hits = ffi.from_handle(data)
+    _, query_hits = ffi.from_handle(data)
     shape = Shape._from_cp_shape(_shape)
+    assert shape != None
     p = PointQueryInfo(
         shape, Vec2d(point.x, point.y), distance, Vec2d(gradient.x, gradient.y)
     )
@@ -38,8 +39,9 @@ def ext_cpSpaceSegmentQueryFunc(
     alpha: float,
     data: ffi.CData,
 ) -> None:
-    self, query_hits = ffi.from_handle(data)
+    _, query_hits = ffi.from_handle(data)
     shape = Shape._from_cp_shape(_shape)
+    assert shape != None
     p = SegmentQueryInfo(
         shape, Vec2d(point.x, point.y), Vec2d(normal.x, normal.y), alpha
     )
@@ -58,8 +60,9 @@ def ext_cpSpaceBBQueryFunc(_shape: ffi.CData, data: ffi.CData) -> None:
 def ext_cpSpaceShapeQueryFunc(
     _shape: ffi.CData, _points: ffi.CData, data: ffi.CData
 ) -> None:
-    self, query_hits = ffi.from_handle(data)
+    _, query_hits = ffi.from_handle(data)
     found_shape = Shape._from_cp_shape(_shape)
+    assert found_shape != None
     point_set = ContactPointSet._from_cp(_points)
     info = ShapeQueryInfo(found_shape, point_set)
     query_hits.append(info)

pymunk/query_info.py

@@ -1,6 +1,6 @@
 __docformat__ = "reStructuredText"
 
-from typing import TYPE_CHECKING, NamedTuple, Optional
+from typing import TYPE_CHECKING, NamedTuple
 
 if TYPE_CHECKING:
     from .contact_point_set import ContactPointSet
@@ -13,8 +13,8 @@ class PointQueryInfo(NamedTuple):
     Space.
     """
 
-    shape: Optional["Shape"]
-    """The nearest shape, None if no shape was within range."""
+    shape: "Shape"
+    """The nearest shape"""
 
     point: "Vec2d"
     """The closest point on the shape's surface. (in world space
@@ -40,18 +40,14 @@ class SegmentQueryInfo(NamedTuple):
     they also return where a shape was hit and it's surface normal at the hit
     point. This object hold that information.
 
-    To test if the query hit something, check if
-    SegmentQueryInfo.shape == None or not.
-
     Segment queries are like ray casting, but because not all spatial indexes
     allow processing infinitely long ray queries it is limited to segments.
     In practice this is still very fast and you don't need to worry too much
     about the performance as long as you aren't using extremely long segments
     for your queries.
-
     """
 
-    shape: Optional["Shape"]
+    shape: "Shape"
     """Shape that was hit, or None if no collision occured"""
 
     point: "Vec2d"
@@ -69,7 +65,7 @@ class ShapeQueryInfo(NamedTuple):
     they also return where a shape was hit. This object hold that information.
     """
 
-    shape: Optional["Shape"]
+    shape: "Shape"
     """Shape that was hit, or None if no collision occured"""
 
     contact_point_set: "ContactPointSet"

pymunk/shapes.py

@@ -299,9 +299,11 @@ def point_query(self, p: Tuple[float, float]) -> PointQueryInfo:
 
     def segment_query(
         self, start: Tuple[float, float], end: Tuple[float, float], radius: float = 0
-    ) -> SegmentQueryInfo:
+    ) -> Optional[SegmentQueryInfo]:
         """Check if the line segment from start to end intersects the shape.
 
+        Returns None if it does not intersect
+
         :rtype: :py:class:`SegmentQueryInfo`
         """
         assert len(start) == 2
@@ -318,12 +320,7 @@ def segment_query(
                 info.alpha,
             )
         else:
-            return SegmentQueryInfo(
-                None,
-                Vec2d(info.point.x, info.point.y),
-                Vec2d(info.normal.x, info.normal.y),
-                info.alpha,
-            )
+            return None
 
     def shapes_collide(self, b: "Shape") -> ContactPointSet:
         """Get contact information about this shape and shape b.

pymunk/space.py

@@ -772,7 +772,7 @@ def point_query_nearest(
             self._space, point, max_distance, shape_filter, info
         )
 
-        shape = shape = Shape._from_cp_shape(_shape)
+        shape = Shape._from_cp_shape(_shape)
 
         if shape != None:
             return PointQueryInfo(
@@ -857,7 +857,7 @@ def segment_query_first(
             self._space, start, end, radius, shape_filter, info
         )
 
-        shape = shape = Shape._from_cp_shape(_shape)
+        shape = Shape._from_cp_shape(_shape)
         if shape != None:
             return SegmentQueryInfo(
                 shape,

pymunk/tests/test_shape.py

@@ -32,15 +32,14 @@ def testSegmentQuery(self) -> None:
         c.cache_bb()
 
         info = c.segment_query((10, -50), (10, 50))
-        self.assertEqual(info.shape, None)
-        self.assertEqual(info.point, (10, 50))
-        self.assertEqual(info.normal, (0, 0))
-        self.assertEqual(info.alpha, 1.0)
+        self.assertEqual(info, None)
 
         info = c.segment_query((10, -50), (10, 50), 6)
+        assert info != None
         self.assertEqual(info.shape, c)
 
         info = c.segment_query((0, -50), (0, 50))
+        assert info != None
         self.assertEqual(info.shape, c)
         self.assertAlmostEqual(info.point.x, 0)
         self.assertAlmostEqual(info.point.y, -5)