Merge branch 'main' into prepare-python-3.11

.flake8

@@ -10,5 +10,6 @@ exclude =
     build
     dist
     venv
+ignore = D200, D204, D205, D400, D401
 max-line-length = 100
 max-complexity = 10

pyproject.toml

@@ -33,11 +33,12 @@ passlib = { version = "^1.7", extras = ["bcrypt"] }
 splunk-sdk = "^1.7"
 
 [tool.poetry.dev-dependencies]
-pytest = "^7.1"
-pytest-cov = "^3.0"
+pytest = "^7.2"
+pytest-cov = "^4.0"
 pytest-asyncio = "^0.20"
 flake8 = "^5.0"
 pylint = "^2.15"
+flake8-docstrings = "^1.6.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tests/whist_server/services/test_room_db_service.py

@@ -37,6 +37,11 @@ def test_not_existing(self):
         with self.assertRaisesRegex(RoomNotFoundError, error_msg):
             self.service.get(game_id)
 
+    def test_get_invalid_room_id(self):
+        room_id = '1'
+        error_msg = f'Room with id "{room_id}" not found.'
+        with self.assertRaisesRegex(RoomNotFoundError, error_msg):
+            self.service.get(room_id)
     def test_get_by_name(self):
         game_id = self.service.add(self.room)
         self.room.id = ObjectId(game_id)

whist_server/api/__init__.py

@@ -0,0 +1 @@
+"""Web API package"""

whist_server/api/oauth2/__init__.py

@@ -0,0 +1 @@
+"""Authentication API"""

whist_server/api/ranking/__init__.py

@@ -0,0 +1 @@
+"""User ranking related API"""

whist_server/api/room/__init__.py

@@ -0,0 +1 @@
+"""Room related API"""

whist_server/api/room/action.py

@@ -90,7 +90,6 @@ def ready_player(room_id: str, user: Player = Security(get_current_user),
     :return: dictionary containing the status of whether the action was successful.
     Raises 403 exception if the user has not be joined yet.
     """
-
     room = room_service.get(room_id)
 
     try:
@@ -116,7 +115,6 @@ def unready_player(room_id: str, user: Player = Security(get_current_user),
     Raises 404 exception if room_id is not found
     Raises 400 exception if player is not ready
     """
-
     room = room_service.get(room_id)
 
     try:

whist_server/api/room/info.py

@@ -27,7 +27,6 @@ def all_rooms(room_service=Depends(RoomDatabaseService),
 @router.get('/info/{room_id}', response_model=RoomInfo)
 def room_info(room_id: str, room_service=Depends(RoomDatabaseService)) -> RoomInfo:
     """
-
     :param room_id:
     :param room_service: Dependency injection of the room service
     :return:

whist_server/api/user/__init__.py

@@ -0,0 +1 @@
+"""User related API"""

whist_server/database/id_wrapper.py

@@ -9,6 +9,7 @@ class PyObjectId(ObjectId):
 
     @classmethod
     def __get_validators__(cls):
+        """Returns the class' validators."""
         yield cls.validate
 
     @classmethod
@@ -24,4 +25,5 @@ def validate(cls, value):
 
     @classmethod
     def __modify_schema__(cls, field_schema):
+        """Changes the type to a string."""
         field_schema.update(type='string')

whist_server/database/user.py

@@ -29,6 +29,11 @@ def validate_password_sso(cls, values):
         return values
 
     def __init__(self, rating=INITIAL_RATING, **data: Any):
+        """
+        Constructor.
+        :param rating: The start value of the player's rating.
+        :param data: dict with 'games' key for amount of games already played
+        """
         super().__init__(rating=rating, **data)
 
     def verify_password(self, password) -> bool:

whist_server/services/__init__.py

@@ -0,0 +1 @@
+"""Services for API calls"""

whist_server/services/channel_service.py

@@ -13,6 +13,7 @@ class ChannelService:
     _channels: dict[str, SideChannel] = None
 
     def __new__(cls):
+        """Creates a new instance of this service singleton."""
         if cls._instance is None:
             cls._instance = super(ChannelService, cls).__new__(cls)
             cls._channels = {}