MotorSet off() vs stop() (#563)

dwalton76 · web-flow · commit 04f705f4ea98 · 2018-11-13T16:53:27.000-05:00
For issue #540
diff --git a/debian/changelog b/debian/changelog
@@ -1,6 +1,7 @@
 python-ev3dev2 (2.0.0~beta3) stable; urgency=medium
 
   [Daniel Walton]
+  * Moved MoveTank.off() to MotorSet
   * cache attributes that never change
   * Display: correct xy variable names passed to Display.rectangle()
   * GyroSensor wait_until_angle_changed_by added direction_sensitive option
diff --git a/ev3dev2/control/rc_tank.py b/ev3dev2/control/rc_tank.py
@@ -43,4 +43,4 @@ def main(self):
         # Exit cleanly so that all motors are stopped
         except (KeyboardInterrupt, Exception) as e:
             log.exception(e)
-            self.stop()
+            self.off()
diff --git a/ev3dev2/motor.py b/ev3dev2/motor.py
@@ -1688,12 +1688,26 @@ def reset(self, motors=None):
         for motor in motors:
             motor.reset()
 
-    def stop(self, motors=None):
+    def off(self, motors=None, brake=True):
+        """
+        Stop motors immediately. Configure motors to brake if ``brake`` is set.
+        """
         motors = motors if motors is not None else self.motors.values()
 
+        for motor in motors:
+            motor._set_brake(brake)
+
         for motor in motors:
             motor.stop()
 
+    def stop(self, motors=None, brake=True):
+        """
+        ``stop`` is an alias of ``off``.  This is deprecated but helps keep
+        the API for MotorSet somewhat similar to Motor which has both ``stop``
+        and ``off``.
+        """
+        self.off(motors, brake)
+
     def _is_state(self, motors, state):
         motors = motors if motors is not None else self.motors.values()
 
@@ -1899,16 +1913,6 @@ def on(self, left_speed, right_speed):
         self.left_motor.run_forever()
         self.right_motor.run_forever()
 
-    def off(self, brake=True):
-        """
-        Stop both motors immediately. Configure both to brake if ``brake`` is
-        set.
-        """
-        self.left_motor._set_brake(brake)
-        self.right_motor._set_brake(brake)
-        self.left_motor.stop()
-        self.right_motor.stop()
-
 
 class MoveSteering(MoveTank):
     """
