feat(transpile): add settings for hook (#27, #38)

Author: Chaoses-Ib

.gitignore

@@ -4,6 +4,10 @@ private/
 
 /examples
 
+# Ignore dynaconf files
+.secrets.*
+*.local.*
+
 # Hatch will only respect the first .gitignore file
 /src/comfy_script/runtime/**/*.pyi
 

README.md

@@ -86,7 +86,7 @@ ComfyScript can also be used without installed ComfyUI. See [only ComfyScript pa
 ## Transpiler
 The transpiler can translate ComfyUI's workflows to ComfyScript.
 
-When ComfyScript is installed as custom nodes, `SaveImage` and similar nodes will be hooked to automatically save the script as images' metadata. And the script will also be output to the terminal.
+When ComfyScript is installed as custom nodes, `SaveImage` and similar nodes will be hooked to automatically save the script as the image's metadata. The script will also be printed to the terminal.
 
 For example, here is a workflow in ComfyUI:
 
@@ -133,6 +133,8 @@ Comparing scripts:
 
 ![](docs/images/README/diff.png)
 
+To control these features, see [settings.example.toml](settings.example.toml).
+
 You can also use the transpiler via the [CLI](docs/Transpiler.md#cli).
 
 ## Runtime

pyproject.toml

@@ -37,10 +37,13 @@ client = [
 
 # Transpiler
 transpile = [
+  # Already required by ComfyUI (torch)
   "networkx[default] ~= 3.0",
 
   # Used to get nodes info
   "comfy-script[client]",
+
+  "dynaconf ~= 3.0",
 ]
 
 # Runtime

settings.example.toml

@@ -0,0 +1,18 @@
+# Settings example
+# Do not edit this file directly, instead, copy the following as `settings.toml` and edit that file.
+
+# These settings can also be overriden by:
+# - Environment variables
+#   e.g. `COMFY_SCRIPT_TRANSPILE_HOOK_ENABLED=false`
+# - Python code
+#   e.g.
+#   ```python
+#   from comfy_script.config import settings
+#   settings.transpile.hook.enabled=False
+#   ```
+
+[transpile.hook]
+# When ComfyScript is installed as custom nodes, `SaveImage` and similar nodes will be hooked to automatically save the script as the image's metadata. The script will also be printed to the terminal.
+# To disable a feature, change its value to `false`.
+save_script = true
+print_script = true

src/comfy_script/config.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+from dynaconf import Dynaconf, Validator
+
+settings = Dynaconf(
+    envvar_prefix='COMFY_SCRIPT',
+    root_path=Path(__file__).resolve().parent,
+    settings_files=['settings.toml', '.secrets.toml'],
+    validators=[
+        Validator('transpile.hook.enabled', default=True),
+        Validator('transpile.hook.save_script', default=True),
+        Validator('transpile.hook.print_script', default=True),
+    ],
+)
+
+# See `settings.example.toml` for details.

src/comfy_script/nodes/__init__.py

@@ -77,30 +77,35 @@ def chunks(self):
                 chunks = self._chunks
                 self._chunks = []
 
-                if 'workflow' in self._texts or 'prompt' in self._texts:
-                    try:
-                        workflow, zip = self._texts['workflow' if 'workflow' in self._texts else 'prompt']
-                        
-                        end_nodes = None
-                        # TODO: UNIQUE_ID
-                        frame = inspect.currentframe()
-                        while frame := frame.f_back:
-                            if 'unique_id' in frame.f_locals:
-                                end_nodes = [frame.f_locals['unique_id']]
-                                break
-                        else:
-                            print('ComfyScript: Failed to resolve the id of current node.')
-
-                        comfy_script = transpile.WorkflowToScriptTranspiler(workflow).to_script(end_nodes)
-                        # TODO: Syntax highlight?
-                        print('ComfyScript:', comfy_script, sep='\n')
-
-                        super().add_text('ComfyScript', comfy_script, zip)
-                    except Exception:
-                        # Print stack trace, but do not block the original saving
-                        traceback.print_exc()
-                else:
-                    print("ComfyScript: Failed to save ComfyScript because neither of workflow and prompt is in extra_pnginfo")
+                print_script = settings.transpile.hook.print_script
+                save_script = settings.transpile.hook.save_script
+                if print_script is True or save_script is True:
+                    if 'workflow' in self._texts or 'prompt' in self._texts:
+                        try:
+                            workflow, zip = self._texts['workflow' if 'workflow' in self._texts else 'prompt']
+                            
+                            end_nodes = None
+                            # TODO: UNIQUE_ID
+                            frame = inspect.currentframe()
+                            while frame := frame.f_back:
+                                if 'unique_id' in frame.f_locals:
+                                    end_nodes = [frame.f_locals['unique_id']]
+                                    break
+                            else:
+                                print('ComfyScript: Failed to resolve the id of current node.')
+
+                            comfy_script = transpile.WorkflowToScriptTranspiler(workflow).to_script(end_nodes)
+                            if print_script is True:
+                                # TODO: Syntax highlight?
+                                print('ComfyScript:', comfy_script, sep='\n')
+
+                            if save_script is True:
+                                super().add_text('ComfyScript', comfy_script, zip)
+                        except Exception:
+                            # Print stack trace, but do not block the original saving
+                            traceback.print_exc()
+                    else:
+                        print("ComfyScript: Failed to save ComfyScript because neither of workflow and prompt is in extra_pnginfo")
 
                 if 'ComfyScriptSource' in self._texts:
                     try:
@@ -165,7 +170,9 @@ def chunks(self):
     # setattr(SaveImage, SaveImage.FUNCTION, save_images_hook)
 
 try:
-    setup()
+    from ..config import settings
+    if settings.transpile.hook.enabled is True:
+        setup()
 except ImportError as e:
     success = False
     print(