Added variants support in Python CDA SDK

Author: sunil-lakshman

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## _v2.2.0_
+
+### **Date: 14-July-2025**
+
+- Variants Support Added.
+
 ## _v2.1.1_
 
 ### **Date: 07-July-2025**

contentstack/__init__.py

@@ -22,7 +22,7 @@
 __title__ = 'contentstack-delivery-python'
 __author__ = 'contentstack'
 __status__ = 'debug'
-__version__ = 'v2.1.1'
+__version__ = 'v2.2.0'
 __endpoint__ = 'cdn.contentstack.io'
 __email__ = 'support@contentstack.com'
 __developer_email__ = 'mobile@contentstack.com'

contentstack/contenttype.py

@@ -118,3 +118,23 @@ def find(self, params=None):
         url = f'{endpoint}/content_types?{encoded_params}'
         result = self.http_instance.get(url)
         return result
+    
+    def variants(self, variant_uid: str | list[str], params: dict = None):
+        """
+        Fetches the variants of the content type
+        :param variant_uid: {str} -- variant_uid
+        :return: Entry, so you can chain this call.
+        """
+        if isinstance(variant_uid, str):
+            self.http_instance.headers['x-cs-variant-uid'] = variant_uid
+        elif isinstance(variant_uid, list):
+            self.http_instance.headers['x-cs-variant-uid'] = ','.join(variant_uid)
+        
+        if params is not None:
+            self.local_param.update(params)
+        
+        encoded_params = parse.urlencode(self.local_param)
+        endpoint = self.http_instance.endpoint
+        url = f'{endpoint}/content_types/{self.__content_type_uid}/entries?{encoded_params}'
+        result = self.http_instance.get(url)
+        return result

contentstack/entry.py

@@ -222,6 +222,26 @@ def _merged_response(self):
             merged_response = DeepMergeMixin(entry_response, lp_entry).to_dict()  # Convert to dictionary
             return merged_response  # Now correctly returns a dictionary
         raise ValueError("Missing required keys in live_preview data")
+    
+    def variants(self, variant_uid: str | list[str], params: dict = None):
+        """
+        Fetches the variants of the entry
+        :param variant_uid: {str} -- variant_uid
+        :return: Entry, so you can chain this call.
+        """
+        if isinstance(variant_uid, str):
+            self.http_instance.headers['x-cs-variant-uid'] = variant_uid
+        elif isinstance(variant_uid, list):
+            self.http_instance.headers['x-cs-variant-uid'] = ','.join(variant_uid)
+        
+        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}'
+        result = self.http_instance.get(url)
+        return result
+
 
 
 

tests/test_entry.py

@@ -8,7 +8,7 @@
 ENVIRONMENT = config.ENVIRONMENT
 HOST = config.HOST
 FAQ_UID = config.FAQ_UID  # Add this in your config.py
-
+VARIANT_UID = config.VARIANT_UID
 
 class TestEntry(unittest.TestCase):
 
@@ -134,6 +134,28 @@ def test_22_entry_include_metadata(self):
         content_type = self.stack.content_type('faq')
         entry = content_type.entry("878783238783").include_metadata()
         self.assertEqual({'include_metadata': 'true'}, entry.entry_queryable_param)
+                
+    def test_23_content_type_variants(self):
+        content_type = self.stack.content_type('faq')
+        entry = content_type.variants(VARIANT_UID)
+        self.assertIn('variants', entry['entries'][0]['publish_details'])
+        
+    def test_24_entry_variants(self):
+        content_type = self.stack.content_type('faq')
+        entry = content_type.entry(FAQ_UID).variants(VARIANT_UID)
+        self.assertIn('variants', entry['entry']['publish_details'])
+        
+    def test_25_content_type_variants_with_has_hash_variant(self):
+        content_type = self.stack.content_type('faq')
+        entry = content_type.variants([VARIANT_UID])
+        self.assertIn('variants', entry['entries'][0]['publish_details'])
+        
+    def test_25_content_type_entry_variants_with_has_hash_variant(self):
+        content_type = self.stack.content_type('faq').entry(FAQ_UID)
+        entry = content_type.variants([VARIANT_UID])
+        self.assertIn('variants', entry['entry']['publish_details'])
+        
+        
 
 
 if __name__ == '__main__':