For #28441: added support + tests for 'include_template_projects' flag

Author: nemoDreamer

shotgun_api3/shotgun.py

@@ -162,6 +162,13 @@ def ensure_include_archived_projects(self):
             'label': 'include_archived_projects parameter'
         })
 
+    def ensure_include_template_projects(self):
+        """Wrapper for ensure_support"""
+        self._ensure_support({
+            'version': (6, 0, 0),
+            'label': 'include_template_projects parameter'
+        })
+
 
     def __str__(self):
         return "ServerCapabilities: host %s, version %s, is_dev %s"\
@@ -426,7 +433,8 @@ def info(self):
         return self._call_rpc("info", None, include_auth_params=False)
 
     def find_one(self, entity_type, filters, fields=None, order=None,
-        filter_operator=None, retired_only=False, include_archived_projects=True):
+        filter_operator=None, retired_only=False,
+        include_archived_projects=True, include_template_projects=False):
         """Calls the find() method and returns the first result, or None.
 
         :param entity_type: Required, entity type (string) to find.
@@ -445,24 +453,34 @@ def find_one(self, entity_type, filters, fields=None, order=None,
         :param limit: Optional, number of entities to return per page.
         Defaults to 0 which returns all entities that match.
 
-        :param page: Optional, page of results to return. By default all
-        results are returned. Use together with limit.
-
         :param retired_only: Optional, flag to return only entities that have
         been retried. Defaults to False which returns only entities which
         have not been retired.
+
+        :param page: Optional, page of results to return. By default all
+        results are returned. Use together with limit.
+
+        :param include_archived_projects: Optional, flag to include entities
+        whose projects have been archived. Default: True
+
+        :param include_template_projects: Optional, flag to include entities
+        belonging to template projects. Default: False
+
+        :returns: Result
         """
 
         results = self.find(entity_type, filters, fields, order,
-            filter_operator, 1, retired_only, include_archived_projects=include_archived_projects)
+            filter_operator, 1, retired_only,
+            include_archived_projects=include_archived_projects,
+            include_template_projects=include_template_projects)
 
         if results:
             return results[0]
         return None
 
     def find(self, entity_type, filters, fields=None, order=None,
             filter_operator=None, limit=0, retired_only=False, page=0,
-            include_archived_projects=True):
+            include_archived_projects=True, include_template_projects=False):
         """Find entities matching the given filters.
 
         :param entity_type: Required, entity type (string) to find.
@@ -489,7 +507,10 @@ def find(self, entity_type, filters, fields=None, order=None,
         have not been retired.
 
         :param include_archived_projects: Optional, flag to include entities
-        whose projects have been archived
+        whose projects have been archived. Default: True
+
+        :param include_template_projects: Optional, flag to include entities
+        belonging to template projects. Default: False
 
         :returns: list of the dicts for each entity with the requested fields,
         and their id and type.
@@ -513,13 +534,19 @@ def find(self, entity_type, filters, fields=None, order=None,
             # So we only need to check the server version if it is False
             self.server_caps.ensure_include_archived_projects()
 
+        if include_template_projects:
+            # This defaults to False on the server (no argument is sent)
+            # So we only need to check the server version if it is True
+            self.server_caps.ensure_include_template_projects()
+
 
         params = self._construct_read_parameters(entity_type,
                                                  fields,
                                                  filters,
                                                  retired_only,
                                                  order,
-                                                 include_archived_projects)
+                                                 include_archived_projects,
+                                                 include_template_projects)
 
         if limit and limit <= self.config.records_per_page:
             params["paging"]["entities_per_page"] = limit
@@ -563,7 +590,8 @@ def _construct_read_parameters(self,
                                    filters,
                                    retired_only,
                                    order,
-                                   include_archived_projects):
+                                   include_archived_projects,
+                                   include_template_projects):
         params = {}
         params["type"] = entity_type
         params["return_fields"] = fields or ["id"]
@@ -577,6 +605,10 @@ def _construct_read_parameters(self,
             # Defaults to True on the server, so only pass it if it's False
             params["include_archived_projects"] = False
 
+        if include_template_projects is True:
+            # Defaults to False on the server, so only pass it if it's True
+            params["include_template_projects"] = True
+
         if order:
             sort_list = []
             for sort in order:
@@ -597,7 +629,8 @@ def summarize(self,
                   summary_fields,
                   filter_operator=None,
                   grouping=None,
-                  include_archived_projects=True):
+                  include_archived_projects=True,
+                  include_template_projects=False):
         """
         Return group and summary information for entity_type for summary_fields
         based on the given filters.
@@ -610,19 +643,24 @@ def summarize(self,
         if isinstance(filters, (list, tuple)):
             filters = _translate_filters(filters, filter_operator)
 
-        if not include_archived_projects:
-            # This defaults to True on the server (no argument is sent)
-            # So we only need to check the server version if it is False
-            self.server_caps.ensure_include_archived_projects()
-
         params = {"type": entity_type,
                   "summaries": summary_fields,
                   "filters": filters}
 
-        if include_archived_projects is False:
-            # Defaults to True on the server, so only pass it if it's False
+        if not include_archived_projects:
+            # This defaults to True on the server (no argument is sent)
+            # So we only need to check the server version if it is False
+            self.server_caps.ensure_include_archived_projects()
+            # Only pass it if it's False
             params["include_archived_projects"] = False
 
+        if include_template_projects:
+            # This defaults to False on the server (no argument is sent)
+            # So we only need to check the server version if it is True
+            self.server_caps.ensure_include_template_projects()
+            # Only pass it if it's True
+            params["include_template_projects"] = True
+
         if grouping != None:
             params['grouping'] = grouping
 

tests/test_api.py

@@ -439,7 +439,7 @@ def test_simple_summary(self):
         assert(result['groups'][0]['summaries'])
         assert(result['summaries'])
 
-    def test_summary_include_archived_projects(self):
+    def _test_summary_include_archived_projects(self):
         if self.sg.server_caps.version > (5, 3, 13):
             # archive project
             self.sg.update('Project', self.project['id'], {'archived':True})
@@ -1345,7 +1345,7 @@ def test_zero_is_not_none(self):
         result = self.sg.find_one( 'Asset', [['id','is',self.asset['id']],[num_field, 'is_not', None]] ,[num_field] )
         self.assertFalse(result == None)
 
-    def test_include_archived_projects(self):
+    def _test_include_archived_projects(self):
         if self.sg.server_caps.version > (5, 3, 13):
             # Ticket #25082
             result = self.sg.find_one('Shot', [['id','is',self.shot['id']]])

tests/test_flags.py

@@ -0,0 +1,127 @@
+"""Test using the Shotgun API flags."""
+
+import shotgun_api3
+from shotgun_api3.lib.httplib2 import Http
+
+import base
+
+class TestFlags(base.LiveTestBase):
+    def setUp(self):
+        super(TestFlags, self).setUp()
+        # We will need the created_at field for the shot
+        fields = self.shot.keys()[:]
+        fields.append('created_at')
+        self.shot = self.sg.find_one('Shot', [['id', 'is', self.shot['id']]], fields)
+        # We will need the uuid field for our LocalStorage
+        fields = self.local_storage.keys()[:]
+        fields.append('uuid')
+        self.local_storage = self.sg.find_one('LocalStorage', [['id', 'is', self.local_storage['id']]], fields)
+
+    def test_summary_include_archived_projects(self):
+        """Test summary with 'include_archived_projects'"""
+
+        if self.sg.server_caps.version > (5, 3, 13):
+            # Ticket #25082 ability to hide archived projects in summary
+
+            # archive project
+            self.sg.update('Project', self.project['id'], {'archived':True})
+
+            summaries = [{'field': 'id', 'type': 'count'}]
+            grouping = [{'direction': 'asc', 'field': 'id', 'type': 'exact'}]
+            filters = [['project', 'is', self.project]]
+
+            # setting defaults to False, so we should get result
+            result = self.sg.summarize('Shot',
+                                       filters=filters,
+                                       summary_fields=summaries,
+                                       grouping=grouping)
+            self.assertEqual(result['summaries']['id'],  1)
+
+            # should get no result
+            result = self.sg.summarize('Shot',
+                                       filters=filters,
+                                       summary_fields=summaries,
+                                       grouping=grouping,
+                                       include_archived_projects=False)
+            self.assertEqual(result['summaries']['id'],  0)
+
+            # reset project
+            self.sg.update('Project', self.project['id'], {'archived':False})
+
+    def test_summary_include_template_projects(self):
+        """Test summary with 'include_template_projects'"""
+
+        if self.sg.server_caps.version > (6, 0, 0):
+            # Ticket #28441
+
+            # set as template project
+            self.sg.update('Project', self.project['id'], {'template':True})
+
+            summaries = [{'field': 'id', 'type': 'count'}]
+            grouping = [{'direction': 'asc', 'field': 'id', 'type': 'exact'}]
+            filters = [['project', 'is', self.project]]
+
+            # setting defaults to False, so we should get no result
+            result = self.sg.summarize('Shot',
+                                       filters=filters,
+                                       summary_fields=summaries,
+                                       grouping=grouping)
+            self.assertEqual(result['summaries']['id'],  0)
+
+            # should get result
+            result = self.sg.summarize('Shot',
+                                       filters=filters,
+                                       summary_fields=summaries,
+                                       grouping=grouping,
+                                       include_template_projects=False)
+            self.assertEqual(result['summaries']['id'],  1)
+
+            # reset project
+            self.sg.update('Project', self.project['id'], {'template':False})
+
+    def test_include_archived_projects(self):
+        """Test find with 'include_archived_projects'"""
+
+        if self.sg.server_caps.version > (5, 3, 13):
+            # Ticket #25082
+
+            result = self.sg.find_one('Shot', [['id','is',self.shot['id']]])
+            self.assertEquals(self.shot['id'], result['id'])
+
+            # archive project 
+            self.sg.update('Project', self.project['id'], {'archived':True})
+
+            # setting defaults to True, so we should get result
+            result = self.sg.find_one('Shot', [['id','is',self.shot['id']]])
+            self.assertEquals(self.shot['id'], result['id'])
+
+            # should get no result
+            result = self.sg.find_one('Shot', [['id','is',self.shot['id']]], include_archived_projects=False)
+            self.assertEquals(None, result)
+
+            # reset project
+            self.sg.update('Project', self.project['id'], {'archived':False})
+
+    def test_include_template_projects(self):
+        """Test find with 'include_template_projects'"""
+
+        if self.sg.server_caps.version > (6, 0, 0):
+            # Ticket #28441
+
+            result = self.sg.find_one('Shot', [['id','is',self.shot['id']]])
+            self.assertEquals(self.shot['id'], result['id'])
+
+            # set as template project 
+            self.sg.update('Project', self.project['id'], {'is_template':True})
+
+            # setting defaults to False, so we should not get result
+            result = self.sg.find_one('Shot', [['id','is',self.shot['id']]])
+            self.assertEquals(None, result)
+
+            # should get result
+            result = self.sg.find_one('Shot', [['id','is',self.shot['id']]], include_template_projects=True)
+            self.assertEquals(self.shot['id'], result['id'])
+
+            # reset project
+            self.sg.update('Project', self.project['id'], {'is_template':False})
+