custom-nodes/v3_migration

[giscus[bot]]

custom-nodes/v3_migration

How to migrate your existing V1 nodes to the new V3 schema.

https://docs.comfy.org/custom-nodes/v3_migration

[set-soft]

Please mention that to name an output you must use something like:

io.Image.Output(display_name="images", tooltip=IMAGE_TOOLTIP)

And that

io.Image.Output("images", tooltip=IMAGE_TOOLTIP)

Is interpreted as id="images"

[set-soft]

Also: which ComfyUI version is required for v3 API?

BTW: Migrating nodes that inherit from other nodes generates really confusing effects, like you see on the frontend the right schema, but the validation is fully messed. As the spec is moving to stateless classes I think the docs should mention that inheritance is discouraged. And for the record: the classes didn't call define_schema of the parent, so the problem is related to some magic under the hood.

[set-soft]

Looks like this is 0.3.48, so we need to add requires-comfyui = ">=0.3.48"

[geroldmeisinger]

_io.py

class NumberDisplay(str, Enum):
    number = "number"
    slider = "slider"

[geroldmeisinger]

also see Node Definitions https://docs.comfy.org/specs/nodedef_json

[geroldmeisinger]

for the __init__.py containing:

__all__ = [
    "NODE_CLASS_MAPPINGS",
    "NODE_DISPLAY_NAME_MAPPINGS",
    "WEB_DIRECTORY",
]

from .src.subproject import (NODE_CLASS_MAPPINGS, NODE_DISPLAY_NAME_MAPPINGS)

use this instead:

from comfy_api.latest import ComfyExtension, io

from mymodule.mynode import MyNode

WEB_DIRECTORY = "./web"

__all__ = ["WEB_DIRECTORY"]

async def comfy_entrypoint() -> ComfyExtension:
	class MyExtension(ComfyExtension):
		async def get_node_list(self) -> list[type[io.ComfyNode]]:
			return [
				MyNode,
			]

	return MyExtension()

[geroldmeisinger]

what about

class AnyType(str):
    def __ne__(self, __value: object) -> bool:
        return False

any = AnyType("*")

?

[geroldmeisinger]

io.AnyType

[geroldmeisinger]

Exception(f"Node {cls.name} is not expandable, but expand included in NodeOutput; developer should set enable_expand=True on node's Schema to allow this.

set enable_expand=True in io.Schema of your node class

[geroldmeisinger]

What about "FLOAT, INT"?

[geroldmeisinger]

What about

    @classmethod
    def IS_CHANGED(s, image):
        return float("NaN")

fingerprint_inputs() requires str now

return str(time.time()) but this can - theoretically - produce false negatives.

[geroldmeisinger]

What about

        "hidden": {
            "unique_id": "UNIQUE_ID",
            "prompt": "PROMPT", 
            "extra_pnginfo": "EXTRA_PNGINFO",
        }

?

[geroldmeisinger]

	@classmethod
	def define_schema(cls) -> io.Schema:
		return io.Schema(
			inputs = [...],
			outputs = [...],
			hidden=[
				io.Hidden.unique_id,
				io.Hidden.prompt,
				io.Hidden.extra_pnginfo,
				io.Hidden.dynprompt,
				io.Hidden.auth_token_comfy_org,
				io.Hidden.api_key_comfy_org,
			], ...)


	@classmethod
	def execute(self, input0: str, ...) -> io.NodeOutput:
		return io.NodeOutput(self.hidden.unique_id)