🌎 azure-na support

Author: ishaileshmishra

contentstack/assetquery.py

@@ -24,11 +24,10 @@ def __init__(self, http_instance):
         super().__init__()
         self.http_instance = http_instance
         self.asset_query_params = {}
-        self.base_url = "{}/assets".format(self.http_instance.endpoint)
+        self.base_url = f"{self.http_instance.endpoint}/assets"
         if "environment" in self.http_instance.headers:
             env = self.http_instance.headers["environment"]
-            self.base_url = "{}?{}".format(
-                self.base_url, "environment={}".format(env))
+            self.base_url = f"{self.base_url}?environment={env}"
 
     def environment(self, environment):
         r"""Provide the name of the environment if you wish to retrieve the assets published

contentstack/basequery.py

@@ -1,4 +1,3 @@
-
 import enum
 import logging
 

contentstack/contenttype.py

@@ -7,7 +7,7 @@
 
 # ************* Module ContentType **************
 # Your code has been rated at 10.00/10 by pylint
-
+import json
 import logging
 from urllib import parse
 
@@ -43,13 +43,15 @@ def entry(self, entry_uid: str):
             >>> import contentstack
             >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
             >>> content_type = stack.content_type('content_type_uid')
-            >>> entry = content_type.entry(uid='entry_uid')
+            >>> content_type.entry(uid='entry_uid')
         --------------------------------
         """
         if self.__content_type_uid is None:
             raise PermissionError('Please provide valid content_type_uid')
         if entry_uid is None:
-            raise PermissionError('Please provide valid entry uid')
+            raise PermissionError(json.dumps({
+                "message": 'Please provide valid entry uid',
+                "message_detail": 'Entry UID can not be None'}))
         entry = Entry(self.http_instance,
                       self.__content_type_uid, entry_uid=entry_uid)
         return entry

contentstack/entry.py

@@ -5,6 +5,9 @@
 
 import logging
 from urllib import parse
+
+import empty as empty
+
 from contentstack.entryqueryable import EntryQueryable
 
 # ************* Module Entry **************
@@ -157,13 +160,12 @@ def include_embedded_items(self):
         return self
 
     def __get_base_url(self, endpoint=''):
-        if endpoint is not None and not endpoint.empty:
+        if endpoint is not None and not empty:
             self.http_instance.endpoint = endpoint
         if None in (self.http_instance, self.content_type_id, self.entry_uid):
             raise KeyError(
                 'Provide valid http_instance, content_type_uid or entry_uid')
-        url = '{}/content_types/{}/entries/{}' \
-            .format(self.http_instance.endpoint, self.content_type_id, self.entry_uid)
+        url = f'{self.http_instance.endpoint}/content_types/{self.content_type_id}/entries/{self.entry_uid}'
         return url
 
     def __validate_live_preview(self):
@@ -195,5 +197,5 @@ def fetch(self):
         if len(self.entry_queryable_param) > 0:
             self.entry_param.update(self.entry_queryable_param)
         encoded_string = parse.urlencode(self.entry_param, doseq=True)
-        url = '{}?{}'.format(self.base_url, encoded_string)
+        url = f'{self.base_url}?{encoded_string}'
         return self.http_instance.get(url)

contentstack/entryqueryable.py

@@ -20,11 +20,11 @@ def __init__(self):
 
     def locale(self, locale: str):
         """
-        Language code of which the entries needs to be included.
+        Language code of which the entries need to be included.
         Only the entries published in this locale will be displayed
 
         Arguments:
-            locale {str} -- locale_code of the language of which the entries needs to be included.
+            locale {str} -- locale_code of the language of which the entries need to be included.
             Only the entries published in this locale will be displayed
 
         :return: self: so you can chain this call.

contentstack/https_connection.py

@@ -7,7 +7,11 @@
 
 import logging
 import platform
+import json
 from json import JSONDecodeError
+import requests
+from requests.adapters import HTTPAdapter
+from requests.exceptions import HTTPError, Timeout
 import contentstack
 
 log = logging.getLogger(__name__)
@@ -34,7 +38,7 @@ def user_agents():
     ),
         'os': __get_os_platform,
         'Content-Type': 'application/json'}
-    package = "contentstack-python/{}".format(contentstack.__version__)
+    package = f"contentstack-python/{contentstack.__version__}"
     return {'User-Agent': str(header), "X-User-Agent": package}
 
 
@@ -52,10 +56,6 @@ def __init__(self, endpoint, headers, timeout, retry_strategy, live_preview):
 
     def get(self, url):
 
-        import requests
-        from requests.adapters import HTTPAdapter
-        from requests.exceptions import HTTPError, Timeout
-
         """
         Here we create a response object, `response` which will store the request-response.
         We use requests.get method since we are sending a GET request.
@@ -71,15 +71,20 @@ def get(self, url):
             session.close()
             if response.encoding is None:
                 response.encoding = 'utf-8'
-            if response is not None:
+            elif response is not None:
                 return response.json()
             else:
-                return {"error": "error details not found", "error_code": 422, "error_message": "unknown error"}
-        except Timeout:
-            raise TimeoutError('The request timed out')
-        except ConnectionError:
-            raise ConnectionError('Connection error occurred')
-        except JSONDecodeError:
-            raise TypeError('Invalid JSON in request')
-        except HTTPError:
-            raise HTTPError('Http Error Occurred')
+                return {"error": "error details not found", "error_code": 422,
+                        "error_message": "unknown error"}
+        except Timeout as timeout_err:
+            raise TimeoutError(
+                json.dumps({"httpStatus": 408,
+                            "message": f'Timeout error ${timeout_err.strerror}'})) from timeout_err
+        except ConnectionError as connect_err:
+            raise ConnectionError(json.dumps({"httpStatus": 503,
+                                              "message": f'Service error ${connect_err.strerror}'})) from connect_err
+        except JSONDecodeError as connection_err:
+            raise TypeError(json.dumps({"httpStatus": 503,
+                                        "message": 'Decoding JSON has failed.'})) from connection_err
+        except HTTPError as http_err:
+            raise HTTPError('Http error occurred') from http_err

contentstack/query.py

@@ -6,6 +6,7 @@
 import logging
 from urllib import parse
 
+import empty as empty
 
 from contentstack.basequery import BaseQuery
 from contentstack.entryqueryable import EntryQueryable
@@ -43,15 +44,13 @@ class Query(BaseQuery, EntryQueryable):
 
     def __init__(self, http_instance, content_type_uid):
         super().__init__()
-        # BaseQuery.__init__(self)
         EntryQueryable.__init__(self)
         self.content_type_uid = content_type_uid
         self.http_instance = http_instance
         if self.content_type_uid is None:
             raise PermissionError(
                 'You are not allowed here without content_type_uid')
-        # self.base_url = '{}/content_types/{}/entries' \
-        #     .format(self.http_instance.endpoint, self.content_type_uid)
+        self.base_url = f'{self.http_instance.endpoint}/content_types/{self.content_type_uid}/entries'
         self.base_url = self.__get_base_url()
 
     def __get_base_url(self, endpoint=''):
@@ -60,8 +59,7 @@ def __get_base_url(self, endpoint=''):
         if None in (self.http_instance, self.content_type_uid):
             raise KeyError(
                 'Provide valid http_instance, content_type_uid or entry_uid')
-        url = '{}/content_types/{}/entries' \
-            .format(self.http_instance.endpoint, self.content_type_uid)
+        url = f'{self.http_instance.endpoint}/content_types/{self.content_type_uid}/entries'
 
         return url
 
@@ -313,8 +311,8 @@ def __execute_network_call(self):
             self.query_params["query"] = json.dumps(self.parameters)
         if 'environment' in self.http_instance.headers:
             self.query_params['environment'] = self.http_instance.headers['environment']
-        # Check if live preview enabled
         self.__validate_live_preview()
         encoded_string = parse.urlencode(self.query_params, doseq=True)
-        url = '{}?{}'.format(self.base_url, encoded_string)
+        url = f'{self.base_url}?{encoded_string}'
+        # url = '{}?{}'.format(self.base_url, encoded_string)
         return self.http_instance.get(url)

contentstack/stack.py

@@ -3,20 +3,18 @@
 this as a container that holds authentication related data.
 """
 
-# ************* Module stack **************
-# Your code has been rated at 10.00/10
-
 import enum
 import logging
 from urllib import parse
 from urllib3.util import Retry
+
+import contentstack
 from contentstack.asset import Asset
 from contentstack.assetquery import AssetQuery
 from contentstack.contenttype import ContentType
 from contentstack.https_connection import HTTPSConnection
 from contentstack.image_transform import ImageTransform
 
-
 __author__ = "ishaileshmishra (ishaileshmishra@gmail.com)"
 __license__ = "MIT"
 __version__ = '1.7.0'
@@ -35,14 +33,12 @@ class ContentstackRegion(enum.Enum):
 
 
 class Stack:
-
     """
     A stack can be defined as a pool of data or a container that holds all
     the content/assets related to a site. It is a collaboration space where multiple users can work
     together to create, edit, approve, and publish content.
     (API Reference)[https://www.contentstack.com/docs/developers/apis/content-delivery-api/#stack]:
     """
-    #from urllib3.util import Retry
 
     def __init__(self, api_key: str, delivery_token: str, environment: str,
                  host=DEFAULT_HOST,
@@ -58,7 +54,7 @@ def __init__(self, api_key: str, delivery_token: str, environment: str,
         Class that wraps the credentials of the authenticated user. Think of
         this as a container that holds authentication related data.
 
-        :param api_key: api_key of the stack
+        param api_key: api_key of the stack
         :param delivery_token: delivery_token of the stack
         :param environment: environment of the stack
         :param host: (optional) host of the stack default is cdm.contentstack.io
@@ -78,14 +74,14 @@ def __init__(self, api_key: str, delivery_token: str, environment: str,
             'edit_tags_type': object | str,
         }
         ```
-        :param retry_strategy (optional) custom retry_strategy can be set.
-        # Method to create retry_strategy: create object of Retry() and provide the
-        # required parameters like below
+        :param retry_strategy: (optional) custom retry_strategy can be set.
+        Method to create retry_strategy: create object of Retry() and provide the
+        required parameters like below
         **Example:**
 
         >>> _strategy = Retry(total=5, backoff_factor=1, status_forcelist=[408, 429])
         >>> stack = contentstack.Stack("api_key", "delivery_token", "environment",
-            live_preview={enable=True, authorization='your auth token'}, retry_strategy= _strategy)
+        live_preview={enable=True, authorization='your auth token'}, retry_strategy= _strategy)
         ```
         """
         if live_preview is None:
@@ -120,19 +116,17 @@ def _validate_stack(self):
             raise PermissionError(
                 'You are not permitted to the stack without valid Environment')
 
-
         if self.region.value == 'eu' and self.host == DEFAULT_HOST:
             self.host = 'eu-cdn.contentstack.com'
         elif self.region.value == 'azure-na' and self.host == DEFAULT_HOST:
             self.host = 'azure-na-cdn.contentstack.com'
         elif self.region.value != 'us':
-            #self.host = '{}-{}'.format(self.region.value, DEFAULT_HOST)
             self.host = f'{self.region.value}-{DEFAULT_HOST}'
         self.endpoint = f'https://{self.host}/{self.version}'
 
         self.headers = {
             'api_key': self.api_key,
-            'access_token':self.delivery_token,
+            'access_token': self.delivery_token,
             'environment': self.environment
         }
 
@@ -156,7 +150,6 @@ def _validate_live_preview(self):
                 if 'host' not in self.live_preview_dict:
                     raise PermissionError("host is required")
                 self.headers['authorization'] = self.live_preview_dict['authorization']
-                # remove deliveryToken and environment
                 self.host = self.live_preview_dict['host']
                 self.endpoint = f'https://{self.host}/{self.version}'
                 self.headers.pop('access_token')

contentstack/utility.py

@@ -73,4 +73,4 @@ def get_complete_url(base_url: str, params: dict):
         if 'query' in params:
             params["query"] = json.dumps(params["query"])
         query = parse.urlencode(params)
-        return '{}&{}'.format(base_url, query)
+        return f'{base_url}&{query}'

tests/__init__.py

@@ -27,4 +27,3 @@ def all_tests():
         test_module_entry,
         test_module_query
     ])
-