Clean up more docs to work with sphinx.

[python_utils.git] / camera_utils.py

diff --git a/camera_utils.py b/camera_utils.py
index bfa23abdaa86c120deb15df6e870e3397b17e266..c2bd04da0adccdb439711e3df6fdacf700d92e84 100644 (file)
--- a/camera_utils.py
+++ b/camera_utils.py
@@ -68,6 +68,7 @@ def fetch_camera_image_from_video_server(
     camera_name: str, *, width: int = 256, quality: int = 70
 ) -> Optional[bytes]:
     """Fetch the raw webcam image from the video server."""
+
     camera_name = camera_name.replace(".house", "")
     camera_name = camera_name.replace(".cabin", "")
     url = f"http://10.0.0.226:8080/{scott_secrets.SHINOBI_KEY1}/jpeg/{scott_secrets.SHINOBI_KEY2}/{camera_name}/s.jpg"
@@ -117,8 +118,8 @@ def camera_name_to_hostname(camera_name: str) -> str:
 
     >>> camera_name_to_hostname('cabin_driveway')
     'driveway.cabin'
-
     """
+
     mapping = {
         "driveway": "driveway.house",
         "backyard": "backyard.house",
@@ -136,6 +137,7 @@ def camera_name_to_hostname(camera_name: str) -> str:
 @decorator_utils.retry_if_none(tries=2, delay_sec=1, backoff=1.1)
 def fetch_camera_image_from_rtsp_stream(camera_name: str, *, width: int = 256) -> Optional[bytes]:
     """Fetch the raw webcam image straight from the webcam's RTSP stream."""
+
     hostname = camera_name_to_hostname(camera_name)
     stream = f"rtsp://camera:{scott_secrets.CAMERA_PASSWORD}@{hostname}:554/live"
     logger.debug('Fetching image from RTSP stream %s', stream)
@@ -170,6 +172,7 @@ def fetch_camera_image_from_rtsp_stream(camera_name: str, *, width: int = 256) -
 @decorator_utils.timeout(seconds=30, use_signals=False)
 def _fetch_camera_image(camera_name: str, *, width: int = 256, quality: int = 70) -> RawJpgHsv:
     """Fetch a webcam image given the camera name."""
+
     logger.debug("Trying to fetch camera image from video server")
     raw = fetch_camera_image_from_video_server(camera_name, width=width, quality=quality)
     if raw is None:
@@ -191,6 +194,8 @@ def _fetch_camera_image(camera_name: str, *, width: int = 256, quality: int = 70
 
 
 def fetch_camera_image(camera_name: str, *, width: int = 256, quality: int = 70) -> RawJpgHsv:
+    """Fetch an image given the camera_name."""
+
     try:
         return _fetch_camera_image(camera_name, width=width, quality=quality)
     except exceptions.TimeoutError: