From 7076eb15437c64c163ff0ce9e80228e342bb5f12 Mon Sep 17 00:00:00 2001 From: clerie Date: Sat, 2 Apr 2022 21:10:05 +0200 Subject: [PATCH] Expose connection object directly instead of proxying the request method --- docs/manual/client.rst | 5 +++-- mitel_ommclient2/client.py | 29 +++++++---------------------- 2 files changed, 10 insertions(+), 24 deletions(-) diff --git a/docs/manual/client.rst b/docs/manual/client.rst index 23eaada..67fabe6 100644 --- a/docs/manual/client.rst +++ b/docs/manual/client.rst @@ -37,6 +37,7 @@ validate common API requests. See class documentation to get and overview and op Making custom requests ---------------------- -:func:`mitel_ommclient2.client.OMMClient2.request` allowes you to send custom requests. -It just passes arguments and results to :func:`mitel_ommclient2.connection.Connection.request`. +:class:`mitel_ommclient2.client.OMMClient2` holds its :class:`mitel_ommclient2.connection.Connection` +in the connection attribute. +Use :func:`mitel_ommclient2.connection.Connection.request` directly for making some custom requests. See :doc:`/manual/connection` about using this. diff --git a/mitel_ommclient2/client.py b/mitel_ommclient2/client.py index d30da26..0b28a07 100644 --- a/mitel_ommclient2/client.py +++ b/mitel_ommclient2/client.py @@ -23,7 +23,7 @@ class OMMClient2: Use request to send custom messages:: - >>> r = s.request(mitel_ommclient2.messages.Ping()) + >>> r = s.connection.request(mitel_ommclient2.messages.Ping()) """ def __init__(self, host, username, password, port=None, ommsync=False): @@ -39,28 +39,13 @@ class OMMClient2: kwargs["port"] = self._port # Connect - self._connection = Connection(self._host, **kwargs) - self._connection.connect() + self.connection = Connection(self._host, **kwargs) + self.connection.connect() # Login - r = self.request(messages.Open(self._username, self._password, UserDeviceSyncClient=self._ommsync)) + r = self.connection.request(messages.Open(self._username, self._password, UserDeviceSyncClient=self._ommsync)) r.raise_on_error() - def request(self, request): - """ - Sends a request, waits for response and returns response - - :param request: Request object - - Usage:: - - >>> r = c.request(mitel_ommclient2.messages.Ping()) - >>> r.name - 'PingResp' - """ - - return self._connection.request(request) - def get_account(self, id): """ Get account @@ -68,7 +53,7 @@ class OMMClient2: :param id: User id """ - r = self.request(messages.GetAccount(id)) + r = self.connection.request(messages.GetAccount(id)) r.raise_on_error() if r.account is None: return None @@ -80,7 +65,7 @@ class OMMClient2: :param id: Device id """ - r = self.request(messages.GetPPDev(ppn)) + r = self.connection.request(messages.GetPPDev(ppn)) r.raise_on_error() if r.pp is None: return None @@ -93,7 +78,7 @@ class OMMClient2: Returns `True` when response is received. """ - r = self.request(messages.Ping()) + r = self.connection.request(messages.Ping()) if r.errCode is None: return True return False