improve documentation and http transport (#5)

ENHANCEMENT:

- Improve documentation: add response fields and models to service documentation (#5)

BUGFIX:

- Fix transport keywork arguments has no-effected error, add user-agent to default headers (#5)

Author: yufeiminds

docs/services.rst

@@ -1,28 +1,34 @@
 UCloud SDK Services
 ===================
 
-UDB
+ULB
 ---
 
-.. autoclass:: ucloud.services.udb.client.UDBClient
+.. autoclass:: ucloud.services.ulb.client.ULBClient
    :members:
 
-UAccount
---------
+UNet
+----
 
-.. autoclass:: ucloud.services.uaccount.client.UAccountClient
+.. autoclass:: ucloud.services.unet.client.UNetClient
    :members:
 
-UHost
+UDPN
+----
+
+.. autoclass:: ucloud.services.udpn.client.UDPNClient
+   :members:
+
+UDisk
 -----
 
-.. autoclass:: ucloud.services.uhost.client.UHostClient
+.. autoclass:: ucloud.services.udisk.client.UDiskClient
    :members:
 
-ULB
+UDB
 ---
 
-.. autoclass:: ucloud.services.ulb.client.ULBClient
+.. autoclass:: ucloud.services.udb.client.UDBClient
    :members:
 
 UPHost
@@ -31,39 +37,33 @@ UPHost
 .. autoclass:: ucloud.services.uphost.client.UPHostClient
    :members:
 
-VPC
----
+UAccount
+--------
 
-.. autoclass:: ucloud.services.vpc.client.VPCClient
+.. autoclass:: ucloud.services.uaccount.client.UAccountClient
    :members:
 
-UDPN
+UMem
 ----
 
-.. autoclass:: ucloud.services.udpn.client.UDPNClient
+.. autoclass:: ucloud.services.umem.client.UMemClient
    :members:
 
-PathX
------
+VPC
+---
 
-.. autoclass:: ucloud.services.pathx.client.PathXClient
+.. autoclass:: ucloud.services.vpc.client.VPCClient
    :members:
 
-UDisk
+UHost
 -----
 
-.. autoclass:: ucloud.services.udisk.client.UDiskClient
-   :members:
-
-UMem
-----
-
-.. autoclass:: ucloud.services.umem.client.UMemClient
+.. autoclass:: ucloud.services.uhost.client.UHostClient
    :members:
 
-UNet
-----
+PathX
+-----
 
-.. autoclass:: ucloud.services.unet.client.UNetClient
+.. autoclass:: ucloud.services.pathx.client.PathXClient
    :members:
 

examples/two-tier/main.py

@@ -5,7 +5,6 @@
 from ucloud.client import Client
 from ucloud.helpers import wait, utils
 
-logging.basicConfig()
 logger = logging.getLogger('ucloud')
 logger.setLevel(logging.DEBUG)
 

examples/uhost/main.py

@@ -5,7 +5,6 @@
 from ucloud.client import Client
 from ucloud.helpers import wait, utils
 
-logging.basicConfig()
 logger = logging.getLogger('ucloud')
 logger.setLevel(logging.DEBUG)
 

ucloud/client.py

@@ -1,64 +1,64 @@
-from ucloud.core import client
-
-
-class Client(client.Client):
-    def __init__(self, config: dict, transport=None, middleware=None):
-        self._config = config
-        super(Client, self).__init__(config, transport, middleware)
-
-    def umem(self):
-        from ucloud.services.umem.client import UMemClient
-
-        return UMemClient(self._config, self.transport, self.middleware, self.logger)
-
-    def unet(self):
-        from ucloud.services.unet.client import UNetClient
-
-        return UNetClient(self._config, self.transport, self.middleware, self.logger)
-
-    def uaccount(self):
-        from ucloud.services.uaccount.client import UAccountClient
-
-        return UAccountClient(
-            self._config, self.transport, self.middleware, self.logger
-        )
-
-    def udisk(self):
-        from ucloud.services.udisk.client import UDiskClient
-
-        return UDiskClient(self._config, self.transport, self.middleware, self.logger)
-
-    def udpn(self):
-        from ucloud.services.udpn.client import UDPNClient
-
-        return UDPNClient(self._config, self.transport, self.middleware, self.logger)
-
-    def uhost(self):
-        from ucloud.services.uhost.client import UHostClient
-
-        return UHostClient(self._config, self.transport, self.middleware, self.logger)
-
-    def pathx(self):
-        from ucloud.services.pathx.client import PathXClient
-
-        return PathXClient(self._config, self.transport, self.middleware, self.logger)
-
-    def uphost(self):
-        from ucloud.services.uphost.client import UPHostClient
-
-        return UPHostClient(self._config, self.transport, self.middleware, self.logger)
-
-    def vpc(self):
-        from ucloud.services.vpc.client import VPCClient
-
-        return VPCClient(self._config, self.transport, self.middleware, self.logger)
-
-    def udb(self):
-        from ucloud.services.udb.client import UDBClient
-
-        return UDBClient(self._config, self.transport, self.middleware, self.logger)
-
-    def ulb(self):
-        from ucloud.services.ulb.client import ULBClient
-
-        return ULBClient(self._config, self.transport, self.middleware, self.logger)
+from ucloud.core import client
+
+
+class Client(client.Client):
+    def __init__(self, config: dict, transport=None, middleware=None):
+        self._config = config
+        super(Client, self).__init__(config, transport, middleware)
+
+    def umem(self):
+        from ucloud.services.umem.client import UMemClient
+
+        return UMemClient(self._config, self.transport, self.middleware, self.logger)
+
+    def unet(self):
+        from ucloud.services.unet.client import UNetClient
+
+        return UNetClient(self._config, self.transport, self.middleware, self.logger)
+
+    def uaccount(self):
+        from ucloud.services.uaccount.client import UAccountClient
+
+        return UAccountClient(
+            self._config, self.transport, self.middleware, self.logger
+        )
+
+    def udisk(self):
+        from ucloud.services.udisk.client import UDiskClient
+
+        return UDiskClient(self._config, self.transport, self.middleware, self.logger)
+
+    def udpn(self):
+        from ucloud.services.udpn.client import UDPNClient
+
+        return UDPNClient(self._config, self.transport, self.middleware, self.logger)
+
+    def uhost(self):
+        from ucloud.services.uhost.client import UHostClient
+
+        return UHostClient(self._config, self.transport, self.middleware, self.logger)
+
+    def pathx(self):
+        from ucloud.services.pathx.client import PathXClient
+
+        return PathXClient(self._config, self.transport, self.middleware, self.logger)
+
+    def uphost(self):
+        from ucloud.services.uphost.client import UPHostClient
+
+        return UPHostClient(self._config, self.transport, self.middleware, self.logger)
+
+    def vpc(self):
+        from ucloud.services.vpc.client import VPCClient
+
+        return VPCClient(self._config, self.transport, self.middleware, self.logger)
+
+    def udb(self):
+        from ucloud.services.udb.client import UDBClient
+
+        return UDBClient(self._config, self.transport, self.middleware, self.logger)
+
+    def ulb(self):
+        from ucloud.services.ulb.client import ULBClient
+
+        return ULBClient(self._config, self.transport, self.middleware, self.logger)

ucloud/core/transport/_requests.py

@@ -62,9 +62,12 @@ def _send(self, req: Request, **options: dict) -> requests.Response:
             session.mount("http://", adapter=adapter)
             session.mount("https://", adapter=adapter)
 
-            resp = self.convert_response(
-                session.request(req.method.upper(), url=req.url, json=req.json)
+            session_resp = session.request(
+                method=req.method.upper(), url=req.url,
+                json=req.json, data=req.data, params=req.params,
+                headers=req.headers,
             )
+            resp = self.convert_response(session_resp)
             resp.request = req
             return resp
 

ucloud/core/utils/compact.py

@@ -7,6 +7,7 @@
     from collections.abc import Callable
 else:
     import types
+
     string_types = types.StringTypes
 
     from collections import Callable