added skeleton filtering to project methods

Author: iLLiCiTiT

ayon_api/_api_helpers/projects.py

@@ -174,6 +174,7 @@ def get_rest_projects(
         self,
         active: Optional[bool] = True,
         library: Optional[bool] = None,
+        skeleton: bool = False,
     ) -> Generator[ProjectDict, None, None]:
         """Query available project entities.
 
@@ -184,12 +185,13 @@ def get_rest_projects(
                 are returned if 'None' is passed.
             library (Optional[bool]): Filter standard/library projects. Both
                 are returned if 'None' is passed.
+            skeleton (bool): Include skeleton projects.
 
         Returns:
             Generator[ProjectDict, None, None]: Available projects.
 
         """
-        for project_name in self.get_project_names(active, library):
+        for project_name in self.get_project_names(active, library, skeleton):
             project = self.get_rest_project(project_name)
             if project:
                 yield project
@@ -198,6 +200,7 @@ def get_rest_projects_list(
         self,
         active: Optional[bool] = True,
         library: Optional[bool] = None,
+        skeleton: bool = False,
     ) -> list[ProjectListDict]:
         """Receive available projects.
 
@@ -208,6 +211,7 @@ def get_rest_projects_list(
                 are returned if 'None' is passed.
             library (Optional[bool]): Filter standard/library projects. Both
                 are returned if 'None' is passed.
+            skeleton (bool): Include skeleton projects.
 
         Returns:
             list[ProjectListDict]: List of available projects.
@@ -219,10 +223,14 @@ def get_rest_projects_list(
         if library is not None:
             library = "true" if library else "false"
 
-        query = prepare_query_string({
+        query_data = {
             "active": active,
             "library": library,
-        })
+        }
+        if skeleton:
+            query_data["skeleton"] = "true"
+
+        query = prepare_query_string(query_data)
         response = self.get(f"projects{query}")
         response.raise_for_status()
         data = response.data
@@ -232,6 +240,7 @@ def get_project_names(
         self,
         active: Optional[bool] = True,
         library: Optional[bool] = None,
+        skeleton: bool = False,
     ) -> list[str]:
         """Receive available project names.
 
@@ -242,20 +251,24 @@ def get_project_names(
                 are returned if 'None' is passed.
             library (Optional[bool]): Filter standard/library projects. Both
                 are returned if 'None' is passed.
+            skeleton (bool): Include skeleton projects.
 
         Returns:
             list[str]: List of available project names.
 
         """
         return [
             project["name"]
-            for project in self.get_rest_projects_list(active, library)
+            for project in self.get_rest_projects_list(
+                active, library, skeleton
+            )
         ]
 
     def get_projects(
         self,
         active: Optional[bool] = True,
         library: Optional[bool] = None,
+        skeleton: bool = False,
         fields: Optional[Iterable[str]] = None,
         own_attributes: bool = False,
     ) -> Generator[ProjectDict, None, None]:
@@ -280,14 +293,15 @@ def get_projects(
 
         graphql_fields, fetch_type = self._get_project_graphql_fields(fields)
         if fetch_type == ProjectFetchType.RESTList:
-            yield from self.get_rest_projects_list(active, library)
+            yield from self.get_rest_projects_list(active, library, skeleton)
             return
 
         projects_by_name = {}
         if graphql_fields:
             projects = list(self._get_graphql_projects(
                 active,
                 library,
+                skeleton=skeleton,
                 fields=graphql_fields,
                 own_attributes=own_attributes,
             ))
@@ -296,7 +310,9 @@ def get_projects(
                 return
             projects_by_name = {p["name"]: p for p in projects}
 
-        for project in self.get_rest_projects(active=active, library=library):
+        for project in self.get_rest_projects(
+            active=active, library=library, skeleton=skeleton
+        ):
             if own_attributes:
                 fill_own_attribs(project)
 
@@ -356,6 +372,8 @@ def create_project(
         project_code: str,
         library_project: bool = False,
         preset_name: Optional[str] = None,
+        data: dict[str, Any] | None = None,
+        skeleton: bool = False,
     ) -> ProjectDict:
         """Create project using AYON settings.
 
@@ -375,6 +393,8 @@ def create_project(
             library_project (Optional[bool]): Project is library project.
             preset_name (Optional[str]): Name of anatomy preset. Default is
                 used if not passed.
+            data (dict[str, Any]): Project data.
+            skeleton (bool): Project is skeleton project.
 
         Raises:
             ValueError: When project name already exists.
@@ -395,12 +415,19 @@ def create_project(
 
         preset = self.get_project_anatomy_preset(preset_name)
 
+        if data is None:
+            data = {}
+
+        if skeleton:
+            data["skeleton"] = True
+
         result = self.post(
             "projects",
             name=project_name,
             code=project_code,
             anatomy=preset,
-            library=library_project
+            library=library_project,
+            data=data,
         )
 
         if result.status != 201:
@@ -858,8 +885,9 @@ def _fill_project_entity_data(self, project: dict[str, Any]) -> None:
 
     def _get_graphql_projects(
         self,
-        active: Optional[bool],
-        library: Optional[bool],
+        active: bool | None,
+        library: bool | None,
+        skeleton: bool,
         fields: set[str],
         own_attributes: bool,
         project_name: Optional[str] = None
@@ -876,6 +904,9 @@ def _get_graphql_projects(
         if project_name is not None:
             query.set_variable_value("projectName", project_name)
 
+        if skeleton:
+            query.set_variable_value("skeleton", True)
+
         attributes = {}
         if "allAttrib" in fields:
             attributes = self.get_attributes_for_type("project")

ayon_api/graphql_queries.py

@@ -91,8 +91,10 @@ def project_graphql_query(fields):
 def projects_graphql_query(fields):
     query = GraphQlQuery("ProjectsQuery")
     project_name_var = query.add_variable("projectName", "String!")
+    skeleton_var = query.add_variable("skeleton", "Boolean!")
     projects_field = query.add_field_with_edges("projects")
     projects_field.set_filter("name", project_name_var)
+    projects_field.set_filter("includeSkeleton", skeleton_var)
 
     nested_fields = fields_to_dict(fields)