Merge pull request #1659 from pypeclub/feature/1658-editorial-conform…

…-assets-validator

openpype/plugins/publish/validate_editorial_asset_name.py

@@ -0,0 +1,112 @@
+import pyblish.api
+from avalon import io
+from pprint import pformat
+
+
+class ValidateEditorialAssetName(pyblish.api.ContextPlugin):
+ """ Validating if editorial's asset names are not already created in db.
+
+ Checking variations of names with different size of caps or with
+ or without underscores.
+ """
+
+ order = pyblish.api.ValidatorOrder
+ label = "Validate Asset Name"
+
+ def process(self, context):
+
+ asset_and_parents = self.get_parents(context)
+
+ if not io.Session:
+ io.install()
+
+ db_assets = list(io.find(
+ {"type": "asset"}, {"name": 1, "data.parents": 1}))
+ self.log.debug("__ db_assets: {}".format(db_assets))
+
+ asset_db_docs = {
+ str(e["name"]): e["data"]["parents"] for e in db_assets}
+
+ self.log.debug("__ project_entities: {}".format(
+ pformat(asset_db_docs)))
+
+ assets_missing_name = {}
+ assets_wrong_parent = {}
+ for asset in asset_and_parents.keys():
+ if asset not in asset_db_docs.keys():
+ # add to some nonexistent list for next layer of check
+ assets_missing_name.update({asset: asset_and_parents[asset]})
+ continue
+
+ if asset_and_parents[asset] != asset_db_docs[asset]:
+ # add to some nonexistent list for next layer of check
+ assets_wrong_parent.update({
+ asset: {
+ "required": asset_and_parents[asset],
+ "already_in_db": asset_db_docs[asset]
+ }
+ })
+ continue
+
+ self.log.info("correct asset: {}".format(asset))
+
+ if assets_missing_name:
+ wrong_names = {}
+ self.log.debug(
+ ">> assets_missing_name: {}".format(assets_missing_name))
+ for asset in assets_missing_name.keys():
+ _asset = asset.lower().replace("_", "")
+ if _asset in [a.lower().replace("_", "")
+ for a in asset_db_docs.keys()]:
+ wrong_names.update({
+ "required_name": asset,
+ "used_variants_in_db": [
+ a for a in asset_db_docs.keys()
+ if a.lower().replace("_", "") == _asset
+ ]
+ })
+
+ if wrong_names:
+ self.log.debug(
+ ">> wrong_names: {}".format(wrong_names))
+ raise Exception(
+ "Some already existing asset name variants `{}`".format(
+ wrong_names))
+
+ if assets_wrong_parent:
+ self.log.debug(
+ ">> assets_wrong_parent: {}".format(assets_wrong_parent))
+ raise Exception(
+ "Wrong parents on assets `{}`".format(assets_wrong_parent))
+
+ def _get_all_assets(self, input_dict):
+ """ Returns asset names in list.
+
+ List contains all asset names including parents
+ """
+ for key in input_dict.keys():
+ # check if child key is available
+ if input_dict[key].get("childs"):
+ # loop deeper
+ self._get_all_assets(
+ input_dict[key]["childs"])
+ else:
+ self.all_testing_assets.append(key)
+
+ def get_parents(self, context):
+ return_dict = {}
+ for instance in context:
+ asset = instance.data["asset"]
+ families = instance.data.get("families", []) + [
+ instance.data["family"]
+ ]
+ # filter out non-shot families
+ if "shot" not in families:
+ continue
+
+ parents = instance.data["parents"]
+
+ return_dict.update({
+ asset: [p["entity_name"] for p in parents]
+ })
+ return return_dict