From 60b0fd42c23dcbb1100c2dcc7932c56c7709d784 Mon Sep 17 00:00:00 2001
From: Christoph Stahl <christoph.stahl@tu-dortmund.de>
Date: Tue, 18 Jun 2024 02:23:19 +0200
Subject: [PATCH] Some typings, to improve compatibility with pyright

---
 .gitlab-ci.yml                  |  5 +--
 pyproject.toml                  | 11 +++--
 syng/client.py                  |  5 ++-
 syng/gui.py                     |  7 ++-
 syng/server.py                  | 75 +++++++++++++++++++++++++--------
 syng/sources/filebased.py       | 11 +++--
 syng/sources/s3.py              |  8 ++--
 syng/sources/youtube.py         |  2 +-
 {stubs => typings}/aiocmd.pyi   |  0
 {stubs => typings}/mutagen.pyi  |  0
 {stubs => typings}/pytube.pyi   |  0
 typings/qrcode/main.pyi         |  8 ++++
 {stubs => typings}/socketio.pyi | 16 +++----
 13 files changed, 102 insertions(+), 46 deletions(-)
 rename {stubs => typings}/aiocmd.pyi (100%)
 rename {stubs => typings}/mutagen.pyi (100%)
 rename {stubs => typings}/pytube.pyi (100%)
 create mode 100644 typings/qrcode/main.pyi
 rename {stubs => typings}/socketio.pyi (74%)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 15bc157..a4acf81 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,12 +1,9 @@
 image: python:3-alpine
 
-variables:
-    MYPYPATH: "stubs/"
-
 mypy:
     stage: test
     script:
-        - pip install mypy types-Pillow types-PyYAML --quiet
+        - pip install .[dev,client] --quiet
         - mypy syng --strict
 
 ruff:
diff --git a/pyproject.toml b/pyproject.toml
index e800eff..c56337f 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -31,15 +31,15 @@ tkcalendar = { version = "^1.6.1", optional = true }
 tktimepicker = { version = "^2.0.2", optional = true }
 platformdirs = { version = "^4.0.0", optional = true }
 packaging = {version = "^23.2", optional = true}
-
-[tool.poetry.group.dev.dependencies]
-types-pyyaml = "^6.0.12.12"
-types-pillow = "^10.1.0.2"
+types-pyyaml = {version = "^6.0.12.12", optional = true}
+types-pillow = {version = "^10.1.0.2", optional = true}
+mypy = {version = "^1.10.0", optional = true}
 
 [tool.poetry.extras]
 client = ["minio", "mutagen", "pillow", "customtkinter", "qrcode",
   "pymediainfo", "pyyaml", "tkcalendar", "tktimepicker", "platformdirs",
   "packaging"]
+dev = ["types-pillow", "types-pillow", "mypy"]
 
 [build-system]
 requires = ["poetry-core"]
@@ -55,6 +55,9 @@ disable = '''too-many-lines,
 too-many-ancestors
 '''
 
+[tool.mypy]
+mypy_path = "typings"
+
 [[tool.mypy.overrides]]
 module = [
   "yt_dlp",
diff --git a/syng/client.py b/syng/client.py
index 3e7bd2a..7b3c187 100644
--- a/syng/client.py
+++ b/syng/client.py
@@ -31,6 +31,7 @@ The config file should be a yaml file in the following style::
         waiting_room_policy: ..
 
 """
+
 import asyncio
 import datetime
 import logging
@@ -46,7 +47,7 @@ from traceback import print_exc
 from typing import Any, Optional
 import platformdirs
 
-import qrcode
+from qrcode.main import QRCode
 
 import socketio
 import engineio
@@ -323,7 +324,7 @@ async def handle_client_registered(data: dict[str, Any]) -> None:
     if data["success"]:
         logging.info("Registered")
         print(f"Join here: {state.config['server']}/{data['room']}")
-        qr = qrcode.QRCode(box_size=20, border=2)
+        qr = QRCode(box_size=20, border=2)
         qr.add_data(f"{state.config['server']}/{data['room']}")
         qr.make()
         qr.print_ascii()
diff --git a/syng/gui.py b/syng/gui.py
index 3aaa564..1c75fb9 100644
--- a/syng/gui.py
+++ b/syng/gui.py
@@ -4,7 +4,7 @@ from datetime import datetime, date, time
 import os
 import builtins
 from functools import partial
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any, Optional
 import webbrowser
 import multiprocessing
 import secrets
@@ -13,7 +13,7 @@ import string
 from PIL import ImageTk
 from yaml import dump, load, Loader, Dumper
 import customtkinter
-from qrcode import QRCode
+from qrcode.main import QRCode
 from tkcalendar import Calendar
 from tktimepicker import AnalogPicker, AnalogThemes, constants
 import platformdirs
@@ -27,6 +27,9 @@ try:
 
     SERVER_AVAILABLE = True
 except ImportError:
+    if TYPE_CHECKING:
+        from .server import main as server_main
+
     SERVER_AVAILABLE = False
 
 
diff --git a/syng/server.py b/syng/server.py
index b098090..dfd51e9 100644
--- a/syng/server.py
+++ b/syng/server.py
@@ -12,6 +12,7 @@ Starts a async socketio server, and serves the web client::
       --root-folder PATH, -r PATH
 
 """
+
 from __future__ import annotations
 
 import asyncio
@@ -135,7 +136,9 @@ class State:
     recent: list[Entry]
     sid: str
     client: Client
-    last_seen: datetime.datetime = field(init=False, default_factory=datetime.datetime.now)
+    last_seen: datetime.datetime = field(
+        init=False, default_factory=datetime.datetime.now
+    )
 
 
 clients: dict[str, State] = {}
@@ -158,7 +161,9 @@ async def send_state(state: State, sid: str) -> None:
     :rtype: None
     """
 
-    safe_config = {k: v for k, v in state.client.config.items() if k not in ["secret", "key"]}
+    safe_config = {
+        k: v for k, v in state.client.config.items() if k not in ["secret", "key"]
+    }
 
     await sio.emit(
         "state",
@@ -209,13 +214,18 @@ async def handle_waiting_room_append(sid: str, data: dict[str, Any]) -> None:
     if entry is None:
         await sio.emit(
             "msg",
-            {"msg": f"Unable to add to the waiting room: {data['ident']}. Maybe try again?"},
+            {
+                "msg": f"Unable to add to the waiting room: {data['ident']}. Maybe try again?"
+            },
             room=sid,
         )
         return
 
     if "uid" not in data or (
-        (data["uid"] is not None and len(list(state.queue.find_by_uid(data["uid"]))) == 0)
+        (
+            data["uid"] is not None
+            and len(list(state.queue.find_by_uid(data["uid"]))) == 0
+        )
         or (data["uid"] is None and state.queue.find_by_name(data["performer"]) is None)
     ):
         await append_to_queue(room, entry, sid)
@@ -232,7 +242,9 @@ async def handle_waiting_room_append(sid: str, data: dict[str, Any]) -> None:
     )
 
 
-async def append_to_queue(room: str, entry: Entry, report_to: Optional[str] = None) -> None:
+async def append_to_queue(
+    room: str, entry: Entry, report_to: Optional[str] = None
+) -> None:
     """
     Append a song to the queue for a given session.
 
@@ -256,7 +268,10 @@ async def append_to_queue(room: str, entry: Entry, report_to: Optional[str] = No
         start_time = first_song.started_at
 
     start_time = state.queue.fold(
-        lambda item, time: time + item.duration + state.client.config["preview_duration"] + 1,
+        lambda item, time: time
+        + item.duration
+        + state.client.config["preview_duration"]
+        + 1,
         start_time,
     )
 
@@ -541,7 +556,11 @@ async def handle_waiting_room_to_queue(sid: str, data: dict[str, Any]) -> None:
 
     if is_admin:
         entry = next(
-            (wr_entry for wr_entry in state.waiting_room if str(wr_entry.uuid) == data["uuid"]),
+            (
+                wr_entry
+                for wr_entry in state.waiting_room
+                if str(wr_entry.uuid) == data["uuid"]
+            ),
             None,
         )
         if entry is not None:
@@ -673,7 +692,9 @@ async def handle_register_client(sid: str, data: dict[str, Any]) -> None:
     """
 
     def gen_id(length: int = 4) -> str:
-        client_id = "".join([random.choice(string.ascii_letters) for _ in range(length)])
+        client_id = "".join(
+            [random.choice(string.ascii_letters) for _ in range(length)]
+        )
         if client_id in clients:
             client_id = gen_id(length + 1)
         return client_id
@@ -685,7 +706,8 @@ async def handle_register_client(sid: str, data: dict[str, Any]) -> None:
 
             if (
                 "key" not in data["config"]
-                or hashlib.sha256(data["config"]["key"].encode()).hexdigest() not in keys
+                or hashlib.sha256(data["config"]["key"].encode()).hexdigest()
+                not in keys
             ):
                 await sio.emit(
                     "client-registered",
@@ -695,7 +717,9 @@ async def handle_register_client(sid: str, data: dict[str, Any]) -> None:
                 return
 
     room: str = (
-        data["config"]["room"] if "room" in data["config"] and data["config"]["room"] else gen_id()
+        data["config"]["room"]
+        if "room" in data["config"] and data["config"]["room"]
+        else gen_id()
     )
     async with sio.session(sid) as session:
         session["room"] = room
@@ -711,11 +735,15 @@ async def handle_register_client(sid: str, data: dict[str, Any]) -> None:
                 config=DEFAULT_CONFIG | data["config"],
             )
             await sio.enter_room(sid, room)
-            await sio.emit("client-registered", {"success": True, "room": room}, room=sid)
+            await sio.emit(
+                "client-registered", {"success": True, "room": room}, room=sid
+            )
             await send_state(clients[room], sid)
         else:
             logger.warning("Got wrong secret for %s", room)
-            await sio.emit("client-registered", {"success": False, "room": room}, room=sid)
+            await sio.emit(
+                "client-registered", {"success": False, "room": room}, room=sid
+            )
     else:
         logger.info("Registerd new client %s", room)
         initial_entries = [Entry(**entry) for entry in data["queue"]]
@@ -806,7 +834,9 @@ async def handle_config_chunk(sid: str, data: dict[str, Any]) -> None:
         return
 
     if data["source"] not in state.client.sources:
-        state.client.sources[data["source"]] = available_sources[data["source"]](data["config"])
+        state.client.sources[data["source"]] = available_sources[data["source"]](
+            data["config"]
+        )
     else:
         state.client.sources[data["source"]].add_to_config(data["config"])
 
@@ -835,7 +865,9 @@ async def handle_config(sid: str, data: dict[str, Any]) -> None:
     if sid != state.sid:
         return
 
-    state.client.sources[data["source"]] = available_sources[data["source"]](data["config"])
+    state.client.sources[data["source"]] = available_sources[data["source"]](
+        data["config"]
+    )
 
 
 @sio.on("register-web")
@@ -1020,10 +1052,17 @@ async def handle_search(sid: str, data: dict[str, Any]) -> None:
 
     query = data["query"]
     results_list = await asyncio.gather(
-        *[state.client.sources[source].search(query) for source in state.client.sources_prio]
+        *[
+            state.client.sources[source].search(query)
+            for source in state.client.sources_prio
+        ]
     )
 
-    results = [search_result for source_result in results_list for search_result in source_result]
+    results = [
+        search_result
+        for source_result in results_list
+        for search_result in source_result
+    ]
     await sio.emit(
         "search-results",
         {"results": results},
@@ -1104,7 +1143,9 @@ def main() -> None:
 
     app["root_folder"] = args.root_folder
 
-    app.add_routes([web.static("/assets/", os.path.join(app["root_folder"], "assets/"))])
+    app.add_routes(
+        [web.static("/assets/", os.path.join(app["root_folder"], "assets/"))]
+    )
 
     app.router.add_route("*", "/", root_handler)
     app.router.add_route("*", "/{room}", root_handler)
diff --git a/syng/sources/filebased.py b/syng/sources/filebased.py
index 136bc79..ffa1812 100644
--- a/syng/sources/filebased.py
+++ b/syng/sources/filebased.py
@@ -1,13 +1,16 @@
 """Module for an abstract filebased Source."""
+
 import asyncio
 import os
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any, Optional
 
 try:
     from pymediainfo import MediaInfo
 
     PYMEDIAINFO_AVAILABLE = True
 except ImportError:
+    if TYPE_CHECKING:
+        from pymediainfo import MediaInfo
     PYMEDIAINFO_AVAILABLE = False
 
 from .source import Source
@@ -35,7 +38,7 @@ class FileBasedSource(Source):
         self.extensions: list[str] = config["extensions"] if "extensions" in config else ["mp3+cdg"]
         self.extra_mpv_arguments = ["--scale=oversample"]
 
-    def has_correct_extension(self, path: str) -> bool:
+    def has_correct_extension(self, path: Optional[str]) -> bool:
         """Check if a `path` has a correct extension.
 
         For A+B type extensions (like mp3+cdg) only the latter halve is checked
@@ -43,7 +46,9 @@ class FileBasedSource(Source):
         :return: True iff path has correct extension.
         :rtype: bool
         """
-        return os.path.splitext(path)[1][1:] in [ext.split("+")[-1] for ext in self.extensions]
+        return path is not None and os.path.splitext(path)[1][1:] in [
+            ext.split("+")[-1] for ext in self.extensions
+        ]
 
     def get_video_audio_split(self, path: str) -> tuple[str, Optional[str]]:
         extension_of_path = os.path.splitext(path)[1][1:]
diff --git a/syng/sources/s3.py b/syng/sources/s3.py
index 8bf294c..9947c20 100644
--- a/syng/sources/s3.py
+++ b/syng/sources/s3.py
@@ -7,13 +7,15 @@ Adds it to the ``available_sources`` with the name ``s3``
 import asyncio
 import os
 from json import dump, load
-from typing import Any, Optional, Tuple, cast
+from typing import TYPE_CHECKING, Any, Optional, Tuple, cast
 
 try:
     from minio import Minio
 
     MINIO_AVAILABE = True
 except ImportError:
+    if TYPE_CHECKING:
+        from minio import Minio
     MINIO_AVAILABE = False
 
 from ..entry import Entry
@@ -87,8 +89,8 @@ class S3Source(FileBasedSource):
             file_list = [
                 obj.object_name
                 for obj in self.minio.list_objects(self.bucket, recursive=True)
-                if self.has_correct_extension(obj.object_name)
-            ]
+                if obj.object_name is not None
+            ]  # and self.has_correct_extension(obj.object_name)
             if self.index_file is not None and not os.path.isfile(self.index_file):
                 with open(self.index_file, "w", encoding="utf8") as index_file_handle:
                     dump(file_list, index_file_handle)
diff --git a/syng/sources/youtube.py b/syng/sources/youtube.py
index 0d839ab..b7938ea 100644
--- a/syng/sources/youtube.py
+++ b/syng/sources/youtube.py
@@ -299,7 +299,7 @@ class YoutubeSource(Source):
         :return: The location of the video file and ``None``.
         :rtype: Tuple[str, Optional[str]]
         """
-        info = await asyncio.to_thread(self._yt_dlp.extract_info, entry.ident)
+        info: Any = await asyncio.to_thread(self._yt_dlp.extract_info, entry.ident)
         combined_path = info["requested_downloads"][0]["filepath"]
         return combined_path, None
 
diff --git a/stubs/aiocmd.pyi b/typings/aiocmd.pyi
similarity index 100%
rename from stubs/aiocmd.pyi
rename to typings/aiocmd.pyi
diff --git a/stubs/mutagen.pyi b/typings/mutagen.pyi
similarity index 100%
rename from stubs/mutagen.pyi
rename to typings/mutagen.pyi
diff --git a/stubs/pytube.pyi b/typings/pytube.pyi
similarity index 100%
rename from stubs/pytube.pyi
rename to typings/pytube.pyi
diff --git a/typings/qrcode/main.pyi b/typings/qrcode/main.pyi
new file mode 100644
index 0000000..d054fee
--- /dev/null
+++ b/typings/qrcode/main.pyi
@@ -0,0 +1,8 @@
+from PIL import Image
+
+class QRCode:
+    def __init__(self, box_size: int, border: int) -> None: ...
+    def add_data(self, string: str) -> None: ...
+    def make(self) -> None: ...
+    def print_ascii(self) -> None: ...
+    def make_image(self) -> Image.Image: ...
diff --git a/stubs/socketio.pyi b/typings/socketio.pyi
similarity index 74%
rename from stubs/socketio.pyi
rename to typings/socketio.pyi
index e183c4a..ef78900 100644
--- a/stubs/socketio.pyi
+++ b/typings/socketio.pyi
@@ -1,15 +1,11 @@
-from typing import Any
+from typing import Any, Awaitable
 from typing import Callable
 from typing import Optional
-from typing import TypeVar
+from typing import TypeVar, TypeAlias
 
-Handler = TypeVar(
-    "Handler",
-    bound=Callable[[str, dict[str, Any]], Any] | Callable[[str], Any],
-)
-ClientHandler = TypeVar(
-    "ClientHandler", bound=Callable[[dict[str, Any]], Any] | Callable[[], Any]
-)
+Handler: TypeAlias = Callable[[str], Awaitable[Any]]
+DictHandler: TypeAlias = Callable[[str, dict[str, Any]], Awaitable[Any]]
+ClientHandler = TypeVar("ClientHandler", bound=Callable[[dict[str, Any]], Any] | Callable[[], Any])
 
 class _session_context_manager:
     async def __aenter__(self) -> dict[str, Any]: ...
@@ -30,7 +26,7 @@ class AsyncServer:
         room: Optional[str] = None,
     ) -> None: ...
     def session(self, sid: str) -> _session_context_manager: ...
-    def on(self, event: str) -> Callable[[Handler], Handler]: ...
+    def on(self, event: str) -> Callable[[Handler | DictHandler], Handler | DictHandler]: ...
     async def enter_room(self, sid: str, room: str) -> None: ...
     async def leave_room(self, sid: str, room: str) -> None: ...
     def attach(self, app: Any) -> None: ...