Style: Add type hinting for function parameters and return types

front/app.py

@@ -4,7 +4,7 @@ import streamlit as st
 from image_preprocessing import get_image_caption, get_images, resize_image
 
 
-def image_gallery(images):
+def image_gallery(images: list) -> None:
     """Display a gallery of images in a streamlit app
 
     Args:
@@ -15,7 +15,7 @@ def image_gallery(images):
     columns = st.columns(3)
     for index, image in enumerate(images):
         with columns[index % 3]:
-            resized_image = resize_image(image, 200)
+            resized_image = resize_image(image)
             image_caption = get_image_caption(image)
             st.image(
                 resized_image,
@@ -25,7 +25,7 @@ def image_gallery(images):
             )
 
 
-def sidebar():
+def sidebar() -> str:
     """Create a sidebar to select the park
 
     Returns:
@@ -37,7 +37,7 @@ def sidebar():
     return selected_park
 
 
-def main():
+def main() -> None:
     """Main function to run the app"""
     path = "../images/"
     park = sidebar()

front/image_preprocessing.py

@@ -1,9 +1,11 @@
+"""File to preprocess images"""
+
 import os
 
 from PIL import Image
 
 
-def get_images(folder):
+def get_images(folder: str) -> list:
     """Get images from a folder
 
     Args:
@@ -20,18 +22,19 @@ def get_images(folder):
     return images
 
 
-def resize_image(image_path, target_height):
+def resize_image(img_path: str, target_w: int = 200, target_h: int = 200) -> Image:
     """Resize an image
 
     Args:
-        image_path (str): path to the image
-        target_height (int): int to resize the height of the image
+        img_path (str): path to the image
+        target_w (int): int to resize the width of the image
+        target_h (int): int to resize the height of the image
 
     Returns:
         img: resized images
     """
-    img = Image.open(image_path)
-    img = img.resize((200, target_height))
+    img = Image.open(img_path)
+    img = img.resize((target_w, target_h))
     return img