#42764 added support for more error messages in tooltips (#48)

Added support for more error messages in tooltips for 3dsMax, Houdini, Nuke and Photoshop.

Author: hawif

hooks/tk-multi-publish2/3dsmax.basic/publish_max_session.py

@@ -196,11 +196,14 @@ def validate(self, settings, item):
         if not path:
             # the session still requires saving. provide a save button.
             # validation fails.
+            session_error_message = "The Max session has not been saved."
             self.logger.error(
-                "The Max session has not been saved.",
+                session_error_message,
                 extra=_get_save_as_action()
             )
-            return False
+
+            # this exception should be cought by plugin.py run_validate() and propagate to tree_node_task.py validate()
+            raise Exception(session_error_message)
 
         # get the path in a normalized state. no trailing separator,
         # separators are appropriate for current os, no double separators,
@@ -254,8 +257,10 @@ def validate(self, settings, item):
             # to the user
             version = publisher.util.get_version_number(next_version_path)
 
+            version_error_message = "The next version of this file already exists on disk."
+
             self.logger.error(
-                "The next version of this file already exists on disk.",
+                version_error_message,
                 extra={
                     "action_button": {
                         "label": "Save to v%s" % (version,),
@@ -265,7 +270,7 @@ def validate(self, settings, item):
                     }
                 }
             )
-            return False
+            raise Exception(version_error_message)
 
         self.logger.info("A Publish will be created in Shotgun and linked to:")
         self.logger.info("  %s" % (path,))

hooks/tk-multi-publish2/3dsmax.basic/start_version_control.py

@@ -176,13 +176,14 @@ def validate(self, settings, item):
         path = _session_path()
 
         if not path:
+            save_error_message = "The Max session has not been saved."
             # the session still requires saving. provide a save button.
             # validation fails
             self.logger.error(
-                "The Max session has not been saved.",
+                save_error_message,
                 extra=_get_save_as_action()
             )
-            return False
+            raise Exception(save_error_message)
 
         # get the path to a versioned copy of the file.
         version_path = publisher.util.get_version_path(path, "v001")
@@ -192,7 +193,7 @@ def validate(self, settings, item):
                 "another name.",
                 extra=_get_save_as_action()
             )
-            return False
+            raise Exception("A file already exists with a version number. Please choose another name.")
 
         return True
 

hooks/tk-multi-publish2/houdini.basic/publish_houdini_session.py

@@ -194,13 +194,14 @@ def validate(self, settings, item):
         path = _session_path()
 
         if not path:
+            session_error_message = "The Houdini session has not been saved."
             # the session still requires saving. provide a save button.
             # validation fails.
             self.logger.error(
-                "The Houdini session has not been saved.",
+                session_error_message,
                 extra=self._get_save_as_action()
             )
-            return False
+            raise Exception(session_error_message)
 
         # get the path in a normalized state. no trailing separator,
         # separators are appropriate for current os, no double separators,
@@ -254,8 +255,9 @@ def validate(self, settings, item):
             # to the user
             version = publisher.util.get_version_number(next_version_path)
 
+            version_error_message = "The next version of this file already exists on disk."
             self.logger.error(
-                "The next version of this file already exists on disk.",
+                version_error_message,
                 extra={
                     "action_button": {
                         "label": "Save to v%s" % (version,),
@@ -265,7 +267,7 @@ def validate(self, settings, item):
                     }
                 }
             )
-            return False
+            raise Exception(version_error_message)
 
         self.logger.info("A Publish will be created in Shotgun and linked to:")
         self.logger.info("  %s" % (path,))

hooks/tk-multi-publish2/houdini.basic/start_version_control.py

@@ -176,13 +176,14 @@ def validate(self, settings, item):
         path = _session_path()
 
         if not path:
+            save_error_message = "The Houdini session has not been saved."
             # the session still requires saving. provide a save button.
             # validation fails
             self.logger.error(
-                "The Houdini session has not been saved.",
+                save_error_message,
                 extra=self._get_save_as_action()
             )
-            return False
+            raise Exception(save_error_message)
 
         # get the path to a versioned copy of the file.
         version_path = publisher.util.get_version_path(path, "v001")
@@ -192,7 +193,7 @@ def validate(self, settings, item):
                 "another name.",
                 extra=self._get_save_as_action()
             )
-            return False
+            raise Exception("A file already exists with a version number. Please choose another name")
 
         return True
 

hooks/tk-multi-publish2/maya.basic/publish_maya_session.py

@@ -202,7 +202,7 @@ def validate(self, settings, item):
                 session_error_message,
                 extra=_get_save_as_action()
             )
-            # this exception should be cought by plugin.py run_validate() and propagate to tree_node_task.py validate()
+            # this exception should be caught by plugin.py run_validate() and propagate to tree_node_task.py validate()
             raise Exception(session_error_message)
 
         # ensure we have an updated project root

hooks/tk-multi-publish2/nuke.basic/nuke_publish_script.py

@@ -194,13 +194,14 @@ def validate(self, settings, item):
         path = _session_path()
 
         if not path:
+            save_error_message = "The Nuke script has not been saved."
             # the session still requires saving. provide a save button.
             # validation fails.
             self.logger.error(
-                "The Nuke script has not been saved.",
+                save_error_message,
                 extra=_get_save_as_action()
             )
-            return False
+            raise Exception(save_error_message)
 
         # get the path in a normalized state. no trailing separator,
         # separators are appropriate for current os, no double separators,
@@ -254,8 +255,9 @@ def validate(self, settings, item):
             # to the user
             version = publisher.util.get_version_number(next_version_path)
 
+            version_error_message = "The next version of this file already exists on disk."
             self.logger.error(
-                "The next version of this file already exists on disk.",
+                version_error_message,
                 extra={
                     "action_button": {
                         "label": "Save to v%s" % (version,),
@@ -265,7 +267,7 @@ def validate(self, settings, item):
                     }
                 }
             )
-            return False
+            raise Exception(version_error_message)
 
         self.logger.info("A Publish will be created in Shotgun and linked to:")
         self.logger.info("  %s" % (path,))

hooks/tk-multi-publish2/nuke.basic/nuke_start_version_control.py

@@ -175,13 +175,14 @@ def validate(self, settings, item):
         path = _session_path()
 
         if not path:
+            save_error_message = "The Nuke script has not been saved."
             # the session still requires saving. provide a save button.
             # validation fails
             self.logger.error(
-                "The Nuke script has not been saved.",
+                save_error_message,
                 extra=_get_save_as_action()
             )
-            return False
+            raise Exception(save_error_message)
 
         # get the path to a versioned copy of the file.
         version_path = publisher.util.get_version_path(path, "v001")
@@ -191,7 +192,7 @@ def validate(self, settings, item):
                 "another name.",
                 extra=_get_save_as_action()
             )
-            return False
+            raise Exception("A file already exists with a version number. Please choose another name.")
 
         return True
 

hooks/tk-multi-publish2/nuke.basic/nukestudio_start_version_control.py

@@ -183,14 +183,14 @@ def validate(self, settings, item):
         path = project.path()
 
         if not path:
+            save_error_message = "The Nuke Studio project '%s' has not been saved." % (project.name(),)
             # the session still requires saving. provide a save button.
             # validation fails
             self.logger.error(
-                "The Nuke Studio project '%s' has not been saved." %
-                (project.name(),),
+                save_error_message,
                 extra=_get_save_as_action(project)
             )
-            return False
+            raise Exception(save_error_message)
 
         # get the path to a versioned copy of the file.
         version_path = publisher.util.get_version_path(path, "v001")
@@ -200,7 +200,7 @@ def validate(self, settings, item):
                 "another name.",
                 extra=_get_save_as_action(project)
             )
-            return False
+            raise Exception("A file already exists with a version number. Please choose another name")
 
         return True
 

hooks/tk-multi-publish2/photoshopcc.basic/publish_photoshop_document.py

@@ -206,14 +206,14 @@ def validate(self, settings, item):
         path = _document_path(document)
 
         if not path:
+            save_error_message = "The Photoshop document '%s' has not been saved." % (document.name,)
             # the document still requires saving. provide a save button.
             # validation fails.
             self.logger.error(
-                "The Photoshop document '%s' has not been saved." %
-                (document.name,),
+                save_error_message,
                 extra=self._get_save_as_action(document)
             )
-            return False
+            raise Exception(save_error_message)
 
         # get the path in a normalized state. no trailing separator,
         # separators are appropriate for current os, no double separators,
@@ -269,8 +269,10 @@ def validate(self, settings, item):
 
             engine = publisher.engine
 
+            version_error_message = "The next version of this file already exists on disk."
+
             self.logger.error(
-                "The next version of this file already exists on disk.",
+                version_error_message,
                 extra={
                     "action_button": {
                         "label": "Save to v%s" % (version,),
@@ -281,7 +283,7 @@ def validate(self, settings, item):
                     }
                 }
             )
-            return False
+            raise Exception(version_error_message)
 
         self.logger.info("A Publish will be created in Shotgun and linked to:")
         self.logger.info("  %s" % (path,))

hooks/tk-multi-publish2/photoshopcc.basic/start_version_control.py

@@ -182,14 +182,14 @@ def validate(self, settings, item):
         path = _document_path(document)
 
         if not path:
+            save_error_message = "The Photoshop document '%s' has not been saved." % (document.name,)
             # the session still requires saving. provide a save button.
             # validation fails
             self.logger.error(
-                "The Photoshop document '%s' has not been saved." %
-                (document.name,),
+                save_error_message,
                 extra=self._get_save_as_action(document)
             )
-            return False
+            raise Exception(save_error_message)
 
         # get the path to a versioned copy of the file.
         version_path = publisher.util.get_version_path(path, "v001")
@@ -199,7 +199,7 @@ def validate(self, settings, item):
                 "another name.",
                 extra=self._get_save_as_action(document)
             )
-            return False
+            raise Exception("A file already exists with a version number. Please choose another name.")
 
         return True