Kitsu: Use query function from client

openpype/modules/kitsu/utils/sync_service.py

@@ -2,11 +2,16 @@
 
 import gazu
 
+from openpype.client import (
+ get_project,
+ get_assets
+)
 from openpype.pipeline import AvalonMongoDB
 from .credentials import validate_credentials
 from .update_op_with_zou import (
  create_op_asset,
  set_op_project,
+ get_kitsu_project_name,
  write_project_to_op,
  update_op_assets,
 )
@@ -119,17 +124,16 @@ def _update_project(self, data):
 
  # Write into DB
  if update_project:
- self.dbcon = self.dbcon.database[project_name]
+ self.dbcon.Session["AVALON_PROJECT"] = project_name
  self.dbcon.bulk_write([update_project])
 
  def _delete_project(self, data):
  """Delete project."""
- project_doc = self.dbcon.find_one(
- {"type": "project", "data.zou_id": data["project_id"]}
- )
+
+ project_name = get_kitsu_project_name(data["project_id"])
 
  # Delete project collection
- self.dbcon.database[project_doc["name"]].drop()
+ self.dbcon.database[project_name].drop()
 
  # == Asset ==
 
@@ -150,7 +154,8 @@ def _new_asset(self, data):
  def _update_asset(self, data):
  """Update asset into OP DB."""
  set_op_project(self.dbcon, data["project_id"])
- project_doc = self.dbcon.find_one({"type": "project"})
+ project_name = self.dbcon.active_project()
+ project_doc = get_project(project_name)
 
  # Get gazu entity
  asset = gazu.asset.get_asset(data["asset_id"])
@@ -159,7 +164,7 @@ def _update_asset(self, data):
  # Query all assets of the local project
  zou_ids_and_asset_docs = {
  asset_doc["data"]["zou"]["id"]: asset_doc
- for asset_doc in self.dbcon.find({"type": "asset"})
+ for asset_doc in get_assets(project_name)
  if asset_doc["data"].get("zou", {}).get("id")
  }
  zou_ids_and_asset_docs[asset["project_id"]] = project_doc
@@ -199,7 +204,8 @@ def _new_episode(self, data):
  def _update_episode(self, data):
  """Update episode into OP DB."""
  set_op_project(self.dbcon, data["project_id"])
- project_doc = self.dbcon.find_one({"type": "project"})
+ project_name = self.dbcon.active_project()
+ project_doc = get_project(project_name)
 
  # Get gazu entity
  episode = gazu.shot.get_episode(data["episode_id"])
@@ -208,7 +214,7 @@ def _update_episode(self, data):
  # Query all assets of the local project
  zou_ids_and_asset_docs = {
  asset_doc["data"]["zou"]["id"]: asset_doc
- for asset_doc in self.dbcon.find({"type": "asset"})
+ for asset_doc in get_assets(project_name)
  if asset_doc["data"].get("zou", {}).get("id")
  }
  zou_ids_and_asset_docs[episode["project_id"]] = project_doc
@@ -249,7 +255,8 @@ def _new_sequence(self, data):
  def _update_sequence(self, data):
  """Update sequence into OP DB."""
  set_op_project(self.dbcon, data["project_id"])
- project_doc = self.dbcon.find_one({"type": "project"})
+ project_name = self.dbcon.active_project()
+ project_doc = get_project(project_name)
 
  # Get gazu entity
  sequence = gazu.shot.get_sequence(data["sequence_id"])
@@ -258,7 +265,7 @@ def _update_sequence(self, data):
  # Query all assets of the local project
  zou_ids_and_asset_docs = {
  asset_doc["data"]["zou"]["id"]: asset_doc
- for asset_doc in self.dbcon.find({"type": "asset"})
+ for asset_doc in get_assets(project_name)
  if asset_doc["data"].get("zou", {}).get("id")
  }
  zou_ids_and_asset_docs[sequence["project_id"]] = project_doc
@@ -299,7 +306,8 @@ def _new_shot(self, data):
  def _update_shot(self, data):
  """Update shot into OP DB."""
  set_op_project(self.dbcon, data["project_id"])
- project_doc = self.dbcon.find_one({"type": "project"})
+ project_name = self.dbcon.active_project()
+ project_doc = get_project(project_name)
 
  # Get gazu entity
  shot = gazu.shot.get_shot(data["shot_id"])
@@ -308,7 +316,7 @@ def _update_shot(self, data):
  # Query all assets of the local project
  zou_ids_and_asset_docs = {
  asset_doc["data"]["zou"]["id"]: asset_doc
- for asset_doc in self.dbcon.find({"type": "asset"})
+ for asset_doc in get_assets(project_name)
  if asset_doc["data"].get("zou", {}).get("id")
  }
  zou_ids_and_asset_docs[shot["project_id"]] = project_doc
@@ -335,14 +343,25 @@ def _new_task(self, data):
  """Create new task into OP DB."""
  # Get project entity
  set_op_project(self.dbcon, data["project_id"])
+ project_name = self.dbcon.active_project()
 
  # Get gazu entity
  task = gazu.task.get_task(data["task_id"])
 
  # Find asset doc
- asset_doc = self.dbcon.find_one(
- {"type": "asset", "data.zou.id": task["entity"]["id"]}
+ parent_name = task["entity"]["name"]
+ parent_zou_id = task["entity"]["id"]
+ asset_docs = get_assets(
+ project_name,
+ asset_names=[parent_name],
+ fields=["_id", "data.zou.id", "data.tasks"]
  )
+ asset_doc = None
+ for _asset_doc in asset_docs:
+ doc_zou_id = _asset_doc.get("data", {}).get("zou", {}).get("id")
+ if doc_zou_id == parent_zou_id:
+ asset_doc = _asset_doc
+ break
 
  # Update asset tasks with new one
  asset_tasks = asset_doc["data"].get("tasks")
@@ -359,10 +378,11 @@ def _update_task(self, data):
 
  def _delete_task(self, data):
  """Delete task of OP DB."""
- set_op_project(self.dbcon, data["project_id"])
 
+ set_op_project(self.dbcon, data["project_id"])
+ project_name = self.dbcon.active_project()
  # Find asset doc
- asset_docs = [doc for doc in self.dbcon.find({"type": "asset"})]
+ asset_docs = list(get_assets(project_name))
  for doc in asset_docs:
  # Match task
  for name, task in doc["data"]["tasks"].items():

openpype/modules/kitsu/utils/update_op_with_zou.py

@@ -10,6 +10,12 @@
  all_tasks_for_shot,
 )
 
+from openpype.client import (
+ get_project,
+ get_assets,
+ get_asset_by_id,
+ get_asset_by_name
+)
 from openpype.pipeline import AvalonMongoDB
 from openpype.api import get_project_settings
 from openpype.lib import create_project
@@ -33,16 +39,29 @@ def create_op_asset(gazu_entity: dict) -> dict:
  }
 
 
+def get_kitsu_project_name(project_id: str):
+ """Get project name based on project id in kitsu.
+
+ Args:
+ project_id (str): Id of project in Kitsu.
+
+ Returns:
+ str: Project name which has project in Kitsu.
+ """
+
+ project = gazu.project.get_project(project_id)
+ return project["name"]
+
+
 def set_op_project(dbcon: AvalonMongoDB, project_id: str):
  """Set project context.
 
  Args:
  dbcon (AvalonMongoDB): Connection to DB
  project_id (str): Project zou ID
  """
- project = gazu.project.get_project(project_id)
- project_name = project["name"]
- dbcon.Session["AVALON_PROJECT"] = project_name
+
+ dbcon.Session["AVALON_PROJECT"] = get_kitsu_project_name(project_id)
 
 
 def update_op_assets(
@@ -72,9 +91,7 @@ def update_op_assets(
  if not item_doc: # Create asset
  op_asset = create_op_asset(item)
  insert_result = dbcon.insert_one(op_asset)
- item_doc = dbcon.find_one(
- {"type": "asset", "_id": insert_result.inserted_id}
- )
+ item_doc = get_asset_by_id(project_name, insert_result.inserted_id)
 
  # Update asset
  item_data = deepcopy(item_doc["data"])
@@ -162,14 +179,32 @@ def update_op_assets(
  )
  if visual_parent_doc_id is None:
  # Find root folder doc
- root_folder_doc = dbcon.find_one(
- {
- "type": "asset",
- "name": entity_parent_folders[-1],
- "data.root_of": substitute_item_type,
- },
- ["_id"],
+ root_folder_docs = get_assets(
+ project_name,
+ asset_name=[entity_parent_folders[-1]],
+ fields=["_id", "data.root_of"]
  )
+ # NOTE: Not sure why it's checking for entity type?
+ # OP3 does not support multiple assets with same names so type
+ # filtering is irelevant.
+ # This way mimics previous implementation:
+ # ```
+ # root_folder_doc = dbcon.find_one(
+ # {
+ # "type": "asset",
+ # "name": entity_parent_folders[-1],
+ # "data.root_of": substitute_item_type,
+ # },
+ # ["_id"],
+ # )
+ # ```
+ root_folder_doc = None
+ for folder_doc in root_folder_docs:
+ root_of = folder_doc.get("data", {}).get("root_of")
+ if root_of == substitute_item_type:
+ root_folder_doc = folder_doc
+ break
+
  if root_folder_doc:
  visual_parent_doc_id = root_folder_doc["_id"]
 
@@ -222,7 +257,7 @@ def write_project_to_op(project: dict, dbcon: AvalonMongoDB) -> UpdateOne:
  UpdateOne: Update instance for the project
  """
  project_name = project["name"]
- project_doc = dbcon.database[project_name].find_one({"type": "project"})
+ project_doc = get_project(project_name)
  if not project_doc:
  print(f"Creating project '{project_name}'")
  project_doc = create_project(project_name, project_name, dbcon=dbcon)
@@ -319,26 +354,44 @@ def sync_project_from_kitsu(dbcon: AvalonMongoDB, project: dict):
  bulk_writes.append(write_project_to_op(project, dbcon))
 
  # Try to find project document
- dbcon.Session["AVALON_PROJECT"] = project["name"]
- project_doc = dbcon.find_one({"type": "project"})
+ project_name = project["name"]
+ dbcon.Session["AVALON_PROJECT"] = project_name
+ project_doc = get_project(project_name)
 
  # Query all assets of the local project
  zou_ids_and_asset_docs = {
  asset_doc["data"]["zou"]["id"]: asset_doc
- for asset_doc in dbcon.find({"type": "asset"})
+ for asset_doc in get_assets(project_name)
  if asset_doc["data"].get("zou", {}).get("id")
  }
  zou_ids_and_asset_docs[project["id"]] = project_doc
 
  # Create entities root folders
- project_module_settings = get_project_settings(project["name"])["kitsu"]
+ project_module_settings = get_project_settings(project_name)["kitsu"]
  for entity_type, root in project_module_settings["entities_root"].items():
  parent_folders = root.split("/")
  direct_parent_doc = None
  for i, folder in enumerate(parent_folders, 1):
- parent_doc = dbcon.find_one(
- {"type": "asset", "name": folder, "data.root_of": entity_type}
+ parent_doc = get_asset_by_name(
+ project_name, folder, fields=["_id", "data.root_of"]
  )
+ # NOTE: Not sure why it's checking for entity type?
+ # OP3 does not support multiple assets with same names so type
+ # filtering is irelevant.
+ # Also all of the entities could find be queried at once using
+ # 'get_assets'.
+ # This way mimics previous implementation:
+ # ```
+ # parent_doc = dbcon.find_one(
+ # {"type": "asset", "name": folder, "data.root_of": entity_type}
+ # )
+ # ```
+ if (
+ parent_doc
+ and parent_doc.get("data", {}).get("root_of") != entity_type
+ ):
+ parent_doc = None
+
  if not parent_doc:
  direct_parent_doc = dbcon.insert_one(
  {
@@ -371,7 +424,7 @@ def sync_project_from_kitsu(dbcon: AvalonMongoDB, project: dict):
  zou_ids_and_asset_docs.update(
  {
  asset_doc["data"]["zou"]["id"]: asset_doc
- for asset_doc in dbcon.find({"type": "asset"})
+ for asset_doc in get_assets(project_name)
  if asset_doc["data"].get("zou")
  }
  )

openpype/modules/kitsu/utils/update_zou_with_op.py

@@ -6,6 +6,7 @@
 import gazu
 from pymongo import UpdateOne
 
+from openpype.client import get_project, get_assets
 from openpype.pipeline import AvalonMongoDB
 from openpype.api import get_project_settings
 from openpype.modules.kitsu.utils.credentials import validate_credentials
@@ -53,9 +54,7 @@ def sync_zou_from_op_project(
  """
  # Get project doc if not provided
  if not project_doc:
- project_doc = dbcon.database[project_name].find_one(
- {"type": "project"}
- )
+ project_doc = get_project(project_name)
 
  # Get all entities from zou
  print(f"Synchronizing {project_name}...")
@@ -96,7 +95,7 @@ def sync_zou_from_op_project(
  dbcon.Session["AVALON_PROJECT"] = project_name
  asset_docs = {
  asset_doc["_id"]: asset_doc
- for asset_doc in dbcon.find({"type": "asset"})
+ for asset_doc in get_assets(project_name)
  }
 
  # Create new assets