✨ Change from aioredis to hiredis, update to pydantic v2

Change from aioredis to hiredis, update to pydantic v2

.github/workflows/test.yml

@@ -12,17 +12,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.8, 3.9, 3.10.4]
+        python-version: [3.8, 3.9, 3.10.4, 3.11]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install system dependencies
       run: |
-        sudo apt-get install gcc gfortran libopenblas-dev liblapack-dev cython
+        sudo apt-get install gcc gfortran libopenblas-dev liblapack-dev cython3
         python -m pip install --upgrade pip
         pip install poetry
     - name: Install dependencies
@@ -44,7 +44,7 @@ jobs:
       run: poetry run coverage report --fail-under=80
 
     - name: Upload HTML report if check failed.
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
           name: html-report
           path: htmlcov

.gitignore

@@ -1,4 +1,5 @@
 .venv
+env
 *.pyc
 
 .idea

pyproject.toml

@@ -19,19 +19,22 @@ packages = [
 
 [tool.poetry.dependencies]
 python = ">=3.8,<4.0"
-aioredis = "2.0.1"
-msgpack = "1.0.3"
-pydantic = "1.9.0"
+msgpack = "1.0.8"
+pydantic = "==2.4.2"
+redis = {version = "==5.0.2", extras = ["hiredis"]}
 
 [tool.poetry.dev-dependencies]
 pytest = "7.1.1"
 isort = "5.10.1"
-black = "22.1.0"
-flake8 = "4.0.1"
-mypy = "0.941"
-pytest-asyncio = "0.18.2"
+black = "22.3.0"
+flake8 = "5.0.4"
+mypy = "1.6.1"
+pytest-asyncio = "0.21.1"
 coverage = "6.3.2"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.isort]
+profile = "black"

readme.md

@@ -14,33 +14,33 @@ poetry add socket.io-redis-emitter
 
 - High quality, typed and modern Python codebase
 - Clean, concise and Pythonic API
-- Uses [aioredis](https://aioredis.readthedocs.io/en/latest/) as a Redis client
+- Uses [redis](https://redis.readthedocs.io/en/latest/) as a Redis client
 - Supports namespaces, rooms and regular Socket.IO message emitting
 
 ```python
-from aioredis import Redis
+import redis
 from socketio_emitter import Emitter
 
-client = Redis(...)
+client = redis.Redis(...)
 emitter = Emitter(client=client)
 
 async with emitter.namespace("/nsp") as nsp:
     async with nsp.rooms("room1", "room2") as clients:
         await clients.emit("machineStatus", {"status": "ok"})
 ```
 
-- Remote requests to join, leave rooms or to disconnect 
+- Remote requests to join, leave rooms or to disconnect
 
 ```python
-from aioredis import Redis
+import redis
 from socketio_emitter import Emitter
 
-client = Redis(...)
+client = redis.Redis(...)
 emitter = Emitter(client=client)
 
 async with emitter.namespace("/nsp") as nsp:
     async with nsp.rooms("room1", "room2") as clients:
         await clients.join("room3")
         # await clients.leave("room3")
         # await clients.disconnect()
-```
+```

socketio_emitter/emitter.py

@@ -2,7 +2,7 @@
 from contextlib import asynccontextmanager
 from typing import Any, AsyncGenerator, Dict, List, Optional, Sequence, Union
 
-from aioredis import Redis
+import redis
 
 from socketio_emitter.consts import (
     CHANNEL_SEPARATOR,
@@ -29,7 +29,7 @@
 class Emitter:
     def __init__(
         self,
-        client: "Redis",
+        client: redis.Redis,
         *,
         channel_prefix: str = DEFAULT_CHANNEL_PREFIX,
         emitter_id: str = DEFAULT_EMITTER_ID,
@@ -55,7 +55,7 @@ async def namespace(
         self, name: str = ROOT_NAMESPACE
     ) -> AsyncGenerator["Emitter", None]:
         """
-        Select a namespace to braodcast
+        Select a namespace to broadcast
         Args:
             name (str): Namespace Name
         Returns:

socketio_emitter/entities.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, List, Optional, Sequence, Tuple
 
 import msgpack
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from socketio_emitter.consts import ROOT_NAMESPACE, PacketTypes, RequestTypes
 
@@ -29,17 +29,15 @@ class MessageOptions(BaseModel):
     flags: Optional[MessageFlags] = None
     except_rooms: Optional[List[str]] = Field(None, alias="except")
 
-    class Config:
-        allow_population_by_field_name = True
+    model_config = ConfigDict(populate_by_name=True)
 
 
 class Packet(BaseModel):
     data: MessageData
     type: PacketTypes = PacketTypes.REGULAR
     namespace: str = Field(ROOT_NAMESPACE, alias="nsp")
 
-    class Config:
-        allow_population_by_field_name = True
+    model_config = ConfigDict(populate_by_name=True)
 
 
 class Message(BaseModel):
@@ -67,8 +65,8 @@ def raw(self) -> bytes:
             msgpack.packb(
                 (
                     self.emitter_id,
-                    self.packet.dict(by_alias=True),
-                    self.options.dict(by_alias=True),
+                    self.packet.model_dump(by_alias=True),
+                    self.options.model_dump(by_alias=True),
                 )
             )
         )
@@ -78,23 +76,20 @@ class RequestOptions(BaseModel):
     rooms: Optional[Sequence[str]] = None
     except_rooms: Optional[Sequence[str]] = Field(None, alias="except")
 
-    class Config:
-        allow_population_by_field_name = True
+    model_config = ConfigDict(populate_by_name=True)
 
 
 class RoomRequest(BaseModel):
     type: RequestTypes
     rooms: Sequence[str]
     options: RequestOptions = Field(..., alias="opts")
 
-    class Config:
-        allow_population_by_field_name = True
+    model_config = ConfigDict(populate_by_name=True)
 
 
 class DisconnectRequest(BaseModel):
     type: RequestTypes = RequestTypes.DISCONNECT
     close: bool
     options: RequestOptions = Field(..., alias="opts")
 
-    class Config:
-        allow_population_by_field_name = True
+    model_config = ConfigDict(populate_by_name=True)