Merge pull request 'Random media requests' (#18) from dev into master

Reviewed-on: #18

classes/exceptions.py

@@ -164,6 +164,26 @@ class VideoSearchQueryEmptyError(HTTPException):
         )
 
 
+class SearchLimitInvalidError(HTTPException):
+    """Raises HTTP 400 if search results limit not in valid range."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Limit",
+            "content": {
+                "application/json": {
+                    "example": {
+                        "detail": "Parameter 'limit' must be greater or equal to 1."
+                    }
+                }
+            },
+        }
+        super().__init__(
+            status_code=400,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
 class SearchPageInvalidError(HTTPException):
     """Raises HTTP 400 if page or page size are not in valid range."""
 

classes/models.py

@@ -72,3 +72,11 @@ class SearchResultsPhoto(BaseModel):
 class SearchResultsVideo(BaseModel):
     results: List[VideoSearch]
     next_page: Union[str, None]
+
+
+class RandomSearchResultsPhoto(BaseModel):
+    results: List[PhotoSearch]
+
+
+class RandomSearchResultsVideo(BaseModel):
+    results: List[VideoSearch]

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(
-        path.join("data", "users", current_user.user, "albums", name), exist_ok=True
-    )
+    makedirs(Path(f"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}
@@ -109,12 +108,12 @@ async def album_patch(
     except InvalidId:
         raise AlbumNotFoundError(id)
 
-    if title is not None:
-        if 2 > len(title) > 40:
-            raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
-    else:
+    if title is None:
         title = album["title"]
 
+    elif 2 > len(title) > 40:
+        raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
+
     if name is not None:
         if re.search(re.compile("^[a-z,0-9,_]*$"), name) is False:
             raise AlbumIncorrectError(
@@ -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.join("data", "users", current_user.user, "albums", name),
+            Path(f"data/users/{current_user.user}/albums/{album['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.join("data", "users", current_user.user, "albums", name),
+        Path(f"data/users/{current_user.user}/albums/{album['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/pages.py

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

extensions/photos.py

@@ -1,6 +1,9 @@
+import logging
 import re
 from datetime import datetime, timedelta, timezone
 from os import makedirs, path, remove, system
+from pathlib import Path
+from random import randint
 from secrets import token_urlsafe
 from shutil import move
 from threading import Thread
@@ -24,10 +27,16 @@ from classes.exceptions import (
     AlbumNameNotFoundError,
     PhotoNotFoundError,
     PhotoSearchQueryEmptyError,
+    SearchLimitInvalidError,
     SearchPageInvalidError,
     SearchTokenInvalidError,
 )
-from classes.models import Photo, PhotoPublic, SearchResultsPhoto
+from classes.models import (
+    Photo,
+    PhotoPublic,
+    RandomSearchResultsPhoto,
+    SearchResultsPhoto,
+)
 from modules.app import app
 from modules.database import col_albums, col_photos, col_tokens
 from modules.exif_reader import extract_location
@@ -42,14 +51,18 @@ from modules.security import (
     get_current_active_user,
     get_user,
 )
-from modules.utils import configGet, logWrite
+from modules.utils import configGet
+
+logger = logging.getLogger(__name__)
 
 
 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
@@ -65,12 +78,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(
-        f"Compressed '{path.split(image_path)[-1]}' from {size_before} Kb to {size_after} Kb"
+    logger.info(
+        "Compressed '%s' from %s Kb to %s Kb",
+        Path(image_path).name,
+        size_before,
+        size_after,
     )
 
 
@@ -109,15 +125,11 @@ async def photo_upload(
     if col_albums.find_one({"user": current_user.user, "name": album}) is None:
         raise AlbumNameNotFoundError(album)
 
-    makedirs(
-        path.join("data", "users", current_user.user, "albums", album), exist_ok=True
-    )
+    makedirs(Path(f"data/users/{current_user.user}/albums/{album}"), exist_ok=True)
 
     filename = file.filename
 
-    if path.exists(
-        path.join("data", "users", current_user.user, "albums", album, file.filename)
-    ):
+    if Path(f"data/users/{current_user.user}/albums/{album}/{file.filename}").exists():
         base_name = file.filename.split(".")[:-1]
         extension = file.filename.split(".")[-1]
         filename = (
@@ -125,20 +137,18 @@ async def photo_upload(
         )
 
     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)
 
-    if len(duplicates) > 0 and ignore_duplicates is False:
+    if len(duplicates) > 0 and not ignore_duplicates:
         if configGet("media_token_access") is True:
-            duplicates_ids = []
-            for entry in duplicates:
-                duplicates_ids.append(entry["id"])
+            duplicates_ids = [entry["id"] for entry in duplicates]
             access_token = create_access_token(
                 data={
                     "sub": current_user.user,
@@ -168,7 +178,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}
@@ -188,14 +198,12 @@ async def photo_upload(
         }
     )
 
-    if compress is True:
+    if compress:
         scheduler.add_job(
             compress_image,
             trigger="date",
             run_date=datetime.now() + timedelta(seconds=1),
-            args=[
-                path.join("data", "users", current_user.user, "albums", album, filename)
-            ],
+            args=[Path(f"data/users/{current_user.user}/albums/{album}/{filename}")],
         )
 
     return UJSONResponse(
@@ -254,8 +262,8 @@ if configGet("media_token_access") is True:
         except InvalidId:
             raise PhotoNotFoundError(id)
 
-        image_path = path.join(
-            "data", "users", user.user, "albums", image["album"], image["filename"]
+        image_path = Path(
+            f"data/users/{user.user}/albums/{image['album']}/{image['filename']}"
         )
 
         mime = Magic(mime=True).from_file(image_path)
@@ -299,8 +307,8 @@ async def photo_get(
     except InvalidId:
         raise PhotoNotFoundError(id)
 
-    image_path = path.join(
-        "data", "users", current_user.user, "albums", image["album"], image["filename"]
+    image_path = Path(
+        f"data/users/{current_user.user}/albums/{image['album']}/{image['filename']}"
     )
 
     mime = Magic(mime=True).from_file(image_path)
@@ -335,11 +343,9 @@ async def photo_move(
     if col_albums.find_one({"user": current_user.user, "name": album}) is None:
         raise AlbumNameNotFoundError(album)
 
-    if path.exists(
-        path.join(
-            "data", "users", current_user.user, "albums", album, image["filename"]
-        )
-    ):
+    if Path(
+        f"data/users/{current_user.user}/albums/{album}/{image['filename']}"
+    ).exists():
         base_name = image["filename"].split(".")[:-1]
         extension = image["filename"].split(".")[-1]
         filename = (
@@ -360,15 +366,10 @@ async def photo_move(
     )
 
     move(
-        path.join(
-            "data",
-            "users",
-            current_user.user,
-            "albums",
-            image["album"],
-            image["filename"],
+        Path(
+            f"data/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(
@@ -441,19 +442,79 @@ async def photo_delete(
         col_albums.update_one({"name": image["album"]}, {"$set": {"cover": None}})
 
     remove(
-        path.join(
-            "data",
-            "users",
-            current_user.user,
-            "albums",
-            image["album"],
-            image["filename"],
+        Path(
+            f"data/users/{current_user.user}/albums/{image['album']}/{image['filename']}"
         )
     )
 
     return Response(status_code=HTTP_204_NO_CONTENT)
 
 
+photo_random_responses = {
+    400: SearchLimitInvalidError().openapi,
+    404: AlbumNameNotFoundError("name").openapi,
+}
+
+
+@app.get(
+    "/albums/{album}/photos/random",
+    description="Get one random photo, optionally by caption",
+    response_class=UJSONResponse,
+    response_model=RandomSearchResultsPhoto,
+    responses=photo_random_responses,
+)
+async def photo_random(
+    album: str,
+    caption: Union[str, None] = None,
+    limit: int = 100,
+    current_user: User = Security(get_current_active_user, scopes=["photos.list"]),
+):
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
+
+    if limit <= 0:
+        raise SearchLimitInvalidError()
+
+    output = {"results": []}
+
+    db_query = (
+        {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+        if caption is not None
+        else {
+            "user": current_user.user,
+            "album": album,
+        }
+    )
+
+    documents_count = col_photos.count_documents(db_query)
+    skip = randint(0, documents_count - 1) if documents_count > 1 else 0
+
+    images = list(
+        col_photos.aggregate(
+            [
+                {"$match": db_query},
+                {"$skip": skip},
+                {"$limit": limit},
+            ]
+        )
+    )
+
+    for image in images:
+        output["results"].append(
+            {
+                "id": image["_id"].__str__(),
+                "filename": image["filename"],
+                "caption": image["caption"],
+            }
+        )
+
+    return UJSONResponse(output)
+
+
 photo_find_responses = {
     400: SearchPageInvalidError().openapi,
     401: SearchTokenInvalidError().openapi,
@@ -528,7 +589,7 @@ async def photo_find(
         }
     elif q is None and caption is None:
         raise PhotoSearchQueryEmptyError()
-    elif q is None and caption is not None:
+    elif q is None:
         db_query = {
             "user": current_user.user,
             "album": album,
@@ -539,7 +600,7 @@ async def photo_find(
             "album": album,
             "caption": re.compile(caption),
         }
-    elif q is not None and caption is None:
+    elif caption is None:
         db_query = {
             "user": current_user.user,
             "album": album,

extensions/users.py

@@ -1,3 +1,4 @@
+import logging
 from datetime import datetime, timedelta
 from uuid import uuid1
 
@@ -21,7 +22,9 @@ from modules.security import (
     get_user,
     verify_password,
 )
-from modules.utils import configGet, logWrite
+from modules.utils import configGet
+
+logger = logging.getLogger(__name__)
 
 
 async def send_confirmation(user: str, email: str):
@@ -41,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,6 +1,8 @@
 import re
 from datetime import datetime, timezone
-from os import makedirs, path, remove
+from os import makedirs, remove
+from pathlib import Path
+from random import randint
 from secrets import token_urlsafe
 from shutil import move
 from typing import Union
@@ -16,12 +18,18 @@ from starlette.status import HTTP_204_NO_CONTENT
 
 from classes.exceptions import (
     AlbumNameNotFoundError,
+    SearchLimitInvalidError,
     SearchPageInvalidError,
     SearchTokenInvalidError,
     VideoNotFoundError,
     VideoSearchQueryEmptyError,
 )
-from classes.models import SearchResultsVideo, Video, VideoPublic
+from classes.models import (
+    RandomSearchResultsVideo,
+    SearchResultsVideo,
+    Video,
+    VideoPublic,
+)
 from modules.app import app
 from modules.database import col_albums, col_tokens, col_videos
 from modules.security import User, get_current_active_user
@@ -45,15 +53,11 @@ async def video_upload(
     if col_albums.find_one({"user": current_user.user, "name": album}) is None:
         raise AlbumNameNotFoundError(album)
 
-    makedirs(
-        path.join("data", "users", current_user.user, "albums", album), exist_ok=True
-    )
+    makedirs(Path(f"data/users/{current_user.user}/albums/{album}"), exist_ok=True)
 
     filename = file.filename
 
-    if path.exists(
-        path.join("data", "users", current_user.user, "albums", album, file.filename)
-    ):
+    if Path(f"data/users/{current_user.user}/albums/{album}/{file.filename}").exists():
         base_name = file.filename.split(".")[:-1]
         extension = file.filename.split(".")[-1]
         filename = (
@@ -61,7 +65,7 @@ async def video_upload(
         )
 
     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:
         await f.write(await file.read())
 
@@ -125,8 +129,8 @@ async def video_get(
     except InvalidId:
         raise VideoNotFoundError(id)
 
-    video_path = path.join(
-        "data", "users", current_user.user, "albums", video["album"], video["filename"]
+    video_path = Path(
+        f"data/users/{current_user.user}/albums/{video['album']}/{video['filename']}"
     )
 
     mime = Magic(mime=True).from_file(video_path)
@@ -161,11 +165,9 @@ async def video_move(
     if col_albums.find_one({"user": current_user.user, "name": album}) is None:
         raise AlbumNameNotFoundError(album)
 
-    if path.exists(
-        path.join(
-            "data", "users", current_user.user, "albums", album, video["filename"]
-        )
-    ):
+    if Path(
+        f"data/users/{current_user.user}/albums/{album}/{video['filename']}"
+    ).exists():
         base_name = video["filename"].split(".")[:-1]
         extension = video["filename"].split(".")[-1]
         filename = (
@@ -186,15 +188,10 @@ async def video_move(
     )
 
     move(
-        path.join(
-            "data",
-            "users",
-            current_user.user,
-            "albums",
-            video["album"],
-            video["filename"],
+        Path(
+            f"data/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(
@@ -264,19 +261,79 @@ async def video_delete(
     album = col_albums.find_one({"name": video["album"]})
 
     remove(
-        path.join(
-            "data",
-            "users",
-            current_user.user,
-            "albums",
-            video["album"],
-            video["filename"],
+        Path(
+            f"data/users/{current_user.user}/albums/{video['album']}/{video['filename']}"
         )
     )
 
     return Response(status_code=HTTP_204_NO_CONTENT)
 
 
+video_random_responses = {
+    400: SearchLimitInvalidError().openapi,
+    404: AlbumNameNotFoundError("name").openapi,
+}
+
+
+@app.get(
+    "/albums/{album}/videos/random",
+    description="Get one random video, optionally by caption",
+    response_class=UJSONResponse,
+    response_model=RandomSearchResultsVideo,
+    responses=video_random_responses,
+)
+async def video_random(
+    album: str,
+    caption: Union[str, None] = None,
+    limit: int = 100,
+    current_user: User = Security(get_current_active_user, scopes=["videos.list"]),
+):
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
+
+    if limit <= 0:
+        raise SearchLimitInvalidError()
+
+    output = {"results": []}
+
+    db_query = (
+        {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+        if caption is not None
+        else {
+            "user": current_user.user,
+            "album": album,
+        }
+    )
+
+    documents_count = col_videos.count_documents(db_query)
+    skip = randint(0, documents_count - 1) if documents_count > 1 else 0
+
+    videos = list(
+        col_videos.aggregate(
+            [
+                {"$match": db_query},
+                {"$skip": skip},
+                {"$limit": limit},
+            ]
+        )
+    )
+
+    for video in videos:
+        output["results"].append(
+            {
+                "id": video["_id"].__str__(),
+                "filename": video["filename"],
+                "caption": video["caption"],
+            }
+        )
+
+    return UJSONResponse(output)
+
+
 video_find_responses = {
     400: SearchPageInvalidError().openapi,
     401: SearchTokenInvalidError().openapi,
@@ -328,7 +385,7 @@ async def video_find(
     if q is None and caption is None:
         raise VideoSearchQueryEmptyError()
 
-    if q is None and caption is not None:
+    if q is None:
         db_query = {
             "user": current_user.user,
             "album": album,
@@ -339,7 +396,7 @@ async def video_find(
             "album": album,
             "caption": re.compile(caption),
         }
-    elif q is not None and caption is None:
+    elif caption is None:
         db_query = list(
             col_videos.find(
                 {"user": current_user.user, "album": album, "filename": re.compile(q)},

modules/app.py

@@ -1,14 +1,14 @@
 from fastapi import FastAPI
 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.5")
 
 
 @app.get("/docs", include_in_schema=False)
 async def custom_swagger_ui_html():
     return get_swagger_ui_html(
-        openapi_url=app.openapi_url,  # type: ignore
-        title=app.title + " - Documentation",
+        openapi_url=app.openapi_url,
+        title=f"{app.title} - Documentation",
         swagger_favicon_url="/favicon.ico",
     )
 
@@ -16,7 +16,7 @@ async def custom_swagger_ui_html():
 @app.get("/redoc", include_in_schema=False)
 async def custom_redoc_html():
     return get_redoc_html(
-        openapi_url=app.openapi_url,  # type: ignore
-        title=app.title + " - Documentation",
+        openapi_url=app.openapi_url,
+        title=f"{app.title} - Documentation",
         redoc_favicon_url="/favicon.ico",
     )

modules/database.py

@@ -24,7 +24,7 @@ db = db_client.get_database(name=db_config["name"])
 collections = db.list_collection_names()
 
 for collection in ["users", "albums", "photos", "videos", "tokens", "emails"]:
-    if not collection in collections:
+    if collection not in collections:
         db.create_collection(collection)
 
 col_users = db.get_collection("users")

modules/exif_reader.py

@@ -1,3 +1,5 @@
+import contextlib
+
 from exif import Image
 
 
@@ -12,8 +14,10 @@ def decimal_coords(coords: float, ref: str) -> float:
         * float: Decimal degrees
     """
     decimal_degrees = coords[0] + coords[1] / 60 + coords[2] / 3600
-    if ref == "S" or ref == "W":
+
+    if ref in {"S", "W"}:
         decimal_degrees = -decimal_degrees
+
     return round(decimal_degrees, 5)
 
 
@@ -35,11 +39,9 @@ def extract_location(filepath: str) -> dict:
     if img.has_exif is False:
         return output
 
-    try:
+    with contextlib.suppress(AttributeError):
         output["lng"] = decimal_coords(img.gps_longitude, img.gps_longitude_ref)
         output["lat"] = decimal_coords(img.gps_latitude, img.gps_latitude_ref)
         output["alt"] = img.gps_altitude
-    except AttributeError:
-        pass
 
     return output

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
 
 # =================================================================================
 
@@ -10,9 +11,9 @@ def get_py_files(src):
     cwd = getcwd()  # Current Working directory
     py_files = []
     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.extend(
+            Path(f"{cwd}/{root}/{file}") for file in files if file.endswith(".py")
+        )
     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,3 +1,6 @@
+from pathlib import Path
+from typing import Union
+
 import cv2
 import numpy as np
 from numpy.typing import NDArray
@@ -17,18 +20,18 @@ def hash_hex_to_hash_array(hash_hex) -> NDArray:
     # convert hash string in hex to hash values of 0 or 1
     hash_str = int(hash_hex, 16)
     array_str = bin(hash_str)[2:]
-    return np.array([i for i in array_str], dtype=np.float32)
+    return np.array(list(array_str), dtype=np.float32)
 
 
 def get_duplicates_cache(album: str) -> dict:
-    output = {}
-    for photo in col_photos.find({"album": album}):
-        output[photo["filename"]] = [photo["_id"].__str__(), photo["hash"]]
-    return output
+    return {
+        photo["filename"]: [photo["_id"].__str__(), photo["hash"]]
+        for photo in col_photos.find({"album": album})
+    }
 
 
-async def get_phash(filepath: str) -> str:
-    img = cv2.imread(filepath)
+async def get_phash(filepath: Union[str, Path]) -> str:
+    img = cv2.imread(str(filepath))
     # resize image and convert to gray scale
     img = cv2.resize(img, (64, 64))
     img = cv2.cvtColor(img, cv2.COLOR_BGR2GRAY)
@@ -49,14 +52,14 @@ async def get_phash(filepath: str) -> str:
     return hash_array_to_hash_hex(dct_block.flatten())
 
 
-async def get_duplicates(hash: str, album: str) -> list:
+async def get_duplicates(hash_string: str, album: str) -> list:
     duplicates = []
     cache = get_duplicates_cache(album)
-    for image_name in cache.keys():
+    for image_name, image_object in cache.items():
         try:
             distance = spatial.distance.hamming(
                 hash_hex_to_hash_array(cache[image_name][1]),
-                hash_hex_to_hash_array(hash),
+                hash_hex_to_hash_array(hash_string),
             )
         except ValueError:
             continue

modules/mailer.py

@@ -1,8 +1,11 @@
+import logging
 from smtplib import SMTP, SMTP_SSL
 from ssl import create_default_context
 from traceback import print_exc
 
-from modules.utils import configGet, logWrite
+from modules.utils import configGet
+
+logger = logging.getLogger(__name__)
 
 try:
     if configGet("use_ssl", "mailer", "smtp") is True:
@@ -10,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"),
@@ -18,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

@@ -73,12 +73,10 @@ def get_user(user: str):
 
 
 def authenticate_user(user_name: str, password: str):
-    user = get_user(user_name)
-    if not user:
+    if user := get_user(user_name):
+        return user if verify_password(password, user.hash) else False
+    else:
         return False
-    if not verify_password(password, user.hash):
-        return False
-    return user
 
 
 def create_access_token(data: dict, expires_delta: Union[timedelta, None] = None):
@@ -89,9 +87,8 @@ def create_access_token(data: dict, expires_delta: Union[timedelta, None] = None
         expire = datetime.now(tz=timezone.utc) + timedelta(
             days=ACCESS_TOKEN_EXPIRE_DAYS
         )
-    to_encode.update({"exp": expire})
-    encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
-    return encoded_jwt
+    to_encode["exp"] = expire
+    return jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
 
 
 async def get_current_user(

modules/utils.py

@@ -1,21 +1,18 @@
-from traceback import print_exc
+import logging
+from pathlib import Path
+from traceback import format_exc
 from typing import Any, Union
 
 from ujson import JSONDecodeError, dumps, loads
 
-
-# Print to stdout and then to log
-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)
+logger = logging.getLogger(__name__)
 
 
-def jsonLoad(filepath: str) -> Any:
+def jsonLoad(filepath: Union[str, Path]) -> Any:
     """Load json file
 
     ### Args:
-        * filepath (`str`): Path to input file
+        * filepath (`Union[str, Path]`): Path to input file
 
     ### Returns:
         * `Any`: Some json deserializable
@@ -24,32 +21,36 @@ def jsonLoad(filepath: str) -> Any:
         try:
             output = loads(file.read())
         except JSONDecodeError:
-            logWrite(
-                f"Could not load json file {filepath}: file seems to be incorrect!\n{print_exc()}"
+            logger.error(
+                "Could not load json file %s: file seems to be incorrect!\n%s",
+                filepath,
+                format_exc(),
             )
             raise
         except FileNotFoundError:
-            logWrite(
-                f"Could not load json file {filepath}: file does not seem to exist!\n{print_exc()}"
+            logger.error(
+                "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
 
 
@@ -63,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,13 +1,20 @@
-from os import makedirs, path
+import logging
+from os import makedirs
+from pathlib import Path
 
 from fastapi.responses import FileResponse
 
 from modules.app import app
 from modules.extensions_loader import dynamic_import_from_src
 from modules.scheduler import scheduler
-from modules.utils import *
 
-makedirs(path.join("data", "users"), exist_ok=True)
+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,11 +1,11 @@
 aiofiles==23.1.0
 apscheduler~=3.10.1
 exif==1.6.0
-fastapi[all]==0.97.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
+scipy~=1.11.0
 ujson~=5.8.0