Merge pull request #4074 from Autodesk/bailp/EMSUSD-2014/bad-object-message

EMSUSD-2014 report error for invalid include and exclude

Author: seando-adsk

lib/mayaUsd/resources/ae/usd-shared-components/src/python/usdSharedComponents/common/host.py

@@ -1,7 +1,17 @@
 from typing import Sequence
+from enum import Enum
 from pxr import Usd
 
 
+class MessageType(Enum):
+    '''
+    Message type used to report messages in the DCC.
+    '''
+    INFO = 1
+    WARNING = 2
+    ERROR = 3
+
+
 class Host(object):
     _instance = None
 
@@ -47,6 +57,13 @@ def pick(self, stage: Usd.Stage, *, dialogTitle: str = "") -> Sequence[Usd.Prim]
         '''
         return None
 
+    def reportMessage(self, message: str, msgType: MessageType=MessageType.ERROR):
+        '''
+        Report an error message using the DCC-specific logging system.
+        By default, simply print the error with an "Error: " prefix.
+        '''
+        print('%s: %s', (msgType, message))
+    
     def createCollectionData(self, prim: Usd.Prim, collection: Usd.CollectionAPI):
         '''
         Create the data to hold a USD collection.

lib/mayaUsd/resources/ae/usd-shared-components/src/python/usdSharedComponents/data/stringListData.py

@@ -47,9 +47,14 @@ def _isValidString(self, s) -> AnyStr:
 
     def addMultiLineStrings(self, multiLineText):
         items = []
+        reportedError = False
         for text in multiLineText.split("\n"):
             text = self._isValidString(text)
-            if text is None:
+            if not text:
+                if not reportedError:
+                    reportedError = True
+                    from ..common.host import Host
+                    Host.instance().reportMessage("Only objects in the same stage as the collection can be added.")
                 continue
             items.append(text)
 

lib/mayaUsd/resources/ae/usdschemabase/collectionMayaHost.py

@@ -1,5 +1,5 @@
 
-from usd_shared_components.common.host import Host
+from usd_shared_components.common.host import Host, MessageType
 from usd_shared_components.common.theme import Theme
 from usd_shared_components.usdData.usdCollectionData import UsdCollectionData
 from usd_shared_components.usdData.usdCollectionStringListData import CollectionStringListData
@@ -239,7 +239,7 @@ def registerCommands(pluginName):
         try:
             plugin.registerCommand(cls.commandName, cls.creator, cls.createSyntax) 
         except Exception as ex:
-            print(ex)
+            MGlobal.displayError(ex)
 
 def deregisterCommands(pluginName):
     '''
@@ -256,7 +256,7 @@ def deregisterCommands(pluginName):
         try:
             plugin.deregisterCommand(cls.commandName) 
         except Exception as ex:
-            print(ex)
+            MGlobal.displayError(ex)
 
 
 class MayaCollectionData(UsdCollectionData):
@@ -334,6 +334,14 @@ def canDrop(self) -> bool:
     def pick(self, stage: Usd.Stage, *, dialogTitle: str = "") -> Sequence[Usd.Prim]:
         return [] # nothing to do yet
 
+    def reportMessage(self, message: str, msgType: MessageType=MessageType.ERROR):
+        if msgType == MessageType.INFO:
+            MGlobal.displayInfo(message)
+        elif msgType == MessageType.WARNING:
+            MGlobal.displayWarning(message)
+        elif msgType == MessageType.ERROR:
+            MGlobal.displayError(message)
+
     def createCollectionData(self, prim: Usd.Prim, collection: Usd.CollectionAPI):
         return MayaCollectionData(prim, collection)