AARD-1710: Exporter auto formatter updates (#985)

.github/workflows/BlackFormat.yml

@@ -9,11 +9,31 @@ on:
 
 jobs:
   blackFormatChecker:
-    name: Black Formatter for Python Exporter
+    name: Black Format Validation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: psf/black@stable
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Python Setup
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+      - name: Setup Isort
+        run: python3 -m pip install isort
+      - name: Validate Isort Formatting
+        run: python3 ./exporter/SynthesisFusionAddin/tools/verifyIsortFormatting.py
+        id: isort-format-validation
+        continue-on-error: true
+      - name: Check Isort Formatting Validation
+        run: |
+          if [ ${{ steps.isort-format-validation.outcome }} == "success" ]; then
+            echo "Isort Formatting Validation Passed"
+          else
+            echo "Isort Formatting Validation Failed"
+            exit 1
+          fi
+      - name: Validate Black Formatting
+        uses: psf/black@stable
         with:
           options: "--check"
           src: "./exporter/SynthesisFusionAddin/"

exporter/SynthesisFusionAddin/README.md

@@ -78,9 +78,10 @@ Contact us for information on how to use the packaging script to obfuscate all o
 
 ### How to Format
 
-We format using a Python formatter called `black` [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+We format using a Python formatter called `black` [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) in conjunction with [`isort`](https://pycqa.github.io/isort/).
 
-- install by `pip3 install black` or `pip install black`
-- use `black ./src`, Formats all files in src directory
+- install by `pip3 install black && pip3 install isort` or `pip install black && pip install isort`
+- use `isort .` followed by `black .` to format all relevant exporter python files.
+  - or, alternatively, run `python ./tools/format.py` to do this for you!
 
 __Note: black will always ignore files in the proto/proto_out folder since google formats those__

exporter/SynthesisFusionAddin/Synthesis.py

@@ -1,16 +1,17 @@
-from .src.general_imports import root_logger, gm, INTERNAL_ID, APP_NAME, DESCRIPTION
-
-from .src.UI import HUI, Handlers, Camera, Helper, ConfigCommand
-from .src.UI.Toolbar import Toolbar
-from .src.Types.OString import OString
-from .src.configure import setAnalytics, unload_config
-
+import importlib.util
+import logging.handlers
+import os
+import traceback
 from shutil import rmtree
-import logging.handlers, traceback, importlib.util, os
 
-from .src.UI import MarkingMenu
 import adsk.core
 
+from .src.configure import setAnalytics, unload_config
+from .src.general_imports import APP_NAME, DESCRIPTION, INTERNAL_ID, gm, root_logger
+from .src.Types.OString import OString
+from .src.UI import HUI, Camera, ConfigCommand, Handlers, Helper, MarkingMenu
+from .src.UI.Toolbar import Toolbar
+
 
 def run(_):
     """## Entry point to application from Fusion.
@@ -32,9 +33,7 @@ def run(_):
         MarkingMenu.setupMarkingMenu(ui)
 
     except:
-        logging.getLogger(f"{INTERNAL_ID}").error(
-            "Failed:\n{}".format(traceback.format_exc())
-        )
+        logging.getLogger(f"{INTERNAL_ID}").error("Failed:\n{}".format(traceback.format_exc()))
 
 
 def stop(_):
@@ -74,9 +73,7 @@ def stop(_):
 
         path = os.path.abspath(os.path.dirname(__file__))
 
-        path_proto_files = os.path.abspath(
-            os.path.join(os.path.dirname(__file__), "..", "proto", "proto_out")
-        )
+        path_proto_files = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "proto", "proto_out"))
 
         if path in sys.path:
             sys.path.remove(path)
@@ -85,9 +82,7 @@ def stop(_):
             sys.path.remove(path_proto_files)
 
     except:
-        logging.getLogger(f"{INTERNAL_ID}").error(
-            "Failed:\n{}".format(traceback.format_exc())
-        )
+        logging.getLogger(f"{INTERNAL_ID}").error("Failed:\n{}".format(traceback.format_exc()))
 
 
 def unregister_all() -> None:
@@ -105,9 +100,7 @@ def unregister_all() -> None:
             tab.deleteMe()
 
     except:
-        logging.getLogger(f"{INTERNAL_ID}").error(
-            "Failed:\n{}".format(traceback.format_exc())
-        )
+        logging.getLogger(f"{INTERNAL_ID}").error("Failed:\n{}".format(traceback.format_exc()))
 
 
 def register_ui() -> None:

exporter/SynthesisFusionAddin/proto/deps.py

@@ -1,11 +1,12 @@
+import logging
 import os
 import platform
-import logging
 from pathlib import Path
 
-from src.general_imports import INTERNAL_ID
+import adsk.core
+import adsk.fusion
 
-import adsk.core, adsk.fusion
+from src.general_imports import INTERNAL_ID
 
 system = platform.system()
 
@@ -21,8 +22,8 @@ def getPythonFolder() -> str:
     """
 
     # Thank you Kris Kaplan
-    import sys
     import importlib.machinery
+    import sys
 
     osPath = importlib.machinery.PathFinder.find_spec("os", sys.path).origin
 
@@ -32,9 +33,7 @@ def getPythonFolder() -> str:
     elif system == "Darwin":
         pythonFolder = f"{Path(osPath).parents[2]}/bin"
     else:
-        raise ImportError(
-            "Unsupported platform! This add-in only supports windows and macos"
-        )
+        raise ImportError("Unsupported platform! This add-in only supports windows and macos")
 
     logging.getLogger(f"{INTERNAL_ID}").debug(f"Python Folder -> {pythonFolder}")
     return pythonFolder
@@ -89,9 +88,7 @@ def installCross(pipDeps: list) -> bool:
     try:
         pythonFolder = getPythonFolder()
     except ImportError as e:
-        logging.getLogger(f"{INTERNAL_ID}").error(
-            f"Failed to download dependencies: {e.msg}"
-        )
+        logging.getLogger(f"{INTERNAL_ID}").error(f"Failed to download dependencies: {e.msg}")
         return False
 
     if system == "Darwin":  # macos
@@ -108,9 +105,9 @@ def installCross(pipDeps: list) -> bool:
 
         executeCommand([f'"{pythonFolder}/python"', f'"{pythonFolder}/get-pip.py"'])
 
-    pythonExecutable = 'python'
+    pythonExecutable = "python"
     if system == "Windows":
-        pythonExecutable = 'python.exe'
+        pythonExecutable = "python.exe"
 
     for depName in pipDeps:
         progressBar.progressValue += 1
@@ -120,17 +117,15 @@ def installCross(pipDeps: list) -> bool:
         # os.path.join needed for varying system path separators
         installResult = executeCommand(
             [
-                f"\"{os.path.join(pythonFolder, pythonExecutable)}\"",
+                f'"{os.path.join(pythonFolder, pythonExecutable)}"',
                 "-m",
                 "pip",
                 "install",
                 depName,
             ]
         )
         if installResult != 0:
-            logging.getLogger(f"{INTERNAL_ID}").warn(
-                f'Dep installation "{depName}" exited with code "{installResult}"'
-            )
+            logging.getLogger(f"{INTERNAL_ID}").warn(f'Dep installation "{depName}" exited with code "{installResult}"')
 
     if system == "Darwin":
         pipAntiDeps = ["dataclasses", "typing"]
@@ -142,7 +137,7 @@ def installCross(pipDeps: list) -> bool:
             adsk.doEvents()
             uninstallResult = executeCommand(
                 [
-                    f"\"{os.path.join(pythonFolder, pythonExecutable)}\"",
+                    f'"{os.path.join(pythonFolder, pythonExecutable)}"',
                     "-m",
                     "pip",
                     "uninstall",
@@ -165,7 +160,7 @@ def installCross(pipDeps: list) -> bool:
 
 def _checkDeps() -> bool:
     try:
-        from .proto_out import joint_pb2, assembly_pb2, types_pb2, material_pb2
+        from .proto_out import assembly_pb2, joint_pb2, material_pb2, types_pb2
 
         return True
     except ImportError:
@@ -174,10 +169,11 @@ def _checkDeps() -> bool:
 
 try:
     import logging.handlers
+
     import google.protobuf
     import pkg_resources
 
-    from .proto_out import joint_pb2, assembly_pb2, types_pb2, material_pb2
+    from .proto_out import assembly_pb2, joint_pb2, material_pb2, types_pb2
 except ImportError or ModuleNotFoundError:
     installCross(["protobuf==4.23.3"])
-    from .proto_out import joint_pb2, assembly_pb2, types_pb2, material_pb2
+    from .proto_out import assembly_pb2, joint_pb2, material_pb2, types_pb2

exporter/SynthesisFusionAddin/pyproject.toml

@@ -1,8 +1,22 @@
 [build-system]
-requires = ["protobuf", "black", "pyminifier"]
+requires = ["protobuf", "isort", "black", "pyminifier"]
+
+[tool.isort]
+py_version = 39
+profile = "black"
+skip = [
+  "*.git/",
+  "*.venv",
+  "/build/",
+  "/docs/",
+  "/logs/",
+  ".vscode/",
+  "/dist/",
+  "proto/proto_out",
+]
 
 [tool.black]
-line-length = 90
+line-length = 120
 target-version = ['py39']
 include = '\.pyi?$'
 exclude = '''
@@ -13,10 +27,9 @@ exclude = '''
     | build
     | docs
     | logs
-    | proto
     | .vscode
     | dist
-    | src/proto_out
+    | proto_out
   )/
 )
-'''
+'''

exporter/SynthesisFusionAddin/requirements.txt

@@ -1,2 +1,2 @@
 black
-pyminifier
+pyminifier

exporter/SynthesisFusionAddin/src/Analytics/alert.py

@@ -1,5 +1,5 @@
-from ..general_imports import gm
 from ..configure import setAnalytics
+from ..general_imports import gm
 
 
 def showAnalyticsAlert():

exporter/SynthesisFusionAddin/src/Analytics/poster.py

@@ -1,7 +1,10 @@
-from ..general_imports import *
-from ..configure import CID, ANALYTICS, DEBUG
+import sys
+import urllib
+
+import adsk.core
 
-import urllib, sys, adsk.core
+from ..configure import ANALYTICS, CID, DEBUG
+from ..general_imports import *
 
 # Reference https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
 
@@ -169,9 +172,7 @@ def __send(self, body) -> bool:
             if DEBUG:
                 self.logger.debug(f"Sending request: \n {url}")
 
-            req = urllib.request.Request(
-                f"{self.url}/collect?{body}", data=b"", headers=headers
-            )
+            req = urllib.request.Request(f"{self.url}/collect?{body}", data=b"", headers=headers)
             # makes the request
             response = urllib.request.urlopen(req)
 

exporter/SynthesisFusionAddin/src/Analyzer/sniff.py

@@ -1,18 +1,21 @@
 """ Takes in a given function call and times and tests the memory allocations to get data
 """
 
-from ..general_imports import *
+import inspect
+import linecache
+import os
+import time
+import tracemalloc
 from time import time
-import tracemalloc, time, linecache, os, inspect
+
+from ..general_imports import *
 
 
 class Sniffer:
     def __init__(self):
         self.logger = logging.getLogger(f"{INTERNAL_ID}.Analyzer.Sniffer")
 
-        (self.filename, self.line_number, _, self.lines, _) = inspect.getframeinfo(
-            inspect.currentframe().f_back.f_back
-        )
+        (self.filename, self.line_number, _, self.lines, _) = inspect.getframeinfo(inspect.currentframe().f_back.f_back)
 
         self.stopped = False
 

exporter/SynthesisFusionAddin/src/Analyzer/timer.py

@@ -1,9 +1,11 @@
 """ Takes in a given function call and times and tests the memory allocations to get data
 """
 
-from ..general_imports import *
+import inspect
+import os
 from time import time
-import os, inspect
+
+from ..general_imports import *
 
 
 class Timer:

exporter/SynthesisFusionAddin/src/GlobalManager.py

@@ -1,7 +1,10 @@
 """ Initializes the global variables that are set in the run method to reduce hanging commands. """
 
-import adsk.core, adsk.fusion, traceback
 import inspect
+import traceback
+
+import adsk.core
+import adsk.fusion
 
 from .general_imports import *
 from .strings import *