Skip to content

The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.

add support to read pyproject.toml from custom node (#8357)

Terry Jia47d55b8b452f
diff --git a/comfy_config/config_parser.py b/comfy_config/config_parser.py
new file mode 100644
index 000000000..a9cbd94dd
--- /dev/null
+++ b/comfy_config/config_parser.py
@@ -0,0 +1,97 @@
+import os
+from pathlib import Path
+from typing import Optional
+
+from pydantic_settings import PydanticBaseSettingsSource, TomlConfigSettingsSource
+
+from comfy_config.types import (
+ ComfyConfig,
+ ProjectConfig,
+ PyProjectConfig,
+ PyProjectSettings
+)
+
+"""
+Extract configuration from a custom node directory's pyproject.toml file or a Python file.
+
+This function reads and parses the pyproject.toml file in the specified directory
+to extract project and ComfyUI-specific configuration information. If no
+pyproject.toml file is found, it creates a minimal configuration using the
+folder name as the project name. If a Python file is provided, it uses the
+file name (without extension) as the project name.
+
+Args:
+ path (str): Path to the directory containing the pyproject.toml file, or
+ path to a .py file. If pyproject.toml doesn't exist in a directory,
+ the folder name will be used as the default project name. If a .py
+ file is provided, the filename (without .py extension) will be used
+ as the project name.
+
+Returns:
+ Optional[PyProjectConfig]: A PyProjectConfig object containing:
+ - project: Basic project information (name, version, dependencies, etc.)
+ - tool_comfy: ComfyUI-specific configuration (publisher_id, models, etc.)
+ Returns None if configuration extraction fails or if the provided file
+ is not a Python file.
+
+Notes:
+ - If pyproject.toml is missing in a directory, creates a default config with folder name
+ - If a .py file is provided, creates a default config with filename (without extension)
+ - Returns None for non-Python files
+
+Example:
+ >>> from comfy_config import config_parser
+ >>> # For directory
+ >>> custom_node_dir = os.path.dirname(os.path.realpath(__file__))
+ >>> project_config = config_parser.extract_node_configuration(custom_node_dir)
+ >>> print(project_config.project.name) # "my_custom_node" or name from pyproject.toml
+ >>>
+ >>> # For single-file Python node file
+ >>> py_file_path = os.path.realpath(__file__) # "/path/to/my_node.py"
+ >>> project_config = config_parser.extract_node_configuration(py_file_path)
+ >>> print(project_config.project.name) # "my_node"
+"""
+def extract_node_configuration(path) -> Optional[PyProjectConfig]:
+ if os.path.isfile(path):
+ file_path = Path(path)
+
+ if file_path.suffix.lower() != '.py':
+ return None
+
+ project_name = file_path.stem
+ project = ProjectConfig(name=project_name)
+ comfy = ComfyConfig()
+ return PyProjectConfig(project=project, tool_comfy=comfy)
+
+ folder_name = os.path.basename(path)
+ toml_path = Path(path) / "pyproject.toml"
+
+ if not toml_path.exists():
+ project = ProjectConfig(name=folder_name)
+ comfy = ComfyConfig()
+ return PyProjectConfig(project=project, tool_comfy=comfy)
+
+ raw_settings = load_pyproject_settings(toml_path)
+
+ project_data = raw_settings.project
+
+ tool_data = raw_settings.tool
+ comfy_data = tool_data.get("comfy", {}) if tool_data else {}
+
+ return PyProjectConfig(project=project_data, tool_comfy=comfy_data)
+
+
+def load_pyproject_settings(toml_path: Path) -> PyProjectSettings:
+ class PyProjectLoader(PyProjectSettings):
+ @classmethod
+ def settings_customise_sources(
+ cls,
+ settings_cls,
+ init_settings: PydanticBaseSettingsSource,
+ env_settings: PydanticBaseSettingsSource,
+ dotenv_settings: PydanticBaseSettingsSource,
+ file_secret_settings: PydanticBaseSettingsSource,
+ ):
+ return (TomlConfigSettingsSource(settings_cls, toml_path),)
+
+ return PyProjectLoader()
diff --git a/comfy_config/types.py b/comfy_config/types.py
new file mode 100644
index 000000000..611982083
--- /dev/null
+++ b/comfy_config/types.py
@@ -0,0 +1,80 @@
+from pydantic import BaseModel, Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from typing import List, Optional
+
+# IMPORTANT: The type definitions specified in pyproject.toml for custom nodes
+# must remain synchronized with the corresponding files in the https://github.com/Comfy-Org/comfy-cli/blob/main/comfy_cli/registry/types.py.
+# Any changes to one must be reflected in the other to maintain consistency.
+
+class NodeVersion(BaseModel):
+ changelog: str
+ dependencies: List[str]
+ deprecated: bool
+ id: str
+ version: str
+ download_url: str
+
+
+class Node(BaseModel):
+ id: str
+ name: str
+ description: str
+ author: Optional[str] = None
+ license: Optional[str] = None
+ icon: Optional[str] = None
+ repository: Optional[str] = None
+ tags: List[str] = Field(default_factory=list)
+ latest_version: Optional[NodeVersion] = None
+
+
+class PublishNodeVersionResponse(BaseModel):
+ node_version: NodeVersion
+ signedUrl: str
+
+
+class URLs(BaseModel):
+ homepage: str = Field(default="", alias="Homepage")
+ documentation: str = Field(default="", alias="Documentation")
+ repository: str = Field(default="", alias="Repository")
+ issues: str = Field(default="", alias="Issues")
+
+
+class Model(BaseModel):
+ location: str
+ model_url: str
+
+
+class ComfyConfig(BaseModel):
+ publisher_id: str = Field(default="", alias="PublisherId")
+ display_name: str = Field(default="", alias="DisplayName")
+ icon: str = Field(default="", alias="Icon")
+ models: List[Model] = Field(default_factory=list, alias="Models")
+ includes: List[str] = Field(default_factory=list)
+
+
+class License(BaseModel):
+ file: str = ""
+ text: str = ""
+
+
+class ProjectConfig(BaseModel):
+ name: str = ""
+ description: str = ""
+ version: str = "1.0.0"
+ requires_python: str = Field(default=">= 3.9", alias="requires-python")
+ dependencies: List[str] = Field(default_factory=list)
+ license: License = Field(default_factory=License)
+ urls: URLs = Field(default_factory=URLs)
+
+
+class PyProjectConfig(BaseModel):
+ project: ProjectConfig = Field(default_factory=ProjectConfig)
+ tool_comfy: ComfyConfig = Field(default_factory=ComfyConfig)
+
+
+class PyProjectSettings(BaseSettings):
+ project: dict = Field(default_factory=dict)
+
+ tool: dict = Field(default_factory=dict)
+
+ model_config = SettingsConfigDict()