mapepire-python 0.1.8__tar.gz → 0.2.0__tar.gz

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mapepire-python
-Version: 0.1.8
+Version: 0.2.0
 Author-email: Adam Shedivy <adam.shedivy@ibm.com>, Irfan Sharif <IrfanSharif@ibm.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -216,8 +216,7 @@ Requires-Python: >3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: dataclasses-json>=0.6.4
-Requires-Dist: websocket-client>=1.2.1
-Requires-Dist: websockets==13.1
+Requires-Dist: websockets>=14.0
 Requires-Dist: pyee
 Requires-Dist: pep249abc
 Provides-Extra: dev
@@ -315,6 +314,13 @@ Requires-Dist: pre-commit; extra == "dev"
 
 `mapepire-python` requires Python 3.10 or later.
 
+ > [!NOTE]
+ >  New websocket Implementation: As of version 0.2.0, `mapepire-python` uses the `websockets` library for websocket connections. If you are upgrading from a previous version, make sure to update your dependecies. The `websocket-client` library is no longer supported.
+ > - To update run `pip install -U mapepire-python`
+ >
+ > - More info on [websockets](https://websockets.readthedocs.io/en/stable/)
+
+
 ### Install with `pip`
 
 `mapepire-python` is available on [PyPi](https://pypi.org/project/mapepire-python/). Just Run

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/README.md

@@ -69,6 +69,13 @@
 
 `mapepire-python` requires Python 3.10 or later.
 
+ > [!NOTE]
+ >  New websocket Implementation: As of version 0.2.0, `mapepire-python` uses the `websockets` library for websocket connections. If you are upgrading from a previous version, make sure to update your dependecies. The `websocket-client` library is no longer supported.
+ > - To update run `pip install -U mapepire-python`
+ >
+ > - More info on [websockets](https://websockets.readthedocs.io/en/stable/)
+
+
 ### Install with `pip`
 
 `mapepire-python` is available on [PyPi](https://pypi.org/project/mapepire-python/). Just Run

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python/base_job.py

@@ -39,9 +39,17 @@ class BaseJob:
 
         if not isinstance(db2_server, DaemonServer):
             raise TypeError("db2_server must be of type DaemonServer")
-
+        self.creds = db2_server
         return db2_server
 
+    def __str__(self) -> str:
+        creds_str = self.creds
+        if isinstance(self.creds, DaemonServer):
+            creds_dict = self.creds.__dict__.copy()
+            creds_dict.pop("password", None)  # Remove password if present
+            creds_str = str(creds_dict)
+        return f"BaseJob(creds={creds_str}, options={self.options})"
+
     def connect(
         self, db2_server: Union[DaemonServer, Dict[str, Any], Path], **kwargs
     ) -> Dict[str, Any]:

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python/client/query.py

@@ -2,6 +2,8 @@ import json
 from enum import Enum
 from typing import Any, Dict, Generic, List, Optional, TypeVar
 
+from mapepire_python.websocket import handle_ws_errors
+
 from ..data_types import QueryOptions
 from .sql_job import SQLJob
 
@@ -39,13 +41,14 @@ class Query(Generic[T]):
         self.close()
 
     def __str__(self):
-        return f"Query(sql={self.sql}, parameters={self.parameters}, correlation_id={self._correlation_id})"
+        return f"Query(job={str(self.job)}, sql={self.sql}, parameters={self.parameters}, correlation_id={self._correlation_id})"
 
     def _execute_query(self, qeury_object: Dict[str, Any]) -> Dict[str, Any]:
         self.job.send(json.dumps(qeury_object))
         query_result: Dict[str, Any] = json.loads(self.job._socket.recv())
         return query_result
 
+    @handle_ws_errors
     def prepare_sql_execute(self):
         # check Query state first
         if self.state == QueryState.RUN_DONE:
@@ -67,7 +70,6 @@ class Query(Generic[T]):
         )
 
         if not query_result.get("success", False) and not self.is_cl_command:
-            print(query_result)
             self.state = QueryState.ERROR
             error_keys = ["error", "sql_state", "sql_rc"]
             error_list = {
@@ -82,6 +84,7 @@ class Query(Generic[T]):
 
         return query_result
 
+    @handle_ws_errors
     def run(self, rows_to_fetch: Optional[int] = None) -> Dict[str, Any]:
         if rows_to_fetch is None:
             rows_to_fetch = self._rows_to_fetch
@@ -135,6 +138,7 @@ class Query(Generic[T]):
 
         return query_result
 
+    @handle_ws_errors
     def fetch_more(self, rows_to_fetch: Optional[int] = None) -> Dict[str, Any]:
         if rows_to_fetch is None:
             rows_to_fetch = self._rows_to_fetch
@@ -169,8 +173,9 @@ class Query(Generic[T]):
 
         return query_result
 
+    @handle_ws_errors
     def close(self):
-        if not self.job._socket.connected:
+        if not self.job._socket:
             raise Exception("SQL Job not connected")
         if self._correlation_id and self.state is not QueryState.RUN_DONE:
             self.state = QueryState.RUN_DONE

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python/client/sql_job.py

@@ -2,11 +2,13 @@ import json
 from pathlib import Path
 from typing import Any, Dict, Optional, Union
 
-from websocket import WebSocket
+from websockets.sync.client import ClientConnection
+
+from mapepire_python.client.websocket_client import WebsocketConnection
+from mapepire_python.websocket import handle_ws_errors
 
 from ..base_job import BaseJob
 from ..data_types import DaemonServer, JobStatus, QueryOptions
-from .websocket import WebsocketConnection
 
 __all__ = ["SQLJob"]
 
@@ -49,7 +51,7 @@ class SQLJob(BaseJob):
         self._unique_id_counter += 1
         return f"{prefix}{self._unique_id_counter}"
 
-    def _get_channel(self, db2_server: DaemonServer) -> WebSocket:
+    def _get_channel(self, db2_server: DaemonServer) -> ClientConnection:
         """returns a websocket connection to the mapepire server
 
         Args:
@@ -69,6 +71,7 @@ class SQLJob(BaseJob):
         """
         return self._status
 
+    @handle_ws_errors
     def send(self, content: str) -> None:
         """sends content to the mapepire server
 
@@ -77,6 +80,7 @@ class SQLJob(BaseJob):
         """
         self._socket.send(content)
 
+    @handle_ws_errors
     def connect(
         self, db2_server: Union[DaemonServer, Dict[str, Any], Path], **kwargs
     ) -> Dict[Any, Any]:
@@ -93,7 +97,7 @@ class SQLJob(BaseJob):
         """
         db2_server = self._parse_connection_input(db2_server, **kwargs)
 
-        self._socket: WebSocket = self._get_channel(db2_server)
+        self._socket: ClientConnection = self._get_channel(db2_server)
 
         props = ";".join(
             [
@@ -164,6 +168,7 @@ class SQLJob(BaseJob):
 
         return Query(job=self, query=sql, opts=query_options)
 
+    @handle_ws_errors
     def query_and_run(
         self, sql: str, opts: Optional[Dict[str, Any]] = None, **kwargs
     ) -> Dict[str, Any]:

mapepire_python-0.2.0/mapepire_python/client/websocket_client.py

@@ -0,0 +1,20 @@
+from websockets.sync.client import ClientConnection, connect
+
+from mapepire_python.websocket import BaseConnection, handle_ws_errors
+
+from ..data_types import DaemonServer
+
+
+class WebsocketConnection(BaseConnection):
+
+    def __init__(self, db2_server: DaemonServer) -> None:
+        super().__init__(db2_server)
+
+    @handle_ws_errors
+    def connect(self) -> ClientConnection:
+        return connect(
+            self.uri,
+            additional_headers=self.headers,
+            open_timeout=10,
+            ssl=self._create_ssl_context(self.db2_server),
+        )

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python/core/cursor.py

@@ -37,7 +37,7 @@ class Cursor(pep249.CursorConnectionMixin, pep249.IterableCursorMixin, pep249.Tr
         self._connection = weakref.proxy(connection)
         self.job = job
         self.query: Query = None
-        self.query_q = deque(maxlen=20)
+        self.query_q: deque[Query] = deque(maxlen=20)
         self.__closed = False
         self.__has_results = False
 
@@ -102,7 +102,6 @@ class Cursor(pep249.CursorConnectionMixin, pep249.IterableCursorMixin, pep249.Tr
             query = Query(self.job, operation, create_opts)
 
         prepare_result = query.prepare_sql_execute()
-        # print(prepare_result)
 
         if prepare_result["has_results"]:
             self.query = query
@@ -188,7 +187,7 @@ class Cursor(pep249.CursorConnectionMixin, pep249.IterableCursorMixin, pep249.Tr
     def close(self) -> None:
         if self._closed:
             return
-        if self.query and self.job._socket.connected:
+        if self.query:
             for q in self.query_q:
                 q.close()
             self.query_q.clear()

mapepire_python-0.2.0/mapepire_python/pool/async_websocket_client.py

@@ -0,0 +1,18 @@
+from websockets.asyncio.client import ClientConnection, connect
+
+from mapepire_python.websocket import BaseConnection, handle_ws_errors
+
+
+class AsyncWebSocketConnection(BaseConnection):
+    def __init__(self, db2_server):
+        super().__init__(db2_server)
+
+    @handle_ws_errors
+    async def connect(self) -> ClientConnection:
+        websocket = await connect(
+            self.uri,
+            additional_headers=self.headers,
+            open_timeout=10,
+            ssl=self._create_ssl_context(self.db2_server),
+        )
+        return websocket

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python/pool/pool_job.py

@@ -1,18 +1,22 @@
 import asyncio
-import base64
 import json
-import ssl
+import logging
 from pathlib import Path
 from typing import Any, Dict, Optional, Union
 
 import websockets
 from pyee.asyncio import AsyncIOEventEmitter
+from websockets.asyncio.client import ClientConnection
+
+from mapepire_python.pool.async_websocket_client import AsyncWebSocketConnection
 
 from ..base_job import BaseJob
 from ..data_types import DaemonServer, JobStatus, QueryOptions
 
 __all__ = ["PoolJob"]
 
+logger = logging.getLogger("websockets.client")
+
 
 class PoolJob(BaseJob):
     unique_id_counter = 0
@@ -64,11 +68,7 @@ class PoolJob(BaseJob):
     def enable_local_channel_trace(self):
         self.is_tracing_channel_data = True
 
-    def _local_log(self, level: bool, message: str) -> None:
-        if level:
-            print(message, flush=True)
-
-    async def get_channel(self, db2_server: DaemonServer) -> websockets.WebSocketClientProtocol:
+    async def get_channel(self, db2_server: DaemonServer) -> ClientConnection:
         """returns a websocket connection to the mapepire server
 
         Args:
@@ -81,26 +81,8 @@ class PoolJob(BaseJob):
         Returns:
             websockets.WebSocketClientProtocol: websocket connection
         """
-        uri = f"wss://{db2_server.host}:{db2_server.port}/db/"
-        headers = {
-            "Authorization": "Basic "
-            + base64.b64encode(f"{db2_server.user}:{db2_server.password}".encode()).decode("ascii")
-        }
-
-        ssl_contest = ssl.create_default_context(cafile=db2_server.ca)
-        ssl_contest.check_hostname = False
-        ssl_contest.verify_mode = ssl.CERT_NONE
-
-        try:
-            socket = await websockets.connect(
-                uri=uri, extra_headers=headers, ssl=ssl_contest, ping_timeout=None, open_timeout=30
-            )
-        except TimeoutError as e:
-            raise TimeoutError("Failed to connect to server") from e
-        except Exception as e:
-            raise e
-
-        return socket
+        socket = AsyncWebSocketConnection(db2_server)
+        return await socket.connect()
 
     async def send(self, content: str) -> Dict[Any, Any]:
         """sends content to the mapepire server
@@ -111,18 +93,21 @@ class PoolJob(BaseJob):
         Returns:
             str: response from the server
         """
-        self._local_log(self.enable_local_trace, f"sending data: {content}")
+        logger.debug(f"sending data: {content}")
 
         req = json.loads(content)
         if self.socket is None:
             raise RuntimeError("Socket is not connected")
-        await self.socket.send(content)
-        self.status = JobStatus.Busy
-        self._local_log(self.enable_local_trace, "wating for response ...")
-        response = await self.wait_for_response(req["id"])
-        self._local_log(self.enable_local_trace, f"recieved response: {response}")
-        self.status = JobStatus.Ready if self.get_running_count() == 0 else JobStatus.Busy
-        return response  # type: ignore
+        try:
+            await self.socket.send(content)
+            self.status = JobStatus.Busy
+            logger.debug("waiting for response ...")
+            response = await self.wait_for_response(req["id"])
+            # logger.debug(f"received response: {response}")
+            self.status = JobStatus.Ready if self.get_running_count() == 0 else JobStatus.Busy
+            return response  # type: ignore
+        except Exception as e:
+            raise e
 
     async def wait_for_response(self, req_id: str) -> str:
         """when a request is sent to the server, this method waits for the response
@@ -139,16 +124,14 @@ class PoolJob(BaseJob):
         future = asyncio.Future()
 
         def on_response(response):
-            self._local_log(
-                self.enable_local_trace, f"Received response for req_id: {req_id} - {response}"
-            )
+            logger.debug(f"Received response for req_id: {req_id} - {response}")
             if not future.done():
                 future.set_result(response)
             self.response_emitter.remove_listener(req_id, on_response)
 
         try:
             self.response_emitter.on(req_id, on_response)
-            self._local_log(self.enable_local_trace, f"Listener registered for req_id: {req_id}")
+            logger.debug(f"Listener registered for req_id: {req_id}")
             return await future
         except Exception as e:
             self.response_emitter.remove_listener(req_id, on_response)
@@ -158,9 +141,8 @@ class PoolJob(BaseJob):
         return self.status
 
     def get_running_count(self) -> int:
-        self._local_log(
-            self.enable_local_trace,
-            f"--- running count {self.unique_id}: {len(self.response_emitter.event_names())}, status: {self.get_status()}",
+        logger.debug(
+            f"--- running count {self.unique_id}: {len(self.response_emitter.event_names())}, status: {self.get_status()}"
         )
         return len(self.response_emitter.event_names())
 
@@ -235,25 +217,21 @@ class PoolJob(BaseJob):
             if self.socket is None:
                 raise RuntimeError("Socket is not connected")
             async for message in self.socket:
-                self._local_log(self.enable_local_trace, f"Received raw message: {message}")
+                logger.debug(f"Received raw message: {message}")
 
                 try:
                     response = json.loads(message)
                     req_id = response.get("id")
                     if req_id:
-                        self._local_log(
-                            self.enable_local_trace, f"Emitting response for req_id: {req_id}"
-                        )
+                        logger.debug(f"Emitting response for req_id: {req_id}")
                         self.response_emitter.emit(req_id, response)
                     else:
-                        self._local_log(
-                            self.enable_local_trace, f"No req_id found in response: {response}"
-                        )
+                        logger.debug(f"No req_id found in response: {response}")
                 except json.JSONDecodeError as e:
                     raise ValueError(f"Error decoding JSON: {e}")
                 except Exception as e:
                     raise RuntimeError(f"Error: {e}")
-        except websockets.exceptions.ConnectionClosed:
+        except websockets.exceptions.ConnectionClosedError:
             await self.dispose()
 
     def query(

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python/ssl.py

@@ -16,4 +16,9 @@ def get_certificate(creds: DaemonServer) -> Optional[bytes]:
         )
     with socket.create_connection((creds.host, creds.port)) as sock:
         with context.wrap_socket(sock, server_hostname=creds.host) as ssock:
-            return ssock.getpeercert(binary_form=True)
+            try:
+                ssock.do_handshake()
+                cert = ssock.getpeercert(binary_form=True)
+                return ssl.DER_cert_to_PEM_cert(cert)
+            except ssl.SSLError as er:
+                raise er

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python/version.py

@@ -1,8 +1,8 @@
 _MAJOR = "0"
-_MINOR = "1"
+_MINOR = "2"
 # On main and in a nightly release the patch should be one ahead of the last
 # released build.
-_PATCH = "8"
+_PATCH = "0"
 # This is mainly for nightly builds which have the suffix ".dev$DATE". See
 # https://semver.org/#is-v123-a-semantic-version for the semantics.
 _SUFFIX = ""

mapepire_python-0.2.0/mapepire_python/websocket.py

@@ -0,0 +1,61 @@
+import base64
+import ssl
+from functools import wraps
+from typing import Any, Callable, TypeVar
+
+from websockets import ConcurrencyError, ConnectionClosed, InvalidHandshake, InvalidURI
+
+from mapepire_python.data_types import DaemonServer
+
+ReturnType = TypeVar("ReturnType")
+
+
+class BaseConnection:
+    def __init__(self, db2_server: DaemonServer) -> None:
+        self.uri = f"wss://{db2_server.host}:{db2_server.port}/db/"
+        self.headers = {
+            "Authorization": "Basic "
+            + base64.b64encode(f"{db2_server.user}:{db2_server.password}".encode()).decode("ascii")
+        }
+        self.db2_server = db2_server
+
+    def _create_ssl_context(self, db2_server: DaemonServer):
+        ssl_context = ssl.create_default_context(purpose=ssl.Purpose.SERVER_AUTH)
+        if db2_server.ignoreUnauthorized:
+            ssl_context.check_hostname = False
+            ssl_context.verify_mode = ssl.CERT_NONE
+        elif db2_server.ca:
+            ssl_context.load_verify_locations(cadata=db2_server.ca)
+        return ssl_context
+
+
+def _parse_ws_error(error: Exception, driver: Any = None):
+    to_str = str(driver)
+
+    if isinstance(error, InvalidURI):
+        raise InvalidURI(f"The provided URI is not a valid WebSocket URI: {to_str}")
+    elif isinstance(error, OSError):
+        raise OSError(f"The TCP connection failed to connect to Mapepire server: {to_str}")
+    elif isinstance(error, InvalidHandshake):
+        raise InvalidHandshake("The opening handshake failed.")
+    elif isinstance(error, TimeoutError):
+        raise TimeoutError("The opening handshake timed out.")
+    elif isinstance(error, ConnectionClosed):
+        raise ConnectionClosed("The Conection was closed.")
+    elif isinstance(error, ConcurrencyError):
+        raise ConcurrencyError("Connection is sending a fragmented message")
+    elif isinstance(error, TypeError):
+        raise TypeError("Message doesn't have a supported type")
+    else:
+        return error
+
+
+def handle_ws_errors(function: Callable[..., ReturnType]) -> Callable[..., ReturnType]:
+    @wraps(function)
+    def _impl(self, *args, **kwargs):
+        try:
+            return function(self, *args, **kwargs)
+        except RuntimeError as err:
+            raise _parse_ws_error(err, driver=self) from err
+
+    return _impl

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mapepire-python
-Version: 0.1.8
+Version: 0.2.0
 Author-email: Adam Shedivy <adam.shedivy@ibm.com>, Irfan Sharif <IrfanSharif@ibm.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -216,8 +216,7 @@ Requires-Python: >3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: dataclasses-json>=0.6.4
-Requires-Dist: websocket-client>=1.2.1
-Requires-Dist: websockets==13.1
+Requires-Dist: websockets>=14.0
 Requires-Dist: pyee
 Requires-Dist: pep249abc
 Provides-Extra: dev
@@ -315,6 +314,13 @@ Requires-Dist: pre-commit; extra == "dev"
 
 `mapepire-python` requires Python 3.10 or later.
 
+ > [!NOTE]
+ >  New websocket Implementation: As of version 0.2.0, `mapepire-python` uses the `websockets` library for websocket connections. If you are upgrading from a previous version, make sure to update your dependecies. The `websocket-client` library is no longer supported.
+ > - To update run `pip install -U mapepire-python`
+ >
+ > - More info on [websockets](https://websockets.readthedocs.io/en/stable/)
+
+
 ### Install with `pip`
 
 `mapepire-python` is available on [PyPi](https://pypi.org/project/mapepire-python/). Just Run

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ mapepire_python/py.typed
 mapepire_python/query_manager.py
 mapepire_python/ssl.py
 mapepire_python/version.py
+mapepire_python/websocket.py
 mapepire_python.egg-info/PKG-INFO
 mapepire_python.egg-info/SOURCES.txt
 mapepire_python.egg-info/dependency_links.txt
@@ -20,13 +21,14 @@ mapepire_python/asyncio/utils.py
 mapepire_python/client/__init__.py
 mapepire_python/client/query.py
 mapepire_python/client/sql_job.py
-mapepire_python/client/websocket.py
+mapepire_python/client/websocket_client.py
 mapepire_python/core/__init__.py
 mapepire_python/core/connection.py
 mapepire_python/core/cursor.py
 mapepire_python/core/exceptions.py
 mapepire_python/core/utils.py
 mapepire_python/pool/__init__.py
+mapepire_python/pool/async_websocket_client.py
 mapepire_python/pool/pool_client.py
 mapepire_python/pool/pool_job.py
 mapepire_python/pool/pool_query.py

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/mapepire_python.egg-info/requires.txt

@@ -1,6 +1,5 @@
 dataclasses-json>=0.6.4
-websocket-client>=1.2.1
-websockets==13.1
+websockets>=14.0
 pyee
 pep249abc
 

{mapepire_python-0.1.8 → mapepire_python-0.2.0}/pyproject.toml

@@ -21,8 +21,7 @@ authors = [
 requires-python = ">3.9"
 dependencies = [
   "dataclasses-json>=0.6.4",
-  "websocket-client>=1.2.1",
-  "websockets==13.1",
+  "websockets>=14.0",
   "pyee",
   "pep249abc"
 ]

mapepire_python-0.1.8/mapepire_python/client/websocket.py

@@ -1,40 +0,0 @@
-import base64
-import ssl
-from typing import Any, Dict
-
-from websocket import WebSocket, create_connection
-
-from ..data_types import DaemonServer
-
-
-class WebsocketConnection:
-    def __init__(self, db2_server: DaemonServer) -> None:
-        self.uri = f"wss://{db2_server.host}:{db2_server.port}/db/"
-        self.headers = {
-            "Authorization": "Basic "
-            + base64.b64encode(f"{db2_server.user}:{db2_server.password}".encode()).decode("ascii")
-        }
-
-        self.ssl_opts = self._build_ssl_options(db2_server)
-        self.db2_server = db2_server
-
-    def _build_ssl_options(self, db2_server: DaemonServer) -> Dict[str, Any]:
-        ssl_opts: Dict[str, Any] = {}
-        if db2_server.ignoreUnauthorized:
-            ssl_opts["cert_reqs"] = ssl.CERT_NONE
-        if db2_server.ca:
-            ssl_context = ssl.create_default_context(cadata=db2_server.ca)
-            ssl_context.check_hostname = False
-            ssl_opts["ssl_context"] = ssl_context
-            ssl_opts["cert_reqs"] = ssl.CERT_NONE
-        return ssl_opts
-
-    def connect(self) -> WebSocket:
-        try:
-            return create_connection(
-                self.uri, header=self.headers, sslopt=self.ssl_opts, timeout=10
-            )
-        except Exception:
-            raise RuntimeError(
-                f"An error occurred while connecting to the server: {self.db2_server.host}"
-            )