Merge pull request #1859 from pypeclub/feature/maya-dirmapping-support

Maya: support for configurable `dirmap` 🗺️

openpype/hosts/maya/api/__init__.py

@@ -26,6 +26,12 @@ INVENTORY_PATH = os.path.join(PLUGINS_DIR, "inventory")
 
 
 def install():
+    from openpype.settings import get_project_settings
+
+    project_settings = get_project_settings(os.getenv("AVALON_PROJECT"))
+    # process path mapping
+    process_dirmap(project_settings)
+
     pyblish.register_plugin_path(PUBLISH_PATH)
     avalon.register_plugin_path(avalon.Loader, LOAD_PATH)
     avalon.register_plugin_path(avalon.Creator, CREATE_PATH)
@@ -53,6 +59,40 @@ def install():
     avalon.data["familiesStateToggled"] = ["imagesequence"]
 
 
+def process_dirmap(project_settings):
+    # type: (dict) -> None
+    """Go through all paths in Settings and set them using `dirmap`.
+
+    Args:
+        project_settings (dict): Settings for current project.
+
+    """
+    if not project_settings["maya"].get("maya-dirmap"):
+        return
+    mapping = project_settings["maya"]["maya-dirmap"]["paths"] or {}
+    mapping_enabled = project_settings["maya"]["maya-dirmap"]["enabled"]
+    if not mapping or not mapping_enabled:
+        return
+    if mapping.get("source-path") and mapping_enabled is True:
+        log.info("Processing directory mapping ...")
+        cmds.dirmap(en=True)
+    for k, sp in enumerate(mapping["source-path"]):
+        try:
+            print("{} -> {}".format(sp, mapping["destination-path"][k]))
+            cmds.dirmap(m=(sp, mapping["destination-path"][k]))
+            cmds.dirmap(m=(mapping["destination-path"][k], sp))
+        except IndexError:
+            # missing corresponding destination path
+            log.error(("invalid dirmap mapping, missing corresponding"
+                       " destination directory."))
+            break
+        except RuntimeError:
+            log.error("invalid path {} -> {}, mapping not registered".format(
+                sp, mapping["destination-path"][k]
+            ))
+            continue
+
+
 def uninstall():
     pyblish.deregister_plugin_path(PUBLISH_PATH)
     avalon.deregister_plugin_path(avalon.Loader, LOAD_PATH)

openpype/settings/defaults/project_settings/maya.json

@@ -7,6 +7,19 @@
         "workfile": "ma",
         "yetiRig": "ma"
     },
+    "maya-dirmap": {
+        "enabled": true,
+        "paths": {
+            "source-path": [
+                "foo1",
+                "foo2"
+            ],
+            "destination-path": [
+                "bar1",
+                "bar2"
+            ]
+        }
+    },
     "scriptsmenu": {
         "name": "OpenPype Tools",
         "definition": [
@@ -164,14 +177,12 @@
         },
         "ValidateModelName": {
             "enabled": false,
-            "database": true,
             "material_file": {
                 "windows": "",
                 "darwin": "",
                 "linux": ""
             },
-            "regex": "(.*)_(\\d)*_(?P<shader>.*)_(GEO)",
-            "top_level_regex": ".*_GRP"
+            "regex": "(.*)_(\\\\d)*_(.*)_(GEO)"
         },
         "ValidateTransformNamingSuffix": {
             "enabled": true,

openpype/settings/entities/schemas/projects_schema/schema_project_maya.json

@@ -14,6 +14,39 @@
                                 "type": "text"
                             }
         },
+        {
+           "type": "dict",
+            "collapsible": true,
+            "checkbox_key": "enabled",
+            "key": "maya-dirmap",
+            "label": "Maya Directory Mapping",
+            "is_group": true,
+            "children": [
+                {
+                    "type": "boolean",
+                    "key": "enabled",
+                    "label": "Enabled"
+                },
+                {
+                    "type": "dict",
+                    "key": "paths",
+                    "children": [
+                        {
+                            "type": "list",
+                            "object_type": "text",
+                            "key": "source-path",
+                            "label": "Source Path"
+                        },
+                        {
+                            "type": "list",
+                            "object_type": "text",
+                            "key": "destination-path",
+                            "label": "Destination Path"
+                        }
+                    ]
+                }
+            ]
+        },
         {
             "type": "schema",
             "name": "schema_maya_scriptsmenu"

website/docs/admin_hosts_maya.md

@@ -94,4 +94,9 @@ You can add your custom tools menu into Maya by extending definitions in **Maya
 :::note Work in progress
 This is still work in progress. Menu definition will be handled more friendly with widgets and not
 raw json.
-:::
+:::
+
+## Multiplatform path mapping
+You can configure path mapping using Maya `dirmap` command. This will add bi-directional mapping between
+list of paths specified in **Settings**. You can find it in **Settings -> Project Settings -> Maya -> Maya Directory Mapping**
+![Dirmap settings](assets/maya-admin_dirmap_settings.png)