8162 fixes (#7)

gplsteph · web-flow · commit 756423f4be16 · 2022-03-01T18:46:05.000+01:00
Fixed the following problems:

- Strings returned by Maya commands in Py2 (Maya 2020) were unicode and causing problems when used as environment variables in subprocess.
- In some cases publishes would be registered with a file:// url, added a _get_local_path method to handle all cases (local file, file:// url).
- Fixed a problem with UE5 "interpreting" \ in Python script path given in the command line.
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,53 @@
+# Copyright 2018 GPL Solutions, LLC.  All rights reserved.
+#
+# Use of this software is subject to the terms of the GPL Solutions license
+# agreement provided at the time of installation or download, or which otherwise
+# accompanies this software in either electronic or hard copy form.
+#
+
+# Flake 8 PEP and lint configuration - https://gitlab.com/pycqa/flake8
+#
+# This defines the official lint and PEP8 rules for this repository
+#
+# You can run this locally by doing pep install flake8 and then
+# >flake8 .
+
+[flake8]
+
+# Things we don't want to lint
+exclude =
+    .tox,
+    .git,
+    .flake8,
+    .gitignore,
+    .travis.yml,
+    .cache,
+    .eggs,
+    *.rst,
+    *.yml,
+    *.pyc,
+    *.pyo,
+    *.egg-info,
+    __pycache__,
+    # Those are our third parties, do not lint them
+    vendors,
+    # Skip __init__.py files, to not have a lot of 'xxx' imported but unused
+    python/__init__.py,
+    python/*/__init__.py,
+    # Skip the auto-generated ui file.
+    python/*/ui,
+    venv,
+    winenv,
+    osx_env,
+    win_env,
+
+# Ignore some errors
+#
+# E402 module level import not at top of file
+# E501 line too long (112 > 79 characters)
+# N802 Variables should be lower case. (clashes with Qt naming conventions)
+# N806 Variables should be lower case. (clashes with Qt naming conventions)
+# W503 line break before binary operator (it breaks before, not after)
+
+ignore = E501, E402, N802, N806, W503
+
diff --git a/framework.py b/framework.py
@@ -1,5 +1,5 @@
 # This file is based on templates provided and copyrighted by Autodesk, Inc.
-# This file has been modified by Epic Games, Inc. and is subject to the license 
+# This file has been modified by Epic Games, Inc. and is subject to the license
 # file included in this repository.
 
 """
@@ -22,7 +22,7 @@ class UnrealQtFramework(sgtk.platform.Framework):
 
     ##########################################################################################
     # init and destroy
-            
+
     def init_framework(self):
         """
         This framework ships with additional Python packages and tweak the Python
@@ -35,7 +35,7 @@ def init_framework(self):
 
         # Check if PySide is already available, do nothing if it is the case
         try:
-            from sgtk.platform.qt import QtCore
+            from sgtk.platform.qt import QtCore  # noqa
             self.log_debug("Qt is already available, not activating any custom package.")
             return
         except ImportError as e:
diff --git a/hooks/core/bootstrap.py b/hooks/core/bootstrap.py
@@ -142,7 +142,7 @@ def populate_bundle_cache_entry(self, destination, descriptor, **kwargs):
             for asset in response_d["assets"]:
                 name = asset["name"]
                 m = re.match(
-                    "%s-py\d.\d-%s.zip" % (version, pname),
+                    r"%s-py\d.\d-%s.zip" % (version, pname),
                     name
                 )
                 if m:
diff --git a/hooks/tk-multi-publish2/tk-maya/basic/collector.py b/hooks/tk-multi-publish2/tk-maya/basic/collector.py
@@ -21,7 +21,6 @@ class MayaSessionCollectorWithSecondaries(HookBaseClass):
         collector: "{self}/collector.py:{engine}/tk-multi-publish2/basic/collector.py:{config}/tk-multi-publish2/tk-maya/basic/collector.py"
     """
 
-
     def collect_current_maya_session(self, settings, parent_item):
         """
         Creates an item that represents the current maya session.
diff --git a/hooks/tk-multi-publish2/tk-maya/basic/publish_fbx.py b/hooks/tk-multi-publish2/tk-maya/basic/publish_fbx.py
@@ -187,7 +187,6 @@ def validate(self, settings, item):
         :raises ValueError: For problems which can't be solved in the current session.
         """
 
-        publisher = self.parent
         path = _session_path()
 
         # ---- ensure the session has been saved
@@ -282,7 +281,6 @@ def validate(self, settings, item):
             # Set the publish_path to be explicit.
             item.local_properties["publish_path"] = publish_path
 
-
         # Set the session path on the item for use by the base plugin validation
         # step.
         # NOTE: this path could change prior to the publish phase.
@@ -312,8 +310,6 @@ def publish(self, settings, item):
         :param item: Item to process
         """
 
-        publisher = self.parent
-
         # Get the path in a normalized state. no trailing separator, separators
         # are appropriate for current os, no double separators, etc.
         path = sgtk.util.ShotgunPath.normalize(_session_path())
@@ -376,6 +372,7 @@ def _session_path():
 
     return path
 
+
 def _save_session(path):
     """
     Save the current session to the supplied path.
diff --git a/hooks/tk-multi-publish2/tk-maya/basic/publish_turntable.py b/hooks/tk-multi-publish2/tk-maya/basic/publish_turntable.py
@@ -5,9 +5,9 @@
 import sgtk
 from tank_vendor import six
 from sgtk.platform.qt import QtGui, QtCore
-from sgtk.platform import SoftwareVersion
 
 import maya.cmds as cmds
+import maya.mel as mel
 
 import copy
 import datetime
@@ -19,6 +19,7 @@
 import subprocess
 import sys
 import tempfile
+from six.moves.urllib import parse
 
 HookBaseClass = sgtk.get_hook_baseclass()
 
@@ -131,7 +132,7 @@ def _open_current_path(self):
         Open the current file in an external application.
         """
         current_path = self.get_path()
-        engine = sgtk.platform.current_engine()
+
         # Would be awesome to use launch app, but launch_from_path does not work
         # in SotfwareEntity mode.
 #        if engine and "tk-multi-launchapp" in engine.apps:
@@ -362,9 +363,6 @@ def description(self):
         Verbose, multi-line description of what the plugin does. This can
         contain simple html for formatting.
         """
-
-        loader_url = "https://support.shotgunsoftware.com/hc/en-us/articles/219033078"
-
         return """
         <p>This plugin renders a turntable of the asset for the current session
         in Unreal Engine.  The asset will be exported to FBX and imported into
@@ -373,6 +371,7 @@ def description(self):
         the turntable render will be published to Shotgun and submitted for review
         as a Version.</p>
         """
+
     @property
     def icon(self):
         """
@@ -515,7 +514,6 @@ def create_settings_widget(self, parent):
         settings_frame.unreal_turntable_asset_label = QtGui.QLabel("Unreal Turntable Assets Path:")
         settings_frame.unreal_turntable_asset_widget = QtGui.QLineEdit("")
 
-
         # Create the layout to use within the QFrame
         settings_layout = QtGui.QVBoxLayout()
         settings_layout.addWidget(settings_frame.description_label)
@@ -549,9 +547,9 @@ def get_ui_settings(self, widget):
             "Turntable Map Path": six.ensure_str(widget.unreal_turntable_map_widget.text()),
             "Sequence Path": six.ensure_str(widget.unreal_sequence_widget.text()),
             "Turntable Assets Path": six.ensure_str(widget.unreal_turntable_asset_widget.text()),
-            #"HDR Path": widget.hdr_image_template_widget.get_path(),
-            #"Start Frame": widget.start_frame_spin_box.value(),
-            #"End Frame": widget.end_frame_spin_box.value(),
+            # "HDR Path": widget.hdr_image_template_widget.get_path(),
+            # "Start Frame": widget.start_frame_spin_box.value(),
+            # "End Frame": widget.end_frame_spin_box.value(),
         }
         return settings
 
@@ -898,7 +896,7 @@ def get_unreal_project_property(self, settings, item):
             raise RuntimeError(
                 "Unable to build an Unreal project path from %s with Unreal version %s" % (
                     unreal_project_path_template,
-                    unreal_engine_version,
+                    item.properties["unreal_engine_version"],
                 )
             )
         if not os.path.isfile(unreal_project_path):
@@ -907,6 +905,39 @@ def get_unreal_project_property(self, settings, item):
             )
         item.properties["unreal_project_path"] = unreal_project_path
 
+    def _get_local_path(self, published_file):
+        """
+        Returns the local path for the given published file.
+
+        :returns: The local path to the published file.
+        :raises ValueError: If no local path can be retrieved.
+        """
+        if "local_path" in published_file["path"]:
+            return published_file["path"]["local_path"]
+
+        if "url" in published_file["path"]:
+            url = published_file["path"]["url"]
+            parsed = parse.urlparse(url)
+            if parsed.scheme == "file":
+                # Copied from
+                # https://github.com/shotgunsoftware/tk-core/blob/2fc8287a19f8f002e23101836bafba0ec0de9dc9/python/tank/util/shotgun/publish_resolve.py#L311
+                if parsed.netloc:
+                    # UNC path
+                    path = parse.unquote(
+                        "//%s%s" % (parsed.netloc, parsed.path)
+                    )
+                else:
+                    path = parse.unquote(parsed.path)
+                    # Deal with bad paths being set
+                    # file:///C:/Users/me/default/data/publishes/Trooper_Full_NoKnife_2.fbx
+                    # Leading to /C:/Users/me/default/data/publishes/Trooper_Full_NoKnife_2.fbx
+                    # as path.
+                    if re.match("^/[A-Za-z]:/", path):
+                        path = path[1:]
+                return path
+
+        raise ValueError("Unable to get a local path from %s" % published_file)
+
     def publish(self, settings, item):
         """
         Executes the publish logic for the given item and settings.
@@ -956,7 +987,7 @@ def publish(self, settings, item):
         # Use the Fbx which was published by another item or save one now.
         published_fbx = item.parent.properties.get("sg_fbx_publish_data")
         if published_fbx:
-            fbx_published_path = published_fbx["path"]["local_path"]
+            fbx_published_path = self._get_local_path(published_fbx)
             # Check the path: Unreal doesn't like non-word characters in filenames
             self.logger.info("Using published FBX file %s" % fbx_published_path)
             if re.search(exp, os.path.splitext(fbx_published_path)[0]):
@@ -997,7 +1028,7 @@ def publish(self, settings, item):
         self.logger.debug("Copying %s to %s" % (unreal_project_path, temp_project_path))
         shutil.copytree(project_path, temp_project_dir)
 
-        current_folder = os.path.dirname( __file__ )
+        current_folder = os.path.dirname(__file__)
         script_path = os.path.abspath(
             os.path.join(
                 current_folder,
@@ -1024,6 +1055,8 @@ def publish(self, settings, item):
             )
             importer_destination = os.path.join(self.temp_folder, "unreal_importer.py")
             shutil.copy(importer_path, importer_destination)
+        # UE5 does some weird things with \ so let's replace them with /
+        script_path = script_path.replace("\\", "/")
 
         if " " in temp_project_path:
             temp_project_path = '"{}"'.format(temp_project_path)
@@ -1033,15 +1066,17 @@ def publish(self, settings, item):
         # on the command line.
         run_env = copy.copy(os.environ)
         # Environment variables for turntable script
+        # Make sure they are strings and not unicode with py2, otherwise
+        # "environment can only contain strings" erors will happen.
         extra_env = {
             # The FBX to import into Unreal
-            "UNREAL_SG_FBX_OUTPUT_PATH": fbx_output_path,
+            "UNREAL_SG_FBX_OUTPUT_PATH": six.ensure_str(fbx_output_path),
             # The Unreal content browser folder where the asset will be imported into
-            "UNREAL_SG_ASSETS_PATH": turntable_assets_path,
+            "UNREAL_SG_ASSETS_PATH": six.ensure_str(turntable_assets_path),
             # The Unreal turntable map to duplicate where the asset will be instantiated into
-            "UNREAL_SG_MAP_PATH": turntable_map_path,
-            "UNREAL_SG_SEQUENCE_PATH": sequence_path,
-            "UNREAL_SG_MOVIE_OUTPUT_PATH": publish_path,
+            "UNREAL_SG_MAP_PATH": six.ensure_str(turntable_map_path),
+            "UNREAL_SG_SEQUENCE_PATH": six.ensure_str(sequence_path),
+            "UNREAL_SG_MOVIE_OUTPUT_PATH": six.ensure_str(publish_path),
         }
         self.logger.info("Adding %s to the environment" % extra_env)
         run_env.update(extra_env)
@@ -1079,7 +1114,7 @@ def publish(self, settings, item):
             )
             # Workaround for Level Sequencer only rendering avi on Windows and Movie Queue rendering
             # mov on all platforms
-            publish_path = re.sub("\.avi$", ".mov", publish_path)
+            publish_path = re.sub(r"\.avi$", ".mov", publish_path)
             item.local_properties["publish_path"] = publish_path
             self._unreal_render_movie_with_movie_render_queue(
                 unreal_exec_path,
@@ -1132,8 +1167,6 @@ def publish(self, settings, item):
         item.local_properties["sg_publish_data"] = item.properties.sg_publish_data
 
         # Create a Version entry linked with the new publish
-        publish_name = item.properties.get("publish_name")
-
         # Populate the version data to send to SG
         self.logger.info("Creating Version...")
         version_data = {
@@ -1153,7 +1186,8 @@ def publish(self, settings, item):
                     "label": "Version Data",
                     "tooltip": "Show the complete Version data dictionary",
                     "text": "<pre>%s</pre>" % (
-                    pprint.pformat(version_data),)
+                        pprint.pformat(version_data),
+                    )
                 }
             }
         )
@@ -1168,7 +1202,7 @@ def publish(self, settings, item):
         # Ensure the path is utf-8 encoded to avoid issues with
         # the shotgun api
         upload_path = six.ensure_text(
-            item.properties.sg_publish_data["path"]["local_path"]
+            self._get_local_path(item.properties.sg_publish_data)
         )
 
         # Upload the file to SG
@@ -1236,7 +1270,7 @@ def _maya_export_fbx(self, fbx_output_path):
             # import maya.mel as mel
             # mel.eval('FBXExport -f "fbx_output_path"')
             cmds.FBXExport('-f', fbx_output_path)
-        except:
+        except Exception:
             self.logger.error("Could not export scene to FBX")
             return False
 
@@ -1322,7 +1356,7 @@ def _unreal_render_movie_with_sequencer(
             # Must delete it first, otherwise the Sequencer will add a number in the filename
             try:
                 os.remove(output_path)
-            except OSError as e:
+            except OSError:
                 self.logger.debug("Couldn't delete {}. The Sequencer won't be able to output the movie to that file.".format(output_path))
                 return False, None
 
@@ -1382,7 +1416,6 @@ def _unreal_render_movie_with_movie_render_queue(
                   string representing the path of the generated movie file
         """
         output_folder, output_file = os.path.split(output_path)
-        movie_name = os.path.splitext(output_file)[0]
 
         cmdline_args = self._get_unreal_base_command(
             unreal_exec_path,
@@ -1434,7 +1467,7 @@ def _unreal_render_movie_with_movie_render_queue(
             "-MoviePipelineConfig=\"%s\"" % manifest_path,
         ])
         self.logger.info("Running %s" % cmdline_args)
-        ret = subprocess.call(cmdline_args)
+        subprocess.call(cmdline_args)
         return os.path.isfile(output_path), output_path
 
     def get_unreal_versions(self):
@@ -1506,7 +1539,6 @@ def evaluate_unreal_project_path(self, unreal_project_path_template, unreal_engi
         short_version = ".".join(unreal_engine_version.split(".")[:2])
         # Evaluate the "template"
         engine = sgtk.platform.current_engine()
-        engine_path = os.path.join(engine.disk_location, "hooks")
         hooks_folder = engine.sgtk.pipeline_configuration.get_hooks_location()
         fw = self.load_framework("tk-framework-unrealqt_v1.x.x")
         return os.path.normpath(
@@ -1531,6 +1563,7 @@ def _copy_work_to_publish(self, settings, item):
         """
         pass
 
+
 def _session_path():
     """
     Return the path to the current session
diff --git a/hooks/tk-multi-publish2/tk-maya/unreal/unreal_importer.py b/hooks/tk-multi-publish2/tk-maya/unreal/unreal_importer.py
diff --git a/hooks/tk-multi-publish2/tk-maya/unreal/unreal_setup_turntable.py b/hooks/tk-multi-publish2/tk-maya/unreal/unreal_setup_turntable.py

Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ def populate_bundle_cache_entry(self, destination, descriptor, **kwargs):`
`142`	`142`	`for asset in response_d["assets"]:`
`143`	`143`	`name = asset["name"]`
`144`	`144`	`m = re.match(`
`145`		`- "%s-py\d.\d-%s.zip" % (version, pname),`
	`145`	`+ r"%s-py\d.\d-%s.zip" % (version, pname),`
`146`	`146`	`name`
`147`	`147`	`)`
`148`	`148`	`if m:`