Merge pull request #75 from pydn/dev

Add UI button to save script directly form ComfyUI web app

Author: pydn

README.md

@@ -116,15 +116,27 @@ if __name__ == "__main__":
 - Creating large queues for image generation (For example, you could adjust the script to generate 1000 images without clicking ctrl+enter 1000 times)
 - Easily expanding or iterating on your architecture in Python once a foundational workflow is in place in the GUI
 
+## V1.3.0 Release Notes
+- Generate .py file directly from the ComfyUI Web App
+
+![Save As Script](images/save_as_script.png)
+
+## V1.2.1 Release Notes
+- Dynamically change `comfyui_to_python.py` parameters with CLI arguments
+- Hotfix to handle nodes that accept kwargs.
+
+## V1.2.0 Release Notes
+- Updates to adhere to latest changes from `ComfyUI`
+
 ## V1.0.0 Release Notes
 - **Use all the custom nodes!**
     - Custom nodes are now supported. If you run into any issues with code execution, first ensure that the each node works as expected in the GUI. If it works in the GUI, but not in the generated script, please submit an issue.
 
 
-## Usage
+## Installation
 
 
-1. Navigate to your `ComfyUI` directory
+1. Navigate to your `ComfyUI/custom_nodes` directory
 
 2. Clone this repo
     ```bash
@@ -135,8 +147,8 @@ if __name__ == "__main__":
     ```
     /comfy
     /comfy_extras
-    /ComfyUI-to-Python-Extension
     /custom_nodes
+    --/ComfyUI-to-Python-Extension
     /input
     /models
     /output
@@ -157,30 +169,44 @@ if __name__ == "__main__":
     server.py
     ```
 
-3. Navigate to the `ComfyUI-to-Python-Extension` folder and install requirements
+## Web App Use
+1. Launch ComfyUI
+
+2. Load your favorite workflow and click `Save As Script`
+
+![Save As Script](images/save_as_script.png)
+
+3. Type your desired file name into the pop up screen.
+
+4. Move .py file from your downloads folder to your `ComfyUI` directory.
+
+5. Now you can execute the newly created .py file to generate images without launching a server.
+
+## CLI Usage
+1. Navigate to the `ComfyUI-to-Python-Extension` folder and install requirements
     ```bash
     pip install -r requirements.txt
     ```
 
-4. Launch ComfyUI, click the gear icon over `Queue Prompt`, then check `Enable Dev mode Options`. **THE SCRIPT WILL NOT WORK IF YOU DO NOT ENABLE THIS OPTION!**
+2. Launch ComfyUI, click the gear icon over `Queue Prompt`, then check `Enable Dev mode Options`. **THE SCRIPT WILL NOT WORK IF YOU DO NOT ENABLE THIS OPTION!**
 
 ![Enable Dev Mode Options](images/dev_mode_options.jpg)
 
-5. Load up your favorite workflows, then click the newly enabled `Save (API Format)` button under Queue Prompt
+3. Load up your favorite workflows, then click the newly enabled `Save (API Format)` button under Queue Prompt
 
-6. Move the downloaded .json workflow file to your `ComfyUI/ComfyUI-to-Python-Extension` folder
+4. Move the downloaded .json workflow file to your `ComfyUI/ComfyUI-to-Python-Extension` folder
 
-7. If needed, add arguments when executing `comfyui_to_python.py` to update the default `input_file` and `output_file` to match your .json workflow file and desired .py file name. By default, the script will look for a file called `workflow_api.json`. You can also update the `queue_size` variable to your desired number of images that you want to generate in a single script execution. By default, the scripts will generate 10 images. Run `python comfyui_to_python.py --help` for more details.
+5. If needed, add arguments when executing `comfyui_to_python.py` to update the default `input_file` and `output_file` to match your .json workflow file and desired .py file name. By default, the script will look for a file called `workflow_api.json`. You can also update the `queue_size` variable to your desired number of images that you want to generate in a single script execution. By default, the scripts will generate 10 images. Run `python comfyui_to_python.py --help` for more details.
 
-8a. Run the script with default arguments:
+6a. Run the script with default arguments:
    ```bash
    python comfyui_to_python.py
    ```
-8b. Run the script with optional arguments:
+6b. Run the script with optional arguments:
    ```bash
    python comfyui_to_python.py --input_file "workflow_api (2).json" --output_file my_workflow.py --queue_size 100
    ```
 
-9. After running `comfyui_to_python.py`, a new .py file will be created in the current working directory. If you made no changes, look for `workflow_api.py`.
+7. After running `comfyui_to_python.py`, a new .py file will be created in the current working directory. If you made no changes, look for `workflow_api.py`.
 
-10. Now you can execute the newly created .py file to generate images without launching a server.
+8. Now you can execute the newly created .py file to generate images without launching a server.

__init__.py

@@ -0,0 +1,58 @@
+import sys
+import os
+
+from io import StringIO
+
+import traceback
+
+from aiohttp import web
+
+ext_dir = os.path.dirname(__file__)
+sys.path.append(ext_dir)
+
+try:
+    import black
+except ImportError:
+    print("Unable to import requirements for ComfyUI-SaveAsScript.")
+    print("Installing...")
+
+    import importlib
+
+    spec = importlib.util.spec_from_file_location(
+        "impact_install", os.path.join(os.path.dirname(__file__), "install.py")
+    )
+    impact_install = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(impact_install)
+
+    print("Successfully installed. Hopefully, at least.")
+
+# Prevent reimporting of custom nodes
+os.environ["RUNNING_IN_COMFYUI"] = "TRUE"
+
+from comfyui_to_python import ComfyUItoPython
+
+sys.path.append(os.path.dirname(os.path.dirname(ext_dir)))
+
+import server
+
+WEB_DIRECTORY = "js"
+NODE_CLASS_MAPPINGS = {}
+
+
+@server.PromptServer.instance.routes.post("/saveasscript")
+async def save_as_script(request):
+    try:
+        data = await request.json()
+        name = data["name"]
+        workflow = data["workflow"]
+
+        sio = StringIO()
+        ComfyUItoPython(workflow=workflow, output_file=sio)
+
+        sio.seek(0)
+        data = sio.read()
+
+        return web.Response(text=data, status=200)
+    except Exception as e:
+        traceback.print_exc()
+        return web.Response(text=str(e), status=500)

comfyui_to_python.py

@@ -6,7 +6,7 @@
 import random
 import sys
 import re
-from typing import Dict, List, Callable, Tuple
+from typing import Dict, List, Any, Callable, Tuple, TextIO
 from argparse import ArgumentParser
 
 import black
@@ -20,7 +20,7 @@
     get_value_at_index,
 )
 
-sys.path.append("../")
+add_comfyui_directory_to_sys_path()
 from nodes import NODE_CLASS_MAPPINGS
 
 
@@ -36,7 +36,7 @@ class FileHandler:
     """
 
     @staticmethod
-    def read_json_file(file_path: str) -> dict:
+    def read_json_file(file_path: str | TextIO, encoding: str = "utf-8") -> dict:
         """
         Reads a JSON file and returns its contents as a dictionary.
 
@@ -51,35 +51,14 @@ def read_json_file(file_path: str) -> dict:
             ValueError: If the file is not a valid JSON.
         """
 
-        try:
-            with open(file_path, "r") as file:
-                data = json.load(file)
-            return data
-
-        except FileNotFoundError:
-            # Get the directory from the file_path
-            directory = os.path.dirname(file_path)
-
-            # If the directory is an empty string (which means file is in the current directory),
-            # get the current working directory
-            if not directory:
-                directory = os.getcwd()
-
-            # Find all JSON files in the directory
-            json_files = glob.glob(f"{directory}/*.json")
-
-            # Format the list of JSON files as a string
-            json_files_str = "\n".join(json_files)
-
-            raise FileNotFoundError(
-                f"\n\nFile not found: {file_path}. JSON files in the directory:\n{json_files_str}"
-            )
-
-        except json.JSONDecodeError:
-            raise ValueError(f"Invalid JSON format in file: {file_path}")
+        if hasattr(file_path, "read"):
+            return json.load(file_path)
+        with open(file_path, "r", encoding="utf-8") as file:
+            data = json.load(file)
+        return data
 
     @staticmethod
-    def write_code_to_file(file_path: str, code: str) -> None:
+    def write_code_to_file(file_path: str | TextIO, code: str) -> None:
         """Write the specified code to a Python file.
 
         Args:
@@ -89,16 +68,19 @@ def write_code_to_file(file_path: str, code: str) -> None:
         Returns:
             None
         """
-        # Extract directory from the filename
-        directory = os.path.dirname(file_path)
+        if isinstance(file_path, str):
+            # Extract directory from the filename
+            directory = os.path.dirname(file_path)
 
-        # If the directory does not exist, create it
-        if directory and not os.path.exists(directory):
-            os.makedirs(directory)
+            # If the directory does not exist, create it
+            if directory and not os.path.exists(directory):
+                os.makedirs(directory)
 
-        # Save the code to a .py file
-        with open(file_path, "w") as file:
-            file.write(code)
+            # Save the code to a .py file
+            with open(file_path, "w", encoding="utf-8") as file:
+                file.write(code)
+        else:
+            file_path.write(code)
 
 
 class LoadOrderDeterminer:
@@ -203,15 +185,12 @@ def __init__(self, node_class_mappings: Dict, base_node_class_mappings: Dict):
     def generate_workflow(
         self,
         load_order: List,
-        filename: str = "generated_code_workflow.py",
         queue_size: int = 10,
     ) -> str:
         """Generate the execution code based on the load order.
 
         Args:
             load_order (List): A list of tuples representing the load order.
-            filename (str): The name of the Python file to which the code should be saved.
-                Defaults to 'generated_code_workflow.py'.
             queue_size (int): The number of photos that will be created by the script.
 
         Returns:
@@ -515,23 +494,37 @@ class ComfyUItoPython:
 
     def __init__(
         self,
-        input_file: str,
-        output_file: str,
-        queue_size: int = 10,
+        workflow: str = "",
+        input_file: str = "",
+        output_file: str | TextIO = "",
+        queue_size: int = 1,
         node_class_mappings: Dict = NODE_CLASS_MAPPINGS,
+        needs_init_custom_nodes: bool = False,
     ):
-        """Initialize the ComfyUItoPython class with the given parameters.
-
+        """Initialize the ComfyUItoPython class with the given parameters. Exactly one of workflow or input_file must be specified.
         Args:
+            workflow (str): The workflow's JSON.
             input_file (str): Path to the input JSON file.
-            output_file (str): Path to the output Python file.
-            queue_size (int): The number of times a workflow will be executed by the script. Defaults to 10.
+            output_file (str | TextIO): Path to the output file or a file-like object.
+            queue_size (int): The number of times a workflow will be executed by the script. Defaults to 1.
             node_class_mappings (Dict): Mappings of node classes. Defaults to NODE_CLASS_MAPPINGS.
+            needs_init_custom_nodes (bool): Whether to initialize custom nodes. Defaults to False.
         """
+        if input_file and workflow:
+            raise ValueError("Can't provide both input_file and workflow")
+        elif not input_file and not workflow:
+            raise ValueError("Needs input_file or workflow")
+
+        if not output_file:
+            raise ValueError("Needs output_file")
+
+        self.workflow = workflow
         self.input_file = input_file
         self.output_file = output_file
         self.queue_size = queue_size
         self.node_class_mappings = node_class_mappings
+        self.needs_init_custom_nodes = needs_init_custom_nodes
+
         self.base_node_class_mappings = copy.deepcopy(self.node_class_mappings)
         self.execute()
 
@@ -541,11 +534,18 @@ def execute(self):
         Returns:
             None
         """
-        # Step 1: Import all custom nodes
-        import_custom_nodes()
+        # Step 1: Import all custom nodes if we need to
+        if self.needs_init_custom_nodes:
+            import_custom_nodes()
+        else:
+            # If they're already imported, we don't know which nodes are custom nodes, so we need to import all of them
+            self.base_node_class_mappings = {}
 
         # Step 2: Read JSON data from the input file
-        data = FileHandler.read_json_file(self.input_file)
+        if self.input_file:
+            data = FileHandler.read_json_file(self.input_file)
+        else:
+            data = json.loads(self.workflow)
 
         # Step 3: Determine the load order
         load_order_determiner = LoadOrderDeterminer(data, self.node_class_mappings)
@@ -556,7 +556,7 @@ def execute(self):
             self.node_class_mappings, self.base_node_class_mappings
         )
         generated_code = code_generator.generate_workflow(
-            load_order, filename=self.output_file, queue_size=self.queue_size
+            load_order, queue_size=self.queue_size
         )
 
         # Step 5: Write the generated code to a file
@@ -582,7 +582,12 @@ def run(
     Returns:
         None
     """
-    ComfyUItoPython(input_file, output_file, queue_size)
+    ComfyUItoPython(
+        input_file=input_file,
+        output_file=output_file,
+        queue_size=queue_size,
+        needs_init_custom_nodes=True,
+    )
 
 
 def main() -> None:
@@ -612,7 +617,7 @@ def main() -> None:
         default=DEFAULT_QUEUE_SIZE,
     )
     pargs = parser.parse_args()
-    ComfyUItoPython(**vars(pargs))
+    run(**vars(pargs))
     print("Done.")
 
 

comfyui_to_python_utils.py

@@ -2,8 +2,6 @@
 from typing import Sequence, Mapping, Any, Union
 import sys
 
-sys.path.append("../")
-
 
 def import_custom_nodes() -> None:
     """Find all custom nodes in the custom_nodes folder and add those node objects to NODE_CLASS_MAPPINGS

images/save_as_script.png

@@ -0,0 +1,20 @@
+import os
+import sys
+
+from subprocess import Popen, check_output, PIPE
+
+requirements = open(os.path.join(os.path.dirname(__file__), "requirements.txt")).read().split("\n")
+
+installed_packages = check_output(
+    [sys.executable, "-m", "pip", "list"],
+    universal_newlines=True
+).split("\n")
+
+installed_packages = set([package.split(" ")[0].lower() for package in installed_packages if package.strip()])
+
+for requirement in requirements:
+    if requirement.lower() not in installed_packages:
+        print(f"Installing requirements...")
+        Popen([sys.executable, "-m", "pip", "install", "-r", "requirements.txt"], stdout=PIPE, stderr=PIPE, cwd=os.path.dirname(__file__)).communicate()
+        print(f"Installed.")
+        break