format_string
FormatString module for ComfyUI.
This module provides a custom node for ComfyUI that allows formatting strings using either simple Python formatting or Jinja2 templates. It can also save formatted templates to disk for later reuse.
The node dynamically updates its inputs and outputs based on the variables detected in the template, making it highly flexible for various text generation and parameter formatting needs in ComfyUI workflows.
FormatString
A ComfyUI node for string formatting using Python's format syntax or Jinja2 templates.
This node dynamically adapts its inputs and outputs based on the variables detected in the provided template. It supports saving template state to disk and loading it back. The node can operate in two modes: 1. Simple: Uses Python's str.format() method 2. Jinja2: Uses Jinja2 templating engine with sandbox protection
Additional context variables like datetime, random, and math functions are available in Jinja2 mode.
Outputs
The node always returns formatted_string and saved_file_path as the first two outputs (positions 0 and 1), followed by any variable values extracted from the template in subsequent positions. This ensures the primary outputs are in fixed, predictable positions.
Attributes:
| Name | Type | Description |
|---|---|---|
CATEGORY |
str
|
The category of the node in ComfyUI's node menu. |
FUNCTION |
str
|
The main function to be called when the node is executed. |
RETURN_TYPES |
tuple
|
Types of the returned outputs (dynamically updated). |
RETURN_NAMES |
tuple
|
Names of the returned outputs (dynamically updated). |
node_configs |
dict
|
Storage for configurations of node instances. |
jinja_env |
SandboxedEnvironment
|
Sandboxed Jinja2 environment for secure template rendering. |
additional_context |
dict
|
Extra context variables available in Jinja2 templates. |
Source code in src/comfydv/format_string.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 | |
INPUT_TYPES()
classmethod
Define the input types for the FormatString node.
This method is called by ComfyUI to determine what inputs the node should have.
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dict[str, Any]: Dictionary defining the node's inputs, including template_type, template, save_path, and a hidden unique_id. |
Example
from format_string import FormatString
input_types = FormatString.INPUT_TYPES()
print(input_types["required"]["template_type"]) # Outputs: (["Simple", "Jinja2"],)
Source code in src/comfydv/format_string.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | |
IS_CHANGED(**kwargs)
classmethod
Determine if the node should be re-executed based on input changes.
This method is called by ComfyUI to check if the node needs to be re-calculated due to changes in its inputs. It forces recalculation when Jinja2 templates contain time-dependent function calls (e.g., datetime.now(), time_now()).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Keyword arguments containing the node's current inputs. |
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
Any |
A hash of inputs for caching, or a random number to force recalculation when time-dependent functions are detected. |
Example
from format_string import FormatString
# This would typically be called by ComfyUI
result = FormatString.IS_CHANGED(template="Hello {name}", template_type="Simple")
# Returns hash of inputs for proper caching
Source code in src/comfydv/format_string.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | |
format_string(template_type, template, save_path, unique_id='', **kwargs)
classmethod
Format a string using the specified template type and variables.
This is the main method executed by the node. It formats the template using either Python's str.format() or Jinja2 templating, and optionally saves the state to disk. The node is OUTPUT_NODE=True so the formatted string also renders as a read-only text display directly on the node (no separate Show Text node needed).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
template_type
|
str
|
Either "Simple" or "Jinja2" to specify the template engine. |
required |
template
|
str
|
The template string to format. |
required |
save_path
|
str
|
Optional path to save the node state. If empty, state is not saved. |
required |
unique_id
|
str
|
The unique identifier for this node instance (passed by ComfyUI). |
''
|
**kwargs
|
Variable keyword arguments that provide values for template variables. |
{}
|
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dict[str, Any]: |
Example
from format_string import FormatString
# Simple template example
ret = FormatString.format_string(
template_type="Simple",
template="Hello {name}, you are {age} years old",
save_path="",
unique_id="123",
name="Alice",
age="30"
)
print(ret["result"]) # Outputs: ('Hello Alice, you are 30 years old', '', 'Alice', '30')
# Jinja2 template example
ret = FormatString.format_string(
template_type="Jinja2",
template="Hello {{ name }}, today is {{ datetime.now().strftime('%A') }}",
save_path="",
unique_id="124",
name="Bob"
)
print(ret["result"]) # Outputs: ('Hello Bob, today is Wednesday', '', 'Bob')
Source code in src/comfydv/format_string.py
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | |
get_node_config(node_id)
classmethod
Get the configuration for a specific node instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
node_id
|
str
|
The unique identifier of the node instance. |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dict[str, Any]: The configuration for the specified node, or an empty dict if not found. |
Example
from format_string import FormatString
# After updating a node's configuration
config = FormatString.get_node_config("node_123")
print(config) # Shows the stored configuration for node_123
Source code in src/comfydv/format_string.py
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 | |
load_node_state(file_path)
classmethod
Load a previously saved node state from disk.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file_path
|
str
|
Path to the saved node state JSON file. |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dict[str, Any]: The loaded node state, or an empty dict if loading failed. |
Example
from format_string import FormatString
# Load a previously saved state
state = FormatString.load_node_state("/path/to/saved_state.json")
print(state["template"]) # Shows the saved template
print(state["inputs"]) # Shows the saved input values
Source code in src/comfydv/format_string.py
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 | |
time_now()
staticmethod
Get the current time in a formatted string.
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
Current time formatted as 'YYYYMMDD-HHMMSS'. |
Example
from format_string import FormatString
timestamp = FormatString.time_now()
print(timestamp) # Outputs something like: '20240327-153045'
Source code in src/comfydv/format_string.py
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 | |
update_widget(node_id, template_type, template)
classmethod
Update a node's widget configuration based on the template.
This method is called when a template is changed to dynamically update the node's inputs and outputs based on the variables detected in the template.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
node_id
|
str
|
The unique identifier of the node instance. |
required |
template_type
|
str
|
The template type ("Simple" or "Jinja2"). |
required |
template
|
str
|
The template string. |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dict[str, Any]: Updated configuration for the node. |
Example
from format_string import FormatString
# Called via ComfyUI's web API when template changes
config = FormatString.update_widget(
node_id="node_123",
template_type="Simple",
template="Hello {name}, you are {age} years old"
)
print(config["inputs"]) # Shows inputs including 'name' and 'age'
print(config["outputs"]) # Shows outputs including extracted variables
Source code in src/comfydv/format_string.py
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 | |
get_format_string_node_config(request)
async
AIOHTTP route handler for retrieving a FormatString node's configuration.
This endpoint retrieves the stored configuration for a specific node instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
Request
|
The HTTP request object containing the node ID in the URL. |
required |
Returns:
| Type | Description |
|---|---|
|
web.Response: JSON response with the node's configuration. |
Example
This would typically be called by the frontend JavaScript via a GET request:
// In ComfyUI frontend
fetch("/get_format_string_node_config/node_123")
.then(response => response.json())
.then(data => console.log(data));
Source code in src/comfydv/format_string.py
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 | |
load_format_string_node(request)
async
AIOHTTP route handler for loading a FormatString node's state from disk.
This endpoint receives JSON data containing a file path, then loads and returns the node state from that file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
Request
|
The HTTP request object containing JSON data. |
required |
Returns:
| Type | Description |
|---|---|
|
web.Response: JSON response with the loaded node state. |
Example
This would typically be called by the frontend JavaScript via a POST request:
// In ComfyUI frontend
fetch("/load_format_string_node", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
file_path: "/path/to/saved_state.json"
})
}).then(response => response.json())
.then(data => console.log(data));
Source code in src/comfydv/format_string.py
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 | |
update_format_string_node(request)
async
AIOHTTP route handler for updating a FormatString node's configuration.
This endpoint receives JSON data containing a node ID, template type, and template, then updates the node's configuration based on the template.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
Request
|
The HTTP request object containing JSON data. |
required |
Returns:
| Type | Description |
|---|---|
|
web.Response: JSON response with the updated node configuration. |
Example
This would typically be called by the frontend JavaScript via a POST request:
// In ComfyUI frontend
fetch("/update_format_string_node", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
nodeId: "node_123",
template_type: "Simple",
template: "Hello {name}"
})
}).then(response => response.json())
.then(data => console.log(data));
Source code in src/comfydv/format_string.py
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 | |