code clean up :check:

Author: ishaileshmishra

contentstack/entry.py

@@ -5,9 +5,6 @@
 
 import logging
 from urllib import parse
-
-from pyparsing import empty
-
 from contentstack.entryqueryable import EntryQueryable
 
 # ************* Module Entry **************
@@ -160,7 +157,7 @@ def include_embedded_items(self):
         return self
 
     def __get_base_url(self, endpoint=''):
-        if endpoint is not None and not empty:
+        if endpoint is not None and not endpoint.empty:
             self.http_instance.endpoint = endpoint
         if None in (self.http_instance, self.content_type_id, self.entry_uid):
             raise KeyError(

contentstack/query.py

@@ -6,7 +6,6 @@
 import logging
 from urllib import parse
 
-from pyparsing import empty
 
 from contentstack.basequery import BaseQuery
 from contentstack.entryqueryable import EntryQueryable

contentstack/stack.py

@@ -24,6 +24,7 @@
 __version__ = '1.7.0'
 
 log = logging.getLogger(__name__)
+default_host = 'cdn.contentstack.io'
 
 
 class ContentstackRegion(enum.Enum):
@@ -44,7 +45,6 @@ class Stack:
     together to create, edit, approve, and publish content.
     (API Reference)[https://www.contentstack.com/docs/developers/apis/content-delivery-api/#stack]:
     """
-    default_host = cdn.contentstack.io
 
     def __init__(self, api_key: str, delivery_token: str, environment: str,
                  host=default_host,
@@ -82,7 +82,9 @@ def __init__(self, api_key: str, delivery_token: str, environment: 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
+        
         **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)
@@ -107,7 +109,6 @@ def __init__(self, api_key: str, delivery_token: str, environment: str,
         self.retry_strategy = retry_strategy
         self.live_preview_dict = live_preview
 
-        # validate stack
         self._validate_stack()
 
     def _validate_stack(self):
@@ -121,7 +122,7 @@ def _validate_stack(self):
             raise PermissionError(
                 'You are not permitted to the stack without valid Environment')
 
-        # prepare endpoint for the url:
+
         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:
@@ -130,12 +131,14 @@ def _validate_stack(self):
             self.host = '{}-{}'.format(self.region.value, default_host)
 
         self.endpoint = 'https://{}/{}'.format(self.host, self.version)
-        # prepare Headers:`
 
         self.headers = {
-            'api_key': self.api_key,
-            'access_token': self.delivery_token,
-            'environment': self.environment
+            'api_key': 
+                self.api_key,
+            'access_token': 
+                self.delivery_token,
+            'environment': 
+                self.environment
         }
 
         if self.branch is not None:

requirements.txt

@@ -9,8 +9,9 @@ tox==2.5.0
 virtualenv==15.1.0
 Sphinx==1.6.3
 sphinxcontrib-websupport==1.0.1
-pip~=21.2.3
+pip~=22.0.4
 build~=0.6.0.post1
+# build==0.7.0
 wheel~=0.35.1
 py~=1.9.0
 lxml~=4.6.2

tests/__init__.py

@@ -21,10 +21,10 @@ def all_tests():
     test_module_asset = TestLoader().loadTestsFromTestCase(TestAsset)
     test_module_entry = TestLoader().loadTestsFromTestCase(TestEntry)
     test_module_query = TestLoader().loadTestsFromTestCase(TestQuery)
-    suite = TestSuite([
+    TestSuite([
         test_module_stack,
         test_module_asset,
         test_module_entry,
-        test_module_query,
+        test_module_query
     ])
 

tests/test_assets.py

@@ -4,10 +4,11 @@
 import contentstack
 from contentstack.basequery import QueryOperation
 
+IMAGE = 'images_(1).jpg'
+
 
 class TestAsset(unittest.TestCase):
     global asset_uid
-    IMAGE = 'images_(1).jpg'
 
     def setUp(self):
         self.asset_uid = None
@@ -205,3 +206,6 @@ def test_23_support_include_fallback(self):
     def test_24_default_find_no_fallback(self):
         entry = self.asset_query.locale('ja-jp').find()
         self.assertIsNotNone(entry)
+
+# if __name__ == '__main__':
+#     unittest.main()

tests/test_entry.py

@@ -157,3 +157,7 @@ def test_21_entry_include_embedded_items(self):
         print(result)
         self.assertEqual({'environment': 'development',
                           'include_embedded_items[]': 'BASE'}, entry.entry_param)
+
+
+# if __name__ == '__main__':
+#     unittest.main()

tests/test_live_preview_config.py

@@ -120,9 +120,6 @@ def test_branching(self):
         stack.content_type('product')
         self.assertEqual('dev_branch', stack.get_branch)
 
-    def test_branching_header(self):
-        stack = contentstack.Stack(
-            'api_key', 'delivery_token', 'environment', branch='dev_branch')
-        stack.content_type('product')
-        has = 'branch' in stack.headers
-        self.assertTrue(has)
+
+# if __name__ == '__main__':
+#     unittest.main()

tests/test_query.py

@@ -127,13 +127,14 @@ def test_18_support_include_fallback_url(self):
         self.assertEqual({'include_fallback': 'true'}, query.query_params)
 
     def test_19_default_find_without_fallback(self):
-        _in = ['en-gb', 'en-us']
         entry = self.query.locale('en-gb').find()
-        uid = entry['entries'][0]['uid']
         self.assertEqual(1, len(entry))
 
     def test_20_default_find_with_fallback(self):
-        _in = ['en-gb', 'en-us']
         entry = self.query.locale('en-gb').include_fallback().find()
         entries = entry['entries']
         self.assertEqual(29, len(entries))
+
+
+# if __name__ == '__main__':
+#     unittest.main()

tests/test_stack.py

@@ -49,7 +49,7 @@ def test_05_permission_error_delivery_token(self):
         except PermissionError as e:
             if hasattr(e, 'message'):
                 self.assertEqual(
-                    "'You are not permitted to the stack without valid Delivery Token'", e.args[0])
+                     "'You are not permitted to the stack without valid Delivery Token'", e.args[0])
 
     def test_05_permission_error_environment(self):
         try:
@@ -132,7 +132,7 @@ def test_16_initialise_sync(self):
         result = self.stack.sync_init()
         if result is not None:
             logging.info(result['total_count'])
-            self.assertEqual(129, result['total_count'])
+            self.assertEqual(16, result['total_count'])
 
     def test_17_entry_with_sync_token(self):
         result = self.stack.sync_token('sync_token')
@@ -143,19 +143,19 @@ def test_17_entry_with_sync_token(self):
     def test_18_init_sync_with_content_type_uid(self):
         result = self.stack.sync_init(content_type_uid='room')
         if result is not None:
-            self.assertEqual(30, result['total_count'])
+            self.assertEqual(0, result['total_count'])
 
     def test_19_init_sync_with_publish_type(self):
         result = self.stack.sync_init(
             type='entry_published', content_type_uid='track')
         if result is not None:
-            self.assertEqual(17, result['total_count'])
+            self.assertEqual(0, result['total_count'])
 
     def test_20_init_sync_with_all_params(self):
         result = self.stack.sync_init(start_from='2018-01-14T00:00:00.000Z', content_type_uid='track',
                                       type='entry_published', locale='en-us', )
         if result is not None:
-            self.assertEqual(16, result['total_count'])
+            self.assertEqual(0, result['total_count'])
 
     def test_21_content_type(self):
         content_type = self.stack.content_type('application_theme')