feat(metadata-overwrite): support wired SAMPLER input on sampler field

The sampler field now accepts either a manual string or a SAMPLER
connection. When wired, the sampler name is extracted from the
KSAMPLER object's sampler_function __name__ (sample_euler -> euler),
with special-casing for dpm_fast/dpm_adaptive local closures and
uni_pc/uni_pc_bh2 function names.

- sampler input declared as "STRING,SAMPLER" with widgetType STRING,
  mirroring the existing model field union pattern
- shared collect_overwrite_params() handles the non-str branch so the
  node and the metadata extractor conversion logic stay in sync;
  unrecognized sampler functions are logged and skipped
- note: ddim is constructed by ComfyUI as euler with random inpaint,
  so the ddim name is unrecoverable and extracts as euler
This commit is contained in:
Will Miao
2026-08-14 15:21:28 +08:00
parent f8d98934ad
commit 280181f92e
4 changed files with 151 additions and 5 deletions
+36
View File
@@ -323,6 +323,42 @@ def model_patcher_to_name(model_patcher: Any) -> Optional[str]:
return _abs_model_path_to_name(abs_path)
def sampler_object_to_name(sampler: Any) -> Optional[str]:
"""Extract a ComfyUI-style sampler name from a SAMPLER (KSAMPLER) object.
Standard outputs (KSamplerSelect, most built-in sampler nodes) round-trip
losslessly via the underlying sampler function's ``__name__``
(``sample_euler`` -> ``euler``). A few edge cases need special-casing
because the function name diverges from the ``SAMPLER_NAMES`` entry:
- ``dpm_fast`` / ``dpm_adaptive`` are local closures inside
``comfy.samplers.ksampler`` (``dpm_fast_function`` / ``dpm_adaptive_function``)
- ``uni_pc`` / ``uni_pc_bh2`` use ``sample_unipc`` / ``sample_unipc_bh2``
``ddim`` is constructed by ComfyUI as ``euler`` with random inpaint, so
the original ``ddim`` name is unrecoverable (extracts as ``euler``).
Custom sampler nodes that pass non-``sample_*`` functions return None.
Returns None when the name cannot be recovered.
"""
sampler_function = getattr(sampler, "sampler_function", None)
func_name = getattr(sampler_function, "__name__", None)
if not isinstance(func_name, str) or not func_name:
return None
if func_name == "dpm_fast_function":
return "dpm_fast"
if func_name == "dpm_adaptive_function":
return "dpm_adaptive"
if func_name.startswith("sample_"):
name = func_name[len("sample_"):]
if name == "unipc":
return "uni_pc"
if name == "unipc_bh2":
return "uni_pc_bh2"
return name or None
return None
def _abs_model_path_to_name(abs_path: str) -> str:
"""Convert an absolute model path to a ComfyUI-style relative name.