Merge pull request 'Update FastAPI to 0.98.0' (#16) from dev into master

Reviewed-on: #16

.renovaterc

@@ -0,0 +1,20 @@
+{
+    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+    "extends": [
+        "config:base"
+    ],
+    "baseBranches": [
+        "dev"
+    ],
+    "packageRules": [
+        {
+            "matchUpdateTypes": [
+                "minor",
+                "patch",
+                "pin",
+                "digest"
+            ],
+            "automerge": true
+        }
+    ]
+}

README.md

@@ -9,7 +9,7 @@ Small and simple API server for saving photos and videos.
 
 ## Dependencies
 
-* [Python 3.7+](https://www.python.org) (3.9+ recommended)
+* [Python 3.8+](https://www.python.org) (3.9+ recommended)
 * [MongoDB](https://www.mongodb.com)
 * [exiftool](https://exiftool.org)
 * [jpegoptim](https://github.com/tjko/jpegoptim)

classes/exceptions.py

@@ -1,7 +1,9 @@
 from typing import Literal
 
+from fastapi import HTTPException
 
-class AlbumNotFoundError(Exception):
+
+class AlbumNotFoundError(HTTPException):
     """Raises HTTP 404 if no album with this ID found."""
 
     def __init__(self, id: str):
@@ -16,7 +18,7 @@ class AlbumNotFoundError(Exception):
         }
 
 
-class AlbumNameNotFoundError(Exception):
+class AlbumNameNotFoundError(HTTPException):
     """Raises HTTP 404 if no album with this name found."""
 
     def __init__(self, name: str):
@@ -29,9 +31,15 @@ class AlbumNameNotFoundError(Exception):
                 }
             },
         }
+        super().__init__(
+            status_code=404,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(name=self.name),
+        )
 
 
-class AlbumAlreadyExistsError(Exception):
+class AlbumAlreadyExistsError(HTTPException):
     """Raises HTTP 409 if album with this name already exists."""
 
     def __init__(self, name: str):
@@ -44,9 +52,15 @@ class AlbumAlreadyExistsError(Exception):
                 }
             },
         }
+        super().__init__(
+            status_code=409,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(name=self.name),
+        )
 
 
-class AlbumIncorrectError(Exception):
+class AlbumIncorrectError(HTTPException):
     """Raises HTTP 406 if album's title or name is invalid."""
 
     def __init__(self, place: Literal["name", "title"], error: str) -> None:
@@ -56,13 +70,19 @@ class AlbumIncorrectError(Exception):
             "description": "Album Name/Title Invalid",
             "content": {
                 "application/json": {
-                    "example": {"detail": "Album {name/title} invalid: {error}"}
+                    "example": {"detail": "Album {place} invalid: {error}"}
                 }
             },
         }
+        super().__init__(
+            status_code=406,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(place=self.place, error=self.error),
+        )
 
 
-class PhotoNotFoundError(Exception):
+class PhotoNotFoundError(HTTPException):
     """Raises HTTP 404 if no photo with this ID found."""
 
     def __init__(self, id: str):
@@ -75,9 +95,15 @@ class PhotoNotFoundError(Exception):
                 }
             },
         }
+        super().__init__(
+            status_code=404,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(id=self.id),
+        )
 
 
-class PhotoSearchQueryEmptyError(Exception):
+class PhotoSearchQueryEmptyError(HTTPException):
     """Raises HTTP 422 if no photo search query provided."""
 
     def __init__(self):
@@ -91,9 +117,13 @@ class PhotoSearchQueryEmptyError(Exception):
                 }
             },
         }
+        super().__init__(
+            status_code=422,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
 
 
-class VideoNotFoundError(Exception):
+class VideoNotFoundError(HTTPException):
     """Raises HTTP 404 if no video with this ID found."""
 
     def __init__(self, id: str):
@@ -106,9 +136,15 @@ class VideoNotFoundError(Exception):
                 }
             },
         }
+        super().__init__(
+            status_code=404,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(id=self.id),
+        )
 
 
-class VideoSearchQueryEmptyError(Exception):
+class VideoSearchQueryEmptyError(HTTPException):
     """Raises HTTP 422 if no video search query provided."""
 
     def __init__(self):
@@ -122,9 +158,13 @@ class VideoSearchQueryEmptyError(Exception):
                 }
             },
         }
+        super().__init__(
+            status_code=422,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
 
 
-class SearchPageInvalidError(Exception):
+class SearchPageInvalidError(HTTPException):
     """Raises HTTP 400 if page or page size are not in valid range."""
 
     def __init__(self):
@@ -138,9 +178,13 @@ class SearchPageInvalidError(Exception):
                 }
             },
         }
+        super().__init__(
+            status_code=400,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
 
 
-class SearchTokenInvalidError(Exception):
+class SearchTokenInvalidError(HTTPException):
     """Raises HTTP 401 if search token is not valid."""
 
     def __init__(self):
@@ -150,9 +194,13 @@ class SearchTokenInvalidError(Exception):
                 "application/json": {"example": {"detail": "Invalid search token."}}
             },
         }
+        super().__init__(
+            status_code=401,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
 
 
-class UserEmailCodeInvalid(Exception):
+class UserEmailCodeInvalid(HTTPException):
     """Raises HTTP 400 if email confirmation code is not valid."""
 
     def __init__(self):
@@ -164,9 +212,13 @@ class UserEmailCodeInvalid(Exception):
                 }
             },
         }
+        super().__init__(
+            status_code=400,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
 
 
-class UserAlreadyExists(Exception):
+class UserAlreadyExists(HTTPException):
     """Raises HTTP 409 if user with this name already exists."""
 
     def __init__(self):
@@ -178,9 +230,13 @@ class UserAlreadyExists(Exception):
                 }
             },
         }
+        super().__init__(
+            status_code=409,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
 
 
-class AccessTokenInvalidError(Exception):
+class AccessTokenInvalidError(HTTPException):
     """Raises HTTP 401 if access token is not valid."""
 
     def __init__(self):
@@ -190,9 +246,13 @@ class AccessTokenInvalidError(Exception):
                 "application/json": {"example": {"detail": "Invalid access token."}}
             },
         }
+        super().__init__(
+            status_code=401,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
 
 
-class UserCredentialsInvalid(Exception):
+class UserCredentialsInvalid(HTTPException):
     """Raises HTTP 401 if user credentials are not valid."""
 
     def __init__(self):
@@ -202,3 +262,7 @@ class UserCredentialsInvalid(Exception):
                 "application/json": {"example": {"detail": "Invalid credentials."}}
             },
         }
+        super().__init__(
+            status_code=401,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )

classes/models.py

@@ -1,4 +1,5 @@
 from typing import List, Union
+
 from pydantic import BaseModel
 
 

extensions/albums.py

@@ -1,5 +1,6 @@
 import re
-from os import makedirs, path, rename
+from os import makedirs, rename
+from pathlib import Path
 from shutil import rmtree
 from typing import Union
 
@@ -49,9 +50,7 @@ async def album_create(
     if col_albums.find_one({"name": name}) is not None:
         raise AlbumAlreadyExistsError(name)
 
-    makedirs(
+    makedirs(Path(f"data/users/{current_user.user}/albums/{name}"), exist_ok=True)
-        path.join("data", "users", current_user.user, "albums", name), exist_ok=True
-    )
 
     uploaded = col_albums.insert_one(
         {"user": current_user.user, "name": name, "title": title, "cover": None}
@@ -123,8 +122,8 @@ async def album_patch(
         if 2 > len(name) > 20:
             raise AlbumIncorrectError("name", "must be >2 and <20 characters.")
         rename(
-            path.join("data", "users", current_user.user, "albums", album["name"]),
+            Path(f"data/users/{current_user.user}/albums/{album['name']}"),
-            path.join("data", "users", current_user.user, "albums", name),
+            Path(f"data/users/{current_user.user}/albums/{name}"),
         )
         col_photos.update_many(
             {"user": current_user.user, "album": album["name"]},
@@ -186,8 +185,8 @@ async def album_put(
     cover = image["_id"].__str__() if image is not None else None  # type: ignore
 
     rename(
-        path.join("data", "users", current_user.user, "albums", album["name"]),
+        Path(f"data/users/{current_user.user}/albums/{album['name']}"),
-        path.join("data", "users", current_user.user, "albums", name),
+        Path(f"data/users/{current_user.user}/albums/{name}"),
     )
 
     col_photos.update_many(
@@ -222,6 +221,6 @@ async def album_delete(
 
     col_photos.delete_many({"album": album["name"]})
 
-    rmtree(path.join("data", "users", current_user.user, "albums", album["name"]))
+    rmtree(Path(f"data/users/{current_user.user}/albums/{album['name']}"))
 
     return Response(status_code=HTTP_204_NO_CONTENT)

extensions/exceptions.py

@@ -1,7 +1,5 @@
 from fastapi import Request
 from fastapi.responses import UJSONResponse
-from modules.app import app
-from classes.exceptions import *
 from starlette.status import (
     HTTP_400_BAD_REQUEST,
     HTTP_401_UNAUTHORIZED,
@@ -11,6 +9,23 @@ from starlette.status import (
     HTTP_422_UNPROCESSABLE_ENTITY,
 )
 
+from classes.exceptions import (
+    AlbumNotFoundError,
+    AlbumAlreadyExistsError,
+    AlbumIncorrectError,
+    PhotoNotFoundError,
+    PhotoSearchQueryEmptyError,
+    VideoNotFoundError,
+    VideoSearchQueryEmptyError,
+    SearchPageInvalidError,
+    SearchTokenInvalidError,
+    AccessTokenInvalidError,
+    UserEmailCodeInvalid,
+    UserAlreadyExists,
+    UserCredentialsInvalid,
+)
+from modules.app import app
+
 
 @app.exception_handler(AlbumNotFoundError)
 async def album_not_found_exception_handler(request: Request, exc: AlbumNotFoundError):

extensions/pages.py

@@ -1,31 +1,36 @@
-from os import path
+from pathlib import Path
-from modules.app import app
+
+import aiofiles
 from fastapi.responses import HTMLResponse, Response
 
+from modules.app import app
+
 
 @app.get("/pages/matter.css", include_in_schema=False)
 async def page_matter():
-    with open(path.join("pages", "matter.css"), "r", encoding="utf-8") as f:
+    async with aiofiles.open(Path("pages/matter.css"), "r", encoding="utf-8") as f:
-        output = f.read()
+        output = await f.read()
     return Response(content=output)
 
 
 @app.get("/pages/{page}/{file}", include_in_schema=False)
 async def page_assets(page: str, file: str):
-    with open(path.join("pages", page, file), "r", encoding="utf-8") as f:
+    async with aiofiles.open(Path(f"pages/{page}/{file}"), "r", encoding="utf-8") as f:
-        output = f.read()
+        output = await f.read()
     return Response(content=output)
 
 
 @app.get("/", include_in_schema=False)
 async def page_home():
-    with open(path.join("pages", "home", "index.html"), "r", encoding="utf-8") as f:
+    async with aiofiles.open(Path("pages/home/index.html"), "r", encoding="utf-8") as f:
-        output = f.read()
+        output = await f.read()
     return HTMLResponse(content=output)
 
 
 @app.get("/register", include_in_schema=False)
 async def page_register():
-    with open(path.join("pages", "register", "index.html"), "r", encoding="utf-8") as f:
+    async with aiofiles.open(
-        output = f.read()
+        Path("pages/register/index.html"), "r", encoding="utf-8"
+    ) as f:
+        output = await f.read()
     return HTMLResponse(content=output)

extensions/photos.py

@@ -1,15 +1,26 @@
+import logging
 import re
-import pickle
+from datetime import datetime, timedelta, timezone
+from os import makedirs, path, remove, system
+from pathlib import Path
 from secrets import token_urlsafe
 from shutil import move
 from threading import Thread
 from typing import Union
 from uuid import uuid4
-from magic import Magic
-from datetime import datetime, timedelta, timezone
-from os import makedirs, path, remove, system
 
+import aiofiles
+from bson.errors import InvalidId
+from bson.objectid import ObjectId
+from fastapi import Security, UploadFile
+from fastapi.responses import Response, UJSONResponse
+from jose import JWTError, jwt
+from magic import Magic
+from plum.exceptions import UnpackError
 from pydantic import ValidationError
+from pymongo import DESCENDING
+from starlette.status import HTTP_204_NO_CONTENT, HTTP_409_CONFLICT
+
 from classes.exceptions import (
     AccessTokenInvalidError,
     AlbumNameNotFoundError,
@@ -19,8 +30,10 @@ from classes.exceptions import (
     SearchTokenInvalidError,
 )
 from classes.models import Photo, PhotoPublic, SearchResultsPhoto
+from modules.app import app
+from modules.database import col_albums, col_photos, col_tokens
 from modules.exif_reader import extract_location
-from modules.hasher import get_phash, get_duplicates
+from modules.hasher import get_duplicates, get_phash
 from modules.scheduler import scheduler
 from modules.security import (
     ALGORITHM,
@@ -31,31 +44,18 @@ from modules.security import (
     get_current_active_user,
     get_user,
 )
-from modules.app import app
+from modules.utils import configGet
-from modules.database import col_photos, col_albums, col_tokens
-from pymongo import DESCENDING
-from bson.objectid import ObjectId
-from bson.errors import InvalidId
-from plum.exceptions import UnpackError
-from jose import JWTError, jwt
 
-from fastapi import UploadFile, Security
+logger = logging.getLogger(__name__)
-from fastapi.responses import UJSONResponse, Response
-from fastapi.exceptions import HTTPException
-from starlette.status import (
-    HTTP_204_NO_CONTENT,
-    HTTP_401_UNAUTHORIZED,
-    HTTP_409_CONFLICT,
-)
-
-from modules.utils import configGet, logWrite
 
 
 async def compress_image(image_path: str):
     image_type = Magic(mime=True).from_file(image_path)
 
     if image_type not in ["image/jpeg", "image/png"]:
-        logWrite(f"Not compressing {image_path} because its mime is '{image_type}'")
+        logger.info(
+            "Not compressing %s because its mime is '%s'", image_path, image_type
+        )
         return
 
     size_before = path.getsize(image_path) / 1024
@@ -71,12 +71,15 @@ async def compress_image(image_path: str):
         return
 
     task.start()
-    logWrite(f"Compressing '{path.split(image_path)[-1]}'...")
+    logger.info("Compressing '%s'...", Path(image_path).name)
     task.join()
 
     size_after = path.getsize(image_path) / 1024
-    logWrite(
+    logger.info(
-        f"Compressed '{path.split(image_path)[-1]}' from {size_before} Kb to {size_after} Kb"
+        "Compressed '%s' from %s Kb to %s Kb",
+        Path(image_path).name,
+        size_before,
+        size_after,
     )
 
 
@@ -115,28 +118,24 @@ async def photo_upload(
     if col_albums.find_one({"user": current_user.user, "name": album}) is None:
         raise AlbumNameNotFoundError(album)
 
-    makedirs(
+    makedirs(Path(f"data/users/{current_user.user}/albums/{album}"), exist_ok=True)
-        path.join("data", "users", current_user.user, "albums", album), exist_ok=True
-    )
 
     filename = file.filename
 
-    if path.exists(
+    if Path(f"data/users/{current_user.user}/albums/{album}/{file.filename}").exists():
-        path.join("data", "users", current_user.user, "albums", album, file.filename)
-    ):
         base_name = file.filename.split(".")[:-1]
         extension = file.filename.split(".")[-1]
         filename = (
             ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
         )
 
-    with open(
+    async with aiofiles.open(
-        path.join("data", "users", current_user.user, "albums", album, filename), "wb"
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}"), "wb"
     ) as f:
-        f.write(await file.read())
+        await f.write(await file.read())
 
     file_hash = await get_phash(
-        path.join("data", "users", current_user.user, "albums", album, filename)
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}")
     )
     duplicates = await get_duplicates(file_hash, album)
 
@@ -174,7 +173,7 @@ async def photo_upload(
 
     try:
         coords = extract_location(
-            path.join("data", "users", current_user.user, "albums", album, filename)
+            Path(f"data/users/{current_user.user}/albums/{album}/{filename}")
         )
     except (UnpackError, ValueError):
         coords = {"lng": 0.0, "lat": 0.0, "alt": 0.0}
@@ -199,9 +198,7 @@ async def photo_upload(
             compress_image,
             trigger="date",
             run_date=datetime.now() + timedelta(seconds=1),
-            args=[
+            args=[Path(f"data/users/{current_user.user}/albums/{album}/{filename}")],
-                path.join("data", "users", current_user.user, "albums", album, filename)
-            ],
         )
 
     return UJSONResponse(
@@ -260,22 +257,40 @@ if configGet("media_token_access") is True:
         except InvalidId:
             raise PhotoNotFoundError(id)
 
-        image_path = path.join(
+        image_path = Path(
-            "data", "users", user.user, "albums", image["album"], image["filename"]
+            f"data/users/{user.user}/albums/{image['album']}/{image['filename']}"
         )
 
         mime = Magic(mime=True).from_file(image_path)
 
-        with open(image_path, "rb") as f:
+        async with aiofiles.open(image_path, "rb") as f:
-            image_file = f.read()
+            image_file = await f.read()
 
         return Response(image_file, media_type=mime)
 
 
-photo_get_responses = {404: PhotoNotFoundError("id").openapi}
+photo_get_responses = {
+    200: {
+        "content": {
+            "application/octet-stream": {
+                "schema": {
+                    "type": "string",
+                    "format": "binary",
+                    "contentMediaType": "image/*",
+                }
+            }
+        }
+    },
+    404: PhotoNotFoundError("id").openapi,
+}
 
 
-@app.get("/photos/{id}", description="Get a photo by id", responses=photo_get_responses)
+@app.get(
+    "/photos/{id}",
+    description="Get a photo by id",
+    responses=photo_get_responses,
+    response_class=Response,
+)
 async def photo_get(
     id: str,
     current_user: User = Security(get_current_active_user, scopes=["photos.read"]),
@@ -287,14 +302,14 @@ async def photo_get(
     except InvalidId:
         raise PhotoNotFoundError(id)
 
-    image_path = path.join(
+    image_path = Path(
-        "data", "users", current_user.user, "albums", image["album"], image["filename"]
+        f"data/users/{current_user.user}/albums/{image['album']}/{image['filename']}"
     )
 
     mime = Magic(mime=True).from_file(image_path)
 
-    with open(image_path, "rb") as f:
+    async with aiofiles.open(image_path, "rb") as f:
-        image_file = f.read()
+        image_file = await f.read()
 
     return Response(image_file, media_type=mime)
 
@@ -323,11 +338,9 @@ async def photo_move(
     if col_albums.find_one({"user": current_user.user, "name": album}) is None:
         raise AlbumNameNotFoundError(album)
 
-    if path.exists(
+    if Path(
-        path.join(
+        f"data/users/{current_user.user}/albums/{album}/{image['filename']}"
-            "data", "users", current_user.user, "albums", album, image["filename"]
+    ).exists():
-        )
-    ):
         base_name = image["filename"].split(".")[:-1]
         extension = image["filename"].split(".")[-1]
         filename = (
@@ -348,15 +361,10 @@ async def photo_move(
     )
 
     move(
-        path.join(
+        Path(
-            "data",
+            f"data/users/{current_user.user}/albums/{image['album']}/{image['filename']}"
-            "users",
-            current_user.user,
-            "albums",
-            image["album"],
-            image["filename"],
         ),
-        path.join("data", "users", current_user.user, "albums", album, filename),
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}"),
     )
 
     return UJSONResponse(
@@ -429,13 +437,8 @@ async def photo_delete(
         col_albums.update_one({"name": image["album"]}, {"$set": {"cover": None}})
 
     remove(
-        path.join(
+        Path(
-            "data",
+            f"data/users/{current_user.user}/albums/{image['album']}/{image['filename']}"
-            "users",
-            current_user.user,
-            "albums",
-            image["album"],
-            image["filename"],
         )
     )
 

extensions/security.py

@@ -1,12 +1,10 @@
 from datetime import timedelta
-from classes.exceptions import UserCredentialsInvalid
-from modules.app import app
 
 from fastapi import Depends
-from fastapi.security import (
+from fastapi.security import OAuth2PasswordRequestForm
-    OAuth2PasswordRequestForm,
-)
 
+from classes.exceptions import UserCredentialsInvalid
+from modules.app import app
 from modules.security import (
     ACCESS_TOKEN_EXPIRE_DAYS,
     Token,

extensions/users.py

@@ -1,27 +1,20 @@
+import logging
 from datetime import datetime, timedelta
+from uuid import uuid1
+
+from fastapi import Depends, Form
+from fastapi.responses import Response, UJSONResponse
+from starlette.status import HTTP_204_NO_CONTENT
+
 from classes.exceptions import (
     UserAlreadyExists,
     UserCredentialsInvalid,
     UserEmailCodeInvalid,
 )
-from modules.database import (
-    col_users,
-    col_albums,
-    col_photos,
-    col_emails,
-    col_videos,
-    col_emails,
-)
 from modules.app import app
-from modules.utils import configGet, logWrite
+from modules.database import col_albums, col_emails, col_photos, col_users, col_videos
-from modules.scheduler import scheduler
 from modules.mailer import mail_sender
-
+from modules.scheduler import scheduler
-from uuid import uuid1
-from fastapi import Depends, Form
-from fastapi.responses import Response, UJSONResponse
-from starlette.status import HTTP_204_NO_CONTENT
-
 from modules.security import (
     User,
     get_current_active_user,
@@ -29,6 +22,9 @@ from modules.security import (
     get_user,
     verify_password,
 )
+from modules.utils import configGet
+
+logger = logging.getLogger(__name__)
 
 
 async def send_confirmation(user: str, email: str):
@@ -48,9 +44,11 @@ async def send_confirmation(user: str, email: str):
         col_emails.insert_one(
             {"user": user, "email": email, "used": False, "code": confirmation_code}
         )
-        logWrite(f"Sent confirmation email to '{email}' with code {confirmation_code}")
+        logger.info(
+            "Sent confirmation email to '%s' with code %s", email, confirmation_code
+        )
     except Exception as exp:
-        logWrite(f"Could not send confirmation email to '{email}' due to: {exp}")
+        logger.error("Could not send confirmation email to '%s' due to: %s", email, exp)
 
 
 @app.get("/users/me/", response_model=User)

extensions/videos.py

@@ -1,11 +1,20 @@
 import re
-import pickle
+from datetime import datetime, timezone
+from os import makedirs, remove
+from pathlib import Path
 from secrets import token_urlsafe
 from shutil import move
 from typing import Union
+
+import aiofiles
+from bson.errors import InvalidId
+from bson.objectid import ObjectId
+from fastapi import Security, UploadFile
+from fastapi.responses import Response, UJSONResponse
 from magic import Magic
-from datetime import datetime, timezone
+from pymongo import DESCENDING
-from os import makedirs, path, remove
+from starlette.status import HTTP_204_NO_CONTENT
+
 from classes.exceptions import (
     AlbumNameNotFoundError,
     SearchPageInvalidError,
@@ -13,17 +22,10 @@ from classes.exceptions import (
     VideoNotFoundError,
     VideoSearchQueryEmptyError,
 )
-from classes.models import Video, SearchResultsVideo, VideoPublic
+from classes.models import SearchResultsVideo, Video, VideoPublic
-from modules.security import User, get_current_active_user
 from modules.app import app
-from modules.database import col_videos, col_albums, col_tokens
+from modules.database import col_albums, col_tokens, col_videos
-from bson.objectid import ObjectId
+from modules.security import User, get_current_active_user
-from bson.errors import InvalidId
-from pymongo import DESCENDING
-
-from fastapi import UploadFile, Security
-from fastapi.responses import UJSONResponse, Response
-from starlette.status import HTTP_204_NO_CONTENT
 
 video_post_responses = {404: AlbumNameNotFoundError("name").openapi}
 
@@ -44,25 +46,21 @@ async def video_upload(
     if col_albums.find_one({"user": current_user.user, "name": album}) is None:
         raise AlbumNameNotFoundError(album)
 
-    makedirs(
+    makedirs(Path(f"data/users/{current_user.user}/albums/{album}"), exist_ok=True)
-        path.join("data", "users", current_user.user, "albums", album), exist_ok=True
-    )
 
     filename = file.filename
 
-    if path.exists(
+    if Path(f"data/users/{current_user.user}/albums/{album}/{file.filename}").exists():
-        path.join("data", "users", current_user.user, "albums", album, file.filename)
-    ):
         base_name = file.filename.split(".")[:-1]
         extension = file.filename.split(".")[-1]
         filename = (
             ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
         )
 
-    with open(
+    async with aiofiles.open(
-        path.join("data", "users", current_user.user, "albums", album, filename), "wb"
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}"), "wb"
     ) as f:
-        f.write(await file.read())
+        await f.write(await file.read())
 
     # Hashing and duplicates check should be here
 
@@ -91,10 +89,28 @@ async def video_upload(
     )
 
 
-video_get_responses = {404: VideoNotFoundError("id").openapi}
+video_get_responses = {
+    200: {
+        "content": {
+            "application/octet-stream": {
+                "schema": {
+                    "type": "string",
+                    "format": "binary",
+                    "contentMediaType": "video/*",
+                }
+            }
+        }
+    },
+    404: VideoNotFoundError("id").openapi,
+}
 
 
-@app.get("/videos/{id}", description="Get a video by id", responses=video_get_responses)
+@app.get(
+    "/videos/{id}",
+    description="Get a video by id",
+    responses=video_get_responses,
+    response_class=Response,
+)
 async def video_get(
     id: str,
     current_user: User = Security(get_current_active_user, scopes=["videos.read"]),
@@ -106,16 +122,16 @@ async def video_get(
     except InvalidId:
         raise VideoNotFoundError(id)
 
-    video_path = path.join(
+    video_path = Path(
-        "data", "users", current_user.user, "albums", video["album"], video["filename"]
+        f"data/users/{current_user.user}/albums/{video['album']}/{video['filename']}"
     )
 
     mime = Magic(mime=True).from_file(video_path)
 
-    with open(video_path, "rb") as f:
+    async with aiofiles.open(video_path, "rb") as f:
-        video_file = f.read()
+        video_file = await f.read()
 
-    return Response(video_file, media_type=mime)
+    return Response(content=video_file, media_type=mime)
 
 
 video_move_responses = {404: VideoNotFoundError("id").openapi}
@@ -142,11 +158,9 @@ async def video_move(
     if col_albums.find_one({"user": current_user.user, "name": album}) is None:
         raise AlbumNameNotFoundError(album)
 
-    if path.exists(
+    if Path(
-        path.join(
+        f"data/users/{current_user.user}/albums/{album}/{video['filename']}"
-            "data", "users", current_user.user, "albums", album, video["filename"]
+    ).exists():
-        )
-    ):
         base_name = video["filename"].split(".")[:-1]
         extension = video["filename"].split(".")[-1]
         filename = (
@@ -167,15 +181,10 @@ async def video_move(
     )
 
     move(
-        path.join(
+        Path(
-            "data",
+            f"data/users/{current_user.user}/albums/{video['album']}/{video['filename']}"
-            "users",
-            current_user.user,
-            "albums",
-            video["album"],
-            video["filename"],
         ),
-        path.join("data", "users", current_user.user, "albums", album, filename),
+        Path(f"data/users/{current_user.user}/albums/{album}/{filename}"),
     )
 
     return UJSONResponse(
@@ -245,13 +254,8 @@ async def video_delete(
     album = col_albums.find_one({"name": video["album"]})
 
     remove(
-        path.join(
+        Path(
-            "data",
+            f"data/users/{current_user.user}/albums/{video['album']}/{video['filename']}"
-            "users",
-            current_user.user,
-            "albums",
-            video["album"],
-            video["filename"],
         )
     )
 

modules/app.py

@@ -1,8 +1,7 @@
 from fastapi import FastAPI
-from fastapi.openapi.docs import get_swagger_ui_html, get_redoc_html
+from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
 
-
+app = FastAPI(title="END PLAY Photos", docs_url=None, redoc_url=None, version="0.4")
-app = FastAPI(title="END PLAY Photos", docs_url=None, redoc_url=None, version="0.2")
 
 
 @app.get("/docs", include_in_schema=False)

modules/database.py

@@ -1,5 +1,6 @@
+from pymongo import GEOSPHERE, MongoClient
+
 from modules.utils import configGet
-from pymongo import MongoClient, GEOSPHERE
 
 db_config = configGet("database")
 

modules/extensions_loader.py

@@ -1,5 +1,6 @@
 from importlib.util import module_from_spec, spec_from_file_location
 from os import getcwd, path, walk
+from pathlib import Path
 
 # =================================================================================
 
@@ -12,7 +13,7 @@ def get_py_files(src):
     for root, dirs, files in walk(src):
         for file in files:
             if file.endswith(".py"):
-                py_files.append(path.join(cwd, root, file))
+                py_files.append(Path(f"{cwd}/{root}/{file}"))
     return py_files
 
 
@@ -36,7 +37,7 @@ def dynamic_import(module_name, py_path):
 def dynamic_import_from_src(src, star_import=False):
     my_py_files = get_py_files(src)
     for py_file in my_py_files:
-        module_name = path.split(py_file)[-1][:-3]
+        module_name = Path(py_file).stem
         print(f"Importing {module_name} extension...", flush=True)
         imported_module = dynamic_import(module_name, py_file)
         if imported_module != None:

modules/hasher.py

@@ -1,8 +1,9 @@
-from modules.database import col_photos
+import cv2
 import numpy as np
 from numpy.typing import NDArray
 from scipy import spatial
-import cv2
+
+from modules.database import col_photos
 
 
 def hash_array_to_hash_hex(hash_array):

modules/mailer.py

@@ -1,7 +1,11 @@
+import logging
 from smtplib import SMTP, SMTP_SSL
-from traceback import print_exc
 from ssl import create_default_context
-from modules.utils import configGet, logWrite
+from traceback import print_exc
+
+from modules.utils import configGet
+
+logger = logging.getLogger(__name__)
 
 try:
     if configGet("use_ssl", "mailer", "smtp") is True:
@@ -9,7 +13,7 @@ try:
             configGet("host", "mailer", "smtp"),
             configGet("port", "mailer", "smtp"),
         )
-        logWrite(f"Initialized SMTP SSL connection")
+        logger.info("Initialized SMTP SSL connection")
     elif configGet("use_tls", "mailer", "smtp") is True:
         mail_sender = SMTP(
             configGet("host", "mailer", "smtp"),
@@ -17,21 +21,21 @@ try:
         )
         mail_sender.starttls(context=create_default_context())
         mail_sender.ehlo()
-        logWrite(f"Initialized SMTP TLS connection")
+        logger.info("Initialized SMTP TLS connection")
     else:
         mail_sender = SMTP(
             configGet("host", "mailer", "smtp"), configGet("port", "mailer", "smtp")
         )
         mail_sender.ehlo()
-        logWrite(f"Initialized SMTP connection")
+        logger.info("Initialized SMTP connection")
 except Exception as exp:
-    logWrite(f"Could not initialize SMTP connection to: {exp}")
+    logger.error("Could not initialize SMTP connection to: %s", exp)
     print_exc()
 
 try:
     mail_sender.login(
         configGet("login", "mailer", "smtp"), configGet("password", "mailer", "smtp")
     )
-    logWrite(f"Successfully initialized mailer")
+    logger.info("Successfully initialized mailer")
 except Exception as exp:
-    logWrite(f"Could not login into provided SMTP account due to: {exp}")
+    logger.error("Could not login into provided SMTP account due to: %s", exp)

modules/security.py

@@ -1,16 +1,13 @@
 from datetime import datetime, timedelta, timezone
 from typing import List, Union
-from modules.database import col_users
 
 from fastapi import Depends, HTTPException, Security, status
-from fastapi.security import (
+from fastapi.security import OAuth2PasswordBearer, SecurityScopes
-    OAuth2PasswordBearer,
-    SecurityScopes,
-)
 from jose import JWTError, jwt
 from passlib.context import CryptContext
 from pydantic import BaseModel, ValidationError
 
+from modules.database import col_users
 
 with open("secret_key", "r", encoding="utf-8") as f:
     SECRET_KEY = f.read()

modules/utils.py

@@ -1,20 +1,18 @@
+import logging
+from pathlib import Path
+from traceback import format_exc
 from typing import Any, Union
-from ujson import loads, dumps, JSONDecodeError
+
-from traceback import print_exc
+from ujson import JSONDecodeError, dumps, loads
+
+logger = logging.getLogger(__name__)
 
 
-# Print to stdout and then to log
+def jsonLoad(filepath: Union[str, Path]) -> Any:
-def logWrite(message: str, debug: bool = False) -> None:
-    # save to log file and rotation is to be done
-    # logAppend(f'{message}', debug=debug)
-    print(f"{message}", flush=True)
-
-
-def jsonLoad(filepath: str) -> Any:
     """Load json file
 
     ### Args:
-        * filepath (`str`): Path to input file
+        * filepath (`Union[str, Path]`): Path to input file
 
     ### Returns:
         * `Any`: Some json deserializable
@@ -23,32 +21,36 @@ def jsonLoad(filepath: str) -> Any:
         try:
             output = loads(file.read())
         except JSONDecodeError:
-            logWrite(
+            logger.error(
-                f"Could not load json file {filepath}: file seems to be incorrect!\n{print_exc()}"
+                "Could not load json file %s: file seems to be incorrect!\n%s",
+                filepath,
+                format_exc(),
             )
             raise
         except FileNotFoundError:
-            logWrite(
+            logger.error(
-                f"Could not load json file {filepath}: file does not seem to exist!\n{print_exc()}"
+                "Could not load json file %s: file does not seem to exist!\n%s",
+                filepath,
+                format_exc(),
             )
             raise
         file.close()
     return output
 
 
-def jsonSave(contents: Union[list, dict], filepath: str) -> None:
+def jsonSave(contents: Union[list, dict], filepath: Union[str, Path]) -> None:
     """Save contents into json file
 
     ### Args:
         * contents (`Union[list, dict]`): Some json serializable
-        * filepath (`str`): Path to output file
+        * filepath (`Union[str, Path]`): Path to output file
     """
     try:
         with open(filepath, "w", encoding="utf8") as file:
             file.write(dumps(contents, ensure_ascii=False, indent=4))
             file.close()
     except Exception as exp:
-        logWrite(f"Could not save json file {filepath}: {exp}\n{print_exc()}")
+        logger.error("Could not save json file %s: %s\n%s", filepath, exp, format_exc())
     return
 
 
@@ -62,7 +64,7 @@ def configGet(key: str, *args: str) -> Any:
     ### Returns:
         * `Any`: Value of provided key
     """
-    this_dict = jsonLoad("config.json")
+    this_dict = jsonLoad(Path("config.json"))
     this_key = this_dict
     for dict_key in args:
         this_key = this_key[dict_key]

photos_api.py

@@ -1,11 +1,20 @@
-from os import makedirs, path
+import logging
-from modules.app import app
+from os import makedirs
-from modules.utils import *
+from pathlib import Path
-from modules.scheduler import scheduler
+
-from modules.extensions_loader import dynamic_import_from_src
 from fastapi.responses import FileResponse
 
-makedirs(path.join("data", "users"), exist_ok=True)
+from modules.app import app
+from modules.extensions_loader import dynamic_import_from_src
+from modules.scheduler import scheduler
+
+makedirs(Path("data/users"), exist_ok=True)
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(name)s.%(funcName)s | %(levelname)s | %(message)s",
+    datefmt="[%X]",
+)
 
 
 @app.get("/favicon.ico", response_class=FileResponse, include_in_schema=False)

requirements.txt

@@ -1,10 +1,11 @@
-fastapi[all]==0.95.0
+aiofiles==23.1.0
-pymongo==4.3.3
-ujson~=5.7.0
-scipy~=1.10.1
-python-magic~=0.4.27
-opencv-python~=4.7.0.72
-python-jose[cryptography]~=3.3.0
-passlib~=1.7.4
 apscheduler~=3.10.1
-exif==1.6.0
+exif==1.6.0
+fastapi[all]==0.98.0
+opencv-python~=4.7.0.72
+passlib~=1.7.4
+pymongo==4.4.0
+python-jose[cryptography]~=3.3.0
+python-magic~=0.4.27
+scipy~=1.10.1
+ujson~=5.8.0