Contentstack 2.6.1__py3-none-any.whl → 2.7.0__py3-none-any.whl

contentstack/__init__.py

@@ -42,7 +42,7 @@ def get_contentstack_endpoint(region='us', service='', omit_https=False):
 __title__ = 'contentstack-delivery-python'
 __author__ = 'contentstack'
 __status__ = 'debug'
-__version__ = 'v2.6.1'
+__version__ = 'v2.7.0'
 __endpoint__ = 'cdn.contentstack.io'
 __email__ = 'support@contentstack.com'
 __developer_email__ = 'mobile@contentstack.com'

contentstack/contenttype.py

@@ -119,17 +119,20 @@ class ContentType:
         result = self.http_instance.get(url)
         return result
     
-    def variants(self, variant_uid: str | list[str], params: dict = None):
+    def variants(self, variant_uid: str | list[str], branch: str = None, params: dict = None):
         """
         Fetches the variants of the content type
-        :param variant_uid: {str} -- variant_uid
-        :return: Entry, so you can chain this call.
+        :param variant_uid: {str | list[str]} -- variant UID or list of variant UIDs
+        :param branch: {str} -- optional branch name to scope the variant request
+        :param params: {dict} -- optional query parameters
+        :return: Variants, so you can chain this call.
         """
         return Variants(
             http_instance=self.http_instance,
             content_type_uid=self.__content_type_uid,
             entry_uid=None,
             variant_uid=variant_uid,
+            branch=branch,
             params=params,
             logger=None
         )

contentstack/entry.py

@@ -267,17 +267,20 @@ class Entry(EntryQueryable):
             return merged_response  # Now correctly returns a dictionary
         raise ValueError(ErrorMessages.MISSING_LIVE_PREVIEW_KEYS)
     
-    def variants(self, variant_uid: str | list[str], params: dict = None):
+    def variants(self, variant_uid: str | list[str], branch: str = None, params: dict = None):
         """
         Fetches the variants of the entry
-        :param variant_uid: {str} -- variant_uid
-        :return: Entry, so you can chain this call.
+        :param variant_uid: {str | list[str]} -- variant UID or list of variant UIDs
+        :param branch: {str} -- optional branch name to scope the variant request
+        :param params: {dict} -- optional query parameters
+        :return: Variants, so you can chain this call.
         """
         return Variants(
             http_instance=self.http_instance,
             content_type_uid=self.content_type_id,
             entry_uid=self.entry_uid,
             variant_uid=variant_uid,
+            branch=branch,
             params=params,
             logger=self.logger
         )

contentstack/variants.py

@@ -20,6 +20,7 @@ class Variants(EntryQueryable):
         content_type_uid=None,
         entry_uid=None,
         variant_uid=None,
+        branch=None,
         params=None,
         logger=None):
         
@@ -30,29 +31,47 @@ class Variants(EntryQueryable):
         self.content_type_id = content_type_uid
         self.entry_uid = entry_uid
         self.variant_uid = variant_uid
+        self.branch = branch
         self.logger = logger or logging.getLogger(__name__)
         self.entry_param = params or {}
 
+    def _prepare_variant_headers(self):
+        headers = self.http_instance.headers.copy()
+        if isinstance(self.variant_uid, str):
+            headers['x-cs-variant-uid'] = self.variant_uid
+        elif isinstance(self.variant_uid, list):
+            headers['x-cs-variant-uid'] = ','.join(self.variant_uid)
+        if self.branch is not None:
+            headers['branch'] = self.branch
+        return headers
+
+    def _apply_variant_headers(self, headers):
+        self._original_branch = self.http_instance.headers.get('branch')
+        self.http_instance.headers.update(headers)
+
+    def _cleanup_variant_headers(self):
+        self.http_instance.headers.pop('x-cs-variant-uid', None)
+        if self.branch is not None:
+            if self._original_branch is not None:
+                self.http_instance.headers['branch'] = self._original_branch
+            else:
+                self.http_instance.headers.pop('branch', None)
+
     def find(self, params=None):
         """
         find the variants of the entry of a particular content type
         :param self.variant_uid: {str} -- self.variant_uid
         :return: Entry, so you can chain this call.
         """
-        headers = self.http_instance.headers.copy()  # Create a local copy of headers
-        if isinstance(self.variant_uid, str):
-            headers['x-cs-variant-uid'] = self.variant_uid
-        elif isinstance(self.variant_uid, list):
-            headers['x-cs-variant-uid'] = ','.join(self.variant_uid)
-        
+        headers = self._prepare_variant_headers()
         if params is not None:
             self.entry_param.update(params)
         encoded_params = parse.urlencode(self.entry_param)
         endpoint = self.http_instance.endpoint
         url = f'{endpoint}/content_types/{self.content_type_id}/entries?{encoded_params}'
-        self.http_instance.headers.update(headers)
+        self._apply_variant_headers(headers)
         result = self.http_instance.get(url)
-        self.http_instance.headers.pop('x-cs-variant-uid', None)
+        self._cleanup_variant_headers()
         return result
     
     def fetch(self, params=None):
@@ -77,18 +96,13 @@ class Variants(EntryQueryable):
         if self.entry_uid is None:
             raise ValueError(ErrorMessages.ENTRY_UID_REQUIRED)
         else:
-            headers = self.http_instance.headers.copy()  # Create a local copy of headers
-            if isinstance(self.variant_uid, str):
-                headers['x-cs-variant-uid'] = self.variant_uid
-            elif isinstance(self.variant_uid, list):
-                headers['x-cs-variant-uid'] = ','.join(self.variant_uid)
-            
+            headers = self._prepare_variant_headers()
             if params is not None:
                 self.entry_param.update(params)
             encoded_params = parse.urlencode(self.entry_param)
             endpoint = self.http_instance.endpoint
             url = f'{endpoint}/content_types/{self.content_type_id}/entries/{self.entry_uid}?{encoded_params}'
-            self.http_instance.headers.update(headers)
+            self._apply_variant_headers(headers)
             result = self.http_instance.get(url)
-            self.http_instance.headers.pop('x-cs-variant-uid', None)
+            self._cleanup_variant_headers()
             return result

{contentstack-2.6.1.dist-info → contentstack-2.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Contentstack
-Version: 2.6.1
+Version: 2.7.0
 Summary: Contentstack is a headless CMS with an API-first approach.
 Home-page: https://github.com/contentstack/contentstack-python
 Author: Contentstack

{contentstack-2.6.1.dist-info → contentstack-2.7.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
-contentstack/__init__.py,sha256=4QJgp8OIVJv_gGHltFImLtKzsWsUCV5w2-2d0hPL98I,1680
+contentstack/__init__.py,sha256=NmvbcorWEY3S0_88qIp1zL_qO0QU72ixtpGoidn2Qps,1680
 contentstack/asset.py,sha256=GY-eC9Tg2uEDr9S7ggXCcrMjIdkcQGkP4UNgTfIqFs0,6977
 contentstack/assetquery.py,sha256=FisGJ02MmH4sYvnHEJhYj4OWZBRORV8iKy38PdzLtxY,7954
 contentstack/basequery.py,sha256=c_A7Pi45OHHfCpd8_ZjcIYAy9mhZ7CXlbBiZ4Plnu3M,6605
-contentstack/contenttype.py,sha256=mEj94nZMY5pGsAMUPt4Xs5gagrFU1vKSfOq7u_Aho4Y,5422
+contentstack/contenttype.py,sha256=16gz2NmS2U8FAT7phRf5UeKDjGAM3JNcIRcP3EDyO5Y,5649
 contentstack/controller.py,sha256=kcFnVdvFJk6_HYgK60-cUgyEK3C1UlD98zv108JtcVI,1095
 contentstack/deep_merge_lp.py,sha256=PIRGo5Dv60g4hzBY__nOrIAKgIx1Pd36gGzxnM5gZK4,1575
 contentstack/endpoint.py,sha256=8ZTPDlpQ0C1oa3EgU_nbcHjFeQ5Chgen8viUFCVGk3w,6579
-contentstack/entry.py,sha256=EVJ89VHF40P5Kv_GSKvQaL3IoNFvxrEur12ucrTMC2k,12320
+contentstack/entry.py,sha256=j3YPTxAevwpolOtKShTn4mdaMFyUkAE4koz8FrTqkFM,12547
 contentstack/entryqueryable.py,sha256=4YBX4N6tNSPMavrPxzM26RFBH8Qi6pIalIu-KEdVOtE,9828
 contentstack/error_messages.py,sha256=Qep3wvN2Rl0lb1UIRGCjzpHBGnpXaortaescCdNuMHY,3334
 contentstack/globalfields.py,sha256=APhIpiAVJ2v7Illh6yS4-S6W8yEzXBtYpAaPUKD-XuQ,2865
@@ -17,9 +17,9 @@ contentstack/region_refresh.py,sha256=zXwsMwVMSMb7duhqhV_Zx5aOHqsQE_6pnSppPLVteW
 contentstack/stack.py,sha256=Xu7iS117AL3q1vhlYNEC97lPho91yrGxBiwk0htAZU8,16948
 contentstack/taxonomy.py,sha256=g6zey4MkoeQqxRlHLSuzbA2NfbphgogGBXAwk28P5KI,2339
 contentstack/utility.py,sha256=qZWckUMZZh4F80A7gV9qHn9QKOhr099M8FiJKxtxdao,3169
-contentstack/variants.py,sha256=9qFGU6VsUcYEDTNjSUPJxnevXw2S8xflnDDIyk2Cmak,3757
-contentstack-2.6.1.dist-info/licenses/LICENSE,sha256=BF_N9KC72HmX8HTAJROoPoFrW6xmO3rlbqpfjxmli08,1099
-contentstack-2.6.1.dist-info/METADATA,sha256=SRI0uOJBjoZm1a0STnjCpQ9wwUVHgMm-DLfuOw04cS8,9346
-contentstack-2.6.1.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-contentstack-2.6.1.dist-info/top_level.txt,sha256=jMUc8tWMXdbMFbvosYZ-vHWHrsLFWeHgrWQytLTVZf4,13
-contentstack-2.6.1.dist-info/RECORD,,
+contentstack/variants.py,sha256=lNaiPfx9126MmlNvlALEomX5z0I8Q0YhqqwhMt2fHH8,4130
+contentstack-2.7.0.dist-info/licenses/LICENSE,sha256=BF_N9KC72HmX8HTAJROoPoFrW6xmO3rlbqpfjxmli08,1099
+contentstack-2.7.0.dist-info/METADATA,sha256=i4cIZqwb8HJ_13JglAroRsxUvjG5OKQU0HBH9mE62Mw,9346
+contentstack-2.7.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+contentstack-2.7.0.dist-info/top_level.txt,sha256=jMUc8tWMXdbMFbvosYZ-vHWHrsLFWeHgrWQytLTVZf4,13
+contentstack-2.7.0.dist-info/RECORD,,