fix:improve TcpFakeServer

Author: cunla

docs/about/changelog.md

@@ -7,6 +7,13 @@ tags:
 toc_depth: 2
 ---
 
+## v2.31.1 - 2025-09-01
+
+### 🐛 Bug Fixes
+
+- Sending lib_name and lib_version only when relevant #408
+- Improve documentation of using `TcpFakeServer` #409
+
 ## v2.31.0 - 2025-08-10
 
 ### 🚀 Features

docs/index.md

@@ -59,6 +59,11 @@ r = redis.Redis(host=server_address[0], port=server_address[1])
 r.set("foo", "bar")
 assert r.get("foo") == b"bar"
 
+
+# When you are done with the server, you can stop it with:
+server.shutdown()
+server.server_close()
+t.join()
 ```
 
 ### Use as a pytest fixture

fakeredis/__init__.py

@@ -1,6 +1,6 @@
 import sys
 
-from . import typing
+from . import _typing
 from ._connection import (
     FakeRedis,
     FakeStrictRedis,
@@ -21,7 +21,7 @@ def __init__(self, *args, **kwargs):
             raise NotImplementedError("TcpFakeServer is only available in Python 3.11+")
 
 
-__version__ = typing.lib_version
+__version__ = _typing.lib_version
 __author__ = "Daniel Moran"
 __maintainer__ = "Daniel Moran"
 __email__ = "daniel@moransoftware.ca"

fakeredis/_commands.py

@@ -12,7 +12,7 @@
 
 from . import _msgs as msgs
 from ._helpers import null_terminate, SimpleError, Database
-from .typing import VersionType, ServerType
+from ._typing import VersionType, ServerType
 
 MAX_STRING_SIZE = 512 * 1024 * 1024
 SUPPORTED_COMMANDS: Dict[str, "Signature"] = dict()  # Dictionary of supported commands name => Signature

fakeredis/_connection.py

@@ -9,7 +9,7 @@
 from fakeredis._helpers import FakeSelector, convert_args_to_redis_init_kwargs
 from . import _msgs as msgs
 from ._server import FakeBaseConnectionMixin, FakeServer, VersionType, ServerType
-from .typing import Self, lib_version, RaiseErrorTypes
+from ._typing import Self, lib_version, RaiseErrorTypes
 
 
 class FakeConnection(FakeBaseConnectionMixin, redis.Connection):

fakeredis/_server.py

@@ -9,7 +9,7 @@
 
 from fakeredis.model import AccessControlList
 from fakeredis._helpers import Database, FakeSelector
-from fakeredis.typing import VersionType, ServerType
+from fakeredis._typing import VersionType, ServerType
 
 LOGGER = logging.getLogger("fakeredis")
 

fakeredis/_tcp_server.py

@@ -6,10 +6,11 @@
 
 from fakeredis import FakeRedis
 from fakeredis import FakeServer
-from fakeredis.typing import VersionType, ServerType
+from fakeredis._typing import VersionType, ServerType
 
 LOGGER = logging.getLogger("fakeredis")
 LOGGER.setLevel(logging.DEBUG)
+# logging.basicConfig(level=logging.DEBUG)
 
 
 def to_bytes(value) -> bytes:
@@ -90,17 +91,23 @@ def setup(self) -> None:
             self.server.clients[self.client_address] = self.current_client
 
     def handle(self):
+        LOGGER.debug(f"+++ {self.client_address[0]} connected")
         while True:
             try:
                 self.data = self.reader.load()
                 LOGGER.debug(f">>> {self.client_address[0]}: {self.data}")
+                if len(self.data) == 1 and self.data[0].upper() == b"SHUTDOWN":
+                    LOGGER.debug(f"*** {self.client_address[0]} requested shutdown")
+                    break
                 res = self.current_client.connection.execute_command(*self.data)
                 LOGGER.debug(f"<<< {self.client_address[0]}: {res}")
                 self.writer.dump(res)
             except Exception as e:
                 LOGGER.debug(f"!!! {self.client_address[0]}: {e}")
                 self.writer.dump(e)
                 break
+        self.server.socket.close()
+        self.server.shutdown()
 
     def finish(self) -> None:
         del self.server.clients[self.current_client.client_address]
@@ -116,6 +123,7 @@ def __init__(
         server_version: VersionType = (8, 0),
     ):
         super().__init__(server_address, TCPFakeRequestHandler, bind_and_activate)
+        self.allow_reuse_address = True
         self.fake_server = FakeServer(server_type=server_type, version=server_version)
         self.client_ids = count(0)
         self.clients: Dict[int, FakeRedis] = dict()

fakeredis/typing.py renamed to fakeredis/_typing.py

@@ -1,14 +1,15 @@
 import sys
+from typing import Tuple, Literal
 
 import redis
 
 if sys.version_info >= (3, 11):
-    from typing import Self, Tuple, Literal
+    from typing import Self
     from asyncio import timeout as async_timeout
 else:
     from async_timeout import timeout as async_timeout
     from typing_extensions import Self
-    from typing import Tuple, Literal
+
 try:
     from importlib import metadata
 except ImportError:  # for Python < 3.8

fakeredis/_valkey.py

@@ -4,7 +4,7 @@
 
 from ._connection import FakeRedisMixin
 from .aioredis import FakeRedisMixin as FakeAsyncRedisMixin
-from .typing import Self
+from ._typing import Self
 
 
 def _validate_server_type(args_dict: Dict[str, Any]) -> None:

fakeredis/aioredis.py

@@ -13,7 +13,7 @@
 from . import _msgs as msgs
 from ._helpers import SimpleError, convert_args_to_redis_init_kwargs
 from ._server import FakeBaseConnectionMixin, VersionType, FakeServer, ServerType
-from .typing import async_timeout, Self
+from ._typing import async_timeout, Self
 
 
 class AsyncFakeSocket(_fakesocket.FakeSocket):