From 26acab7c67900a50085b495af5e4e80f02d68ed5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Laure=CE=B7t?= <laurentfainsin@protonmail.com>
Date: Tue, 2 Nov 2021 19:03:47 +0100
Subject: [PATCH] feat: moved classes into their own file for clarity

---
 .gitignore    |   1 +
 src/server.py | 104 +-------------------------------------------------
 src/utils.py  | 104 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 107 insertions(+), 102 deletions(-)
 create mode 100644 src/utils.py

diff --git a/.gitignore b/.gitignore
index 8fe4e99..104384a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@ roms/
 .venv/
 .mypy_cache/
 states/
+__pycache__/
diff --git a/src/server.py b/src/server.py
index 3e72e50..6fbb322 100644
--- a/src/server.py
+++ b/src/server.py
@@ -2,111 +2,11 @@ import asyncio
 import json
 import logging
 import time
-from dataclasses import dataclass
-from typing import Any, Optional
+from typing import Any
 
 import websockets
 
-
-class User:
-    """Store infos related to a connected user."""
-
-    websocket: Any
-    last_message: float
-    has_voted: bool
-
-    def __init__(self, websocket: Any) -> None:
-        """Construct a User object.
-
-        Args:
-            websocket (Any): the websocket used by the user.
-        """
-        self.websocket = websocket
-        self.last_message = time.time()
-        self.has_voted = False
-
-    async def send(self, data: str):
-        """Send data through the user's websocket.
-
-        Args:
-            data (str): message to send.
-        """
-        await self.websocket.send(data)
-
-    def __str__(self) -> str:
-        """Convert user to string.
-
-        Returns:
-            str: string representing the user.
-        """
-        return f"{self.websocket.remote_address} ({self.websocket.id})"
-
-
-@dataclass
-class Users(set):
-    """Store `User`s connected to the server."""
-
-    emulator: Optional[User] = None
-    admin: Optional[User] = None
-
-    def register(self, user: User):
-        """Register a user in the set.
-
-        Args:
-            user (User): the user to register.
-        """
-        self.add(user)
-        logging.debug(f"user registered: {user}")
-
-    def unregister(self, user: User):
-        """Unregister a user in the set.
-
-        Args:
-            user (User): the user to unregister.
-        """
-        self.remove(user)
-        logging.debug(f"user unregistered: {self}")
-
-    def clear(self) -> None:
-        """Clear the `has_voted` of each user in the set."""
-        for user in self:
-            user.has_voted = False
-
-
-@dataclass
-class Votes(dict):
-    """Store the votes sent by users."""
-
-    def __init__(self) -> None:
-        """Construct a `Votes` object."""
-        super(Votes, self)
-        self["a"] = 0
-        self["b"] = 0
-        self["select"] = 0
-        self["start"] = 0
-        self["right"] = 0
-        self["left"] = 0
-        self["up"] = 0
-        self["down"] = 0
-        self["r"] = 0
-        self["l"] = 0
-
-    def clear(self) -> None:
-        """Clear the `VOTES` dict."""
-        for key in self.keys():
-            self[key] = 0
-
-    def next_vote(self):
-        """Return the most voted action in the last frame.
-
-        Returns:
-            str: the most voted action.
-        """
-        if any(self.values()):
-            return max(self, key=self.get)
-        else:
-            return "null"
-
+from utils import User, Users, Votes
 
 logging.basicConfig(level=logging.DEBUG)
 
diff --git a/src/utils.py b/src/utils.py
new file mode 100644
index 0000000..727296c
--- /dev/null
+++ b/src/utils.py
@@ -0,0 +1,104 @@
+import logging
+import time
+from dataclasses import dataclass
+from typing import Any, Optional
+
+
+class User:
+    """Store infos related to a connected user."""
+
+    websocket: Any
+    last_message: float
+    has_voted: bool
+
+    def __init__(self, websocket: Any) -> None:
+        """Construct a User object.
+
+        Args:
+            websocket (Any): the websocket used by the user.
+        """
+        self.websocket = websocket
+        self.last_message = time.time()
+        self.has_voted = False
+
+    async def send(self, data: str):
+        """Send data through the user's websocket.
+
+        Args:
+            data (str): message to send.
+        """
+        await self.websocket.send(data)
+
+    def __str__(self) -> str:
+        """Convert user to string.
+
+        Returns:
+            str: string representing the user.
+        """
+        return f"{self.websocket.remote_address} ({self.websocket.id})"
+
+
+@dataclass
+class Users(set):
+    """Store `User`s connected to the server."""
+
+    emulator: Optional[User] = None
+    admin: Optional[User] = None
+
+    def register(self, user: User):
+        """Register a user in the set.
+
+        Args:
+            user (User): the user to register.
+        """
+        self.add(user)
+        logging.debug(f"user registered: {user}")
+
+    def unregister(self, user: User):
+        """Unregister a user in the set.
+
+        Args:
+            user (User): the user to unregister.
+        """
+        self.remove(user)
+        logging.debug(f"user unregistered: {self}")
+
+    def clear(self) -> None:
+        """Clear the `has_voted` of each user in the set."""
+        for user in self:
+            user.has_voted = False
+
+
+@dataclass
+class Votes(dict):
+    """Store the votes sent by users."""
+
+    def __init__(self) -> None:
+        """Construct a `Votes` object."""
+        super(Votes, self)
+        self["a"] = 0
+        self["b"] = 0
+        self["select"] = 0
+        self["start"] = 0
+        self["right"] = 0
+        self["left"] = 0
+        self["up"] = 0
+        self["down"] = 0
+        self["r"] = 0
+        self["l"] = 0
+
+    def clear(self) -> None:
+        """Clear the `VOTES` dict."""
+        for key in self.keys():
+            self[key] = 0
+
+    def next_vote(self):
+        """Return the most voted action in the last frame.
+
+        Returns:
+            str: the most voted action.
+        """
+        if any(self.values()):
+            return max(self, key=self.get)
+        else:
+            return "null"