compitable for python2 migration (#4)

ENHANCEMENT:

- Provide static code analysis tools with ast transformer to sync python 3 sdk implementation to python 2 (#4)
- Improve validation error message (#4)
- Add client-level logger (#4)

Author: yufeiminds

.travis.yml

@@ -28,7 +28,6 @@ deploy:
     local_dir: docs/build/html
     on:
       branch: master
-      tags: true
       repo: ucloud/ucloud-sdk-python3
       python: 3.7
   - provider: pypi

docs/services.rst

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

examples/uhost/main.py

@@ -6,7 +6,7 @@
 from ucloud.helpers import wait, utils
 
 logging.basicConfig()
-logger = logging.getLogger(__name__)
+logger = logging.getLogger('ucloud')
 logger.setLevel(logging.DEBUG)
 
 
@@ -19,7 +19,9 @@ def main():
     })
 
     logger.info("finding image, random choice one")
-    images = client.uhost().describe_image({'ImageType': 'Base'}).get('ImageSet', [])
+    images = client.uhost().describe_image({
+        'ImageType': 'Base', 'OsType': 'Linux'
+    }).get('ImageSet', [])
 
     assert len(images) > 0
 
@@ -35,7 +37,7 @@ def main():
         'CPU': 1,
         'Memory': 1024,
         'Disks': [{
-            'Size': 20,
+            'Size': image["ImageSize"],
             'Type': 'CLOUD_NORMAL',
             'IsBoot': 'True',
         }],

setup.py

@@ -100,6 +100,9 @@ def do_setup():
             "Intended Audience :: System Administrators",
             "License :: OSI Approved :: Apache Software License",
             "Programming Language :: Python :: 3 :: Only",
+            "Programming Language :: Python :: 3.5",
+            "Programming Language :: Python :: 3.6",
+            "Programming Language :: Python :: 3.7",
             "Topic :: Software Development",
         ],
         author="ucloud",

tests/test_core/test_client.py

@@ -21,11 +21,11 @@ def client():
     )
 
 
-def test_pre_check(client):
-    env.pre_check_env()
-
-
 class TestAccClient:
+    @pytest.mark.skipif(env.is_ut(), reason=env.get_skip_reason())
+    def test_pre_check(self, client):
+        env.pre_check_env()
+
     @pytest.mark.skipif(env.is_ut(), reason=env.get_skip_reason())
     def test_client_invoke(self, client):
         resp = client.invoke("DescribeUHostInstance")

tests/test_helpers/test_utils.py

@@ -0,0 +1,11 @@
+from ucloud.helpers import utils
+
+
+def test_b64encode():
+    encoded = utils.b64encode("foobar42")
+    assert encoded == 'Zm9vYmFyNDI='
+
+
+def test_b64decode():
+    decoded = utils.b64decode("Zm9vYmFyNDI=")
+    assert decoded == 'foobar42'

ucloud/client.py

@@ -1,52 +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 udb(self):
-        from ucloud.services.udb.client import UDBClient
-        return UDBClient(self._config, self.transport, self.middleware)
-
-    def uphost(self):
-        from ucloud.services.uphost.client import UPHostClient
-        return UPHostClient(self._config, self.transport, self.middleware)
-
-    def unet(self):
-        from ucloud.services.unet.client import UNetClient
-        return UNetClient(self._config, self.transport, self.middleware)
-
-    def vpc(self):
-        from ucloud.services.vpc.client import VPCClient
-        return VPCClient(self._config, self.transport, self.middleware)
-
-    def udpn(self):
-        from ucloud.services.udpn.client import UDPNClient
-        return UDPNClient(self._config, self.transport, self.middleware)
-
-    def uaccount(self):
-        from ucloud.services.uaccount.client import UAccountClient
-        return UAccountClient(self._config, self.transport, self.middleware)
-
-    def uhost(self):
-        from ucloud.services.uhost.client import UHostClient
-        return UHostClient(self._config, self.transport, self.middleware)
-
-    def umem(self):
-        from ucloud.services.umem.client import UMemClient
-        return UMemClient(self._config, self.transport, self.middleware)
-
-    def ulb(self):
-        from ucloud.services.ulb.client import ULBClient
-        return ULBClient(self._config, self.transport, self.middleware)
-
-    def udisk(self):
-        from ucloud.services.udisk.client import UDiskClient
-        return UDiskClient(self._config, self.transport, self.middleware)
-
-    def pathx(self):
-        from ucloud.services.pathx.client import PathXClient
-        return PathXClient(self._config, self.transport, self.middleware)
-
+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/client/_client.py

@@ -5,11 +5,10 @@
 from ucloud import version
 from ucloud.core.client._cfg import Config
 from ucloud.core.transport import Transport, RequestsTransport, Request, Response
+from ucloud.core.utils import log
 from ucloud.core.utils.middleware import Middleware
 from ucloud.core import auth, exc
 
-logger = logging.getLogger(__name__)
-
 default_transport = RequestsTransport()
 
 
@@ -19,31 +18,32 @@ def __init__(
         config: dict,
         transport: typing.Optional[Transport] = None,
         middleware: typing.Optional[Middleware] = None,
+        logger: typing.Optional[logging.Logger] = None,
     ):
         cfg, cred = self._parse_dict_config(config)
         self.config = cfg
         self.credential = cred
         self.transport = transport or default_transport
-
+        self.logger = logger or log.default_logger
         if middleware is None:
             middleware = Middleware()
-            middleware.response(Client.logged_response_handler)
+            middleware.response(self.logged_response_handler)
+            middleware.request(self.logged_request_handler)
         self._middleware = middleware
 
-    def invoke(self, action: str, args: dict = None, **options: typing.Any) -> dict:
+    def invoke(self, action: str, args: dict = None, **options) -> dict:
         """ invoke will invoke the action with arguments data and options
 
         :param str action: the api action, like `CreateUHostInstance`
         :param dict args: arguments of api(action), see doc: `UCloud API Documentation <https://docs.ucloud.cn/api>`__
         :return:
         """
         retries = 0
-        req = self._build_request(action, args)
         max_retries = options.get("max_retries") or self.config.max_retries
 
         while retries <= max_retries:
             try:
-                return self._send(req, **options)
+                return self._send(action, args or {}, **options)
             except exc.UCloudException as e:
                 if e.retryable and retries != max_retries:
                     logging.info(
@@ -61,14 +61,12 @@ def invoke(self, action: str, args: dict = None, **options: typing.Any) -> dict:
     def middleware(self) -> Middleware:
         return self._middleware
 
-    @staticmethod
-    def logged_response_handler(resp: Response) -> Response:
-        """ logging response data
+    def logged_request_handler(self, req):
+        self.logger.info("[request] {} {}".format(req.get("Action", ""), req))
+        return req
 
-        :param resp:
-        :return:
-        """
-        logger.info(resp)
+    def logged_response_handler(self, resp):
+        self.logger.info("[response] {} {}".format(resp.get("Action", ""), resp))
         return resp
 
     def __enter__(self):
@@ -78,9 +76,11 @@ def __enter__(self):
     def _parse_dict_config(config: dict) -> typing.Tuple[Config, auth.Credential]:
         return Config.from_dict(config), auth.Credential.from_dict(config)
 
-    def _send(self, req: Request, **options: dict) -> dict:
+    def _send(self, action: str, args: dict, **options) -> dict:
+        args["Action"] = action
         for handler in self.middleware.request_handlers:
-            req = handler(req)
+            args = handler(args)
+        req = self._build_http_request(args)
 
         max_retries = options.get("max_retries") or self.config.max_retries
         timeout = options.get("timeout") or self.config.timeout
@@ -98,12 +98,9 @@ def _send(self, req: Request, **options: dict) -> dict:
 
         return resp
 
-    def _build_request(self, action: str, data: dict = None) -> Request:
+    def _build_http_request(self, args: dict) -> Request:
         payload = {"Region": self.config.region, "ProjectId": self.config.project_id}
-        payload.update(
-            {k: v for k, v in (data or {}).items() if v is not None}
-        )  # overwrite region and project id
-        payload["Action"] = action  # overwrite action
+        payload.update({k: v for k, v in args.items() if v is not None})
         payload["Signature"] = self.credential.verify_ac(payload)
 
         return Request(