8010 more ue5 fixes (#12)

Mostly addressed CR comments from Epic.
Fixed a warning with yaml loading.

Author: gplsteph

engine.py

@@ -88,7 +88,7 @@ def pre_app_init(self):
 
         self.init_qt_app()
 
-        # Load the tk_unreal module (the Shotgun engine wrapper for Unreal)
+        # Load the tk_unreal module (the SG engine wrapper for Unreal)
         self.tk_unreal = self.import_module("tk_unreal")
         self.unreal_sg_engine = self.tk_unreal.config.wrapper_instance
 

hooks/tk-multi-publish2/basic/publish_movie.py

@@ -756,6 +756,8 @@ def _unreal_render_sequence_with_sequencer(self, output_path, unreal_map_path, s
         # Prevent SG TK to try to bootstrap in the new process
         if "UE_SHOTGUN_BOOTSTRAP" in run_env:
             del run_env["UE_SHOTGUN_BOOTSTRAP"]
+        if "UE_SHOTGRID_BOOTSTRAP" in run_env:
+            del run_env["UE_SHOTGRID_BOOTSTRAP"]
 
         subprocess.call(cmdline_args, env=run_env)
 
@@ -896,6 +898,8 @@ def _unreal_render_sequence_with_movie_queue(self, output_path, unreal_map_path,
         # Prevent SG TK to try to bootstrap in the new process
         if "UE_SHOTGUN_BOOTSTRAP" in run_env:
             del run_env["UE_SHOTGUN_BOOTSTRAP"]
+        if "UE_SHOTGRID_BOOTSTRAP" in run_env:
+            del run_env["UE_SHOTGRID_BOOTSTRAP"]
         self.logger.info("Running %s" % cmd_args)
         subprocess.call(cmd_args, env=run_env)
         return os.path.isfile(output_path), output_path

plugins/basic/bootstrap.py

@@ -4,23 +4,10 @@
 
 import sys
 import os
-import unreal
 
 # Setup sys.path so that we can import our bootstrapper.
 plugin_root_dir = os.path.abspath(os.path.dirname(__file__))
 sys.path.insert(0, os.path.join(plugin_root_dir, "python"))
 
-# Temp workaround for UE5 dev: for some reasons the core/python path is missing
-# in sys.path but is present in the PYTHONPATH.
-# Make sure sys.path is up to date with what is in the PYTHON PATH
-python_path = os.environ.get("PYTHONPATH") or ""
-for path in python_path.split(os.pathsep):
-    # We can have empty entries for consecutives separators
-    if path and path not in sys.path:
-        unreal.log_warning(
-            "Adding missing %s Python path to sys paths" % path,
-        )
-        sys.path.append(path)
-
 from tk_unreal_basic import plugin_bootstrap
 plugin_bootstrap.bootstrap_plugin(plugin_root_dir)

plugins/basic/python/tk_unreal_basic/plugin_bootstrap.py

@@ -68,6 +68,7 @@ def _on_engine_initialized():
     sgtk_logger.debug("tk-unreal finished initialization.")
 
     import unreal
+    # ShotgunEngine was renamed to ShotgridEngine from UE5
     if hasattr(unreal, "ShotgridEngine"):
         unreal.ShotgridEngine.get_instance().on_engine_initialized()
     else:
@@ -89,7 +90,7 @@ def _initialize_manager(plugin_root_path):
 
     # open the yaml file and read the data
     with open(plugin_info_yml, "r") as plugin_info_fh:
-        plugin_info = yaml.load(plugin_info_fh)
+        plugin_info = yaml.load(plugin_info_fh, yaml.SafeLoader)
 
     base_config = plugin_info["base_configuration"]
     plugin_id = plugin_info["plugin_id"]

python/tk_unreal/unreal_sg_engine.py

@@ -28,6 +28,10 @@ def _post_init(self):
         config.wrapper_instance = self
 
     # Shotgun integration components were renamed to Shotgrid from UE5
+    # these new methods are not available in UE4, we provide backward
+    # compatibility so scripts using the old methods don't break in UE5,
+    # but also forward compatibility, so users can start using the new
+    # names in UE4.
     if hasattr(UESGEngine, "get_shotgrid_menu_items"):
         @unreal.ufunction(override=True)
         def get_shotgrid_menu_items(self):
@@ -47,6 +51,7 @@ def get_shotgun_menu_items(self):
             """
             Provide backward compatibility.
             """
+            unreal.log_warning("get_shotgun_menu_items is deprecated, get_shotgrid_menu_items should be used instead.")
             return self.get_shotgrid_menu_items()
     else:
         @unreal.ufunction(override=True)
@@ -59,6 +64,7 @@ def get_shotgun_menu_items(self):
             engine = sgtk.platform.current_engine()
             menu_items = self.create_menu(engine)
 
+            unreal.log_warning("get_shotgun_menu_items is deprecated, get_shotgrid_menu_items should be used instead.")
             unreal.log("get_shotgun_menu_items returned: {0}".format(menu_items.__str__()))
 
             return menu_items
@@ -74,6 +80,7 @@ def get_shotgun_work_dir(self, *args, **kwargs):
             """
             Provide backward compatibility.
             """
+            unreal.log_warning("get_shotgun_work_dir is deprecated, get_shotgrid_work_dir should be used instead.")
             return self.get_shotgrid_work_dir(*args, **kwargs)
     else:
         def get_shotgrid_work_dir(self, *args, **kwargs):

startup.py

@@ -90,10 +90,17 @@ def prepare_launch(self, exec_path, args, file_to_open=None):
         # Signals which engine instance from the environment is going to be used.
         required_env["SHOTGUN_ENGINE"] = self.engine_name
 
-        # Set the bootstrap location in the environment variable that will be used by the Unreal Shotgun startup script
+        # Set the bootstrap location in the environment variable that will be used by the Unreal Shotgun plugin
+        # startup script
         bootstrap_script = os.path.join(self.disk_location, "plugins", "basic", "bootstrap.py")
+        # From UE5, the UE_SHOTGRID_BOOTSTRAP environment variable is supported.
+        # We still need to support UE_SHOTGUN_BOOTSTRAP for previous UE versions.
         required_env["UE_SHOTGUN_BOOTSTRAP"] = bootstrap_script
-
+        required_env["UE_SHOTGRID_BOOTSTRAP"] = bootstrap_script
+        # UE5 Python ignores PYTHONPATH and only uses UE_PYTHONPATH
+        # blindly copy what was set so modules (e.g. SG TK core) are found
+        # when bootstrapping.
+        required_env["UE_PYTHONPATH"] = os.environ.get("PYTHONPATH") or ""
         self.logger.debug("Executable path: %s", exec_path)
         self.logger.debug("Launch environment: %s", pprint.pformat(required_env))
         self.logger.debug("Launch arguments: %s", args)