Address review comments

Author: alan412

external_samples/color_range_sensor.py

@@ -1,5 +1,5 @@
 from component import Component, PortType, InvalidPortException
-from collections.abc import Callable, Protocol
+from collections.abc import Protocol
 
 class DistanceCallable(Protocol):
     def __call__(self, distance : float) -> None:
@@ -11,7 +11,6 @@ def __call__(self, hue : int, saturation : int, value : int) -> None:
 class ColorRangeSensor(Component):    
     # Required methods
     def __init__(self, ports : list[tuple[PortType, int]]):
-        self.is_pressed = None
         portType, port = ports[0]
         if portType != PortType.I2C_PORT:
             raise InvalidPortException
@@ -37,27 +36,29 @@ def periodic(self) -> None:
         pass
 
     # Component specific methods
-    def get_color_rgb(self) -> list[int, int, int]:
+    def get_color_rgb(self) -> tuple[int, int, int]:
         '''gets the color in rgb (red, green, blue)'''
         pass
-    def get_color_hsv(self) -> list[int, int, int]:
+    def get_color_hsv(self) -> tuple[int, int, int]:
         '''gets the color in hsv (hue, saturation, value)'''
         pass
     def get_distance_mm(self) -> float:
         '''gets the distance of the object seen'''
         pass
 
-    def register_when_less_than_distance(self, distance : float, callback: DistanceCallable) -> None:
+    def register_when_less_than_distance(self, distance : float, 
+                                               callback: DistanceCallable) -> None:
         '''Event when item is seen closer than a distance'''
         self.less_than_distance_callback = callback
 
-    def register_when_hue_in_range(self, min_hue : int, max_hue : int, callback: ColorCallable) -> None:
+    def register_when_hue_in_range(self, min_hue : int, 
+                                         max_hue : int, 
+                                         callback: ColorCallable) -> None:
         '''Event when hue is in range'''
         self.hue_in_range_callback = callback
 
-    def register_when_saturation_in_range(self, min_saturation : int, max_saturation : int, callback : ColorCallable) -> None:
+    def register_when_saturation_in_range(self, min_saturation : int, 
+                                                max_saturation : int, 
+                                                callback : ColorCallable) -> None:
         '''Event when saturation is in range'''
-        self.saturation_in_range_callback = callback
-
-    
-    
+        self.saturation_in_range_callback = callback

external_samples/component.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 from enum import Enum
-from collections.abc import Callable, Protocol
+from collections.abc import Protocol
 
 class EmptyCallable(Protocol):
     def __call__(self) -> None:
@@ -17,7 +17,7 @@ class InvalidPortException(Exception):
     pass
 
 # This is an abstract class
-class Component:
+class Component(ABC):
     @abstractmethod
     def __init__(self, ports : list[tuple[PortType, int]]):
         pass
@@ -39,7 +39,8 @@ def get_url(self) -> str:
         pass
     # This is the version of the software (returned as a (major, minor, revision) tuple where 
     # major and minor are positive integers
-    # revision is an optional string
+    # revision can be an empty string or specify small changes that are less than a
+    # minor revision
     @abstractmethod
     def get_version(self) -> tuple[int, int, str]: 
         pass
@@ -49,7 +50,7 @@ def get_version(self) -> tuple[int, int, str]:
     def stop(self) -> None:
         pass
 
-    # any reset required (if any) at the beginning of each opmode
+    # This performs any reset required (if any) at the beginning of each opmode
     # This might remove any registered callbacks
     @abstractmethod
     def reset(self) -> None:

external_samples/rev_touch_sensor.py

@@ -44,10 +44,10 @@ def is_pressed(self) -> bool:
 
     # Events
     def register_when_pressed(self, callback: EmptyCallable) -> None:
-        '''Event when touch sensor is first pressed'''
+        '''Event when touch sensor is pressed (after being not pressed)'''
         self.pressed_callback = callback
 
 
     def register_when_released(self, callback: EmptyCallable) -> None:
-        '''Event when touch sensor is first released'''
+        '''Event when touch sensor is released (after being pressed)'''
         self.released_callback = callback

external_samples/servo.py

@@ -1,10 +1,8 @@
 from component import Component, PortType, InvalidPortException
-from collections.abc import Callable
 
 class Servo(Component):    
     # Required methods
     def __init__(self, ports : list[tuple[PortType, int]]):
-        self.is_pressed = None
         portType, port = ports[0]
         if portType != PortType.SERVO_PORT:
             raise InvalidPortException

external_samples/smart_motor.py

@@ -3,7 +3,6 @@
 class SmartMotor(Component):    
     # Required methods
     def __init__(self, ports : list[tuple[PortType, int]]):
-        self.is_pressed = None
         portType, port = ports[0]
         if portType != PortType.SMART_MOTOR_PORT:
             raise InvalidPortException