Merge pull request #161 from robotpy/warn-sensors

Warn about moved sensors classes

Author: auscompgeek

ctre/__init__.py

@@ -196,6 +196,19 @@
 
 from .version import version as __version__
 
+
 # backwards compat
 # TODO: remove in 2024
-from .sensors import *
+def __getattr__(name):
+    if name != "sensors":
+        from .sensors import __all__ as sensors_all
+
+        if name in sensors_all:
+            import warnings
+            from . import sensors
+
+            message = f"{__name__}.{name} has moved to {__name__}.sensors"
+            warnings.warn(message, FutureWarning, stacklevel=2)
+            return getattr(sensors, name)
+
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

tests/test_sensors.py

@@ -0,0 +1,15 @@
+import pytest
+
+import ctre.sensors
+
+
+def test_cancoder():
+    enc = ctre.sensors.CANCoder(0)
+    enc.getPosition()
+
+
+def test_deprecated_import():
+    with pytest.warns(FutureWarning, match="moved"):
+        from ctre import CANCoder
+
+    assert CANCoder is ctre.sensors.CANCoder