6646 osx support (#1)

Added flake8 stuff and fixed reported problems.
Added basic support for Osx so at least the Unreal Engine app can be found.

Author: gplsteph

.flake8

@@ -0,0 +1,44 @@
+# 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 running 'pip 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
+
+# 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
+

azure-pipelines.yml

@@ -0,0 +1,27 @@
+# Python package
+# Create and test a Python package on multiple Python versions.
+# Add steps that analyze code, save the dist with the build record, publish to a PyPI-compatible index, and more:
+# https://docs.microsoft.com/azure/devops/pipelines/languages/python
+
+# The github_ci_token variable is defined in the Azure Pipeline web page as a
+# secret variable and is a github personal token.
+
+jobs:
+- job: 'Flake8'
+  pool:
+   vmImage: 'Ubuntu 16.04'
+
+  steps:
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: 2.7
+      architecture: 'x64'
+
+  - script: |
+        python -m pip install --upgrade pip setuptools wheel
+    displayName: 'Install prerequisites'
+
+  - script: |
+        python -m pip install flake8
+        flake8 .
+    displayName: 'Run flake8'

engine.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.
 
 """
@@ -27,21 +27,10 @@
 class UnrealEditorEngine(Engine):
     """
     Toolkit engine for Unreal.
-
-    All the methods that are present are either stubs or example of the expected functionality.
-
-    Note that when the engine starts up a log file is created at
-
-    Windows: %APPDATA%\Shotgun\logs\tk-unreal.log
-    macOS: ~/Library/Logs/Shotgun/tk-unreal.log
-    Linux: ~/.shotgun/logs/tk-unreal.log
-
-    and that all logging calls to Toolkit logging methods will be forwarded there.
-    It all uses the Python's logger under the hood.
     """
 
     metadata_tag_prefix = "SG."
-    
+
     def __init__(self, *args, **kwargs):
         """
         Engine Constructor
@@ -119,7 +108,7 @@ def init_qt_app(self):
         self.logger.debug("%s: Initializing QtApp for Unreal", self)
 
         from sgtk.platform.qt5 import QtWidgets
-        
+
         if not QtWidgets.QApplication.instance():
             self._qt_app = QtWidgets.QApplication(sys.argv)
             self._qt_app.setQuitOnLastWindowClosed(False)
@@ -129,7 +118,7 @@ def init_qt_app(self):
 
         # Make the QApplication use the dark theme. Must be called after the QApplication is instantiated
         self._initialize_dark_look_and_feel()
-            
+
     def post_app_init(self):
         """
         Called when all apps have initialized
@@ -214,10 +203,10 @@ def destroy_engine(self):
         """
         self.logger.debug("%s: Destroying tk-unreal engine...", self)
 
-        # Close all Shotgun app dialogs that are still opened since 
+        # Close all Shotgun app dialogs that are still opened since
         # some apps do threads cleanup in their onClose event handler
         # Note that this function is called when the engine is restarted (through "Reload Engine and Apps")
-        
+
         # Important: Copy the list of dialogs still opened since the call to close() will modify created_qt_dialogs
         dialogs_still_opened = self.created_qt_dialogs[:]
 
@@ -229,7 +218,7 @@ def get_metadata_tag(self, tag):
         Returns the given tag with the metadata tag prefix defined for this engine
         """
         return UnrealEditorEngine.metadata_tag_prefix + tag
-        
+
     def _get_dialog_parent(self):
         """
         Get the QWidget parent for all dialogs created through
@@ -259,17 +248,17 @@ def _create_dialog(self, title, bundle, widget, parent):
         Function override to set the window icon
         """
         dialog = sgtk.platform.Engine._create_dialog(self, title, bundle, widget, parent)
-        
+
         from sgtk.platform.qt import QtGui
 
         unreal_icon = os.path.realpath(os.path.join(
             os.path.dirname(__file__),
             "icon_256.png"))
-            
+
         dialog.setWindowIcon(QtGui.QIcon(unreal_icon))
 
         return dialog
-        
+
     def _define_qt_base(self):
         """
         This will be called at initialisation time and will allow

hooks/tk-multi-loader2/tk-unreal_actions.py

@@ -1,12 +1,11 @@
 # 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.
 
 """
 Hook that loads defines all the available actions, broken down by publish type.
 """
 
-import pprint
 import os
 import sgtk
 import unreal
@@ -68,7 +67,7 @@ def generate_actions(self, sg_publish_data, actions, ui_area):
                                      "params": None,
                                      "caption": "Import into Content Browser",
                                      "description": "This will import the asset into the Unreal Editor Content Browser."})
-        
+
         return action_instances
 
     def execute_multiple_actions(self, actions):
@@ -135,24 +134,24 @@ def _import_to_content_browser(self, path, sg_publish_data):
         :param path: Path to file.
         :param sg_publish_data: Shotgun data dictionary with all the standard publish fields.
         """
-        
+
         unreal.log("File to import: {}".format(path))
 
         if not os.path.exists(path):
             raise Exception("File not found on disk - '%s'" % path)
 
         destination_path, destination_name = self._get_destination_path_and_name(sg_publish_data)
-        
+
         asset_path = _unreal_import_fbx_asset(path, destination_path, destination_name)
-        
+
         if asset_path:
             self._set_asset_metadata(asset_path, sg_publish_data)
-            
+
             # Focus the Unreal Content Browser on the imported asset
             asset_paths = []
             asset_paths.append(asset_path)
             unreal.EditorAssetLibrary.sync_browser_to_objects(asset_paths)
-        
+
     def _set_asset_metadata(self, asset_path, sg_publish_data):
         """
         Set needed metadata on the given asset
@@ -161,9 +160,9 @@ def _set_asset_metadata(self, asset_path, sg_publish_data):
 
         if not asset:
             return
-            
+
         engine = sgtk.platform.current_engine()
-        
+
         # Add a metadata tag for "created_by"
         if "created_by" in sg_publish_data:
             createdby_dict = sg_publish_data["created_by"]
@@ -172,12 +171,12 @@ def _set_asset_metadata(self, asset_path, sg_publish_data):
                 name = createdby_dict["name"]
             elif "id" in createdby_dict:
                 name = createdby_dict["id"]
-            
+
             tag = engine.get_metadata_tag("created_by")
             unreal.EditorAssetLibrary.set_metadata_tag(asset, tag, name)
 
         # Add a metadata tag for the Shotgun URL
-        # Construct the PublishedFile URL from the publish data type and id since 
+        # Construct the PublishedFile URL from the publish data type and id since
         # the context of a PublishedFile is the Project context
         shotgun_site = self.sgtk.shotgun_url
         type = sg_publish_data["type"]
@@ -191,24 +190,24 @@ def _set_asset_metadata(self, asset_path, sg_publish_data):
         entity_dict = sg_publish_data["entity"]
         context = self.sgtk.context_from_entity_dictionary(entity_dict)
         url = context.shotgun_url
-        
+
         if entity_dict["type"] == "Project":
-            # As a last resort, construct the PublishedFile URL from the publish data type and id since 
+            # As a last resort, construct the PublishedFile URL from the publish data type and id since
             # the context of a PublishedFile is the Project context
             shotgun_site = self.sgtk.shotgun_url
             type = sg_publish_data["type"]
             id = sg_publish_data["id"]
             url = shotgun_site + "/detail/" + type + "/" + str(id)
         """
-        
+
         tag = engine.get_metadata_tag("url")
         unreal.EditorAssetLibrary.set_metadata_tag(asset, tag, url)
 
         unreal.EditorAssetLibrary.save_loaded_asset(asset)
-            
+
     ##############################################################################################################
     # helper methods which can be subclassed in custom hooks to fine tune the behaviour of things
-        
+
     def _get_destination_path_and_name(self, sg_publish_data):
         """
         Get the destination path and name from the publish data and the templates
@@ -247,14 +246,14 @@ def _get_destination_path_and_name(self, sg_publish_data):
 
         # Add the name field from the publish data
         fields["name"] = name
-        
+
         # Get destination path by applying fields to destination template
         # Fall back to the root level if unsuccessful
         try:
             destination_path = destination_template.apply_fields(fields)
         except Exception:
             destination_path = "/Game/Assets/"
-        
+
         # Query the fields needed for the name template from the context
         name_fields = context.as_template_fields(destination_name_template)
 
@@ -269,18 +268,21 @@ def _get_destination_path_and_name(self, sg_publish_data):
             destination_name = _sanitize_name(sg_publish_data["code"])
 
         return destination_path, destination_name
-        
+
+
 """
 Functions to import FBX into Unreal
 """
 
+
 def _sanitize_name(name):
     # Remove the default Shotgun versioning number if found (of the form '.v001')
     name_no_version = re.sub(r'.v[0-9]{3}', '', name)
-    
+
     # Replace any remaining '.' with '_' since they are not allowed in Unreal asset names
     return name_no_version.replace('.', '_')
 
+
 def _unreal_import_fbx_asset(input_path, destination_path, destination_name):
     """
     Import an FBX into Unreal Content Browser
@@ -291,11 +293,11 @@ def _unreal_import_fbx_asset(input_path, destination_path, destination_name):
     """
     tasks = []
     tasks.append(_generate_fbx_import_task(input_path, destination_path, destination_name))
-    
+
     unreal.AssetToolsHelpers.get_asset_tools().import_asset_tasks(tasks)
 
     first_imported_object = None
-    
+
     for task in tasks:
         unreal.log("Import Task for: {}".format(task.filename))
         for object_path in task.imported_object_paths:
@@ -304,10 +306,19 @@ def _unreal_import_fbx_asset(input_path, destination_path, destination_name):
                 first_imported_object = object_path
 
     return first_imported_object
-        
-def _generate_fbx_import_task(filename, destination_path, destination_name=None, replace_existing=True,
-                             automated=True, save=True, materials=True,
-                             textures=True, as_skeletal=False):
+
+
+def _generate_fbx_import_task(
+    filename,
+    destination_path,
+    destination_name=None,
+    replace_existing=True,
+    automated=True,
+    save=True,
+    materials=True,
+    textures=True,
+    as_skeletal=False
+):
     """
     Create and configure an Unreal AssetImportTask
 
@@ -318,11 +329,11 @@ def _generate_fbx_import_task(filename, destination_path, destination_name=None,
     task = unreal.AssetImportTask()
     task.filename = filename
     task.destination_path = destination_path
-    
+
     # By default, destination_name is the filename without the extension
     if destination_name is not None:
         task.destination_name = destination_name
-        
+
     task.replace_existing = replace_existing
     task.automated = automated
     task.save = save