format code with ruff, refactor dialog input handling

Author: cowboy

commands/commandDialog/entry.py

@@ -3,26 +3,27 @@
 from ...lib import fusionAddInUtils as futil
 from ... import config
 from ...lib.panelUtils.panel_command import command_created, CMD_NAME, CMD_Description
+
 app = adsk.core.Application.get()
 ui = app.userInterface
 
 
 # TODO *** Specify the command identity information. ***
-CMD_ID = f'{config.COMPANY_NAME}_{config.ADDIN_NAME}_cmdDialog'
+CMD_ID = f"{config.COMPANY_NAME}_{config.ADDIN_NAME}_cmdDialog"
 
 # Specify that the command will be promoted to the panel.
 IS_PROMOTED = True
 
 # TODO *** Define the location where the command button will be created. ***
-# This is done by specifying the workspace, the tab, and the panel, and the 
+# This is done by specifying the workspace, the tab, and the panel, and the
 # command it will be inserted beside. Not providing the command to position it
 # will insert it at the end.
-WORKSPACE_ID = 'FusionSolidEnvironment'
-PANEL_ID = 'SolidCreatePanel'
-COMMAND_BESIDE_ID = 'ScriptsManagerCommand'
+WORKSPACE_ID = "FusionSolidEnvironment"
+PANEL_ID = "SolidCreatePanel"
+COMMAND_BESIDE_ID = "ScriptsManagerCommand"
 
 # Resource location for command icons, here we assume a sub folder in this directory named "resources".
-ICON_FOLDER = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'resources', '')
+ICON_FOLDER = os.path.join(os.path.dirname(os.path.abspath(__file__)), "resources", "")
 
 
 # Executed when add-in is run.
@@ -43,7 +44,7 @@ def start():
     # Create the button command control in the UI after the specified existing command.
     control = panel.controls.addCommand(cmd_def, COMMAND_BESIDE_ID, False)
 
-    # Specify if the command is promoted to the main toolbar. 
+    # Specify if the command is promoted to the main toolbar.
     control.isPromoted = IS_PROMOTED
 
 

lib/generalUtils/__init__.py

@@ -2,4 +2,4 @@
 from .sketch_utils import *
 from .extrude_utils import *
 from .persist_utils import *
-from .debug_utils import *
+from .debug_utils import *

lib/generalUtils/debug_utils.py

@@ -1,18 +1,22 @@
-import adsk.core, adsk.fusion
+from enum import Enum
+import adsk.core
+import adsk.fusion
 from ..fusionAddInUtils import log
 
 app = adsk.core.Application.get()
 ui = app.userInterface
 
+
 def alert(msg):
-  ui.messageBox(str(msg))
+    ui.messageBox(str(msg))
+
 
 def identifyFaces(body: adsk.fusion.BRepBody):
-  component = body.parentComponent
-  sketches = component.sketches
-  for i, face in enumerate(body.faces):
-    try:
-      sketch = sketches.add(face)
-      sketch.name = 'Face {}'.format(i)
-    except Exception as err:
-      log(f'Error occurred, {err}')
+    component = body.parentComponent
+    sketches = component.sketches
+    for i, face in enumerate(body.faces):
+        try:
+            sketch = sketches.add(face)
+            sketch.name = "Face {}".format(i)
+        except Exception as err:
+            log(f"Error occurred, {err}")

lib/generalUtils/extrude_utils.py

@@ -1,4 +1,5 @@
-import adsk.core, adsk.fusion
+import adsk.core
+import adsk.fusion
 from .value_utils import getNormalizedValueInput
 from typing import TypedDict, NotRequired, Unpack
 
@@ -7,35 +8,37 @@
 
 app = adsk.core.Application.get()
 
+
 class ExtrudeKwargs(TypedDict):
-  operation: NotRequired[adsk.fusion.FeatureOperations]
-  offsetFrom: NotRequired[adsk.core.Base]
+    operation: NotRequired[adsk.fusion.FeatureOperations]
+    offsetFrom: NotRequired[adsk.core.Base]
+
 
 def extrude(
-  component: adsk.fusion.Component,
-  sketch: adsk.fusion.Sketch,
-  profileIndices: list[int],
-  height: float,
-  name: str,
-  **kwargs: Unpack[ExtrudeKwargs]
+    component: adsk.fusion.Component,
+    sketch: adsk.fusion.Sketch,
+    profileIndices: list[int],
+    height: float,
+    name: str,
+    **kwargs: Unpack[ExtrudeKwargs],
 ):
-  operation = kwargs.get('operation', adsk.fusion.FeatureOperations.NewBodyFeatureOperation)
-  offsetFrom = kwargs.get('offsetFrom')
-
-  profiles = adsk.core.ObjectCollection.create()
-  for i in profileIndices:
-    profiles.add(sketch.profiles.item(i))
-
-  features = component.features
-  extrudeFeatures = features.extrudeFeatures
-
-  extrudeInput = extrudeFeatures.createInput(profiles, operation) # type: ignore
-  extent = adsk.fusion.DistanceExtentDefinition.create(getNormalizedValueInput(height))
-  extrudeInput.setOneSideExtent(extent, adsk.fusion.ExtentDirections.PositiveExtentDirection) # type: ignore
-  if offsetFrom:
-    extrudeInput.startExtent = adsk.fusion.FromEntityStartDefinition.create(offsetFrom, adsk.core.ValueInput.createByReal(0))
-  
-  extrude = extrudeFeatures.add(extrudeInput)
-  extrude.name = "Extrude {}".format(name)
-  body = extrude.bodies.item(0)
-  return body
+    operation = kwargs.get("operation", adsk.fusion.FeatureOperations.NewBodyFeatureOperation)
+    offsetFrom = kwargs.get("offsetFrom")
+
+    profiles = adsk.core.ObjectCollection.create()
+    for i in profileIndices:
+        profiles.add(sketch.profiles.item(i))
+
+    features = component.features
+    extrudeFeatures = features.extrudeFeatures
+
+    extrudeInput = extrudeFeatures.createInput(profiles, operation)  # type: ignore
+    extent = adsk.fusion.DistanceExtentDefinition.create(getNormalizedValueInput(height))
+    extrudeInput.setOneSideExtent(extent, adsk.fusion.ExtentDirections.PositiveExtentDirection)  # type: ignore
+    if offsetFrom:
+        extrudeInput.startExtent = adsk.fusion.FromEntityStartDefinition.create(offsetFrom, adsk.core.ValueInput.createByReal(0))
+
+    extrude = extrudeFeatures.add(extrudeInput)
+    extrude.name = "Extrude {}".format(name)
+    body = extrude.bodies.item(0)
+    return body

lib/generalUtils/persist_utils.py

@@ -3,64 +3,64 @@
 import json
 from ...lib import fusionAddInUtils as futil
 
-persistDir = normpath(join(dirname(abspath(__file__)), '../../persist_defaults'))
+persistDir = normpath(join(dirname(abspath(__file__)), "../../persist_defaults"))
 
-class Persistable():
-  def __init__(self, persistFile: str, defaults: dict):
-    self.persistFile = join(persistDir, persistFile)
-    self._defaults = defaults
-    self.restoreDefaults()
-  
-  def saveDefaults(self):
-    try:
-      if not exists(persistDir):
-        mkdir(persistDir)
-      with open(self.persistFile, 'w') as persistFile:
-        data = {}
-        for key in self._defaults.keys():
-          data[key] = getattr(self, key)
-        json.dump(data, persistFile, indent=2)
-        futil.log(f'saved defaults file {self.persistFile}')
-      return True
-    except:
-      futil.log(f'error when attempting to save defaults file {self.persistFile}')
-      return False
 
-  def __loadDefaults(self):
-    try:
-      data = False
-      if exists(self.persistFile):
-        with open(self.persistFile) as persistFile:
-          data = json.load(persistFile)
-          futil.log(f'loaded defaults file {self.persistFile}')
-      else:
-        futil.log(f'no defaults file to load {self.persistFile}')
-      return data
-    except:
-      futil.log(f'error when attempting to load defaults file {self.persistFile}')
-      return False
+class Persistable:
+    def __init__(self, persistFile: str, defaults: dict):
+        self.persistFile = join(persistDir, persistFile)
+        self._defaults = defaults
+        self.restoreDefaults()
 
-  def restoreDefaults(self):
-    data = self._defaults | (self.__loadDefaults() or {})
-    for key, value in data.items():
-      setattr(self, key, value)
+    def saveDefaults(self):
+        try:
+            if not exists(persistDir):
+                mkdir(persistDir)
+            with open(self.persistFile, "w") as persistFile:
+                data = {}
+                for key in self._defaults.keys():
+                    data[key] = getattr(self, key)
+                json.dump(data, persistFile, indent=4)
+                futil.log(f"saved defaults file {self.persistFile}")
+            return True
+        except Exception as err:
+            futil.log(f"error when attempting to save defaults file {self.persistFile}: {err}")
+            return False
 
-  # Ensure invalid values loaded from persistFile don't break things
-  def ensureDefaultKeyIsValid(self, keyName, obj):
-    key = getattr(self, keyName)
-    if not key in obj:
-      futil.log(f'Warning: {keyName} "{key}" invalid, restoring default value "{self._defaults[keyName]}"')
-      setattr(self, keyName, self._defaults[keyName])
+    def __loadDefaults(self):
+        try:
+            data = False
+            if exists(self.persistFile):
+                with open(self.persistFile) as persistFile:
+                    data = json.load(persistFile)
+                    futil.log(f"loaded defaults file {self.persistFile}")
+            else:
+                futil.log(f"no defaults file to load {self.persistFile}")
+            return data
+        except Exception as err:
+            futil.log(f"error when attempting to load defaults file {self.persistFile}: {err}")
+            return False
 
-  def eraseDefaults(self):
-    try:
-      if exists(self.persistFile):
-        remove(self.persistFile)
-        futil.log(f'erased defaults file {self.persistFile}')
-      else:
-        futil.log(f'no defaults file to erase {self.persistFile}')
-      return True
-    except:
-      futil.log(f'error when attempting to erase defaults file {self.persistFile}')
-      return False
+    def restoreDefaults(self):
+        data = self._defaults | (self.__loadDefaults() or {})
+        for key, value in data.items():
+            setattr(self, key, value)
 
+    # Ensure invalid values loaded from persistFile don't break things
+    def ensureDefaultKeyIsValid(self, keyName, obj):
+        key = getattr(self, keyName)
+        if key not in obj:
+            futil.log(f'Warning: {keyName} "{key}" invalid, restoring default value "{self._defaults[keyName]}"')
+            setattr(self, keyName, self._defaults[keyName])
+
+    def eraseDefaults(self):
+        try:
+            if exists(self.persistFile):
+                remove(self.persistFile)
+                futil.log(f"erased defaults file {self.persistFile}")
+            else:
+                futil.log(f"no defaults file to erase {self.persistFile}")
+            return True
+        except Exception as err:
+            futil.log(f"error when attempting to erase defaults file {self.persistFile}: {err}")
+            return False