refactor python client using urllib3

modules/swagger-codegen/src/main/resources/python/rest.mustache

@@ -0,0 +1,223 @@
+# coding: utf-8
+import sys
+import io
+import json
+
+# python 2 and python 3 compatibility library
+from six import iteritems
+
+try:
+    import urllib3
+except ImportError:
+    raise ImportError('Swagger python client requires urllib3.')
+
+try:
+    # for python3
+    from urllib.parse import urlencode
+except ImportError:
+    # for python2
+    from urllib import urlencode
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp):
+        self.urllib3_response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = resp.data
+
+    def getheaders(self):
+        """
+        Returns a dictionary of the response headers.
+        """
+        return self.urllib3_response.getheaders()
+
+    def getheader(self, name, default=None):
+        """
+        Returns a given response header.
+        """
+        return self.urllib3_response.getheader(name, default)
+
+class RESTClientObject(object):
+
+    def __init__(self, pools_size=4):
+        self.pool_manager = urllib3.PoolManager(
+            num_pools=pools_size
+        )
+
+    def request(self, method, url, query_params=None, headers=None,
+                body=None, post_params=None):
+        """
+        :param method: http request method
+        :param url: http request url
+        :param query_params: query parameters in the url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters, `application/x-www-form-urlencode`
+                            and `multipart/form-data`
+        :param raw_response: if return the raw response
+        """
+        method = method.upper()
+        assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', 'PATCH']
+
+        if post_params and body:
+            raise ValueError("body parameter cannot be used with post_params parameter.")
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        if 'Content-Type' not in headers:
+            headers['Content-Type'] = 'application/json'
+
+        # For `POST`, `PUT`, `PATCH`
+        if method in ['POST', 'PUT', 'PATCH']:
+            if query_params:
+                url += '?' + urlencode(query_params)
+            if headers['Content-Type'] == 'application/json':
+                r = self.pool_manager.request(method, url,
+                                              body=json.dumps(body),
+                                              headers=headers)
+            if headers['Content-Type'] == 'application/x-www-form-urlencoded':
+                r = self.pool_manager.request(method, url,
+                                              fields=post_params,
+                                              encode_multipart=False,
+                                              headers=headers)
+            if headers['Content-Type'] == 'multipart/form-data':
+                # must del headers['Content-Type'], or the correct Content-Type
+                # which generated by urllib3 will be overwritten.
+                del headers['Content-Type']
+                r = self.pool_manager.request(method, url,
+                                              fields=post_params,
+                                              encode_multipart=True,
+                                              headers=headers)
+        # For `GET`, `HEAD`, `DELETE`
+        else:
+            r = self.pool_manager.request(method, url,
+                                          fields=query_params,
+                                          headers=headers)
+        r = RESTResponse(r)
+
+        if r.status not in range(200, 206):
+            raise ErrorResponse(r)
+
+        return self.process_response(r)
+
+    def process_response(self, response):
+        # In the python 3, the response.data is bytes.
+        # we need to decode it to string.
+        if sys.version_info > (3,):
+            data = response.data.decode('utf8')
+        else:
+            data = response.data
+        try:
+            resp = json.loads(data)
+        except ValueError:
+            resp = data
+
+        return resp
+
+    def GET(self, url, headers=None, query_params=None):
+        return self.request("GET", url, headers=headers, query_params=query_params)
+
+    def HEAD(self, url, headers=None, query_params=None):
+        return self.request("HEAD", url, headers=headers, query_params=query_params)
+
+    def DELETE(self, url, headers=None, query_params=None):
+        return self.request("DELETE", url, headers=headers, query_params=query_params)
+
+    def POST(self, url, headers=None, post_params=None, body=None):
+        return self.request("POST", url, headers=headers, post_params=post_params, body=body)
+
+    def PUT(self, url, headers=None, post_params=None, body=None):
+        return self.request("PUT", url, headers=headers, post_params=post_params, body=body)
+
+    def PATCH(self, url, headers=None, post_params=None, body=None):
+        return self.request("PATCH", url, headers=headers, post_params=post_params, body=body)
+
+
+class ErrorResponse(Exception):
+    """
+    Non-2xx HTTP response
+    """
+
+    def __init__(self, http_resp):
+        self.status = http_resp.status
+        self.reason = http_resp.reason
+        self.body = http_resp.data
+        self.headers = http_resp.getheaders()
+
+        # In the python 3, the self.body is bytes.
+        # we need to decode it to string.
+        if sys.version_info > (3,):
+            data = self.body.decode('utf8')
+        else:
+            data = self.body
+            
+        try:
+            self.body = json.loads(data)
+        except ValueError:
+            self.body = data
+
+    def __str__(self):
+        """
+        Custom error response messages
+        """
+        return "({0})\nReason: {1}\nHeader: {2}\nBody: {3}\n".\
+            format(self.status, self.reason, self.headers, self.body)
+
+class RESTClient(object):
+    """
+    A class with all class methods to perform JSON requests.
+    """
+
+    IMPL = RESTClientObject()
+
+    @classmethod
+    def request(cls, *n, **kw):
+        """
+        Perform a REST request and parse the response.
+        """
+        return cls.IMPL.request(*n, **kw)
+
+    @classmethod
+    def GET(cls, *n, **kw):
+        """
+        Perform a GET request using `RESTClient.request()`.
+        """
+        return cls.IMPL.GET(*n, **kw)
+
+    @classmethod
+    def HEAD(cls, *n, **kw):
+        """
+        Perform a HEAD request using `RESTClient.request()`.
+        """
+        return cls.IMPL.GET(*n, **kw)
+
+    @classmethod
+    def POST(cls, *n, **kw):
+        """
+        Perform a POST request using `RESTClient.request()`
+        """
+        return cls.IMPL.POST(*n, **kw)
+
+    @classmethod
+    def PUT(cls, *n, **kw):
+        """
+        Perform a PUT request using `RESTClient.request()`
+        """
+        return cls.IMPL.PUT(*n, **kw)
+
+    @classmethod
+    def PATCH(cls, *n, **kw):
+        """
+        Perform a PATCH request using `RESTClient.request()`
+        """
+        return cls.IMPL.PATCH(*n, **kw)
+
+    @classmethod
+    def DELETE(cls, *n, **kw):
+        """
+        Perform a DELETE request using `RESTClient.request()`
+        """
+        return cls.IMPL.DELETE(*n, **kw)