X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=smart_home%2Fthermometers.py;h=4531c618fc17b749f172abaa301863646f67a0a0;hb=a9bdfd8fc9f84b7b2c09a57cd12ba32259e84d1c;hp=90199b9cdaa3dd0e2f09c9a7a521b0b03c8b7e5b;hpb=f2600f30801c849fc1d139386e3ddc3c9eb43e30;p=python_utils.git

diff --git a/smart_home/thermometers.py b/smart_home/thermometers.py
index 90199b9..4531c61 100644
--- a/smart_home/thermometers.py
+++ b/smart_home/thermometers.py
@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+# © Copyright 2021-2022, Scott Gasch
+
 """Code involving querying various smart home thermometers."""
 
 import logging
@@ -26,6 +28,22 @@ class ThermometerRegistry(object):
         }
 
     def read_temperature(self, location: str, *, convert_to_fahrenheit=False) -> Optional[float]:
+        """Read the current value of a thermometer (in celsius unless
+        convert_to_fahrenheit is True) and return it.  Return None on
+        error.
+
+        >>> registry = ThermometerRegistry()
+        >>> registry.read_temperature('unknown') is None
+        True
+
+        >>> temp = registry.read_temperature('house_computer_closet')
+        >>> temp is None
+        False
+        >>> temp > 0.0
+        True
+
+        """
+
         record = self.thermometers.get(location, None)
         if record is None:
             logger.error(
@@ -34,6 +52,7 @@ class ThermometerRegistry(object):
                 self.thermometers.keys(),
             )
             return None
+
         url = f'http://{record[0]}/~pi/{record[1]}'
         logger.debug('Constructed URL: %s', url)
         try:
@@ -52,3 +71,9 @@ class ThermometerRegistry(object):
             if www is not None:
                 www.close()
         return temp
+
+
+if __name__ == '__main__':
+    import doctest
+
+    doctest.testmod()