dsmq 0.6.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

dsmq/client.py

@@ -0,0 +1,27 @@
+import json
+from websockets.sync.client import connect as ws_connect
+
+_default_host = "127.0.0.1"
+_default_port = 30008
+
+
+def connect(host=_default_host, port=_default_port):
+    return DSMQClientSideConnection(host, port)
+
+
+class DSMQClientSideConnection:
+    def __init__(self, host, port):
+        self.uri = f"ws://{host}:{port}"
+        self.websocket = ws_connect(self.uri)
+
+    def get(self, topic):
+        msg = {"action": "get", "topic": topic}
+        self.websocket.send(json.dumps(msg))
+
+        msg_text = self.websocket.recv()
+        msg = json.loads(msg_text)
+        return msg["message"]
+
+    def put(self, topic, msg_body):
+        msg_dict = {"action": "put", "topic": topic, "message": msg_body}
+        self.websocket.send(json.dumps(msg_dict))

dsmq/demo_linux.py

@@ -1,8 +1,8 @@
 # Heads up: This script only works on Linux because of use of "fork" method.
 import multiprocessing as mp
-import dsmq
-import example_get_client
-import example_put_client
+from dsmq.server import serve
+import dsmq.example_get_client
+import dsmq.example_put_client
 
 mp.set_start_method("fork")
 
@@ -11,11 +11,11 @@ PORT = 25252
 
 
 def test_server_with_clients():
-    p_server = mp.Process(target=dsmq.start_server, args=(HOST, PORT))
+    p_server = mp.Process(target=serve, args=(HOST, PORT))
     p_server.start()
 
-    p_putter = mp.Process(target=example_put_client.run, args=(HOST, PORT, 20))
-    p_getter = mp.Process(target=example_get_client.run, args=(HOST, PORT, 20))
+    p_putter = mp.Process(target=dsmq.example_put_client.run, args=(HOST, PORT, 20))
+    p_getter = mp.Process(target=dsmq.example_get_client.run, args=(HOST, PORT, 20))
 
     p_putter.start()
     p_getter.start()

dsmq/example_get_client.py

@@ -1,9 +1,9 @@
 import time
-import dsmq
+from dsmq.client import connect
 
 
 def run(host="127.0.0.1", port=30008, n_iter=1000):
-    mq = dsmq.connect_to_server(host=host, port=port)
+    mq = connect(host=host, port=port)
 
     for i in range(n_iter):
         time.sleep(1)

dsmq/example_put_client.py

@@ -1,9 +1,9 @@
 import time
-import dsmq
+from dsmq.client import connect
 
 
 def run(host="127.0.0.1", port=30008, n_iter=1000):
-    mq = dsmq.connect_to_server(host=host, port=port)
+    mq = connect(host=host, port=port)
 
     for i in range(n_iter):
         time.sleep(1)

dsmq/{dsmq.py → server.py}

@@ -1,80 +1,36 @@
 import json
-import socket
 import sqlite3
 import sys
-from threading import Thread
 import time
+from websockets.sync.server import serve as ws_serve
 
-DEFAULT_HOST = "127.0.0.1"
-DEFAULT_PORT = 30008
+_default_host = "127.0.0.1"
+_default_port = 30008
+_n_retries = 5
+_first_retry = 0.01  # seconds
+_time_to_live = 600.0  # seconds
 
-N_RETRIES = 5
-FIRST_RETRY = 0.01  # seconds
-TIME_TO_LIVE = 600.0  # seconds
 
-
-def start_server(host=DEFAULT_HOST, port=DEFAULT_PORT):
+def serve(host=_default_host, port=_default_port):
     """
     For best results, start this running in its own process and walk away.
     """
     sqlite_conn = sqlite3.connect("file:mem1?mode=memory&cache=shared")
     cursor = sqlite_conn.cursor()
-
     cursor.execute("""
-        CREATE TABLE IF NOT EXISTS messages (timestamp DOUBLE, topic TEXT, message TEXT)
+CREATE TABLE IF NOT EXISTS messages (timestamp DOUBLE, topic TEXT, message TEXT)
     """)
 
-    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
-        # Setting this socket option to re-use the address,
-        # even if it's already in use.
-        # This is helpful in recovering from crashes where things didn't
-        # shut down properly.
-        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-
-        s.bind((host, port))
-        s.listen()
-
+    with ws_serve(request_handler, host, port) as server:
+        server.serve_forever()
         print()
         print(f"Server started at {host} on port {port}.")
         print("Waiting for clients...")
 
-        while True:
-            socket_conn, addr = s.accept()
-            print(f"Connected by {addr}")
-            Thread(target=_handle_client_connection, args=(socket_conn,)).start()
-
     sqlite_conn.close()
 
 
-def connect_to_server(host=DEFAULT_HOST, port=DEFAULT_PORT):
-    return DSMQClientSideConnection(host, port)
-
-
-class DSMQClientSideConnection:
-    def __init__(self, host, port):
-        self.dsmq_conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-        self.dsmq_conn.connect((host, port))
-
-    def get(self, topic):
-        msg = json.dumps({"action": "get", "topic": topic})
-        self.dsmq_conn.sendall(bytes(msg, "utf-8"))
-
-        data = self.dsmq_conn.recv(1024)
-        if not data:
-            raise RuntimeError("Connection terminated by server")
-        msg_str = data.decode("utf-8")
-        msg = json.loads(msg_str)
-        try:
-            return msg["message"]
-        except KeyError:
-            return ""
-
-    def put(self, topic, msg):
-        msg = json.dumps({"action": "put", "topic": topic, "message": msg})
-        self.dsmq_conn.sendall(bytes(msg, "utf-8"))
-
-
-def _handle_client_connection(socket_conn):
+def request_handler(websocket):
     sqlite_conn = sqlite3.connect("file:mem1?mode=memory&cache=shared")
     cursor = sqlite_conn.cursor()
 
@@ -82,20 +38,8 @@ def _handle_client_connection(socket_conn):
     last_read_times = {}
     time_of_last_purge = time.time()
 
-    while True:
-        data = socket_conn.recv(1024)
-        # Check whether the connection has been terminated
-        if not data:
-            break
-
-        msg_str = data.decode("utf-8")
-        try:
-            msg = json.loads(msg_str)
-        except json.decoder.JSONDecodeError:
-            print("Message must be json-friendly")
-            print(f"    Received: {msg}")
-            continue
-
+    for msg_text in websocket:
+        msg = json.loads(msg_text)
         topic = msg["topic"]
         timestamp = time.time()
 
@@ -104,7 +48,7 @@ def _handle_client_connection(socket_conn):
 
             # This block allows for multiple retries if the database
             # is busy.
-            for i_retry in range(N_RETRIES):
+            for i_retry in range(_n_retries):
                 try:
                     cursor.execute(
                         """
@@ -115,7 +59,7 @@ VALUES (:timestamp, :topic, :message)
                     )
                     sqlite_conn.commit()
                 except sqlite3.OperationalError:
-                    wait_time = FIRST_RETRY * 2**i_retry
+                    wait_time = _first_retry * 2**i_retry
                     time.sleep(wait_time)
                     continue
                 break
@@ -130,7 +74,7 @@ VALUES (:timestamp, :topic, :message)
 
             # This block allows for multiple retries if the database
             # is busy.
-            for i_retry in range(N_RETRIES):
+            for i_retry in range(_n_retries):
                 try:
                     cursor.execute(
                         """
@@ -149,7 +93,7 @@ AND timestamp = a.min_time
                         msg,
                     )
                 except sqlite3.OperationalError:
-                    wait_time = FIRST_RETRY * 2**i_retry
+                    wait_time = _first_retry * 2**i_retry
                     time.sleep(wait_time)
                     continue
                 break
@@ -163,15 +107,15 @@ AND timestamp = a.min_time
                 # Handle the case where no results are returned
                 message = ""
 
-            msg = json.dumps({"message": message})
-            socket_conn.sendall(bytes(msg, "utf-8"))
+            websocket.send(json.dumps({"message": message}))
         else:
             print("Action must either be 'put' or 'get'")
 
+
         # Periodically clean out messages from the queue that are
         # past their sell buy date.
         # This operation is pretty fast. I clock it at 12 us on my machine.
-        if time.time() - time_of_last_purge > TIME_TO_LIVE:
+        if time.time() - time_of_last_purge > _time_to_live:
             cursor.execute(
                 """
 DELETE FROM messages
@@ -189,21 +133,21 @@ if __name__ == "__main__":
     if len(sys.argv) == 3:
         host = sys.argv[1]
         port = int(sys.argv[2])
-        start_server(host=host, port=port)
+        serve(host=host, port=port)
     elif len(sys.argv) == 2:
         host = sys.argv[1]
-        start_server(host=host)
+        serve(host=host)
     elif len(sys.argv) == 1:
-        start_server()
+        serve()
     else:
         print(
             """
 Try one of these:
-$ python3 dsmq.py
+$ python3 server.py
 
-$ python3 dsmq.py 127.0.0.1
+$ python3 server.py 127.0.0.1
 
-$ python3 dsmq.py 127.0.0.1 25853
+$ python3 server.py 127.0.0.1 25853
 
-            """
+"""
         )

{dsmq-0.6.0.dist-info → dsmq-1.0.0.dist-info}/METADATA

@@ -1,8 +1,10 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: dsmq
-Version: 0.6.0
+Version: 1.0.0
 Summary: A dead simple message queue
+License-File: LICENSE
 Requires-Python: >=3.10
+Requires-Dist: websockets>=14.1
 Description-Content-Type: text/markdown
 
 # Dead Simple Message Queue
@@ -26,9 +28,9 @@ pip install dsmq
 As in `src/dsmq/example_server.py`
 
 ```python
-from dsmq import dsmq
+from dsmq.server import serve
 
-dsmq.start_server(host="127.0.0.1", port=30008)
+serve(host="127.0.0.1", port=30008)
 ```
 
 ### Connect a client to a dsmq server
@@ -36,7 +38,9 @@ dsmq.start_server(host="127.0.0.1", port=30008)
 As in `src/dsmq/example_put_client.py`
 
 ```python
-mq = dsmq.connect_to_server(host="127.0.0.1", port=12345)
+from dsmq.client import connect
+
+mq = connect(host="127.0.0.1", port=12345)
 ```
 ### Add a message to a queue
 
@@ -66,7 +70,7 @@ managed
 ```python
 import multiprocessing as mp
 
-p_mq = mp.Process(target=dsmq.start_server, args=(config.MQ_HOST, config.MQ_PORT))
+p_mq = mp.Process(target=serve, args=(config.MQ_HOST, config.MQ_PORT))
 p_mq.start()
 
 p_mq.join()
@@ -78,7 +82,7 @@ p_mq.close()
 ### Demo
 
 1. Open 3 separate terminal windows.
-1. In the first, run `src/dsmq/dsmq.py`.
+1. In the first, run `src/dsmq/server.py` as a script.
 1. In the second, run `src/dsmq/example_put_client.py`.
 1. In the third, run `src/dsmq/example_get_client.py`.
 
@@ -109,9 +113,9 @@ get larger than your RAM, you will reach an out-of-memory condition.
 
 
 # API Reference
-[[source](https://github.com/brohrer/dsmq/blob/main/src/dsmq/dsmq.py)]
+[[source](https://github.com/brohrer/dsmq/blob/main/src/dsmq/serve.py)]
 
-### `start_server(host="127.0.0.1", port=30008)`
+### `serve(host="127.0.0.1", port=30008)`
 
 Kicks off the mesage queue server. This process will be the central exchange
 for all incoming and outgoing messages.
@@ -119,9 +123,9 @@ for all incoming and outgoing messages.
 - `port` (int), port. These will be used by all clients.
 Non-privileged ports are numbered 1024 and higher.
 
-### `connect_to_server(host="127.0.0.1", port=30008)`
+### `connect(host="127.0.0.1", port=30008)`
 
-Connects to an existing message queue server.
+Connects a client to an existing message queue server.
 - `host` (str), IP address of the *server*.
 - `port` (int), port on which the server is listening.
 - returns a `DSMQClientSideConnection` object.

dsmq-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+dsmq/__init__.py,sha256=YCgbnQAk8YbtHRyMcU0v2O7RdRhPhlT-vS_q40a7Q6g,50
+dsmq/client.py,sha256=sgkz7iabc8hirq0HRfhqlKCPwHVYgvg2C01aoRbvTSo,768
+dsmq/demo_linux.py,sha256=O5B2DH9pAvCCaYSRE5DV1o2fSx_bXU9hcxTis0ier5I,648
+dsmq/example_get_client.py,sha256=PvAsDGEAH1kVBifLVg2rx8ZxnAZmvzVCvZq13VgpLds,301
+dsmq/example_put_client.py,sha256=QxDc3i7KAjjhpwxRRpI0Ke5KTNSPuBf9kkcGyTvUEaw,353
+dsmq/server.py,sha256=fFM8soN4y8CULX5yk3Temir-pl2K1hp38MOEwqzPN5U,4343
+dsmq-1.0.0.dist-info/METADATA,sha256=TaoyVGkRJasSK-D6UQ9vNTeY07gOH9At7j1rZgiFxp0,4069
+dsmq-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dsmq-1.0.0.dist-info/licenses/LICENSE,sha256=3Yu1mAp5VsKmnDtzkiOY7BdmrLeNwwZ3t6iWaLnlL0Y,1071
+dsmq-1.0.0.dist-info/RECORD,,

{dsmq-0.6.0.dist-info → dsmq-1.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.1
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

dsmq/example_server.py

@@ -1,3 +0,0 @@
-import dsmq
-
-dsmq.start_server(host="127.0.0.1", port=30008)

dsmq-0.6.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-dsmq/__init__.py,sha256=YCgbnQAk8YbtHRyMcU0v2O7RdRhPhlT-vS_q40a7Q6g,50
-dsmq/demo_linux.py,sha256=7yLglGmirDLuuyMxppYSK-dfx2Fg2Q0dIWB4cl2yV1c,622
-dsmq/dsmq.py,sha256=zg69Tf3x9z26a9NrEXTWgr78kcNKVszmLq0INv3IHuM,6132
-dsmq/example_get_client.py,sha256=chFfB2949PBENmgdUc3ASrATq1m4wvHGBzEnOC-o_Xs,296
-dsmq/example_put_client.py,sha256=mUKCRhmUieMZEpHLFWFvzeKB6IR7A8l4tWN8TvPzdKU,348
-dsmq/example_server.py,sha256=kkXOPaaTzVxf9_iIM76zU9pZhkPna_1vcGWkPrhCjus,61
-dsmq-0.6.0.dist-info/METADATA,sha256=0mL4N2uHDGtlnH_fqrdNLdpS-flp6x1O1g-uLGzF4b4,4006
-dsmq-0.6.0.dist-info/WHEEL,sha256=3U_NnUcV_1B1kPkYaPzN-irRckL5VW_lytn0ytO_kRY,87
-dsmq-0.6.0.dist-info/licenses/LICENSE,sha256=3Yu1mAp5VsKmnDtzkiOY7BdmrLeNwwZ3t6iWaLnlL0Y,1071
-dsmq-0.6.0.dist-info/RECORD,,