v1.1.0 updated include_reference in Queryable class

Author: mshaileshr@gmail.com

changelog.rst

@@ -2,15 +2,23 @@
 CHANGELOG
 =========
 
+*Date: 7-Aug-2020 - initial release*
+
+**v1.1.0**
+============
+- **EntryQueyable**
+    - updated include_reference function.
+
+-----------------------------
+
 *Date: 17-Jun-2020 - initial release*
 
 **v1.0.0**
 ============
 
 - **Stack**
-    - Initialisation of stack has been modified
-    - External config support moved to stack initialisation optional paramters
-    - Added support for whereIn(String key) and whereNotIn(String key) methods in Query
+    - Initialization of the stack has been modified
+    - External config support moved to stack initialization optional parameters
 
 - **Asset**
     - changes incorporated in Asset class.

contentstack/entryqueryable.py

@@ -1,27 +1,14 @@
-import enum
-
-
-class Include(enum.Enum):
-    """
-    Include is enum that Provides Options to perform operation to query the result.
-
-    Available Options for QueryOperation are below.
-    DEFAULT, ONLY, EXCEPT
-
-    Arguments:
-        enum {Include} -- Type of IncludeReference
-    """
-    EXCEPT = 'except'
-    ONLY = 'only'
-    DEFAULT = ''
 
 
 class EntryQueryable:
     """
     This class is base class for the Entry and Query class that shares common functions
     """
+
     def __init__(self):
         self.entry_queryable_param = {}
+        self.entry_include_array = []
+        self.entry_include_dict = {}
 
     def locale(self, locale: str):
         """
@@ -53,7 +40,7 @@ def locale(self, locale: str):
         self.entry_queryable_param['locale'] = locale
         return self
 
-    def only(self, field_uid):
+    def only(self, field_uid: str):
         """
         Specifies an array of only keys in BASE object that would be included in the response.
         It refers to the top-level fields of the schema
@@ -62,57 +49,56 @@ def only(self, field_uid):
             self -- so you can chain this call.
         """
         if field_uid is not None:
-            self.entry_queryable_param['only[BASE][]'] = field_uid
-            return self
+            if isinstance(field_uid, str):
+                self.entry_queryable_param['only[BASE][]'] = [field_uid]
+            else:
+                raise KeyError("Invalid field_uid provided")
+        return self
 
-    def excepts(self, field_uid):
+    def excepts(self, field_uid: str):
         """
         Specifies list of field_uid that would be excluded from the response.
         It refers to the top-level fields of the schema
         :param field_uid: to be excluded from the response.
         :return: self -- so you can chain this call.
         """
         if field_uid is not None:
-            self.entry_queryable_param['except[BASE][]'] = field_uid
-            return self
+            if isinstance(field_uid, str):
+                self.entry_queryable_param['except[BASE][]'] = [field_uid]
+            else:
+                raise KeyError("Invalid field_uid provided")
+        return self
 
-    def include_reference(self, include_reference_type:  Include, reference_field_uid: str, field_uid=None):
+    def include_reference(self, field_uid):
         """
         **Include Reference:**
         When you fetch an entry of a content type that has a reference field,
         by default, the content of the referred entry is not fetched.
         It only fetches the UID of the referred entry, along with the content of
         the specified entry.
 
+        Note: The maximum reference depth limit to which a multiple content type
+        referencing Reference field works is three levels deep
+
         Arguments:
-        reference_field_uid {str} -- Key who has reference to some other class object.
         Array of the only reference keys to be included in response
-        include_type {Include} -- Provides three options, none, only and except
-        i.e accepts list of field_uid
-        field_uid {list} -- list of field_uid on which include operation to perform
+        field_uid {str or list of str} -- [str/list of str] of field_uid on which include operation to perform
 
         Returns:
             self -- So you can chain this call.
         """
-        container = {}
-        if reference_field_uid is None:
-            raise KeyError("reference_field_uid can't be None")
-        if include_reference_type.name == 'DEFAULT':
-            self.entry_queryable_param["include[]"] = reference_field_uid
-        else:
-            container[reference_field_uid] = field_uid
-            self.entry_queryable_param["include[]"] = {include_reference_type.value: container}
+        if field_uid is not None and isinstance(field_uid, str):
+            self.entry_queryable_param["include[]"] = [field_uid]
+        if field_uid is not None and isinstance(field_uid, list) and len(field_uid) > 0:
+            self.entry_queryable_param["include[]"] = field_uid
         return self
 
     def include_content_type(self):
         """
         This method also includes the ContentType in the entry
         :return: self: so you can chain this call.
-
         -------------------------------
-
         [Example: for Entry]
-
             >>> import contentstack
             >>> stack = contentstack.Stack('api_key', 'delivery_token', 'environment')
             >>> content_type = stack.content_type('content_type_uid')

contentstack/https_connection.py

@@ -44,6 +44,7 @@ def user_agents():
 # "pylint doesn't know what's best" - use your own judgement but as a rule.
 class HTTPSConnection:
     """Make Https Request to fetch the result as per requested url"""
+
     def __init__(self, endpoint, headers):
         if None not in (endpoint, headers):
             self.payload = None
@@ -76,10 +77,9 @@ def update_connection_timeout(self, timeout: int):
         """Facilitate to update timeout for the https request"""
         self.default_timeout = timeout
 
-    def get_complete_url(self, base_url: str, params:dict):
+    def get_complete_url(self, base_url: str, params: dict):
         if 'query' in params:
             params["query"] = json.dumps(params["query"])
         query = urlparse.urlencode(params)
         url = '{}&{}'.format(base_url, query)
         return url
-

requirements.txt

@@ -1,28 +1,34 @@
-docutils~=0.15.2
-dnspython~=1.16.0
-idna~=2.9
-pip~=20.1.1
-wheel~=0.33.6
-keyring~=19.2.0
-pytz~=2019.3
+docutils~=0.16
+dnspython~=2.0.0
+idna~=2.10
+pip~=20.2
+wheel~=0.34.2
+keyring~=21.2.1
+pytz~=2020.1
 Babel~=2.8.0
 pkginfo~=1.5.0.1
-MarkupSafe~=1.1.1
-Sphinx~=2.4.3
-packaging~=20.1
-Jinja2~=2.11.1
+MarkupSafe~=2.0.0a1
+Sphinx~=3.1.2
+packaging~=20.4
+Jinja2~=3.0.0a1
 imagesize~=1.2.0
 enum34~=1.1.10
-requests~=2.23.0
+requests~=2.24.0
 snowballstemmer~=2.0.0
-Pygments~=2.4.2
-certifi~=2019.11.28
+Pygments~=2.6.1
+certifi~=2020.6.20
 chardet~=3.0.4
-six~=1.13.0
-toml~=0.10.0
-urllib3~=1.25.8
+six~=1.15.0
+toml~=0.10.1
+urllib3~=1.25.10
 alabaster~=0.7.12
-pyparsing~=2.4.6
-setuptools~=41.6.0
-zipp~=0.6.0
-html-testRunner~=1.2.1
+pyparsing~=3.0.0.a2
+setuptools~=49.2.0
+zipp~=3.1.0
+html-testRunner~=1.2.1
+py~=1.9.0
+pytest~=6.0.1
+attrs~=19.3.0
+pluggy~=1.0.0.dev0
+wcwidth~=0.2.5
+coverage~=5.2.1