Add timeout argument for yaqc (#55)

* Add timeout argument for yaqc

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* py<3.10 timeout errors

* Change default to 10 seconds

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: ksunden

tests/connection/test_connection.py

@@ -86,6 +86,17 @@ def test_invalid_argument():
     initial._socket._socket.sendall.assert_not_called()
 
 
+def test_timeout():
+    # Open a socket which is NOT a yaq daemon
+    s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    s.bind(("", 36098))
+    s.listen(1)
+    # socket.timeout is actually deprecated, but is an alias for TimeoutError in py3.10+
+    # and its own OSError subclass in py<3.10
+    with pytest.raises(socket.timeout):
+        yaqc.Client(36098, timeout=0.1)
+
+
 if __name__ == "__main__":
     test_shutdown()
     test_restart()

yaqc/CHANGELOG.md

@@ -8,6 +8,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 ### Fixed
 - fastavro >=1.7 prevents infrequent CPU locking from bad string parsing
 
+### Added
+- `timeout` argument to Client, defaulting to 10 seconds
+
 ## [2022.5.0]
 
 ### Changed

yaqc/yaqc/_client.py

@@ -35,10 +35,10 @@ def inner(self, *args, **kwargs):
 
 
 class Client:
-    def __init__(self, port, host="127.0.0.1"):
+    def __init__(self, port, host="127.0.0.1", timeout=10):
         self._host = host
         self._port = port
-        self._socket = Socket(self._host, self._port)
+        self._socket = Socket(self._host, self._port, timeout)
         self._id_counter = 0
         self._connection_callbacks = []
         self._mutex = Lock()

yaqc/yaqc/_socket.py

@@ -14,9 +14,9 @@
 
 
 class Socket:
-    def __init__(self, host, port):
+    def __init__(self, host, port, timeout=None):
         self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-        self._socket.settimeout(None)
+        self._socket.settimeout(timeout)
         self._socket.connect((host, port))
         self._named_types = {}