Deprecated matplotlib_util

Author: viblo

CHANGELOG.rst

@@ -7,7 +7,8 @@ Changelog
    Added Vec2d.length_squared, and depreacted Vec2d.get_length_sqrd()
    Added Vec2d.get_distance_squared(), and deprecated Vec2d.get_dist_sqrd()
    A dynamic body must have non-zero mass when calling Space.step (either from Body.mass, or by setting mass or density on a Shape attached to the Body). Its not valid to set mass to 0 on a dynamic body attached to a space. 
-   
+   Deprecated matplotlib_util. If you think this is a useful module and you use it, please create an issue on the Pymunk issue track
+
    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.
 

TODO.txt

@@ -44,7 +44,6 @@ v6.x
 - Add Canvas util module (after pyodide) 
 - Use https://diataxis.fr/ method of organizing docs (tutorials, how-to, explanation, reference)
 - Make sure cffi extensions included in wheel and zip!
-- Catch error when NaN in debugdraw, suggest doublecheck mass=0. https://github.com/viblo/pymunk/issues/226 and https://github.com/viblo/pymunk/issues/267
 - Make benchmark between pymunk and pybullet. 2d bullet inspiration: https://github.com/bulletphysics/bullet3/blob/2.83/examples/Planar2D/Planar2D.cpp
 - After a couple of versions / time passed, re-evaluate if batch api should be separate or merged in to space.
 - Think about the copyright notice in some files. Keep / put everywere / remove?

pymunk/matplotlib_util.py

@@ -1,13 +1,14 @@
-"""This submodule contains helper functions to help with quick prototyping 
+"""This submodule contains helper functions to help with quick prototyping
 using pymunk together with matplotlib.
 
 Intended to help with debugging and prototyping, not for actual production use
-in a full application. The methods contained in this module is opinionated 
-about your coordinate system and not very optimized. 
+in a full application. The methods contained in this module is opinionated
+about your coordinate system and not very optimized.
 """
 
 __docformat__ = "reStructuredText"
 
+import warnings
 from typing import TYPE_CHECKING, Any, Sequence
 
 import matplotlib.pyplot as plt  # type: ignore
@@ -43,11 +44,26 @@ def __init__(self, ax: Any) -> None:
 
         See matplotlib_util.demo.py for a full example
 
+        .. deprecated:: 7.0.0
+            If you find this class useful, please open an issue on the pymunk
+            issue tracker at https://github.com/viblo/pymunk/issues Otherwise
+            this is likely to be completely removed in a future Pymunk version.
+
+
         :Param:
             ax: matplotlib.Axes
                 A matplotlib Axes object.
 
         """
+        warnings.warn(
+            "matplotlib_util.DrawOptions is deprecated. If you find it useful, "
+            "please open an issue on the pymunk issue tracker at "
+            "https://github.com/viblo/pymunk/issues Otherwise this is likely "
+            "to be completely removed in a future Pymunk version.",
+            category=DeprecationWarning,
+            stacklevel=2,
+        )
+
         super(DrawOptions, self).__init__()
 
         self.ax = ax