Merge pull request #91 from joegasewicz/Fix-static-routes-for-images-&-static-files-#90

#90 Fix static routes for images & static files

Author: Joe Gasewicz

.github/workflows/python-package.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", 3.11]
+        python-version: ["3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v2

Pipfile

@@ -5,15 +5,19 @@ name = "pypi"
 
 [packages]
 birman = "0.0.2"
+sphinx-rtd-theme = "*"
 
 [dev-packages]
 pytest = "*"
 gunicorn = "*"
 sphinx = "*"
-pylint = "2.15.6"
 pytest-deprecate = "*"
 tox = "*"
 pip = "*"
-install = "*"
-sphinx-rtd-theme = "1.2.2"
-
+sphinx-rtd-theme = "*"
+pylint = "*"
+# below pkgs are for py310 running pylint in CI
+tomli = "*"
+typing-extensions = "*"
+dill = "*"
+exceptiongroup = "*"

Pipfile.lock

@@ -250,7 +250,7 @@ class sets the `STATIC_DIR` directory.
 
     class Static(AbstractRoute):
         def get(self, req: Request, res: Response) -> None:
-            res.set_static("/static/imgs/cat1.jpg")
+            res.set_static(req.path)
 ```
 You can set the static file path using the :class:`~BaseOptions`.
 ```python
@@ -261,7 +261,7 @@ class Options(BaseOptions):
 # Now in a route handler we can access static directory the via options
 class Static(AbstractRoute):
     def get(self, req: Request, res: Response) -> None:
-        res.set_static(f"{res.options.STATIC_DIR}/imgs/cat1.jpg")
+        res.set_static(req.path)
 ```
 By default, `STATIC_DIR` is set to `/static`, if your static file is nested
 within a Python package, for example `app/static` the set as `STATIC_DIR = "app/static"`

README.md

@@ -20,3 +20,7 @@ class MultipartFormDataError(Exception):
 
 class TemplatePathError(Exception):
     pass
+
+
+class StaticFileError(Exception):
+    pass

bobtail/exceptions.py

@@ -30,7 +30,7 @@ class Request(ABC):
 
     multipart: MultipartForm
 
-    def __init__(self, *,
+    def __init__(self, *,  # pylint: disable=too-many-arguments
                  path: str,
                  method: str,
                  byte_data: bytes,

bobtail/request.py

@@ -2,6 +2,7 @@
 import json
 
 from bobtail.options import BaseOptions
+from bobtail.exceptions import StaticFileError
 
 
 class Response:
@@ -137,7 +138,7 @@ class sets the `STATIC_DIR` directory.
 
                 class Static(AbstractRoute):
                     def get(self, req: Request, res: Response) -> None:
-                        res.set_static("/static/imgs/cat1.jpg")
+                        res.set_static(req.path)
 
         You can set the static file path using the :class:`~BaseOptions`.
         For example::
@@ -148,7 +149,7 @@ class Options(BaseOptions):
                 # Now in a route handler we can access static directory the via options
                 class Static(AbstractRoute):
                     def get(self, req: Request, res: Response) -> None:
-                        res.set_static(f"{res.options.STATIC_DIR}/imgs/cat1.jpg")
+                        res.set_static(req.path)
 
         By default, `STATIC_DIR` is set to `/static`, if your static file is nested
         within a Python package, for example `app/static` the set as `STATIC_DIR = "app/static"`
@@ -175,9 +176,20 @@ def get(self, req: Request, res: Response) -> None:
         if len(path_seg) <= 1:
             return None
         path = path_seg[1]
-        path = f"{self.options.STATIC_DIR}{path}"
-        self.set_headers({"Content-Type": "image/jpeg"})
-        with open(path, "rb") as f:
-            file_data = f.read()
-            f.close()
-        self.static = file_data
+        try:
+            file_suffix = path.split("/")[-1:][0].split(".")[-1:][0]
+            path = f"{self.options.STATIC_DIR}{path}"
+            if file_suffix in ("jpg", "jpeg", "png"):
+                self.set_headers({"Content-Type": "image/jpeg"})
+        except Exception as exc:
+            self.set_status(500)
+            raise StaticFileError(
+                f"Error getting filetype from static file path - {path}"
+            ) from exc
+        try:
+            with open(path, "rb") as f:
+                file_data = f.read()
+                f.close()
+            self.static = file_data
+        except FileNotFoundError:
+            self.set_status(404)

bobtail/response.py

@@ -7,7 +7,7 @@
 
 setup(
     name="bobtail",
-    version="0.0.25",
+    version="0.0.26",
     description="A little Python http framework",
     packages=["bobtail"],
     py_modules=["bobtail"],
@@ -17,6 +17,7 @@
     classifiers=[
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],