xinyun/ComfyUI
1
0
Fork 0
mirror of https://git.datalinker.icu/comfyanonymous/ComfyUI synced 2026-11-12 11:46:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update example_node.py.example

Browse Source 
Huggingface-hub telemetry extracts example docstrings for telemetry purposes.
Check hub.py and hf_api.py in .cache. If a user has not opted out of hf telemetry this could potentially expose sensitive data if template is widely used. Commented out all occurences of """
This commit is contained in:
311_code 2024-08-17 23:42:17 -05:00 committed by GitHub
parent 9aa39e743c
commit 1699a6eba0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
custom_nodes/example_node.py.example
View File

@ -1,5 +1,8 @@
class Example: class Example:
""" # huggingface-hub telemetry extracts example docstrings for telemetry purposes.
# Check hub.py and hf_api.py. If a user has not opted out of telemetry this could
# potentially expose sensitive data if template is widely used.
# """
A example node A example node
Class methods Class methods
@ -26,13 +29,13 @@ class Example:
execute(s) -> tuple || None: execute(s) -> tuple || None:
The entry point method. The name of this method must be the same as the value of property `FUNCTION`. The entry point method. The name of this method must be the same as the value of property `FUNCTION`.
For example, if `FUNCTION = "execute"` then this method's name must be `execute`, if `FUNCTION = "foo"` then it must be `foo`. For example, if `FUNCTION = "execute"` then this method's name must be `execute`, if `FUNCTION = "foo"` then it must be `foo`.
""" # """
def __init__(self): def __init__(self):
pass pass
@classmethod @classmethod
def INPUT_TYPES(s): def INPUT_TYPES(s):
""" # """
Return a dictionary which contains config for all input fields. Return a dictionary which contains config for all input fields.
Some types (string): "MODEL", "VAE", "CLIP", "CONDITIONING", "LATENT", "IMAGE", "INT", "STRING", "FLOAT". Some types (string): "MODEL", "VAE", "CLIP", "CONDITIONING", "LATENT", "IMAGE", "INT", "STRING", "FLOAT".
Input types "INT", "STRING" or "FLOAT" are special values for fields on the node. Input types "INT", "STRING" or "FLOAT" are special values for fields on the node.
@ -45,7 +48,7 @@ class Example:
* Value field_config (`tuple`): * Value field_config (`tuple`):
+ First value is a string indicate the type of field or a list for selection. + First value is a string indicate the type of field or a list for selection.
+ Second value is a config for type "INT", "STRING" or "FLOAT". + Second value is a config for type "INT", "STRING" or "FLOAT".
""" # """
return { return {
"required": { "required": {
"image": ("IMAGE",), "image": ("IMAGE",),
@ -85,7 +88,7 @@ class Example:
CATEGORY = "Example" CATEGORY = "Example"
def check_lazy_status(self, image, string_field, int_field, float_field, print_to_screen): def check_lazy_status(self, image, string_field, int_field, float_field, print_to_screen):
""" # """
Return a list of input names that need to be evaluated. Return a list of input names that need to be evaluated.
This function will be called if there are any lazy inputs which have not yet been This function will be called if there are any lazy inputs which have not yet been
@ -95,7 +98,7 @@ class Example:
Any evaluated inputs will be passed as arguments to this function. Any unevaluated Any evaluated inputs will be passed as arguments to this function. Any unevaluated
inputs will have the value None. inputs will have the value None.
""" # """
if print_to_screen == "enable": if print_to_screen == "enable":
return ["int_field", "float_field", "string_field"] return ["int_field", "float_field", "string_field"]
else: else:
@ -112,14 +115,14 @@ class Example:
image = 1.0 - image image = 1.0 - image
return (image,) return (image,)
""" # """
The node will always be re executed if any of the inputs change but The node will always be re executed if any of the inputs change but
this method can be used to force the node to execute again even when the inputs don't change. this method can be used to force the node to execute again even when the inputs don't change.
You can make this node return a number or a string. This value will be compared to the one returned the last time the node was You can make this node return a number or a string. This value will be compared to the one returned the last time the node was
executed, if it is different the node will be executed again. executed, if it is different the node will be executed again.
This method is used in the core repo for the LoadImage node where they return the image hash as a string, if the image hash This method is used in the core repo for the LoadImage node where they return the image hash as a string, if the image hash
changes between executions the LoadImage node is executed again. changes between executions the LoadImage node is executed again.
""" # """
#@classmethod #@classmethod
#def IS_CHANGED(s, image, string_field, int_field, float_field, print_to_screen): #def IS_CHANGED(s, image, string_field, int_field, float_field, print_to_screen):
# return "" # return ""