refactor: replace essentials_category string literals with constants

Yourz · ampcode-com · Yourz · commit 1aaf1dc40a34 · 2026-02-19T07:33:23.000+08:00
Amp-Thread-ID: https://ampcode.com/threads/T-019c7303-ab53-7341-be76-a5da1f7a657e Co-authored-by: Amp <amp@ampcode.com>
diff --git a/comfy/essentials_category.py b/comfy/essentials_category.py
@@ -0,0 +1,8 @@
+ESSENTIALS_BASICS = "Basics"
+ESSENTIALS_IMAGE_GENERATION = "Image Generation"
+ESSENTIALS_IMAGE_TOOLS = "Image Tools"
+ESSENTIALS_TEXT_GENERATION = "Text Generation"
+ESSENTIALS_VIDEO_GENERATION = "Video Generation"
+ESSENTIALS_VIDEO_TOOLS = "Video Tools"
+ESSENTIALS_AUDIO = "Audio"
+ESSENTIALS_3D = "3D"
diff --git a/comfy_api_nodes/nodes_hunyuan3d.py b/comfy_api_nodes/nodes_hunyuan3d.py
@@ -1,5 +1,6 @@
 from typing_extensions import override
 
+from comfy.essentials_category import ESSENTIALS_3D
 from comfy_api.latest import IO, ComfyExtension, Input, Types
 from comfy_api_nodes.apis.hunyuan3d import (
     Hunyuan3DViewImage,
@@ -54,7 +55,7 @@ def define_schema(cls):
             node_id="TencentTextToModelNode",
             display_name="Text to 3D model",
             category="api node/3d/Tencent",
-            essentials_category="3D",
+            essentials_category=ESSENTIALS_3D,
             inputs=[
                 IO.Combo.Input(
                     "model",
@@ -169,7 +170,7 @@ def define_schema(cls):
             node_id="TencentImageToModelNode",
             display_name="Image to 3D Model",
             category="api node/3d/Tencent",
-            essentials_category="3D",
+            essentials_category=ESSENTIALS_3D,
             inputs=[
                 IO.Combo.Input(
                     "model",
diff --git a/comfy_api_nodes/nodes_kling.py b/comfy_api_nodes/nodes_kling.py
@@ -11,6 +11,7 @@
 import torch
 from typing_extensions import override
 
+from comfy.essentials_category import ESSENTIALS_VIDEO_GENERATION
 from comfy_api.latest import IO, ComfyExtension, Input, InputImpl
 from comfy_api_nodes.apis import (
     KlingCameraControl,
@@ -2262,7 +2263,7 @@ def define_schema(cls) -> IO.Schema:
             node_id="KlingLipSyncAudioToVideoNode",
             display_name="Lipsync",
             category="api node/video/Kling",
-            essentials_category="Video Generation",
+            essentials_category=ESSENTIALS_VIDEO_GENERATION,
             description="Kling Lip Sync Audio to Video Node. Syncs mouth movements in a video file to the audio content of an audio file. When using, ensure that the audio contains clearly distinguishable vocals and that the video contains a distinct face. The audio file should not be larger than 5MB. The video file should not be larger than 100MB, should have height/width between 720px and 1920px, and should be between 2s and 10s in length.",
             inputs=[
                 IO.Video.Input("video"),
diff --git a/comfy_api_nodes/nodes_openai.py b/comfy_api_nodes/nodes_openai.py
@@ -9,6 +9,7 @@
 from typing_extensions import override
 
 import folder_paths
+from comfy.essentials_category import ESSENTIALS_TEXT_GENERATION
 from comfy_api.latest import IO, ComfyExtension, Input
 from comfy_api_nodes.apis.openai import (
     InputFileContent,
@@ -575,7 +576,7 @@ def define_schema(cls):
             node_id="OpenAIChatNode",
             display_name="Text generation (LLM)",
             category="api node/text/OpenAI",
-            essentials_category="Text Generation",
+            essentials_category=ESSENTIALS_TEXT_GENERATION,
             description="Generate text responses from an OpenAI model.",
             inputs=[
                 IO.String.Input(
diff --git a/comfy_api_nodes/nodes_recraft.py b/comfy_api_nodes/nodes_recraft.py
@@ -6,6 +6,7 @@
 from typing_extensions import override
 
 from comfy.utils import ProgressBar
+from comfy.essentials_category import ESSENTIALS_IMAGE_TOOLS
 from comfy_api.latest import IO, ComfyExtension
 from comfy_api_nodes.apis.recraft import (
     RECRAFT_V4_PRO_SIZES,
@@ -963,7 +964,7 @@ def define_schema(cls):
             node_id="RecraftRemoveBackgroundNode",
             display_name="Remove Background",
             category="api node/image/Recraft",
-            essentials_category="Image Tools",
+            essentials_category=ESSENTIALS_IMAGE_TOOLS,
             description="Remove background from image, and return processed image and mask.",
             inputs=[
                 IO.Image.Input("image"),
diff --git a/comfy_api_nodes/nodes_stability.py b/comfy_api_nodes/nodes_stability.py
@@ -2,6 +2,7 @@
 from typing import Optional
 from typing_extensions import override
 
+from comfy.essentials_category import ESSENTIALS_AUDIO
 from comfy_api.latest import ComfyExtension, Input, IO
 from comfy_api_nodes.apis.stability import (
     StabilityUpscaleConservativeRequest,
@@ -624,7 +625,7 @@ def define_schema(cls):
             node_id="StabilityTextToAudio",
             display_name="Music generation",
             category="api node/audio/Stability AI",
-            essentials_category="Audio",
+            essentials_category=ESSENTIALS_AUDIO,
             description=cleandoc(cls.__doc__ or ""),
             inputs=[
                 IO.Combo.Input(
diff --git a/comfy_extras/nodes_audio.py b/comfy_extras/nodes_audio.py
@@ -5,6 +5,7 @@
 import torch
 import comfy.model_management
 import folder_paths
+from comfy.essentials_category import ESSENTIALS_AUDIO
 import os
 import hashlib
 import node_helpers
@@ -159,7 +160,7 @@ def define_schema(cls):
             search_aliases=["export flac"],
             display_name="Save Audio",
             category="audio",
-            essentials_category="Audio",
+            essentials_category=ESSENTIALS_AUDIO,
             inputs=[
                 IO.Audio.Input("audio"),
                 IO.String.Input("filename_prefix", default="audio/ComfyUI"),
@@ -301,7 +302,7 @@ def define_schema(cls):
             search_aliases=["import audio", "open audio", "audio file"],
             display_name="Load Audio",
             category="audio",
-            essentials_category="Audio",
+            essentials_category=ESSENTIALS_AUDIO,
             inputs=[
                 IO.Combo.Input("audio", upload=IO.UploadType.audio, options=sorted(files)),
             ],
diff --git a/comfy_extras/nodes_canny.py b/comfy_extras/nodes_canny.py
@@ -2,6 +2,7 @@
 from typing_extensions import override
 
 import comfy.model_management
+from comfy.essentials_category import ESSENTIALS_IMAGE_TOOLS
 from comfy_api.latest import ComfyExtension, io
 
 
@@ -12,7 +13,7 @@ def define_schema(cls):
             node_id="Canny",
             search_aliases=["edge detection", "outline", "contour detection", "line art"],
             category="image/preprocessors",
-            essentials_category="Image Tools",
+            essentials_category=ESSENTIALS_IMAGE_TOOLS,
             inputs=[
                 io.Image.Input("image"),
                 io.Float.Input("low_threshold", default=0.4, min=0.01, max=0.99, step=0.01),
diff --git a/comfy_extras/nodes_hunyuan3d.py b/comfy_extras/nodes_hunyuan3d.py
@@ -4,6 +4,7 @@
 import struct
 import numpy as np
 from comfy.ldm.modules.diffusionmodules.mmdit import get_1d_sincos_pos_embed_from_grid_torch
+from comfy.essentials_category import ESSENTIALS_BASICS
 import folder_paths
 import comfy.model_management
 from comfy.cli_args import args
@@ -621,7 +622,7 @@ def define_schema(cls):
             display_name="Save 3D Model",
             search_aliases=["export 3d model", "save mesh"],
             category="3d",
-            essentials_category="Basic",
+            essentials_category=ESSENTIALS_BASICS,
             is_output_node=True,
             inputs=[
                 IO.MultiType.Input(
diff --git a/comfy_extras/nodes_images.py b/comfy_extras/nodes_images.py
@@ -2,6 +2,7 @@
 
 import nodes
 import folder_paths
+from comfy.essentials_category import ESSENTIALS_IMAGE_TOOLS
 
 import json
 import os
@@ -26,7 +27,7 @@ def define_schema(cls):
             display_name="Crop Image (Deprecated)",
             category="image/transform",
             is_deprecated=True,
-            essentials_category="Image Tools",
+            essentials_category=ESSENTIALS_IMAGE_TOOLS,
             inputs=[
                 IO.Image.Input("image"),
                 IO.Int.Input("width", default=512, min=1, max=nodes.MAX_RESOLUTION, step=1),
@@ -591,7 +592,7 @@ def define_schema(cls):
             display_name="Rotate",
             search_aliases=["turn", "flip orientation"],
             category="image/transform",
-            essentials_category="Image Tools",
+            essentials_category=ESSENTIALS_IMAGE_TOOLS,
             inputs=[
                 IO.Image.Input("image"),
                 IO.Combo.Input("rotation", options=["none", "90 degrees", "180 degrees", "270 degrees"]),
diff --git a/comfy_extras/nodes_load_3d.py b/comfy_extras/nodes_load_3d.py
@@ -4,6 +4,7 @@
 import uuid
 
 from typing_extensions import override
+from comfy.essentials_category import ESSENTIALS_BASICS
 from comfy_api.latest import IO, UI, ComfyExtension, InputImpl, Types
 
 from pathlib import Path
@@ -31,7 +32,7 @@ def define_schema(cls):
             node_id="Load3D",
             display_name="Load 3D model",
             category="3d",
-            essentials_category="Basic",
+            essentials_category=ESSENTIALS_BASICS,
             is_experimental=True,
             inputs=[
                 IO.Combo.Input("model_file", options=sorted(files), upload=IO.UploadType.model),
diff --git a/comfy_extras/nodes_post_processing.py b/comfy_extras/nodes_post_processing.py
@@ -8,6 +8,7 @@
 from typing import TypedDict, Literal
 
 import comfy.utils
+from comfy.essentials_category import ESSENTIALS_IMAGE_TOOLS
 import comfy.model_management
 from comfy_extras.nodes_latent import reshape_latent_to
 import node_helpers
@@ -77,7 +78,7 @@ def define_schema(cls):
         return io.Schema(
             node_id="ImageBlur",
             category="image/postprocessing",
-            essentials_category="Image Tools",
+            essentials_category=ESSENTIALS_IMAGE_TOOLS,
             inputs=[
                 io.Image.Input("image"),
                 io.Int.Input("blur_radius", default=1, min=1, max=31, step=1),
diff --git a/comfy_extras/nodes_video.py b/comfy_extras/nodes_video.py
@@ -4,6 +4,7 @@
 import av
 import torch
 import folder_paths
+from comfy.essentials_category import ESSENTIALS_BASICS, ESSENTIALS_VIDEO_TOOLS
 import json
 from typing import Optional
 from typing_extensions import override
@@ -73,7 +74,7 @@ def define_schema(cls):
             search_aliases=["export video"],
             display_name="Save Video",
             category="image/video",
-            essentials_category="Basic",
+            essentials_category=ESSENTIALS_BASICS,
             description="Saves the input images to your ComfyUI output directory.",
             inputs=[
                 io.Video.Input("video", tooltip="The video to save."),
@@ -147,7 +148,7 @@ def define_schema(cls):
             search_aliases=["extract frames", "split video", "video to images", "demux"],
             display_name="Extract frame",
             category="image/video",
-            essentials_category="Video Tools",
+            essentials_category=ESSENTIALS_VIDEO_TOOLS,
             description="Extracts all components from a video: frames, audio, and framerate.",
             inputs=[
                 io.Video.Input("video", tooltip="The video to extract components from."),
@@ -176,7 +177,7 @@ def define_schema(cls):
             search_aliases=["import video", "open video", "video file"],
             display_name="Load Video",
             category="image/video",
-            essentials_category="Basic",
+            essentials_category=ESSENTIALS_BASICS,
             inputs=[
                 io.Combo.Input("file", options=sorted(files), upload=io.UploadType.video),
             ],
diff --git a/nodes.py b/nodes.py
@@ -8,6 +8,8 @@
 import glob
 import hashlib
 import inspect
+
+from comfy.essentials_category import ESSENTIALS_BASICS, ESSENTIALS_IMAGE_GENERATION, ESSENTIALS_IMAGE_TOOLS
 import traceback
 import math
 import time
@@ -69,7 +71,7 @@ def INPUT_TYPES(s) -> InputTypeDict:
     FUNCTION = "encode"
 
     CATEGORY = "conditioning"
-    ESSENTIALS_CATEGORY = "Basic"
+    ESSENTIALS_CATEGORY = ESSENTIALS_BASICS
     DESCRIPTION = "Encodes a text prompt using a CLIP model into an embedding that can be used to guide the diffusion model towards generating specific images."
     SEARCH_ALIASES = ["text", "prompt", "text prompt", "positive prompt", "negative prompt", "encode text", "text encoder", "encode prompt"]
 
@@ -668,7 +670,7 @@ def set_last_layer(self, clip, stop_at_clip_layer):
         return (clip,)
 
 class LoraLoader:
-    ESSENTIALS_CATEGORY = "Image Generation"
+    ESSENTIALS_CATEGORY = ESSENTIALS_IMAGE_GENERATION
 
     def __init__(self):
         self.loaded_lora = None
@@ -1651,7 +1653,7 @@ def INPUT_TYPES(s):
     OUTPUT_NODE = True
 
     CATEGORY = "image"
-    ESSENTIALS_CATEGORY = "Basic"
+    ESSENTIALS_CATEGORY = ESSENTIALS_BASICS
     DESCRIPTION = "Saves the input images to your ComfyUI output directory."
     SEARCH_ALIASES = ["save", "save image", "export image", "output image", "write image", "download"]
 
@@ -1710,7 +1712,7 @@ def INPUT_TYPES(s):
                 }
 
     CATEGORY = "image"
-    ESSENTIALS_CATEGORY = "Basic"
+    ESSENTIALS_CATEGORY = ESSENTIALS_BASICS
     SEARCH_ALIASES = ["load image", "open image", "import image", "image input", "upload image", "read image", "image loader"]
 
     RETURN_TYPES = ("IMAGE", "MASK")
@@ -1868,7 +1870,7 @@ def INPUT_TYPES(s):
     FUNCTION = "upscale"
 
     CATEGORY = "image/upscaling"
-    ESSENTIALS_CATEGORY = "Image Tools"
+    ESSENTIALS_CATEGORY = ESSENTIALS_IMAGE_TOOLS
     SEARCH_ALIASES = ["resize", "resize image", "scale image", "image resize", "zoom", "zoom in", "change size"]
 
     def upscale(self, image, upscale_method, width, height, crop):
@@ -1908,7 +1910,7 @@ def upscale(self, image, upscale_method, scale_by):
 
 class ImageInvert:
     SEARCH_ALIASES = ["reverse colors"]
-    ESSENTIALS_CATEGORY = "Image Tools"
+    ESSENTIALS_CATEGORY = ESSENTIALS_IMAGE_TOOLS
 
     @classmethod
     def INPUT_TYPES(s):
@@ -1925,7 +1927,7 @@ def invert(self, image):
 
 class ImageBatch:
     SEARCH_ALIASES = ["combine images", "merge images", "stack images"]
-    ESSENTIALS_CATEGORY = "Image Tools"
+    ESSENTIALS_CATEGORY = ESSENTIALS_IMAGE_TOOLS
 
     @classmethod
     def INPUT_TYPES(s):
