soia-client 1.0.16__py3-none-any.whl → 1.0.18__py3-none-any.whl

soia/_impl/service.py

@@ -1,19 +1,47 @@
 import inspect
 import json
+from collections.abc import Mapping
 from dataclasses import dataclass
-from typing import Any, Callable, Generic, Literal, Protocol, TypeAlias, Union, cast
+from typing import Any, Callable, Generic, Literal, TypeAlias, Union, cast
 
 from soia._impl.method import Method, Request, Response
 
-
-class RequestHeaders(Protocol):
-    def __getitem__(self, key: str, /) -> str | None: ...
+RequestHeaders: TypeAlias = Mapping[str, str]
 
 
 ResponseHeaders: TypeAlias = dict[str, str]
 
 
 class Service:
+    """Wraps around the implementation of a soia service on the server side.
+
+    Usage: call '.add_method()' to register method implementations, then call
+    '.handle_request()' from the function called by your web framework when an
+    HTTP request is sent to your service's URL.
+
+    Example with Flask:
+
+        from flask import Response, request
+
+        soia_service = soia.Service()
+        soia_service.add_method(...)
+        soia_service.add_method(...)
+
+        @app.route("/myapi", methods=["GET", "POST"])
+        def myapi():
+            if request.method == "POST":
+                req_body = request.get_data(as_text=True)
+            else:
+                req_body = urllib.parse.unquote(request.query_string.decode("utf-8"))
+            req_headers = dict(request.headers)
+            raw_response = soia_service.handle_request(req_body, req_headers, {})
+            return Response(
+                raw_response.data,
+                status=raw_response.status_code,
+                content_type=raw_response.content_type,
+            )
+    """
+
     _number_to_method_impl: dict[int, "_MethodImpl"]
 
     def __init__(self):

soia/_impl/service_client.py

@@ -1,5 +1,6 @@
 import http.client
-from typing import Final, Mapping
+import re
+from typing import Any, Final, Mapping
 from urllib.parse import urlparse
 
 from soia._impl.method import Method, Request, Response
@@ -10,8 +11,8 @@ class ServiceClient:
     _host: Final[str]  # May include the port
     _path: Final[str]
 
-    def __init__(self, service_url: str):
-        parsed_url = urlparse(service_url)
+    def __init__(self, url: str):
+        parsed_url = urlparse(url)
         if parsed_url.query:
             raise ValueError("Service URL must not contain a query string")
         scheme = parsed_url.scheme
@@ -26,7 +27,12 @@ class ServiceClient:
         method: Method[Request, Response],
         request: Request,
         headers: Mapping[str, str] = {},
+        *,
+        res_headers: list[tuple[str, str]] | None = None,
+        timeout_secs: float | None = None,
     ) -> Response:
+        """Invokes the given method on the remote server through an RPC."""
+
         request_json = method.request_serializer.to_json_code(request)
         body = ":".join(
             [
@@ -41,10 +47,13 @@ class ServiceClient:
             "Content-Type": "text/plain; charset=utf-8",
             "Content-Length": str(len(body)),
         }
+        connection_options: dict[str, Any] = {}
+        if timeout_secs is not None:
+            connection_options["timeout"] = timeout_secs
         if self._scheme == "https":
-            conn = http.client.HTTPSConnection(self._host)
+            conn = http.client.HTTPSConnection(self._host, **connection_options)
         else:
-            conn = http.client.HTTPConnection(self._host)
+            conn = http.client.HTTPConnection(self._host, **connection_options)
         try:
             conn.request(
                 "POST",
@@ -53,15 +62,18 @@ class ServiceClient:
                 headers=headers,
             )
             response = conn.getresponse()
+            if res_headers is not None:
+                res_headers.clear()
+                res_headers.extend(response.getheaders())
             status_code = response.status
-            content_type = response.getheader("Content-Type")
+            content_type = response.getheader("Content-Type") or ""
             response_data = response.read().decode("utf-8", errors="ignore")
         finally:
             conn.close()
         if status_code in range(200, 300):
             return method.response_serializer.from_json_code(response_data)
         else:
-            message = f"HTTP response status {status_code}"
-            if content_type == "text/plain":
+            message = f"HTTP status {status_code}"
+            if re.match(r"text/plain\b", content_type):
                 message = f"{message}: {response_data}"
             raise RuntimeError(message)

{soia_client-1.0.16.dist-info → soia_client-1.0.18.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: soia-client
-Version: 1.0.16
+Version: 1.0.18
 Author-email: Tyler Fibonacci <gepheum@gmail.com>
 License: MIT License
         

{soia_client-1.0.16.dist-info → soia_client-1.0.18.dist-info}/RECORD

@@ -14,13 +14,13 @@ soia/_impl/primitives.py,sha256=Xk26Fv4oQG2oXd3tS_2sAnJYQdXYX9nva09713AcJvs,8940
 soia/_impl/repr.py,sha256=7WX0bEAVENTjlyZIcbT8TcJylS7IRIyafGCmqaIMxFM,1413
 soia/_impl/serializer.py,sha256=28IwkjtUnLpbnPQfVNfJXkApCK4JhXHwLkC5MVhF8xo,3529
 soia/_impl/serializers.py,sha256=IL9jHHMo11pgrL1-crarOEElvTyV5YM6FTcgumjW6IU,2564
-soia/_impl/service.py,sha256=Z0HZlitdEyosbrTXK8OQMnqvahywUJPi7GRTnyRE8B4,6004
-soia/_impl/service_client.py,sha256=5gS7tUt0LJdKGxJsjNU6-aQaZk4dRg1alT83oJfqIZo,2218
+soia/_impl/service.py,sha256=z8Zj2s8AYAz-Bf1Dm7PRdNvh5FbGpgj5hm2velMBjmc,7052
+soia/_impl/service_client.py,sha256=qDntwRyXfLsmXl4ELfOkh-fgv553nrGy72K0JghLM80,2734
 soia/_impl/structs.py,sha256=YTc3Ykj2TxPquar2XsP2DhFfkfIoELXOveyd8yTqN90,26545
 soia/_impl/timestamp.py,sha256=lXBNH8mPmzflkNjSKZSBl2XS-ot9N8N92B_zGO2SMtU,4078
 soia/_impl/type_adapter.py,sha256=RyIyh4Fnt9rMy0HRzC-a2v2JAdZsV9FBzoGEUVygVRE,2101
-soia_client-1.0.16.dist-info/licenses/LICENSE,sha256=SaAftKkX6hfSOiPdENQPS70tifH3PDHgazq8eK2Pwfw,1064
-soia_client-1.0.16.dist-info/METADATA,sha256=mAhZErll3dmFwg-rMhQWEwd-EWFi9yf2rvCpBjS3a14,1667
-soia_client-1.0.16.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-soia_client-1.0.16.dist-info/top_level.txt,sha256=lsYG9JrvauFe1oIV5zvnwsS9hsx3ztwfK_937op9mxc,5
-soia_client-1.0.16.dist-info/RECORD,,
+soia_client-1.0.18.dist-info/licenses/LICENSE,sha256=SaAftKkX6hfSOiPdENQPS70tifH3PDHgazq8eK2Pwfw,1064
+soia_client-1.0.18.dist-info/METADATA,sha256=2KPUoHzmxfNNNQ6Dnj4XYPbu8nHZpQzs2Dbt17GXGq0,1667
+soia_client-1.0.18.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+soia_client-1.0.18.dist-info/top_level.txt,sha256=lsYG9JrvauFe1oIV5zvnwsS9hsx3ztwfK_937op9mxc,5
+soia_client-1.0.18.dist-info/RECORD,,