mirror of
https://github.com/comfyanonymous/ComfyUI.git
synced 2025-03-15 14:09:36 +00:00
Fix link pointing to non-exisiting docs (#6891)
* Fix link pointing to non-exisiting docs The current link is pointing to a path that does not exist any longer. I changed it to point to the currect correct path for custom nodes datatypes. * Update node_typing.py
This commit is contained in:
parent
b4d3652d88
commit
c5be423d6b
@ -85,7 +85,7 @@ class InputTypeOptions(TypedDict):
|
|||||||
|
|
||||||
Due to IDE limitations with unions, for now all options are available for all types (e.g. `label_on` is hinted even when the type is not `IO.BOOLEAN`).
|
Due to IDE limitations with unions, for now all options are available for all types (e.g. `label_on` is hinted even when the type is not `IO.BOOLEAN`).
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_datatypes
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/datatypes
|
||||||
"""
|
"""
|
||||||
|
|
||||||
default: bool | str | float | int | list | tuple
|
default: bool | str | float | int | list | tuple
|
||||||
@ -154,7 +154,7 @@ class HiddenInputTypeDict(TypedDict):
|
|||||||
class InputTypeDict(TypedDict):
|
class InputTypeDict(TypedDict):
|
||||||
"""Provides type hinting for node INPUT_TYPES.
|
"""Provides type hinting for node INPUT_TYPES.
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_more_on_inputs
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/more_on_inputs
|
||||||
"""
|
"""
|
||||||
|
|
||||||
required: dict[str, tuple[IO, InputTypeOptions]]
|
required: dict[str, tuple[IO, InputTypeOptions]]
|
||||||
@ -164,14 +164,14 @@ class InputTypeDict(TypedDict):
|
|||||||
hidden: HiddenInputTypeDict
|
hidden: HiddenInputTypeDict
|
||||||
"""Offers advanced functionality and server-client communication.
|
"""Offers advanced functionality and server-client communication.
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_more_on_inputs#hidden-inputs
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/more_on_inputs#hidden-inputs
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
class ComfyNodeABC(ABC):
|
class ComfyNodeABC(ABC):
|
||||||
"""Abstract base class for Comfy nodes. Includes the names and expected types of attributes.
|
"""Abstract base class for Comfy nodes. Includes the names and expected types of attributes.
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_server_overview
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/server_overview
|
||||||
"""
|
"""
|
||||||
|
|
||||||
DESCRIPTION: str
|
DESCRIPTION: str
|
||||||
@ -188,7 +188,7 @@ class ComfyNodeABC(ABC):
|
|||||||
CATEGORY: str
|
CATEGORY: str
|
||||||
"""The category of the node, as per the "Add Node" menu.
|
"""The category of the node, as per the "Add Node" menu.
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_server_overview#category
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/server_overview#category
|
||||||
"""
|
"""
|
||||||
EXPERIMENTAL: bool
|
EXPERIMENTAL: bool
|
||||||
"""Flags a node as experimental, informing users that it may change or not work as expected."""
|
"""Flags a node as experimental, informing users that it may change or not work as expected."""
|
||||||
@ -202,9 +202,9 @@ class ComfyNodeABC(ABC):
|
|||||||
|
|
||||||
* Must include the ``required`` key, which describes all inputs that must be connected for the node to execute.
|
* Must include the ``required`` key, which describes all inputs that must be connected for the node to execute.
|
||||||
* The ``optional`` key can be added to describe inputs which do not need to be connected.
|
* The ``optional`` key can be added to describe inputs which do not need to be connected.
|
||||||
* The ``hidden`` key offers some advanced functionality. More info at: https://docs.comfy.org/essentials/custom_node_more_on_inputs#hidden-inputs
|
* The ``hidden`` key offers some advanced functionality. More info at: https://docs.comfy.org/custom-nodes/backend/more_on_inputs#hidden-inputs
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_server_overview#input-types
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/server_overview#input-types
|
||||||
"""
|
"""
|
||||||
return {"required": {}}
|
return {"required": {}}
|
||||||
|
|
||||||
@ -219,7 +219,7 @@ class ComfyNodeABC(ABC):
|
|||||||
|
|
||||||
By default, a node is not considered an output. Set ``OUTPUT_NODE = True`` to specify that it is.
|
By default, a node is not considered an output. Set ``OUTPUT_NODE = True`` to specify that it is.
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_server_overview#output-node
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/server_overview#output-node
|
||||||
"""
|
"""
|
||||||
INPUT_IS_LIST: bool
|
INPUT_IS_LIST: bool
|
||||||
"""A flag indicating if this node implements the additional code necessary to deal with OUTPUT_IS_LIST nodes.
|
"""A flag indicating if this node implements the additional code necessary to deal with OUTPUT_IS_LIST nodes.
|
||||||
@ -230,7 +230,7 @@ class ComfyNodeABC(ABC):
|
|||||||
|
|
||||||
A node can also override the default input behaviour and receive the whole list in a single call. This is done by setting a class attribute `INPUT_IS_LIST` to ``True``.
|
A node can also override the default input behaviour and receive the whole list in a single call. This is done by setting a class attribute `INPUT_IS_LIST` to ``True``.
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_lists#list-processing
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/lists#list-processing
|
||||||
"""
|
"""
|
||||||
OUTPUT_IS_LIST: tuple[bool]
|
OUTPUT_IS_LIST: tuple[bool]
|
||||||
"""A tuple indicating which node outputs are lists, but will be connected to nodes that expect individual items.
|
"""A tuple indicating which node outputs are lists, but will be connected to nodes that expect individual items.
|
||||||
@ -248,7 +248,7 @@ class ComfyNodeABC(ABC):
|
|||||||
the node should provide a class attribute `OUTPUT_IS_LIST`, which is a ``tuple[bool]``, of the same length as `RETURN_TYPES`,
|
the node should provide a class attribute `OUTPUT_IS_LIST`, which is a ``tuple[bool]``, of the same length as `RETURN_TYPES`,
|
||||||
specifying which outputs which should be so treated.
|
specifying which outputs which should be so treated.
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_lists#list-processing
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/lists#list-processing
|
||||||
"""
|
"""
|
||||||
|
|
||||||
RETURN_TYPES: tuple[IO]
|
RETURN_TYPES: tuple[IO]
|
||||||
@ -258,19 +258,19 @@ class ComfyNodeABC(ABC):
|
|||||||
|
|
||||||
RETURN_TYPES = (IO.INT, "INT", "CUSTOM_TYPE")
|
RETURN_TYPES = (IO.INT, "INT", "CUSTOM_TYPE")
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_server_overview#return-types
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/server_overview#return-types
|
||||||
"""
|
"""
|
||||||
RETURN_NAMES: tuple[str]
|
RETURN_NAMES: tuple[str]
|
||||||
"""The output slot names for each item in `RETURN_TYPES`, e.g. ``RETURN_NAMES = ("count", "filter_string")``
|
"""The output slot names for each item in `RETURN_TYPES`, e.g. ``RETURN_NAMES = ("count", "filter_string")``
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_server_overview#return-names
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/server_overview#return-names
|
||||||
"""
|
"""
|
||||||
OUTPUT_TOOLTIPS: tuple[str]
|
OUTPUT_TOOLTIPS: tuple[str]
|
||||||
"""A tuple of strings to use as tooltips for node outputs, one for each item in `RETURN_TYPES`."""
|
"""A tuple of strings to use as tooltips for node outputs, one for each item in `RETURN_TYPES`."""
|
||||||
FUNCTION: str
|
FUNCTION: str
|
||||||
"""The name of the function to execute as a literal string, e.g. `FUNCTION = "execute"`
|
"""The name of the function to execute as a literal string, e.g. `FUNCTION = "execute"`
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_server_overview#function
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/server_overview#function
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
@ -288,7 +288,7 @@ class CheckLazyMixin:
|
|||||||
Params should match the nodes execution ``FUNCTION`` (self, and all inputs by name).
|
Params should match the nodes execution ``FUNCTION`` (self, and all inputs by name).
|
||||||
Will be executed repeatedly until it returns an empty list, or all requested items were already evaluated (and sent as params).
|
Will be executed repeatedly until it returns an empty list, or all requested items were already evaluated (and sent as params).
|
||||||
|
|
||||||
Comfy Docs: https://docs.comfy.org/essentials/custom_node_lazy_evaluation#defining-check-lazy-status
|
Comfy Docs: https://docs.comfy.org/custom-nodes/backend/lazy_evaluation#defining-check-lazy-status
|
||||||
"""
|
"""
|
||||||
|
|
||||||
need = [name for name in kwargs if kwargs[name] is None]
|
need = [name for name in kwargs if kwargs[name] is None]
|
||||||
|
Loading…
Reference in New Issue
Block a user