Compare commits

..
Author SHA1 Message Date
Vito Sansevero 90c1aa402d Merge remote-tracking branch 'origin/main' into chore/housekeeping 2025-08-01 09:37:01 -07:00
Vito 932e30ade0 Merge pull request #13 from ComfyAssets/feature/image-to-multiple-of
Feature/image to multiple of
2025-08-01 09:34:25 -07:00
Vito Sansevero f9540bd984 chore: update black line-length to 88 to match CI configuration 2025-08-01 09:30:16 -07:00
Vito Sansevero a8af833c31 chore: trigger CI 2025-08-01 09:10:28 -07:00
Vito Sansevero 005c3bdf65 fix: code formatting for Image to Multiple Of node
- Apply black formatting
- Remove unused torch import from logic.py
- All critical linting issues resolved
2025-08-01 09:01:39 -07:00
Vito 67a59a0d3b Merge pull request #11 from ComfyAssets/chore/housekeeping
chore: project housekeeping and configuration updates
2025-08-01 08:53:03 -07:00
Vito Sansevero bb5653fc0e fix: resolve flake8 linting errors in example.py
- Remove unused variable 'temp' assignment
- Remove unused exception variable assignments
- All flake8 checks now pass
2025-08-01 08:43:22 -07:00
Vito Sansevero ab23992c29 chore: project housekeeping and configuration updates
- Add code quality tools: flake8, mypy, black, pre-commit
- Add .gitattributes for line ending consistency
- Add .secrets.baseline for secret scanning
- Update GitHub workflows for better CI/CD
- Update documentation formatting and examples
- Add CLAUDE.md for AI assistant guidance
- Add scripts directory for automation tools
- Update project configuration in pyproject.toml
- Improve type hints and code formatting across all modules
- Update test configurations and fixtures
2025-08-01 08:35:08 -07:00
Vito Sansevero 9007b10d42 feat: add Image to Multiple Of node
- Add ImageToMultipleOfNode for image dimension adjustment
- Ensures image dimensions are multiples of specified values
- Supports both padding and cropping modes
- Useful for model-specific dimension requirements
- Add tests and documentation
- Register node in ComfyAssets category
2025-08-01 08:28:10 -07:00
Vito b71bfa8d4e Merge pull request #10 from ComfyAssets/fix-samplers
Fix samplers
2025-07-26 14:18:48 -07:00
Vito Sansevero c1128addc7 chore: bump version to 1.0.7 in pyproject.toml 2025-07-26 14:16:06 -07:00
Vito Sansevero a49071f824 fix(resolution_calculator): update scale factor tooltip 2025-07-26 14:15:39 -07:00
Vito Sansevero bbdd27f498 fix(ci): correct return type in tests.yml configuration 2025-07-23 13:56:57 -07:00
Vito Sansevero 22f62bf7b4 test: Update test assertions for sampler combo node 2025-07-23 13:56:45 -07:00
Vito Sansevero 4ff6067dad refactor(compact_node): update sampler return type 2025-07-23 13:29:46 -07:00
Vito Sansevero ad13e66506 refactor(node): update sampler handling logic 2025-07-23 13:29:32 -07:00
Vito Sansevero b16f6f40bd style(logic): fix whitespace issues in logic.py 2025-07-21 08:23:18 -07:00
Vito Sansevero 6dfa66963b feat: Add subfolder support in image URL handling 2025-07-21 08:20:27 -07:00
Vito Sansevero ab016e0903 feat(logic): add subfolder info to enhanced data 2025-07-21 08:20:17 -07:00
Vito Sansevero f4228a850c refactor(logic): improve path handling in image saving 2025-07-21 07:56:13 -07:00
Vito Sansevero 79042b78d2 chore: bump version to 1.0.5 in pyproject.toml 2025-06-28 09:31:40 -07:00
Vito Sansevero 0c4e59c4e9 test: Remove unused imports from test file 2025-06-28 09:14:45 -07:00
Vito Sansevero 4a0a206d61 refactor(node): use helper methods for tensor validation 2025-06-28 09:14:34 -07:00
Vito Sansevero 8e0d4485bd style: Remove unused imports in node.py 2025-06-28 09:14:23 -07:00
Vito Sansevero 92a3b1db4e style: Remove unused import 'Any' 2025-06-28 09:13:03 -07:00
Vito Sansevero ab628b1bf2 style: Remove unused import 'os' 2025-06-28 09:11:49 -07:00
Vito Sansevero 7e712a17d9 docs: Add Kiko Save Image section to README.md 2025-06-28 09:11:42 -07:00
Vito Sansevero 269fb2ba80 ci: add checks for KikoSaveImageNode imports 2025-06-28 09:11:36 -07:00
Vito Sansevero e17fdddcd7 refactor(tests/ui): Remove 'subfolder' support 2025-06-28 08:55:25 -07:00
Vito Sansevero 5d1f01e6cb refactor(node): replace 'subfolder' with 'popup' 2025-06-28 08:54:46 -07:00
Vito Sansevero b3b8826044 refactor(logic): Rename 'subfolder' to 'popup' parameter 2025-06-28 08:54:35 -07:00
Vito Sansevero 9dbb1f749d chore: bump version to 1.0.4 in pyproject.toml 2025-06-27 21:06:30 -07:00
Vito Sansevero 682f2b0a47 feat(ui): Add KikoSaveImage UI enhancements 2025-06-27 21:06:00 -07:00
Vito Sansevero 1233cf693e test(kiko_save_image): add unit tests for save image tool 2025-06-27 21:05:52 -07:00
Vito Sansevero 32d44a282f feat(kiko_save_image): add new image saving tool 2025-06-27 21:05:42 -07:00
Vito Sansevero bb79c7434f feat(init): add KikoSaveImageNode to tools and mappings 2025-06-27 21:05:25 -07:00
Vito Sansevero bd8c0a42bc fix: handle import error for testing environment 2025-06-27 21:05:14 -07:00
Vito Sansevero 5d9e71dc7b chore: bump version to 1.0.3 in pyproject.toml 2025-06-20 08:03:48 -07:00
Vito 321d89dcc4 Merge pull request #9 from ComfyAssets/latent-batch
style: Add blank lines for better readability
2025-06-20 08:02:57 -07:00
Vito Sansevero cd77d06ac9 style: Add blank lines for better readability 2025-06-20 07:50:49 -07:00
Vito d23ff34b27 Merge pull request #8 from ComfyAssets/latent-batch
Latent batch
2025-06-19 12:00:57 -07:00
Vito Sansevero cc725d27f6 chore: bump version to 1.0.2 in pyproject.toml 2025-06-19 11:56:26 -07:00
Vito Sansevero 4c3d3958d6 docs: Add Empty Latent Batch documentation 2025-06-19 11:56:05 -07:00
Vito Sansevero 2c992b5c97 feat(empty-latent-batch): add preset & batch processing 2025-06-19 11:55:51 -07:00
Vito Sansevero 8628bc39bb feat(init): add EmptyLatentBatchNode support 2025-06-19 10:22:33 -07:00
Vito Sansevero 3654867a21 feat(empty_latent_batch): add empty latent batch tool 2025-06-19 10:22:05 -07:00
Vito Sansevero 85af1b38f9 test: Add unit tests for EmptyLatentBatch features 2025-06-19 10:21:45 -07:00
Vito 03189afd85 Merge pull request #7 from ComfyAssets/version
Version
2025-06-16 18:32:40 -07:00
Vito Sansevero 69db6e12b4 feat(makefile): add virtualenv setup and commands 2025-06-16 18:29:16 -07:00
Vito Sansevero fb9c313724 feat(init): Add version parsing from pyproject.toml 2025-06-16 18:29:08 -07:00
Vito Sansevero ffae4e9f21 chore: update version to 1.0.1 in pyproject.toml 2025-06-16 18:28:58 -07:00
Vito 24b257ea6d Merge pull request #6 from ComfyAssets/registry
build(ci): add publish workflow and dependencies
2025-06-16 06:49:45 -07:00
Vito Sansevero 398cf27546 build(ci): add publish workflow and dependencies 2025-06-16 06:43:56 -07:00
Vito Sansevero 6c6c0e6abe feat(workflows): update width_height_selector_example 2025-06-15 17:12:25 -07:00
Vito Sansevero bc1a34eef2 refactor(workflows): Simplify seed history example 2025-06-15 17:08:51 -07:00
Vito Sansevero 599981cd9a refactor(workflows): simplify sampler combo example JSON 2025-06-15 17:06:52 -07:00
Vito Sansevero 880f376e8e feat(workflow): enhance resolution calculator example 2025-06-15 16:59:54 -07:00
Vito dcf2d679c1 Merge pull request #5 from ComfyAssets/resolution-metadata
Resolution metadata
2025-06-15 09:01:44 -07:00
Vito Sansevero 965ad60c74 refactor(node): use logging for error handling 2025-06-15 08:59:02 -07:00
Vito Sansevero be0c70eab1 style(test_width_height_selector): format code for readability 2025-06-15 08:54:47 -07:00
Vito Sansevero 549d2dc014 style: Reformat code for better readability 2025-06-15 08:54:34 -07:00
Vito Sansevero f04020b728 refactor(node): Simplify input validation logic 2025-06-15 08:48:13 -07:00
Vito Sansevero c7e02a4565 feat(examples): add sampler combo workflow example 2025-06-15 08:39:19 -07:00
Vito Sansevero 5af7a56409 docs: Add Sampler Combo documentation file 2025-06-15 08:39:07 -07:00
Vito Sansevero 9833ccd694 refactor(web): add resolution extraction helper function 2025-06-15 08:38:58 -07:00
Vito Sansevero 2d6fef8fb4 test: Add tests for formatted preset metadata handling 2025-06-15 08:38:33 -07:00
Vito Sansevero ce8c36f309 refactor(node): enhance preset metadata handling 2025-06-15 08:38:21 -07:00
Vito Sansevero bc30806fee test: Add tests for new tools and error handling 2025-06-15 08:38:05 -07:00
Vito Sansevero 36b861e778 docs: update Sampler Combo link in README.md 2025-06-15 06:21:37 -07:00
Vito Sansevero 5cf3977744 style: Update startup message formatting 2025-06-15 06:08:28 -07:00
Vito 0b542eafbc Merge pull request #4 from ComfyAssets/SamplerCombo
Sampler combo
2025-06-14 15:30:50 -07:00
Vito Sansevero 214851f2ef style: Clean up unused imports in test files 2025-06-14 15:25:55 -07:00
Vito Sansevero bc7608f891 style: Fix line formatting issues 2025-06-14 15:25:45 -07:00
Vito Sansevero 1ab839c58c style: Break long lines for readability 2025-06-14 15:25:36 -07:00
Vito Sansevero 0cf64ae411 style(logic): adjust typing imports and line breaks 2025-06-14 15:25:25 -07:00
Vito Sansevero da26d40d98 test: Add unit tests for Sampler Combo functionality 2025-06-14 13:41:58 -07:00
Vito Sansevero bc6e4938ef feat(sampler combo): add unified sampling interface 2025-06-14 13:41:43 -07:00
Vito 1c0e88435c Merge pull request #3 from ComfyAssets/seed-history
docs: Add Seed History documentation to README.md
2025-06-14 11:59:20 -07:00
Vito 7711cf31d8 Merge pull request #2 from ComfyAssets/seed-history
Seed history
2025-06-14 11:43:34 -07:00
68 changed files with 10128 additions and 1156 deletions
+31
View File
@@ -0,0 +1,31 @@
[flake8]
max-line-length = 127
max-complexity = 10
exclude =
.git,
__pycache__,
.mypy_cache,
.pytest_cache,
venv,
env,
build,
dist,
*.egg-info,
.tox
ignore =
# W503: line break before binary operator (conflicts with Black)
W503,
# E203: whitespace before ':' (conflicts with Black)
E203,
# E501: line too long (we use max-line-length)
E501
per-file-ignores =
# Allow unused imports in __init__.py files
__init__.py:F401,F403
# Allow assertions in tests
tests/*:S101
# Statistics
count = True
statistics = True
+41
View File
@@ -0,0 +1,41 @@
# Auto detect text files and perform LF normalization
* text=auto
# Python files
*.py text eol=lf
*.pyi text eol=lf
# Configuration files
*.json text eol=lf
*.yaml text eol=lf
*.yml text eol=lf
*.toml text eol=lf
*.ini text eol=lf
*.cfg text eol=lf
# Documentation
*.md text eol=lf
*.rst text eol=lf
*.txt text eol=lf
# Scripts
*.sh text eol=lf
*.bash text eol=lf
# Git files
.gitignore text eol=lf
.gitattributes text eol=lf
# ComfyUI specific
*.workflow text eol=lf
# Binary files
*.png binary
*.jpg binary
*.jpeg binary
*.gif binary
*.webp binary
*.safetensors binary
*.ckpt binary
*.pt binary
*.pth binary
+1 -1
View File
@@ -45,4 +45,4 @@ Paste any error messages or stack traces here
If possible, attach the ComfyUI workflow file (.json) that reproduces the issue.
**Additional context**
Add any other context about the problem here.
Add any other context about the problem here.
+2 -2
View File
@@ -37,7 +37,7 @@ Describe how the tool should process inputs and generate outputs.
**Model Compatibility:**
- [ ] SDXL optimized
- [ ] FLUX optimized
- [ ] FLUX optimized
- [ ] General purpose
- [ ] Specific model requirements: [describe]
@@ -64,4 +64,4 @@ Are there existing ComfyUI nodes that do something similar? How would this be di
- [ ] Yes, I can help with implementation
- [ ] Yes, I can help with testing
- [ ] Yes, I can help with documentation
- [ ] No, but I'd be happy to test it
- [ ] No, but I'd be happy to test it
+108 -26
View File
@@ -59,7 +59,7 @@ jobs:
import sys
import os
sys.path.insert(0, os.getcwd())
# Test that all imports work correctly
try:
from kikotools import NODE_CLASS_MAPPINGS, NODE_DISPLAY_NAME_MAPPINGS
@@ -67,47 +67,64 @@ jobs:
except ImportError as e:
print(f'Warning: Package-level imports failed: {e}')
# This is expected since we don't have ComfyUI installed
# Test individual module imports
from kikotools.base import ComfyAssetsBaseNode
from kikotools.tools.resolution_calculator import ResolutionCalculatorNode
from kikotools.tools.resolution_calculator.logic import extract_dimensions
from kikotools.tools.resolution_calculator.node import ResolutionCalculatorNode as NodeClass
# Test Width Height Selector imports
from kikotools.tools.width_height_selector import WidthHeightSelectorNode
from kikotools.tools.width_height_selector.logic import get_preset_dimensions
from kikotools.tools.width_height_selector.presets import PRESET_OPTIONS, PRESET_METADATA
# Test Sampler Combo imports
from kikotools.tools.sampler_combo import SamplerComboNode
from kikotools.tools.sampler_combo.logic import get_sampler_combo, SAMPLERS, SCHEDULERS
# Test Seed History imports
from kikotools.tools.seed_history import SeedHistoryNode
from kikotools.tools.seed_history.logic import generate_random_seed, validate_seed_value
# Test Kiko Save Image imports
from kikotools.tools.kiko_save_image import KikoSaveImageNode
from kikotools.tools.kiko_save_image.logic import process_image_batch, validate_save_inputs
print('✓ All module imports successful')
"
- name: Check code style consistency
run: |
echo "Checking code style consistency..."
# Check for consistent naming
find kikotools/ -name "*.py" -exec grep -l "class.*Node" {} \; | while read file; do
if ! grep -q "ComfyAssetsBaseNode" "$file" && ! grep -q "class ComfyAssetsBaseNode" "$file"; then
echo "Checking $file for ComfyUI node inheritance..."
fi
done
# Check for proper docstrings
python -c "
import ast
import os
def check_docstrings(filepath):
with open(filepath, 'r') as f:
tree = ast.parse(f.read())
for node in ast.walk(tree):
if isinstance(node, (ast.FunctionDef, ast.ClassDef)):
if not ast.get_docstring(node) and not node.name.startswith('_'):
print(f'Warning: {filepath}:{node.lineno} - {node.name} missing docstring')
for root, dirs, files in os.walk('kikotools'):
for file in files:
if file.endswith('.py') and not file.startswith('__'):
filepath = os.path.join(root, file)
check_docstrings(filepath)
print('✓ Docstring check completed')
"
@@ -134,7 +151,7 @@ jobs:
- name: Check for hardcoded secrets
run: |
echo "Checking for potential secrets..."
# Check for common secret patterns
if grep -r -i "password\|secret\|key\|token" kikotools/ --include="*.py" | grep -v "# " | grep -v "def " | grep -v "class "; then
echo "Warning: Potential hardcoded secrets found"
@@ -163,61 +180,126 @@ jobs:
import sys
import os
sys.path.insert(0, os.getcwd())
print('Checking architecture compliance...')
# Test separation of concerns
from kikotools.tools.resolution_calculator import logic, node
# Logic module should not import node-specific things
import inspect
logic_source = inspect.getsource(logic)
if 'ComfyUI' in logic_source and 'INPUT_TYPES' not in logic_source:
print('⚠️ Warning: Logic module contains ComfyUI-specific code')
else:
print('✓ Logic module properly separated')
# Node module should inherit from base
from kikotools.tools.resolution_calculator.node import ResolutionCalculatorNode
from kikotools.base import ComfyAssetsBaseNode
if issubclass(ResolutionCalculatorNode, ComfyAssetsBaseNode):
print('✓ Node properly inherits from base class')
else:
print('❌ Node does not inherit from base class')
sys.exit(1)
# Check that nodes have proper ComfyUI interface
required_attrs = ['INPUT_TYPES', 'RETURN_TYPES', 'RETURN_NAMES', 'FUNCTION', 'CATEGORY']
# Test Resolution Calculator Node
for attr in required_attrs:
if not hasattr(ResolutionCalculatorNode, attr):
print(f'❌ Node missing required attribute: {attr}')
print(f'❌ ResolutionCalculatorNode missing required attribute: {attr}')
sys.exit(1)
print('✓ All architecture checks passed')
# Test Width Height Selector Node
from kikotools.tools.width_height_selector.node import WidthHeightSelectorNode
if issubclass(WidthHeightSelectorNode, ComfyAssetsBaseNode):
print('✓ WidthHeightSelectorNode properly inherits from base class')
else:
print('❌ WidthHeightSelectorNode does not inherit from base class')
sys.exit(1)
for attr in required_attrs:
if not hasattr(WidthHeightSelectorNode, attr):
print(f'❌ WidthHeightSelectorNode missing required attribute: {attr}')
sys.exit(1)
# Test Sampler Combo Node
from kikotools.tools.sampler_combo.node import SamplerComboNode
if issubclass(SamplerComboNode, ComfyAssetsBaseNode):
print('✓ SamplerComboNode properly inherits from base class')
else:
print('❌ SamplerComboNode does not inherit from base class')
sys.exit(1)
for attr in required_attrs:
if not hasattr(SamplerComboNode, attr):
print(f'❌ SamplerComboNode missing required attribute: {attr}')
sys.exit(1)
# Test Seed History Node
from kikotools.tools.seed_history.node import SeedHistoryNode
if issubclass(SeedHistoryNode, ComfyAssetsBaseNode):
print('✓ SeedHistoryNode properly inherits from base class')
else:
print('❌ SeedHistoryNode does not inherit from base class')
sys.exit(1)
for attr in required_attrs:
if not hasattr(SeedHistoryNode, attr):
print(f'❌ SeedHistoryNode missing required attribute: {attr}')
sys.exit(1)
# Test Kiko Save Image Node
from kikotools.tools.kiko_save_image.node import KikoSaveImageNode
if issubclass(KikoSaveImageNode, ComfyAssetsBaseNode):
print('✓ KikoSaveImageNode properly inherits from base class')
else:
print('❌ KikoSaveImageNode does not inherit from base class')
sys.exit(1)
# KikoSaveImage is an output node, so it doesn't have RETURN_TYPES/RETURN_NAMES
save_required_attrs = ['INPUT_TYPES', 'FUNCTION', 'CATEGORY']
for attr in save_required_attrs:
if not hasattr(KikoSaveImageNode, attr):
print(f'❌ KikoSaveImageNode missing required attribute: {attr}')
sys.exit(1)
# Check that it's properly marked as an output node
if not hasattr(KikoSaveImageNode, 'OUTPUT_NODE') or not KikoSaveImageNode.OUTPUT_NODE:
print('❌ KikoSaveImageNode missing OUTPUT_NODE = True')
sys.exit(1)
print('✓ All architecture checks passed for all tools')
"
- name: Check test coverage expectations
run: |
python -c "
import os
# Count test files vs implementation files
test_files = 0
impl_files = 0
for root, dirs, files in os.walk('tests'):
test_files += len([f for f in files if f.startswith('test_') and f.endswith('.py')])
for root, dirs, files in os.walk('kikotools'):
impl_files += len([f for f in files if f.endswith('.py') and not f.startswith('__')])
print(f'Implementation files: {impl_files}')
print(f'Test files: {test_files}')
if test_files >= impl_files * 0.5: # At least 50% test coverage by file count
print('✓ Adequate test file coverage')
else:
print('⚠️ Warning: Low test file coverage')
"
"
+28
View File
@@ -0,0 +1,28 @@
name: Publish to Comfy registry
on:
workflow_dispatch:
push:
branches:
- main
- master
paths:
- "pyproject.toml"
permissions:
issues: write
jobs:
publish-node:
name: Publish Custom Node to registry
runs-on: ubuntu-latest
if: ${{ github.repository_owner == 'ComfyAssets' }}
steps:
- name: Check out code
uses: actions/checkout@v4
with:
submodules: true
- name: Publish Custom Node
uses: Comfy-Org/publish-node-action@v1
with:
## Add your own personal access token to your Github Repository secrets and reference it here.
personal_access_token: ${{ secrets.REGISTRY_ACCESS_TOKEN }}
+24 -24
View File
@@ -8,7 +8,7 @@ on:
jobs:
create-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
@@ -28,30 +28,30 @@ jobs:
import sys
import os
sys.path.insert(0, os.getcwd())
# Run comprehensive tests before release
from kikotools.base import ComfyAssetsBaseNode
from kikotools.tools.resolution_calculator.logic import extract_dimensions, calculate_scaled_dimensions
from kikotools.tools.resolution_calculator.node import ResolutionCalculatorNode
import torch
print('Running pre-release validation...')
# Test all major functionality
node = ResolutionCalculatorNode()
# Test various scenarios
test_cases = [
(torch.randn(1, 512, 512, 3), 2.0),
(torch.randn(1, 1024, 1024, 3), 1.5),
(torch.randn(1, 1216, 832, 3), 1.53), # User scenario
]
for i, (image, scale) in enumerate(test_cases):
width, height = node.calculate_resolution(scale, image=image)
print(f'✓ Test case {i+1}: {image.shape[2]}×{image.shape[1]} → {width}×{height} (scale: {scale})')
assert width % 8 == 0 and height % 8 == 0
print('🎉 All pre-release tests passed!')
"
@@ -64,22 +64,22 @@ jobs:
run: |
cat > release_notes.md << 'EOF'
## ComfyUI-KikoTools ${{ steps.get_version.outputs.version }}
### 🎉 What's New
#### Resolution Calculator Tool
- **Smart Input Handling**: Works with both IMAGE and LATENT tensors
- **Model Optimized**: Specific optimizations for SDXL and FLUX models
- **Model Optimized**: Specific optimizations for SDXL and FLUX models
- **Constraint Enforcement**: Automatically ensures dimensions divisible by 8
- **Flexible Scaling**: Supports scale factors from 1.0x to 8.0x
### 📦 Installation
#### ComfyUI Manager
1. Search for "ComfyUI-KikoTools"
2. Click Install
3. Restart ComfyUI
#### Manual Installation
```bash
cd ComfyUI/custom_nodes/
@@ -87,24 +87,24 @@ jobs:
cd ComfyUI-KikoTools
pip install -r requirements-dev.txt
```
### 🚀 Quick Start
Look for **ComfyAssets** nodes in your ComfyUI node browser!
### 📊 Technical Details
- **Nodes**: 1 (Resolution Calculator)
- **Test Coverage**: 100%
- **Python Support**: 3.8+
- **ComfyUI Compatibility**: Latest
### 🐛 Bug Reports
Found an issue? Please report it [here](https://github.com/ComfyAssets/ComfyUI-KikoTools/issues).
---
**Full Changelog**: https://github.com/ComfyAssets/ComfyUI-KikoTools/compare/v0.0.0...${{ steps.get_version.outputs.version }}
EOF
@@ -128,18 +128,18 @@ jobs:
runs-on: ubuntu-latest
needs: create-release
if: success()
steps:
- name: Community notification placeholder
run: |
echo "🎉 Release ${{ needs.create-release.outputs.version }} created!"
echo "Consider posting to:"
echo "- ComfyUI Discord"
echo "- Reddit r/ComfyUI"
echo "- Reddit r/ComfyUI"
echo "- ComfyUI-Manager database"
echo ""
echo "Release includes:"
echo "- Resolution Calculator tool"
echo "- Complete documentation"
echo "- Example workflows"
echo "- 100% test coverage"
echo "- 100% test coverage"
+316 -36
View File
@@ -78,67 +78,318 @@ jobs:
print('🎉 All tests passed!')
"
- name: Test error handling
- name: Test Width Height Selector
run: |
python -c "
import sys
import os
sys.path.insert(0, os.getcwd())
from kikotools.tools.resolution_calculator.node import ResolutionCalculatorNode
# Test Width Height Selector imports
from kikotools.tools.width_height_selector.node import WidthHeightSelectorNode
from kikotools.tools.width_height_selector.presets import PRESET_OPTIONS, PRESET_METADATA
from kikotools.tools.width_height_selector.logic import get_preset_dimensions
node = ResolutionCalculatorNode()
print('✓ Width Height Selector imports successful')
# Test error handling
try:
node.calculate_resolution(2.0) # No input provided
assert False, 'Should have raised ValueError'
except ValueError:
print('✓ Error handling test passed')
# Test preset structure
assert len(PRESET_OPTIONS) > 0
assert 'custom' in PRESET_OPTIONS
assert len(PRESET_METADATA) > 0
print('✓ Preset structure tests passed')
# Test invalid scale factor
try:
node.calculate_resolution(0.0) # Invalid scale
assert False, 'Should have raised ValueError'
except ValueError:
print('✓ Scale factor validation test passed')
# Test node interface
node = WidthHeightSelectorNode()
input_types = node.INPUT_TYPES()
assert 'required' in input_types
assert 'preset' in input_types['required']
assert 'width' in input_types['required']
assert 'height' in input_types['required']
print('✓ Node interface tests passed')
print('✓ All error handling tests passed')
# Test formatted presets
preset_options = input_types['required']['preset'][0]
assert 'custom' in preset_options
formatted_count = len([opt for opt in preset_options if ' - ' in opt and 'MP' in opt])
assert formatted_count > 0
print(f'✓ Found {formatted_count} formatted presets')
# Test dimension calculation
result = node.get_dimensions('1024×1024', 512, 512)
assert result == (1024, 1024)
print('✓ Dimension calculation tests passed')
# Test formatted preset dimensions
formatted_preset = '1024×1024 - 1:1 (1.1MP) - SDXL'
result = node.get_dimensions(formatted_preset, 512, 512)
assert result == (1024, 1024)
print('✓ Formatted preset tests passed')
# Test preset extraction
extracted = node._extract_preset_name(formatted_preset)
assert extracted == '1024×1024'
print('✓ Preset extraction tests passed')
print('🎉 All Width Height Selector tests passed!')
"
- name: Test ComfyUI integration readiness
- name: Test Sampler Combo
run: |
python -c "
import sys
import os
sys.path.insert(0, os.getcwd())
# Test Sampler Combo imports
from kikotools.tools.sampler_combo.node import SamplerComboNode
from kikotools.tools.sampler_combo.logic import (
get_sampler_combo, validate_sampler_settings, SAMPLERS, SCHEDULERS
)
print('✓ Sampler Combo imports successful')
# Test node interface
node = SamplerComboNode()
input_types = node.INPUT_TYPES()
assert 'required' in input_types
assert 'sampler_name' in input_types['required']
assert 'scheduler' in input_types['required']
assert 'steps' in input_types['required']
assert 'cfg' in input_types['required']
print('✓ Sampler Combo interface tests passed')
# Test return types
assert node.RETURN_TYPES == ('SAMPLER', SCHEDULERS, 'INT', 'FLOAT')
assert node.RETURN_NAMES == ('sampler_name', 'scheduler', 'steps', 'cfg')
assert node.CATEGORY == 'ComfyAssets'
print('✓ Sampler Combo return types tests passed')
# Test sampler combo functionality
result = node.get_sampler_combo('euler', 'normal', 20, 7.0)
assert result == ('euler', 'normal', 20, 7.0)
print('✓ Sampler combo functionality tests passed')
# Test validation
assert validate_sampler_settings('euler', 'normal', 20, 7.0) == True
print('✓ Sampler validation tests passed')
# Test available samplers and schedulers
samplers = node.get_available_samplers()
schedulers = node.get_available_schedulers()
assert len(samplers) > 0
assert len(schedulers) > 0
assert 'euler' in samplers
assert 'normal' in schedulers
print(f'✓ Found {len(samplers)} samplers and {len(schedulers)} schedulers')
print('🎉 All Sampler Combo tests passed!')
"
- name: Test Seed History
run: |
python -c "
import sys
import os
sys.path.insert(0, os.getcwd())
# Test Seed History imports
from kikotools.tools.seed_history.node import SeedHistoryNode
from kikotools.tools.seed_history.logic import (
generate_random_seed, validate_seed_value, sanitize_seed_value
)
print('✓ Seed History imports successful')
# Test node interface
node = SeedHistoryNode()
input_types = node.INPUT_TYPES()
assert 'required' in input_types
assert 'seed' in input_types['required']
print('✓ Seed History interface tests passed')
# Test return types
assert node.RETURN_TYPES == ('INT',)
assert node.RETURN_NAMES == ('seed',)
assert node.CATEGORY == 'ComfyAssets'
print('✓ Seed History return types tests passed')
# Test seed output functionality
result = node.output_seed(12345)
assert result == (12345,)
print('✓ Seed output functionality tests passed')
# Test seed validation
assert validate_seed_value(12345) == True
assert validate_seed_value(-1) == False
print('✓ Seed validation tests passed')
# Test seed generation
new_seed = generate_random_seed()
assert isinstance(new_seed, int)
assert validate_seed_value(new_seed) == True
print('✓ Seed generation tests passed')
# Test seed sanitization
clean_seed = sanitize_seed_value(12345)
assert clean_seed == 12345
print('✓ Seed sanitization tests passed')
# Test node helper methods
assert node.is_seed_in_range(12345) == True
assert node.is_seed_in_range(-1) == False
assert node.get_default_seed() == 12345
print('✓ Seed helper methods tests passed')
print('🎉 All Seed History tests passed!')
"
- name: Test error handling for all tools
run: |
python -c "
import sys
import os
sys.path.insert(0, os.getcwd())
print('=== Testing Error Handling for All Tools ===')
# Test Resolution Calculator error handling
from kikotools.tools.resolution_calculator.node import ResolutionCalculatorNode
res_node = ResolutionCalculatorNode()
# Test ComfyUI interface requirements
node_class = ResolutionCalculatorNode
try:
res_node.calculate_resolution(2.0) # No input provided
assert False, 'Should have raised ValueError'
except ValueError:
print('✓ Resolution Calculator error handling test passed')
# Check required class attributes
assert hasattr(node_class, 'INPUT_TYPES')
assert hasattr(node_class, 'RETURN_TYPES')
assert hasattr(node_class, 'RETURN_NAMES')
assert hasattr(node_class, 'FUNCTION')
assert hasattr(node_class, 'CATEGORY')
try:
res_node.calculate_resolution(0.0) # Invalid scale
assert False, 'Should have raised ValueError'
except ValueError:
print('✓ Resolution Calculator scale factor validation test passed')
# Check INPUT_TYPES structure
input_types = node_class.INPUT_TYPES()
# Test Width Height Selector error handling
from kikotools.tools.width_height_selector.node import WidthHeightSelectorNode
wh_node = WidthHeightSelectorNode()
# Test invalid preset fallback
result = wh_node.get_dimensions('invalid_preset', 800, 600)
assert result == (800, 600) # Should fallback to custom dimensions
print('✓ Width Height Selector invalid preset handling test passed')
# Test Sampler Combo error handling
from kikotools.tools.sampler_combo.node import SamplerComboNode
sampler_node = SamplerComboNode()
# Test with invalid sampler (should use safe defaults)
result = sampler_node.get_sampler_combo('invalid_sampler', 'normal', 20, 7.0)
assert result == ('euler', 'normal', 20, 7.0) # Safe defaults
print('✓ Sampler Combo invalid input handling test passed')
# Test Seed History error handling
from kikotools.tools.seed_history.node import SeedHistoryNode
seed_node = SeedHistoryNode()
# Test invalid seed value (should use fallback)
result = seed_node.output_seed(-1) # Invalid negative seed
assert result == (12345,) # Fallback seed
print('✓ Seed History invalid seed handling test passed')
print('🎉 All error handling tests passed for all tools!')
"
- name: Test ComfyUI integration readiness for all tools
run: |
python -c "
import sys
import os
sys.path.insert(0, os.getcwd())
print('=== Testing ComfyUI Integration for All Tools ===')
# Test Resolution Calculator
from kikotools.tools.resolution_calculator.node import ResolutionCalculatorNode
res_class = ResolutionCalculatorNode
assert hasattr(res_class, 'INPUT_TYPES')
assert hasattr(res_class, 'RETURN_TYPES')
assert hasattr(res_class, 'RETURN_NAMES')
assert hasattr(res_class, 'FUNCTION')
assert hasattr(res_class, 'CATEGORY')
input_types = res_class.INPUT_TYPES()
assert 'required' in input_types
assert 'optional' in input_types
assert 'scale_factor' in input_types['required']
assert 'image' in input_types['optional']
assert 'latent' in input_types['optional']
# Check return types
assert node_class.RETURN_TYPES == ('INT', 'INT')
assert node_class.RETURN_NAMES == ('width', 'height')
assert node_class.CATEGORY == 'ComfyAssets'
assert res_class.RETURN_TYPES == ('INT', 'INT')
assert res_class.RETURN_NAMES == ('width', 'height')
assert res_class.CATEGORY == 'ComfyAssets'
print('✓ Resolution Calculator ComfyUI integration passed')
print('✓ ComfyUI integration readiness tests passed')
# Test Width Height Selector
from kikotools.tools.width_height_selector.node import WidthHeightSelectorNode
wh_class = WidthHeightSelectorNode
assert hasattr(wh_class, 'INPUT_TYPES')
assert hasattr(wh_class, 'RETURN_TYPES')
assert hasattr(wh_class, 'RETURN_NAMES')
assert hasattr(wh_class, 'FUNCTION')
assert hasattr(wh_class, 'CATEGORY')
input_types = wh_class.INPUT_TYPES()
assert 'required' in input_types
assert 'preset' in input_types['required']
assert 'width' in input_types['required']
assert 'height' in input_types['required']
assert wh_class.RETURN_TYPES == ('INT', 'INT')
assert wh_class.RETURN_NAMES == ('width', 'height')
assert wh_class.CATEGORY == 'ComfyAssets'
print('✓ Width Height Selector ComfyUI integration passed')
# Test Sampler Combo
from kikotools.tools.sampler_combo.node import SamplerComboNode
sampler_class = SamplerComboNode
assert hasattr(sampler_class, 'INPUT_TYPES')
assert hasattr(sampler_class, 'RETURN_TYPES')
assert hasattr(sampler_class, 'RETURN_NAMES')
assert hasattr(sampler_class, 'FUNCTION')
assert hasattr(sampler_class, 'CATEGORY')
input_types = sampler_class.INPUT_TYPES()
assert 'required' in input_types
assert 'sampler_name' in input_types['required']
assert 'scheduler' in input_types['required']
assert 'steps' in input_types['required']
assert 'cfg' in input_types['required']
assert sampler_class.CATEGORY == 'ComfyAssets'
print('✓ Sampler Combo ComfyUI integration passed')
# Test Seed History
from kikotools.tools.seed_history.node import SeedHistoryNode
seed_class = SeedHistoryNode
assert hasattr(seed_class, 'INPUT_TYPES')
assert hasattr(seed_class, 'RETURN_TYPES')
assert hasattr(seed_class, 'RETURN_NAMES')
assert hasattr(seed_class, 'FUNCTION')
assert hasattr(seed_class, 'CATEGORY')
input_types = seed_class.INPUT_TYPES()
assert 'required' in input_types
assert 'seed' in input_types['required']
assert seed_class.RETURN_TYPES == ('INT',)
assert seed_class.RETURN_NAMES == ('seed',)
assert seed_class.CATEGORY == 'ComfyAssets'
print('✓ Seed History ComfyUI integration passed')
print('🎉 All tools ComfyUI integration readiness tests passed!')
"
test-package-structure:
@@ -163,14 +414,37 @@ jobs:
test -d kikotools/base || (echo "kikotools/base directory missing" && exit 1)
test -d kikotools/tools || (echo "kikotools/tools directory missing" && exit 1)
test -d kikotools/tools/resolution_calculator || (echo "resolution_calculator directory missing" && exit 1)
test -d kikotools/tools/width_height_selector || (echo "width_height_selector directory missing" && exit 1)
test -d kikotools/tools/sampler_combo || (echo "sampler_combo directory missing" && exit 1)
test -d kikotools/tools/seed_history || (echo "seed_history directory missing" && exit 1)
test -d tests || (echo "tests directory missing" && exit 1)
test -d examples || (echo "examples directory missing" && exit 1)
test -d web || (echo "web directory missing" && exit 1)
# Check key files
test -f kikotools/__init__.py || (echo "kikotools/__init__.py missing" && exit 1)
test -f kikotools/base/base_node.py || (echo "base_node.py missing" && exit 1)
test -f kikotools/tools/resolution_calculator/node.py || (echo "node.py missing" && exit 1)
test -f kikotools/tools/resolution_calculator/logic.py || (echo "logic.py missing" && exit 1)
# Resolution Calculator files
test -f kikotools/tools/resolution_calculator/node.py || (echo "resolution_calculator node.py missing" && exit 1)
test -f kikotools/tools/resolution_calculator/logic.py || (echo "resolution_calculator logic.py missing" && exit 1)
# Width Height Selector files
test -f kikotools/tools/width_height_selector/node.py || (echo "width_height_selector node.py missing" && exit 1)
test -f kikotools/tools/width_height_selector/logic.py || (echo "width_height_selector logic.py missing" && exit 1)
test -f kikotools/tools/width_height_selector/presets.py || (echo "width_height_selector presets.py missing" && exit 1)
# Sampler Combo files
test -f kikotools/tools/sampler_combo/node.py || (echo "sampler_combo node.py missing" && exit 1)
test -f kikotools/tools/sampler_combo/logic.py || (echo "sampler_combo logic.py missing" && exit 1)
# Seed History files
test -f kikotools/tools/seed_history/node.py || (echo "seed_history node.py missing" && exit 1)
test -f kikotools/tools/seed_history/logic.py || (echo "seed_history logic.py missing" && exit 1)
# Web files
test -f web/width_height_swap.js || (echo "width_height_swap.js missing" && exit 1)
test -f web/seed_history_ui.js || (echo "seed_history_ui.js missing" && exit 1)
echo "✓ Package structure tests passed"
@@ -181,9 +455,15 @@ jobs:
- name: Test documentation completeness
run: |
# Check documentation files
# Check documentation files for all tools
test -f examples/documentation/resolution_calculator.md || (echo "Resolution calculator docs missing" && exit 1)
test -f examples/workflows/resolution_calculator_example.json || (echo "Example workflow missing" && exit 1)
test -f examples/workflows/resolution_calculator_example.json || (echo "Resolution calculator workflow missing" && exit 1)
test -f examples/documentation/width_height_selector.md || (echo "Width height selector docs missing" && exit 1)
test -f examples/workflows/width_height_selector_example.json || (echo "Width height selector workflow missing" && exit 1)
test -f examples/documentation/sampler_combo.md || (echo "Sampler combo docs missing" && exit 1)
test -f examples/workflows/sampler_combo_example.json || (echo "Sampler combo workflow missing" && exit 1)
test -f examples/documentation/seed_history.md || (echo "Seed history docs missing" && exit 1)
test -f examples/workflows/seed_history_example.json || (echo "Seed history workflow missing" && exit 1)
# Check README has key sections
grep -q "Installation" README.md || (echo "README missing Installation section" && exit 1)
+1 -1
View File
@@ -158,4 +158,4 @@ input/
test_images/
test_outputs/
experiments/
.claude/
.claude/
+84
View File
@@ -0,0 +1,84 @@
# Pre-commit hooks configuration for ComfyUI-KikoTools
# This ensures code quality checks are run before each commit
repos:
# Python code formatting with Black
- repo: https://github.com/psf/black
rev: 25.1.0
hooks:
- id: black
language_version: python3.10
args: ['--line-length=127'] # Match CI configuration
# Python linting with flake8
- repo: https://github.com/pycqa/flake8
rev: 7.3.0
hooks:
- id: flake8
args: ['--max-line-length=127', '--max-complexity=10']
exclude: '^tests/'
# Python type checking with mypy
# Note: Mypy is disabled in pre-commit due to package name issue
# Run manually with: mypy kikotools/
# - repo: https://github.com/pre-commit/mirrors-mypy
# rev: v1.8.0
# hooks:
# - id: mypy
# args: ['--config-file=mypy.ini']
# files: '^kikotools/'
# exclude: '^tests/'
# additional_dependencies: ['types-requests']
# Security checks with bandit
- repo: https://github.com/PyCQA/bandit
rev: 1.8.6
hooks:
- id: bandit
args: ['-ll', '-r']
files: '^kikotools/'
# General file checks
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
args: ['--maxkb=1000']
- id: check-case-conflict
- id: check-merge-conflict
- id: check-docstring-first
- id: debug-statements
- id: mixed-line-ending
# Check for hardcoded secrets
- repo: https://github.com/Yelp/detect-secrets
rev: v1.5.0
hooks:
- id: detect-secrets
args: ['--baseline', '.secrets.baseline']
exclude: '^(tests/|\.git/)'
# Configuration for specific hooks
default_language_version:
python: python3.10
# Run hooks on all files by default
fail_fast: false
# Exclude patterns
exclude: |
(?x)^(
\.git/|
\.mypy_cache/|
\.pytest_cache/|
__pycache__/|
build/|
dist/|
\.eggs/|
.*\.egg-info/|
venv/|
env/
)
+164
View File
@@ -0,0 +1,164 @@
{
"version": "1.5.0",
"plugins_used": [
{
"name": "ArtifactoryDetector"
},
{
"name": "AWSKeyDetector"
},
{
"name": "AzureStorageKeyDetector"
},
{
"name": "Base64HighEntropyString",
"limit": 4.5
},
{
"name": "BasicAuthDetector"
},
{
"name": "CloudantDetector"
},
{
"name": "DiscordBotTokenDetector"
},
{
"name": "GitHubTokenDetector"
},
{
"name": "GitLabTokenDetector"
},
{
"name": "HexHighEntropyString",
"limit": 3.0
},
{
"name": "IbmCloudIamDetector"
},
{
"name": "IbmCosHmacDetector"
},
{
"name": "IPPublicDetector"
},
{
"name": "JwtTokenDetector"
},
{
"name": "KeywordDetector",
"keyword_exclude": ""
},
{
"name": "MailchimpDetector"
},
{
"name": "NpmDetector"
},
{
"name": "OpenAIDetector"
},
{
"name": "PrivateKeyDetector"
},
{
"name": "PypiTokenDetector"
},
{
"name": "SendGridDetector"
},
{
"name": "SlackDetector"
},
{
"name": "SoftlayerDetector"
},
{
"name": "SquareOAuthDetector"
},
{
"name": "StripeDetector"
},
{
"name": "TelegramBotTokenDetector"
},
{
"name": "TwilioKeyDetector"
}
],
"filters_used": [
{
"path": "detect_secrets.filters.allowlist.is_line_allowlisted"
},
{
"path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
"min_level": 2
},
{
"path": "detect_secrets.filters.heuristic.is_indirect_reference"
},
{
"path": "detect_secrets.filters.heuristic.is_likely_id_string"
},
{
"path": "detect_secrets.filters.heuristic.is_lock_file"
},
{
"path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
},
{
"path": "detect_secrets.filters.heuristic.is_potential_uuid"
},
{
"path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
},
{
"path": "detect_secrets.filters.heuristic.is_sequential_string"
},
{
"path": "detect_secrets.filters.heuristic.is_swagger_file"
},
{
"path": "detect_secrets.filters.heuristic.is_templated_secret"
}
],
"results": {
"examples/workflows/resolution_calculator_example.json": [
{
"type": "Hex High Entropy String",
"filename": "examples/workflows/resolution_calculator_example.json",
"hashed_secret": "5264b0f1a47aeafad88f33511dda3191b32dbf38",
"is_verified": false,
"line_number": 57
}
],
"examples/workflows/sampler_combo_example.json": [
{
"type": "Hex High Entropy String",
"filename": "examples/workflows/sampler_combo_example.json",
"hashed_secret": "e3c1848dd1141985e412fa39922ac9ba37c4714d",
"is_verified": false,
"line_number": 348
}
],
"examples/workflows/seed_history_example.json": [
{
"type": "Hex High Entropy String",
"filename": "examples/workflows/seed_history_example.json",
"hashed_secret": "e3c1848dd1141985e412fa39922ac9ba37c4714d",
"is_verified": false,
"line_number": 408
}
],
"examples/workflows/width_height_selector_example.json": [
{
"type": "Hex High Entropy String",
"filename": "examples/workflows/width_height_selector_example.json",
"hashed_secret": "e3c1848dd1141985e412fa39922ac9ba37c4714d",
"is_verified": false,
"line_number": 425
}
]
},
"generated_at": "2025-07-31T23:51:20Z"
}
+288
View File
@@ -0,0 +1,288 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project Overview
ComfyUI-KikoTools is a planned modular collection of custom ComfyUI nodes that will provide essential tools missing from the standard ComfyUI release. All nodes will be grouped under "ComfyAssets" in the ComfyUI interface. The project is designed for extensibility, allowing new tools to be added easily while maintaining clean separation of concerns.
**Current Status**: Project is in initial planning phase. Only documentation and licensing files exist.
## Architecture
### Design Principles
- **Modular Design**: Each tool is a separate, self-contained module
- **ComfyAssets Grouping**: All nodes appear under the "ComfyAssets" category
- **Test-Driven Development**: Every tool includes comprehensive tests
- **Clean Interfaces**: Standardized input/output patterns across tools
### Core Components
- **Tool Registry**: Central registration system for all KikoTools nodes
- **Base Classes**: Shared functionality for consistent tool behavior
- **Individual Tools**: Self-contained modules for specific functionality
### Current Tools
#### 1. Resolution Calculator (First Tool)
- **Purpose**: Calculate upscale resolution from image or latent inputs
- **Inputs**:
- Image or Latent tensor
- Scale factor (1, 2, 3, 1.2, 1.5, 2.0)
- **Outputs**:
- Width (INT)
- Height (INT)
- **Target Models**: Flux and SDXL optimized
- **Use Case**: Connect calculated dimensions to upscaler nodes
## Technology Stack
- **Backend**: Python with ComfyUI node patterns
- **Node Framework**: ComfyUI INPUT_TYPES, RETURN_TYPES, execute() patterns
- **Testing**: pytest with ComfyUI test fixtures
- **Code Quality**: black, flake8, mypy
- **Integration**: ComfyUI execution queue and tensor systems
## Development Commands
**Note**: These commands are planned for when the project structure is implemented.
### Initial Setup
```bash
# Create basic project structure
mkdir -p kikotools/{base,tools} tests/{unit,integration,fixtures} scripts examples
# Create entry point files
touch __init__.py kikotools/__init__.py
```
### Code Quality (Future)
```bash
# Format Python code
black .
# Python linting
flake8 .
# Type checking
mypy .
```
### Testing (Future TDD Workflow)
```bash
# Run all tests
pytest tests/
# Run tests for specific tool
pytest tests/unit/tools/test_{tool_name}.py
# Test coverage
pytest --cov=kikotools tests/
```
## Project Structure (Planned)
**Current State**: Only `CLAUDE.md` and `LICENSE` files exist.
**Planned Structure**:
```
├── __init__.py # ComfyUI node registration entry point
├── kikotools/ # Main package
│ ├── __init__.py # Package initialization and tool registry
│ ├── base/ # Base classes and shared utilities
│ │ ├── __init__.py
│ │ ├── base_node.py # Base node class with ComfyAssets grouping
│ │ └── utils.py # Shared utility functions
│ ├── tools/ # Individual tool implementations
│ │ ├── __init__.py
│ │ ├── resolution_calculator/ # First planned tool
│ │ │ ├── __init__.py
│ │ │ ├── node.py # ResolutionCalculatorNode implementation
│ │ │ └── logic.py # Core calculation logic
│ │ └── template/ # Template for new tools
│ │ ├── __init__.py
│ │ ├── node.py
│ │ └── logic.py
├── tests/ # Comprehensive test suite (TDD approach)
│ ├── __init__.py
│ ├── conftest.py # pytest fixtures and ComfyUI test setup
│ ├── unit/ # Unit tests for individual components
│ │ ├── test_base_node.py
│ │ └── tools/
│ │ └── test_resolution_calculator.py
│ ├── integration/ # ComfyUI integration tests
│ │ ├── test_node_registration.py
│ │ └── test_workflow_execution.py
│ └── fixtures/ # Test data and workflow files
│ ├── workflows/ # .json workflow files for testing
│ ├── images/ # Test images
│ └── latents/ # Test latent tensors
├── scripts/ # Development automation
│ ├── create_tool.py # Tool template generator
│ ├── register_tool.py # Tool registration helper
│ └── validate_nodes.py # Node validation script
├── examples/ # Usage examples and demonstrations
│ ├── workflows/ # Example workflow .json files
│ └── documentation/ # Usage documentation per tool
└── requirements-dev.txt # Development dependencies
```
## Key ComfyUI Integration Points
### Node Registration Pattern
```python
# Each tool follows this pattern in kikotools/tools/{tool_name}/node.py
class ResolutionCalculatorNode:
@classmethod
def INPUT_TYPES(cls):
return {
"required": {
"scale_factor": ("FLOAT", {"default": 2.0, "min": 1.0, "max": 8.0, "step": 0.1}),
},
"optional": {
"image": ("IMAGE",),
"latent": ("LATENT",),
}
}
RETURN_TYPES = ("INT", "INT")
RETURN_NAMES = ("width", "height")
FUNCTION = "calculate_resolution"
CATEGORY = "ComfyAssets" # All tools use this category
def calculate_resolution(self, scale_factor, image=None, latent=None):
# Implementation here
pass
```
### Base Node Class
- Provides consistent "ComfyAssets" categorization
- Standardizes error handling and logging
- Implements common validation patterns
- Ensures consistent return type handling
### Tool Registry System
- Automatic discovery of tools in `kikotools/tools/`
- Dynamic node registration during ComfyUI startup
- Version compatibility checking
- Dependency validation
## Test-Driven Development (TDD) Workflow
### 1. Write Tests First
```python
# tests/unit/tools/test_resolution_calculator.py
def test_resolution_calculator_with_image():
"""Test resolution calculation with image input."""
# Arrange
node = ResolutionCalculatorNode()
test_image = create_test_image(512, 512) # fixture
scale_factor = 2.0
# Act
width, height = node.calculate_resolution(scale_factor, image=test_image)
# Assert
assert width == 1024
assert height == 1024
def test_resolution_calculator_with_latent():
"""Test resolution calculation with latent input."""
# Similar pattern for latent inputs
pass
```
### 2. Run Tests (Should Fail)
```bash
pytest tests/unit/tools/test_resolution_calculator.py -v
```
### 3. Implement Minimal Code
```python
# kikotools/tools/resolution_calculator/logic.py
def calculate_upscale_resolution(input_tensor, scale_factor):
"""Calculate new resolution based on input and scale factor."""
# Minimal implementation to pass tests
pass
```
### 4. Refactor and Expand
- Add error handling
- Optimize for Flux/SDXL specific requirements
- Add comprehensive validation
- Implement edge case handling
### 5. Integration Testing
```python
# tests/integration/test_workflow_execution.py
def test_resolution_calculator_in_workflow():
"""Test resolution calculator in full ComfyUI workflow."""
workflow = load_test_workflow("resolution_calculator_example.json")
result = execute_comfyui_workflow(workflow)
assert result.success
```
## Tool-Specific Implementation Notes
### Resolution Calculator
- **Input Validation**: Handle both image and latent tensors
- **Scale Factors**: Support integer (1, 2, 3) and float (1.2, 1.5, 2.0) multipliers
- **Model Optimization**: Consider Flux and SDXL specific resolution requirements
- **Output Format**: Integer width/height suitable for upscaler node connections
- **Error Handling**: Graceful handling of invalid inputs or edge cases
### Future Tools (Planned)
- Batch Image Processor
- Advanced Prompt Utilities
- Model Management Tools
- Custom Sampling Methods
## Development Workflow
### Adding a New Tool
1. **Plan**: Define tool purpose, inputs, outputs, and test cases
2. **Generate**: Use `python scripts/create_tool.py --name "NewTool"`
3. **Test**: Write comprehensive tests following TDD principles
4. **Implement**: Build tool logic with proper ComfyUI integration
5. **Register**: Add tool to registry and validate registration
6. **Document**: Update examples and documentation
7. **Validate**: Test in real ComfyUI environment with actual workflows
### Code Quality Standards
- **Type Hints**: Full type annotation for all functions
- **Documentation**: Docstrings for all public methods and classes
- **Testing**: Minimum 90% test coverage for all tools
- **Linting**: Pass all flake8 and mypy checks
- **Formatting**: Auto-formatted with black
### Release Process
1. Run full test suite: `pytest tests/`
2. Validate in ComfyUI: `python scripts/validate_nodes.py`
3. Update version numbers and changelog
4. Create example workflows demonstrating new features
5. Update ComfyUI-Manager compatibility metadata
## Critical Implementation Notes
### ComfyUI Compatibility
- Follow ComfyUI tensor format conventions
- Implement proper memory management for large tensors
- Handle ComfyUI execution context correctly
- Ensure compatibility with ComfyUI's automatic typing system
### Performance Considerations
- Optimize for real-time workflow execution
- Minimize memory allocation during processing
- Cache expensive computations when appropriate
- Profile performance with typical Flux/SDXL workflows
### User Experience
- Clear, descriptive node names and parameter labels
- Helpful tooltips and parameter descriptions
- Consistent visual styling within ComfyAssets group
- Robust error messages with actionable guidance
### Extensibility
- Plugin architecture for easy tool addition
- Shared utilities for common operations
- Consistent API patterns across all tools
- Future-proof design for ComfyUI updates
+47 -27
View File
@@ -2,6 +2,22 @@
.PHONY: help install test test-fast lint format type-check quality-check clean setup dev-test release-test
# Python and virtual environment setup
PYTHON := python3
VENV_DIR := venv
VENV_BIN := $(VENV_DIR)/bin
VENV_PYTHON := $(VENV_BIN)/python
VENV_PIP := $(VENV_BIN)/pip
# Check if we're in a virtual environment, if not use venv
ifeq ($(VIRTUAL_ENV),)
PYTHON_CMD := $(VENV_PYTHON)
PIP_CMD := $(VENV_PIP)
else
PYTHON_CMD := python
PIP_CMD := pip
endif
# Default target
help:
@echo "ComfyUI-KikoTools Development Commands"
@@ -28,44 +44,48 @@ help:
@echo " help - Show this help message"
# Setup and installation
setup:
@echo "Setting up ComfyUI-KikoTools development environment..."
python -m venv venv
@echo "Virtual environment created. Activate with:"
@echo " source venv/bin/activate (Linux/Mac)"
@echo " venv\\Scripts\\activate (Windows)"
@echo "Then run: make install"
setup: $(VENV_DIR)
@echo "✅ ComfyUI-KikoTools development environment ready"
@echo "Virtual environment created. Dependencies installed."
install:
$(VENV_DIR):
@echo "Creating virtual environment..."
$(PYTHON) -m venv $(VENV_DIR)
@echo "Installing development dependencies..."
pip install --upgrade pip
pip install -r requirements-dev.txt
$(VENV_PIP) install --upgrade pip
$(VENV_PIP) install -r requirements-dev.txt
@echo "✅ Virtual environment created and dependencies installed"
install: $(VENV_DIR)
@echo "Installing/updating development dependencies..."
$(PIP_CMD) install --upgrade pip
$(PIP_CMD) install -r requirements-dev.txt
@echo "✅ Dependencies installed"
# Code quality
format:
format: $(VENV_DIR)
@echo "Formatting code with black..."
black .
$(PYTHON_CMD) -m black .
@echo "✅ Code formatted"
lint:
lint: $(VENV_DIR)
@echo "Linting with flake8..."
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
$(PYTHON_CMD) -m flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=venv
$(PYTHON_CMD) -m flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude=venv
@echo "✅ Linting completed"
type-check:
type-check: $(VENV_DIR)
@echo "Type checking with mypy..."
mypy kikotools/ --ignore-missing-imports --no-strict-optional || true
$(PYTHON_CMD) -m mypy kikotools/ --ignore-missing-imports --no-strict-optional || true
@echo "✅ Type checking completed"
quality-check: format lint type-check
@echo "✅ All quality checks completed"
# Testing
dev-test:
dev-test: $(VENV_DIR)
@echo "Running quick development test..."
@python -c "\
@$(PYTHON_CMD) -c "\
import sys, os; \
sys.path.insert(0, os.getcwd()); \
from kikotools.tools.resolution_calculator.node import ResolutionCalculatorNode; \
@@ -75,9 +95,9 @@ dev-test:
print(f'✅ Development test passed! Result: {result[0]}x{result[1]}'); \
"
test-fast:
test-fast: $(VENV_DIR)
@echo "Running core functionality tests..."
@python -c "\
@$(PYTHON_CMD) -c "\
import sys, os; \
sys.path.insert(0, os.getcwd()); \
from kikotools.base import ComfyAssetsBaseNode; \
@@ -103,7 +123,7 @@ test-fast:
test: test-fast
@echo "Running comprehensive test suite..."
@echo "✅ Test case 1: 512×512 → 1024×1024 (scale: 2.0)"
@echo "✅ Test case 2: 1024×1024 → 1536×1536 (scale: 1.5)"
@echo "✅ Test case 2: 1024×1024 → 1536×1536 (scale: 1.5)"
@echo "✅ Test case 3: 832×1216 → 1272×1864 (scale: 1.53)"
@echo "✅ Error handling test passed"
@echo "🎉 All comprehensive tests passed!"
@@ -146,13 +166,13 @@ ci: quality-check test
@echo "✅ CI checks passed!"
# Tool-specific commands (can be extended for new tools)
test-resolution-calculator:
test-resolution-calculator: $(VENV_DIR)
@echo "Testing Resolution Calculator specifically..."
@python -c "import sys, os; sys.path.insert(0, os.getcwd()); from kikotools.tools.resolution_calculator.node import ResolutionCalculatorNode; import torch; node = ResolutionCalculatorNode(); scenarios = [('SDXL Portrait', torch.randn(1, 1216, 832, 3), 1.5), ('FLUX Square', torch.randn(1, 1024, 1024, 3), 2.0), ('User Scenario', torch.randn(1, 1216, 832, 3), 1.53)]; [print(f'✅ {name}: {image.shape[2]}×{image.shape[1]} → {node.calculate_resolution(scale, image=image)[0]}×{node.calculate_resolution(scale, image=image)[1]} ({scale}x)') for name, image, scale in scenarios]; print('🎉 Resolution Calculator tests completed!')"
@$(PYTHON_CMD) -c "import sys, os; sys.path.insert(0, os.getcwd()); from kikotools.tools.resolution_calculator.node import ResolutionCalculatorNode; import torch; node = ResolutionCalculatorNode(); scenarios = [('SDXL Portrait', torch.randn(1, 1216, 832, 3), 1.5), ('FLUX Square', torch.randn(1, 1024, 1024, 3), 2.0), ('User Scenario', torch.randn(1, 1216, 832, 3), 1.53)]; [print(f'✅ {name}: {image.shape[2]}×{image.shape[1]} → {node.calculate_resolution(scale, image=image)[0]}×{node.calculate_resolution(scale, image=image)[1]} ({scale}x)') for name, image, scale in scenarios]; print('🎉 Resolution Calculator tests completed!')"
test-width-height-selector:
test-width-height-selector: $(VENV_DIR)
@echo "Testing Width Height Selector specifically..."
@python -c "\
@$(PYTHON_CMD) -c "\
import sys, os; \
sys.path.insert(0, os.getcwd()); \
from kikotools.tools.width_height_selector.node import WidthHeightSelectorNode; \
@@ -176,4 +196,4 @@ test-width-height-selector:
"
test-all-tools: test-resolution-calculator test-width-height-selector
@echo "🎉 All tool-specific tests completed!"
@echo "🎉 All tool-specific tests completed!"
+264 -19
View File
@@ -25,7 +25,7 @@ Calculate upscaled dimensions from image or latent inputs with precision.
**Use Cases:**
- Calculate target dimensions for upscaler nodes
- Plan memory usage for large generations
- Plan memory usage for large generations
- Ensure ComfyUI tensor compatibility
- Optimize batch processing workflows
@@ -60,6 +60,86 @@ Advanced seed tracking with interactive history management and UI.
- Maintain reproducibility across sessions
- Compare results from different seeds efficiently
#### ⚙️ Sampler Combo
Unified sampling configuration interface combining sampler, scheduler, steps, and CFG.
- **All-in-One Interface**: Single node for complete sampling configuration
- **Smart Recommendations**: Optimal settings suggestions per sampler type
- **Compatibility Validation**: Ensures sampler/scheduler combinations work well
- **Intelligent Defaults**: Context-aware parameter recommendations
- **Range Validation**: Prevents invalid parameter combinations
- **Comprehensive Tooltips**: Detailed guidance for each parameter
**Use Cases:**
- Simplify complex sampling workflows
- Ensure optimal sampler/scheduler combinations
- Reduce node clutter in workflows
- Quick sampling parameter experimentation
#### 📦 Empty Latent Batch
Advanced empty latent creation with preset support and batch processing capabilities.
- **Preset Integration**: 26 curated resolution presets with model optimization
- **Batch Processing**: Create multiple empty latents (1-64) in a single operation
- **Visual Swap Button**: Interactive blue button for quick dimension swapping
- **Smart Validation**: Automatic dimension sanitization for VAE compatibility
- **Memory Estimation**: Built-in memory usage calculation and warnings
- **Model-Aware Presets**: SDXL (~1MP), FLUX (high-res), and Ultra-wide options
**Use Cases:**
- Initialize batch processing workflows efficiently
- Create consistent latent dimensions across model types
- Optimize memory usage with batch size planning
- Quick preset-based latent generation for different aspect ratios
#### 💾 Kiko Save Image
Enhanced image saving with format selection, quality control, and floating popup viewer.
- **Multiple Format Support**: Save as PNG, JPEG, or WebP with format-specific optimizations
- **Advanced Quality Controls**: JPEG/WebP quality (1-100), PNG compression (0-9), WebP lossless mode
- **Floating Popup Viewer**: Draggable, resizable window that shows saved images immediately
- **Interactive Previews**: Click any image to open in new tab, download individual images
- **Batch Selection**: Multi-select images for bulk actions (open all, download all)
- **Format-Specific Settings**: Quality indicators, file size display, compression info
- **Smart UI**: Auto-hide/show, minimize/maximize, roll-up functionality
- **Popup Toggle**: Enable/disable popup viewer per save operation
#### 🤖 Gemini Prompt Engineer
AI-powered image analysis using Google's Gemini to generate optimized prompts for various models.
- **Multi-Model Support**: Generate prompts for FLUX, SDXL, Danbooru, and Video generation
- **Smart Analysis**: Gemini analyzes composition, style, lighting, colors, and details
- **Format-Specific Output**: FLUX artistic prompts, SDXL positive/negative pairs, Danbooru tags, Video motion descriptions
- **Custom System Prompts**: Override templates with your own analysis instructions
- **Flexible API Key Management**: Environment variable, config file, or direct input
- **Visual Status Feedback**: Real-time processing indicators and error states
- **Help Integration**: Built-in setup guide and documentation
**Use Cases:**
- Reverse-engineer prompts from reference images
- Convert artistic descriptions between different AI model formats
- Generate consistent style descriptions across workflows
- Create detailed scene breakdowns for complex compositions
- Analyze and replicate lighting/mood from existing artwork
### 💾 Kiko Save Image Features
**Use Cases:**
- Quick preview and management of saved images without file browser navigation
- Compare multiple format outputs side-by-side (PNG vs JPEG vs WebP)
- Batch download or open selected images efficiently
- Monitor file sizes and compression effectiveness in real-time
- Streamlined workflow for iterative image generation and saving
**Why Better Than Standard Save Image:**
- **Immediate Visual Feedback**: See your saved images instantly without opening file explorer
- **Multi-Format Flexibility**: Choose optimal format for your use case (PNG for quality, JPEG for size, WebP for modern efficiency)
- **Advanced Compression Control**: Fine-tune file sizes with format-specific quality settings
- **Batch Operations**: Handle multiple images efficiently with selection and bulk actions
- **Modern UI**: Floating, draggable interface that doesn't interrupt your workflow
- **Smart Memory Usage**: File size indicators help optimize storage and sharing
- **One-Click Access**: Direct image opening in browser tabs for quick sharing or review
### 🔧 Architecture Highlights
- **Modular Design**: Each tool is self-contained and independently testable
@@ -97,8 +177,8 @@ Image Loader → Resolution Calculator → Upscaler
↘ scale_factor: 1.5 ↗
```
**Input:** 832×1216 (SDXL portrait format)
**Scale:** 1.5x
**Input:** 832×1216 (SDXL portrait format)
**Scale:** 1.5x
**Output:** 1248×1824 (ready for upscaling)
### Width Height Selector Example
@@ -109,8 +189,8 @@ preset: "1920×1080" ↘ 1920×1080 ↗
[swap button]
```
**Preset:** FLUX HD (1920×1080)
**Output:** 1920×1080 (16:9 cinematic)
**Preset:** FLUX HD (1920×1080)
**Output:** 1920×1080 (16:9 cinematic)
**Swap Button:** Click to get 1080×1920 (9:16 portrait)
### Seed History Example
@@ -121,10 +201,63 @@ Seed History → KSampler → VAE Decode → Save Image
[History UI: 54321, 99999, 11111...]
```
**Current Seed:** 12345
**History:** Auto-tracked previous seeds with timestamps
**Current Seed:** 12345
**History:** Auto-tracked previous seeds with timestamps
**Interaction:** Click any historical seed to reload instantly
### Sampler Combo Example
```
Sampler Combo → KSampler → VAE Decode → Save Image
⚙️ All Settings ↘ sampler/scheduler/steps/cfg ↗
```
**Configuration:** euler, normal, 20 steps, CFG 7.0
**Output:** Complete sampling configuration in one node
**Smart Features:** Recommendations and compatibility validation
### Empty Latent Batch Example
```
Empty Latent Batch → KSampler → VAE Decode → Kiko Save Image
📦 preset: "1024×1024" ↘ batch latents ↗ ↘ popup viewer ↗
batch_size: 4
[swap button]
```
**Preset:** SDXL Square (1024×1024)
**Batch Size:** 4 empty latents
**Output:** 4×4×128×128 latent tensor ready for sampling
**Swap Button:** Click to switch to any available swapped preset
### Kiko Save Image Example
```
Generate Image → Kiko Save Image → Floating Popup Viewer
📷 output ↘ format: WEBP ↘ draggable window ↗
quality: 85
[popup: enabled]
```
**Format:** WebP (efficient compression, modern format)
**Quality:** 85% (balanced size/quality)
**Popup Viewer:** Floating, draggable window with saved images
**Features:** Click images to open in new tabs, download individual files, batch selection
**Advantages:** Immediate preview without file explorer, multi-format comparison, advanced quality controls
### Gemini Prompt Engineer Example
```
Load Image → Gemini Prompt → Text Generation Model
🖼️ reference ↘ type: FLUX ↘ "majestic landscape..."
[API key] → FLUX model
```
**Input:** Reference image for style analysis
**Prompt Type:** FLUX (detailed artistic prompts)
**Output:** Optimized prompt with style, lighting, composition details
**API:** Requires Gemini API key (free tier available)
**Use Case:** Recreate similar style/mood from reference images
### Common Workflows
<details>
@@ -133,7 +266,7 @@ Seed History → KSampler → VAE Decode → Save Image
```json
{
"workflow": "Load SDXL portrait → Calculate 1.5x dimensions → Feed to upscaler",
"input_resolution": "832×1216",
"input_resolution": "832×1216",
"scale_factor": 1.5,
"output_resolution": "1248×1824",
"memory_efficient": true
@@ -148,7 +281,7 @@ Seed History → KSampler → VAE Decode → Save Image
{
"workflow": "Generate latents → Calculate target size → Batch upscale",
"input_resolution": "1024×1024",
"scale_factor": 2.0,
"scale_factor": 2.0,
"output_resolution": "2048×2048",
"batch_optimized": true
}
@@ -164,6 +297,9 @@ Seed History → KSampler → VAE Decode → Save Image
| **Resolution Calculator** | Calculate upscaled dimensions with model optimization | ✅ Complete | [Docs](examples/documentation/resolution_calculator.md) |
| **Width Height Selector** | Preset-based dimension selection with 26 curated options | ✅ Complete | [Docs](examples/documentation/width_height_selector.md) |
| **Seed History** | Advanced seed tracking with interactive history management | ✅ Complete | [Docs](examples/documentation/seed_history.md) |
| **Sampler Combo** | Unified sampling configuration with smart recommendations | ✅ Complete | [Docs](examples/documentation/sampler_combo.md) |
| **Empty Latent Batch** | Create empty latent batches with preset support | ✅ Complete | [Docs](examples/documentation/empty_latent_batch.md) |
| **Kiko Save Image** | Enhanced image saving with popup viewer and multi-format support | ✅ Complete | [Docs](examples/documentation/kiko_save_image.md) |
| **Batch Image Processor** | Process multiple images with consistent settings | 🚧 Planned | Coming Soon |
| **Advanced Prompt Utilities** | Enhanced prompt manipulation and generation | 🚧 Planned | Coming Soon |
@@ -173,7 +309,7 @@ Seed History → KSampler → VAE Decode → Save Image
**Inputs:**
- `scale_factor` (FLOAT): 1.0-8.0, default 2.0
- `image` (IMAGE, optional): Input image tensor
- `image` (IMAGE, optional): Input image tensor
- `latent` (LATENT, optional): Input latent tensor
**Outputs:**
@@ -195,7 +331,7 @@ Seed History → KSampler → VAE Decode → Save Image
**Outputs:**
- `width` (INT): Selected or calculated width
- `height` (INT): Selected or calculated height
- `height` (INT): Selected or calculated height
**UI Features:**
- Visual blue swap button in bottom-right corner
@@ -229,6 +365,92 @@ Seed History → KSampler → VAE Decode → Save Image
- Newest entries displayed first
- Human-readable time formatting (5m ago, 2h ago)
#### Sampler Combo
**Inputs:**
- `sampler_name` (DROPDOWN): Available ComfyUI samplers (euler, dpmpp_2m, etc.)
- `scheduler` (DROPDOWN): Available schedulers (normal, karras, exponential, etc.)
- `steps` (INT): 1-1000, default 20
- `cfg` (FLOAT): 0.0-30.0, default 7.0
**Outputs:**
- `sampler_name` (STRING): Selected sampler algorithm
- `scheduler` (STRING): Selected scheduler algorithm
- `steps` (INT): Validated step count
- `cfg` (FLOAT): Validated CFG scale
**Features:**
- Smart parameter validation and sanitization
- Sampler-specific recommendations for optimal settings
- Compatibility checking between samplers and schedulers
- Graceful error handling with safe defaults
- Comprehensive tooltips for user guidance
#### Empty Latent Batch
**Inputs:**
- `preset` (DROPDOWN): 26 preset options + custom with formatted metadata display
- `width` (INT): 64-8192, step 8, default 1024
- `height` (INT): 64-8192, step 8, default 1024
- `batch_size` (INT): 1-64, default 1
**Outputs:**
- `latent` (LATENT): Batch of empty latent tensors in ComfyUI format
- `width` (INT): Final sanitized width (divisible by 8)
- `height` (INT): Final sanitized height (divisible by 8)
**UI Features:**
- Visual blue swap button with hover and click feedback
- Intelligent preset switching when swapping dimensions
- Memory usage estimation and warnings for large batches
- Auto-update width/height widgets when presets change
**Batch Processing:**
- Creates tensors with shape: [batch_size, 4, height//8, width//8]
- Efficient memory allocation with torch.zeros
- Validates batch size limits (1-64) with performance warnings
- Compatible with all ComfyUI latent processing nodes
**Preset Integration:**
- Full access to 26 curated resolution presets from Width Height Selector
- Model-aware categorization (SDXL, FLUX, Ultra-wide)
- Formatted display with aspect ratio and megapixel information
- Intelligent fallback to custom dimensions for invalid presets
#### Kiko Save Image
**Inputs:**
- `images` (IMAGE): Batch of images to save
- `filename_prefix` (STRING): Prefix for saved filenames, default "KikoSave"
- `format` (DROPDOWN): Output format (PNG, JPEG, WEBP), default PNG
- `quality` (INT): JPEG/WebP quality (1-100), default 90
- `png_compress_level` (INT): PNG compression level (0-9), default 4
- `webp_lossless` (BOOLEAN): Use lossless WebP compression, default False
- `popup` (BOOLEAN): Enable popup viewer window, default True
**Outputs:**
- `UI`: Enhanced image preview data with popup viewer functionality
**UI Features:**
- Floating, draggable popup window showing saved images immediately
- Interactive image grid with click-to-open functionality
- Individual image download buttons with format-specific quality indicators
- Batch selection with multi-select checkboxes for bulk operations
- Window controls: minimize, maximize, roll-up, close, and dragging
- Auto-hide/show behavior with smart positioning
**Format Support:**
- **PNG**: Lossless compression with metadata preservation, configurable compression levels
- **JPEG**: Quality-controlled lossy compression with automatic transparency handling
- **WebP**: Modern format with both lossy and lossless modes, superior compression ratios
**Advanced Features:**
- File size monitoring and display for optimization feedback
- Format-specific quality indicators (PNG compression level, JPEG/WebP quality percentage)
- Smart filename sanitization with timestamp-based uniqueness
- Persistent popup viewer across multiple save operations
- Toggle button integration in node UI for manual viewer control
## 🛠️ Development
### Prerequisites
@@ -251,6 +473,9 @@ source venv/bin/activate # On Windows: venv\Scripts\activate
# Install development dependencies
pip install -r requirements-dev.txt
# Install pre-commit hooks
pre-commit install
# Run tests
python -c "
import sys, os
@@ -267,13 +492,32 @@ print(f'✅ Development setup successful! Test result: {result[0]}x{result[1]}')
### Code Quality
We maintain high code quality standards:
We maintain high code quality standards with automated pre-commit hooks:
#### Pre-commit Hooks
Our pre-commit configuration automatically runs:
- **Black**: Code formatting (127 char line length)
- **Flake8**: Linting and style checks
- **Bandit**: Security vulnerability scanning
- **detect-secrets**: Prevents accidental secret commits
- File checks: trailing whitespace, YAML validation, merge conflicts
```bash
# Run all pre-commit hooks manually
pre-commit run --all-files
# Update hooks to latest versions
pre-commit autoupdate
```
#### Manual Code Quality Checks
```bash
# Format code
black .
# Lint code
# Lint code
flake8 .
# Type checking
@@ -296,7 +540,7 @@ Following **Test-Driven Development (TDD)**:
# Test structure
tests/
├── unit/ # Individual component tests
├── integration/ # ComfyUI workflow tests
├── integration/ # ComfyUI workflow tests
└── fixtures/ # Test data and workflows
```
@@ -349,13 +593,14 @@ MIT License - see [LICENSE](LICENSE) file for details.
## 📈 Stats
- **Nodes**: 3 (Resolution Calculator, Width Height Selector, Seed History)
- **Nodes**: 6 (Resolution Calculator, Width Height Selector, Seed History, Sampler Combo, Empty Latent Batch, Kiko Save Image)
- **Format Support**: 3 (PNG, JPEG, WebP with advanced controls)
- **Presets**: 26 curated resolution presets
- **Interactive Features**: 2 (Swap Button, History UI)
- **Test Coverage**: 100% (150+ comprehensive tests)
- **Interactive Features**: 4 (Width/Height Swap Button, Seed History UI, Empty Latent Batch Swap Button, Kiko Save Image Popup Viewer)
- **Test Coverage**: 100% (200+ comprehensive tests)
- **Python Version**: 3.8+
- **ComfyUI Compatibility**: Latest
- **Dependencies**: Minimal (PyTorch, NumPy)
- **Dependencies**: Minimal (PyTorch, NumPy, Pillow)
---
@@ -365,4 +610,4 @@ MIT License - see [LICENSE](LICENSE) file for details.
[⭐ Star this repo](https://github.com/ComfyAssets/ComfyUI-KikoTools) • [🐛 Report Bug](https://github.com/ComfyAssets/ComfyUI-KikoTools/issues) • [💡 Request Feature](https://github.com/ComfyAssets/ComfyUI-KikoTools/issues)
</div>
</div>
+30 -3
View File
@@ -3,12 +3,39 @@ ComfyUI-KikoTools: Modular collection of custom ComfyUI nodes
All nodes are grouped under the "ComfyAssets" category
"""
from .kikotools import NODE_CLASS_MAPPINGS, NODE_DISPLAY_NAME_MAPPINGS
import re
from pathlib import Path
try:
from .kikotools import NODE_CLASS_MAPPINGS, NODE_DISPLAY_NAME_MAPPINGS
except ImportError:
# Fallback for testing environment
from kikotools import NODE_CLASS_MAPPINGS, NODE_DISPLAY_NAME_MAPPINGS
# Tell ComfyUI where to find our JavaScript extensions
WEB_DIRECTORY = "./web"
# Print startup message
print("\033[94m[ComfyUI-KikoTools] Loaded with swap button support!\033[0m")
def get_version():
"""Parse version from pyproject.toml"""
try:
pyproject_path = Path(__file__).parent / "pyproject.toml"
if pyproject_path.exists():
content = pyproject_path.read_text()
match = re.search(r'version\s*=\s*["\']([^"\']+)["\']', content)
if match:
return match.group(1)
except Exception:
pass
return "unknown"
# Print startup message with loaded tools
print()
print(f"\033[94m[ComfyUI-KikoTools] Version:\033[0m {get_version()}")
for node_key, display_name in NODE_DISPLAY_NAME_MAPPINGS.items():
print(f"🫶 \033[94mLoaded:\033[0m {display_name}")
print(f"\033[94mTotal: {len(NODE_CLASS_MAPPINGS)} tools loaded\033[0m")
print()
__all__ = ["NODE_CLASS_MAPPINGS", "NODE_DISPLAY_NAME_MAPPINGS", "WEB_DIRECTORY"]
+362
View File
@@ -0,0 +1,362 @@
import os
from typing import Tuple
import comfy.sd
import comfy.utils
import torch
import torch.nn.functional as F
from comfy.sd import CLIP
from diffusers import ConsistencyDecoderVAE
from folder_paths import get_folder_paths
from huggingface_hub import hf_hub_download
from torch import Tensor
def find_or_create_cache():
cwd = os.getcwd()
if os.path.exists(os.path.join(cwd, "ComfyUI")):
cwd = os.path.join(cwd, "ComfyUI")
if os.path.exists(os.path.join(cwd, "models")):
cwd = os.path.join(cwd, "models")
if not os.path.exists(os.path.join(cwd, "huggingface_cache")):
print("Creating huggingface_cache directory within comfy")
os.mkdir(os.path.join(cwd, "huggingface_cache"))
return str(os.path.join(cwd, "huggingface_cache"))
class ConsistencyDecoder:
@classmethod
def INPUT_TYPES(s):
return {"required": {"latent": ("LATENT",)}}
RETURN_TYPES = ("IMAGE",)
FUNCTION = "decode"
CATEGORY = "latent"
def __init__(self):
self.vae = (
ConsistencyDecoderVAE.from_pretrained(
"openai/consistency-decoder",
torch_dtype=torch.float16,
variant="fp16",
use_safetensors=True,
cache_dir=find_or_create_cache(),
)
.eval()
.to("cuda")
)
def _decode(self, latent):
"""Used when patching another vae."""
return self.vae.decode(latent.half().cuda()).sample
def decode(self, latent):
"""Used for standalone decoding."""
sample = self._decode(latent["samples"])
sample = sample.clamp(-1, 1).movedim(1, -1).add(1.0).mul(0.5).cpu()
return (sample,)
class PatchDecoderTiled:
@classmethod
def INPUT_TYPES(s):
return {"required": {"vae": ("VAE",)}}
RETURN_TYPES = ("VAE",)
FUNCTION = "patch"
category = "vae"
def __init__(self):
self.vae = ConsistencyDecoder()
def patch(self, vae):
del vae.first_stage_model.decoder
vae.first_stage_model.decode = self.vae._decode
vae.decode = (
lambda x: vae.decode_tiled_(
x,
tile_x=512,
tile_y=512,
overlap=64,
)
.to("cuda")
.movedim(1, -1)
)
return (vae,)
# quick node to set SDXL-friendly aspect ratios in 1024^2
# adapted from throttlekitty
class SDXLAspectRatio:
def __init__(self):
pass
@classmethod
def INPUT_TYPES(s):
return {
"required": {
"image": ("IMAGE",),
}
}
RETURN_TYPES = ("INT", "INT")
RETURN_NAMES = ("width", "height")
FUNCTION = "run"
CATEGORY = "image"
def run(self, image: Tensor) -> Tuple[int, int]:
_, height, width, _ = image.shape
aspect_ratio = width / height
aspect_ratios = (
(1 / 1, 1024, 1024),
(2 / 3, 832, 1216),
(3 / 4, 896, 1152),
(5 / 8, 768, 1216),
(9 / 16, 768, 1344),
(9 / 19, 704, 1472),
(9 / 21, 640, 1536),
(3 / 2, 1216, 832),
(4 / 3, 1152, 896),
(8 / 5, 1216, 768),
(16 / 9, 1344, 768),
(19 / 9, 1472, 704),
(21 / 9, 1536, 640),
)
# find the closest aspect ratio
closest = min(aspect_ratios, key=lambda x: abs(x[0] - aspect_ratio))
return (closest[1], closest[2])
class ImageToMultipleOf:
@classmethod
def INPUT_TYPES(s):
return {
"required": {
"image": ("IMAGE",),
"multiple_of": (
"INT",
{
"default": 64,
"min": 1,
"max": 256,
"step": 16,
"display": "number",
},
),
"method": (["center crop", "rescale"],),
}
}
RETURN_TYPES = ("IMAGE",)
RETURN_NAMES = ("image",)
FUNCTION = "run"
CATEGORY = "image"
def run(self, image: Tensor, multiple_of: int, method: str) -> Tuple[Tensor]:
"""Center crop the image to a specific multiple of a number."""
_, height, width, _ = image.shape
new_height = height - (height % multiple_of)
new_width = width - (width % multiple_of)
if method == "rescale":
return (
F.interpolate(
image.unsqueeze(0),
size=(new_height, new_width),
mode="bilinear",
align_corners=False,
).squeeze(0),
)
else:
top = (height - new_height) // 2
left = (width - new_width) // 2
bottom = top + new_height
right = left + new_width
return (image[:, top:bottom, left:right, :],)
class HFHubLoraLoader:
def __init__(self):
self.loaded_lora = None
self.loaded_lora_path = None
@classmethod
def INPUT_TYPES(s):
return {
"required": {
"model": ("MODEL",),
"clip": ("CLIP",),
"repo_id": ("STRING", {"default": ""}),
"subfolder": ("STRING", {"default": ""}),
"filename": ("STRING", {"default": ""}),
"strength_model": (
"FLOAT",
{"default": 1.0, "min": -20.0, "max": 20.0, "step": 0.01},
),
"strength_clip": (
"FLOAT",
{"default": 1.0, "min": -20.0, "max": 20.0, "step": 0.01},
),
}
}
RETURN_TYPES = ("MODEL", "CLIP")
FUNCTION = "load_lora"
CATEGORY = "loaders"
def load_lora(
self,
model,
clip,
repo_id: str,
subfolder: str,
filename: str,
strength_model: float,
strength_clip: float,
):
if strength_model == 0 and strength_clip == 0:
return (model, clip)
lora_path = hf_hub_download(
repo_id=repo_id.strip(),
subfolder=None
if subfolder is None or subfolder.strip() == ""
else subfolder.strip(),
filename=filename.strip(),
cache_dir=find_or_create_cache(),
)
lora = None
if self.loaded_lora is not None:
if self.loaded_lora_path == lora_path:
lora = self.loaded_lora
else:
self.loaded_lora = None
self.loaded_lora_path = None
if lora is None:
lora = comfy.utils.load_torch_file(lora_path, safe_load=True)
self.loaded_lora = lora
self.loaded_lora_path = lora_path
model_lora, clip_lora = comfy.sd.load_lora_for_models(
model, clip, lora, strength_model, strength_clip
)
return (model_lora, clip_lora)
class HFHubEmbeddingLoader:
"""Load a text model embedding from Huggingface Hub.
The connected CLIP model is not manipulated."""
@classmethod
def INPUT_TYPES(s):
return {
"required": {
"clip": ("CLIP",),
"repo_id": ("STRING", {"default": ""}),
"subfolder": ("STRING", {"default": ""}),
"filename": ("STRING", {"default": ""}),
}
}
RETURN_TYPES = ("CLIP",)
FUNCTION = "download_embedding"
CATEGORY = "n/a"
def download_embedding(
self,
clip: CLIP, # added to signify it's best put in between nodes
repo_id: str,
subfolder: str,
filename: str,
):
hf_hub_download(
repo_id=repo_id.strip(),
subfolder=None
if subfolder is None or subfolder.strip() == ""
else subfolder.strip(),
filename=filename.strip(),
local_dir=get_folder_paths("embeddings")[0],
)
return (clip,)
class GlifVariable:
@classmethod
def INPUT_TYPES(s):
return {
"required": {
"variable": (
[
"",
],
),
"fallback": (
"STRING",
{
"default": "",
"single_line": True,
},
),
}
}
RETURN_TYPES = ("STRING", "INT", "FLOAT")
FUNCTION = "do_it"
CATEGORY = "glif/variables"
@classmethod
def VALIDATE_INPUTS(cls, variable: str, fallback: str):
# Since we populate dynamically, comfy will report invalid inputs. Override to always return True
return True
def do_it(self, variable: str, fallback: str):
variable = variable.strip()
fallback = fallback.strip()
if variable == "" or (variable.startswith("{") and variable.endswith("}")):
variable = fallback
int_val = 0
float_val = 0.0
string_val = f"{variable}"
try:
int_val = int(variable)
except Exception:
pass
try:
float_val = float(variable)
except Exception:
pass
return (string_val, int_val, float_val)
NODE_CLASS_MAPPINGS = {
"GlifConsistencyDecoder": ConsistencyDecoder,
"GlifPatchConsistencyDecoderTiled": PatchDecoderTiled,
"SDXLAspectRatio": SDXLAspectRatio,
"ImageToMultipleOf": ImageToMultipleOf,
"HFHubLoraLoader": HFHubLoraLoader,
"HFHubEmbeddingLoader": HFHubEmbeddingLoader,
"GlifVariable": GlifVariable,
}
NODE_DISPLAY_NAME_MAPPINGS = {
"GlifConsistencyDecoder": "Consistency VAE Decoder",
"GlifPatchConsistencyDecoderTiled": "Patch Consistency VAE Decoder",
"SDXLAspectRatio": "Image to SDXL compatible WH",
"ImageToMultipleOf": "Image to Multiple of",
"HFHubLoraLoader": "Load HF Lora",
"HFHubEmbeddingLoader": "Load HF Embedding",
"GlifVariable": "Glif Variable",
}
@@ -0,0 +1,222 @@
# Empty Latent Batch Documentation
## Overview
The Empty Latent Batch is a ComfyUI node that creates empty latent tensors with batch support and preset integration. It combines the preset functionality of Width Height Selector with efficient batch processing capabilities, making it ideal for batch workflows and optimized generation pipelines.
## Features
### 🎯 **Preset Integration**
- **26 Curated Presets**: Full access to SDXL, FLUX, and Ultra-wide presets
- **Formatted Display**: Shows aspect ratio, megapixels, and model group
- **Smart Fallback**: Automatic fallback to custom dimensions for invalid presets
- **Model Optimization**: Preset categories optimized for different model types
### 📦 **Batch Processing**
- **Configurable Batch Size**: Create 1-64 empty latents in single operation
- **Memory Efficient**: Uses torch.zeros for optimal memory allocation
- **Batch Validation**: Prevents excessive memory usage with warnings
- **ComfyUI Compatible**: Standard latent format for seamless integration
### 🔄 **Visual Swap Button**
- **Interactive UI**: Blue swap button with hover and click feedback
- **Preset-Aware Swapping**: Intelligent switching between matching presets
- **Custom Dimension Support**: Simple value swapping for custom inputs
- **Visual Feedback**: Button state changes during interaction
### ✅ **Smart Validation**
- **Dimension Sanitization**: Automatic adjustment to divisible-by-8 constraint
- **Memory Estimation**: Built-in memory usage calculation
- **Error Handling**: Graceful handling of invalid inputs with helpful messages
- **Logging**: Detailed operation logging for debugging
## Node Interface
### Inputs
- **preset**: Dropdown with 26 formatted preset options + custom
- **width**: Custom width (64-8192, step 8, default 1024)
- **height**: Custom height (64-8192, step 8, default 1024)
- **batch_size**: Number of latents to create (1-64, default 1)
### Outputs
- **latent**: Dictionary containing batch of empty latent tensors
- **width**: Final sanitized width (guaranteed divisible by 8)
- **height**: Final sanitized height (guaranteed divisible by 8)
## Preset Reference
The Empty Latent Batch node uses the same 26 curated presets as the Width Height Selector:
### SDXL Presets (~1 Megapixel)
Optimized for SDXL models with ~1MP resolution constraint.
### FLUX Presets (High Resolution)
Higher resolution presets optimized for FLUX models with better quality/speed balance.
### Ultra-Wide Presets (Modern Ratios)
Modern aspect ratios for ultra-wide and panoramic generation.
*For complete preset details, see [Width Height Selector Documentation](width_height_selector.md#preset-reference)*
## Usage Examples
### Basic Empty Latent Creation
1. **Select Preset**: Choose from dropdown (e.g., "1024×1024 - 1:1 (1.0MP) - SDXL")
2. **Set Batch Size**: Enter desired number of latents (e.g., 4)
3. **Connect Output**: Link latent output to KSampler or other processing nodes
### Custom Batch Creation
1. **Set Preset**: Select "custom"
2. **Enter Dimensions**: Input width and height manually
3. **Set Batch Size**: Configure number of latents needed
4. **Validation**: Automatic sanitization ensures compatibility
### Orientation Swapping
1. **Choose Preset**: Any preset (e.g., "1920×1080")
2. **Click Swap Button**: Blue button in bottom-right corner
3. **Result**: Gets swapped preset if available, or custom dimensions with swapped values
4. **Widget Update**: Width/height widgets automatically update
### Memory-Aware Batch Processing
1. **Large Batch**: Set batch_size to 16 or higher
2. **Memory Warning**: Node provides memory usage estimation
3. **Optimization**: Choose appropriate resolution preset for available VRAM
## Common Workflows
### Batch Generation Pipeline
```
Empty Latent Batch → KSampler → VAE Decode → Save Image
(batch_size: 4) ↓ ↓ ↓
4 samples 4 images 4 files
```
- Create 4 empty latents at once
- Process all through sampling
- Generate 4 images in single operation
- Efficient for parameter exploration
### Model Comparison Workflow
```
Empty Latent Batch → [Multiple KSamplers] → [Multiple VAE Decoders] → Compare Results
(batch_size: 8) ↓ ↓ ↓
Split batch Process variants Side-by-side
```
- Create consistent batch of empty latents
- Split across different samplers/models
- Compare results with identical starting conditions
### Upscaling Preparation
```
Empty Latent Batch → KSampler → VAE Decode → Resolution Calculator → Upscaler
(832×1216, batch:4) ↓ ↓ ↓ ↓
Sample Decode Calculate 2x Upscale batch
```
- Generate batch at base resolution
- Calculate upscale dimensions
- Process entire batch through upscaler
### Aspect Ratio Exploration
```
Empty Latent Batch → [Clone to multiple orientations] → Parallel Processing
(1920×1080) ↓ ↓
[Swap Button] → Portrait & Landscape versions Compare orientations
```
- Start with base preset
- Use swap button to create orientation variants
- Process both simultaneously
## Advanced Features
### Memory Estimation
The node provides built-in memory estimation for batch operations:
```python
# Example memory calculations
Batch Size: 4, Resolution: 1024×1024
Latent Tensor: 4 × 4 × 128 × 128 = 262,144 elements
Memory Usage: 262,144 × 4 bytes = 1.0 MB per batch
```
### Intelligent Preset Handling
- **Formatted Display**: Shows full metadata in dropdown
- **Original Extraction**: Extracts original preset name from formatted strings
- **Validation**: Verifies preset exists before processing
- **Fallback Logic**: Uses custom dimensions if preset is invalid
### Batch Size Optimization
- **Performance Warnings**: Alerts for large batch sizes
- **Memory Limits**: Prevents excessive memory allocation
- **Hardware Awareness**: Considers available system resources
## Tips and Best Practices
### Batch Size Selection
- **Small Batches (1-4)**: Good for testing and development
- **Medium Batches (5-16)**: Efficient for most production workflows
- **Large Batches (17-64)**: Only for high-memory systems and specific use cases
### Preset Selection
- **SDXL Projects**: Use SDXL presets for memory efficiency
- **FLUX Projects**: Use FLUX presets for optimal quality
- **Ultra-wide Projects**: Ensure sufficient VRAM for large resolutions
- **Custom Projects**: Use custom dimensions for specific requirements
### Memory Management
- Monitor memory usage with large batches
- Use appropriate resolution presets for available VRAM
- Consider splitting very large batches across multiple nodes
- Clear GPU memory between large batch operations
### Workflow Integration
- Always connect all three outputs (latent, width, height)
- Use width/height outputs for downstream dimension calculations
- Combine with Resolution Calculator for upscaling workflows
- Leverage batch processing for efficient parameter exploration
## Troubleshooting
### Common Issues
- **Out of Memory**: Reduce batch_size or use lower resolution presets
- **Invalid Dimensions**: Node automatically sanitizes to valid values
- **Preset Not Found**: Falls back to custom dimensions with warning
- **Swap Button Not Working**: Ensure node is not collapsed and button is visible
### Performance Optimization
- **Batch Size**: Start with smaller batches and increase as needed
- **Resolution**: Use appropriate presets for your model and VRAM
- **Memory Monitoring**: Watch for memory warnings and adjust accordingly
- **Cleanup**: Clear unused tensors between large batch operations
### Error Handling
- **Dimension Validation**: Automatic rounding to nearest valid values
- **Batch Size Limits**: Clamped to 1-64 range with warnings
- **Memory Allocation**: Graceful handling of insufficient memory
- **Preset Fallbacks**: Automatic fallback to custom dimensions
## Technical Details
### Latent Tensor Format
- **Shape**: [batch_size, 4, height//8, width//8]
- **Data Type**: torch.float32
- **Initialization**: torch.zeros for clean empty state
- **Memory Layout**: Contiguous tensor for optimal performance
### Validation Pipeline
1. **Preset Extraction**: Parse formatted preset strings
2. **Dimension Calculation**: Get base dimensions from preset or custom
3. **Sanitization**: Ensure divisible-by-8 constraint
4. **Batch Validation**: Check batch size limits
5. **Memory Estimation**: Calculate expected memory usage
6. **Tensor Creation**: Allocate and initialize latent tensor
### UI Integration
- **JavaScript Extension**: Custom UI for swap button functionality
- **Widget Synchronization**: Auto-update width/height when preset changes
- **Visual Feedback**: Hover effects and click animations
- **Event Handling**: Proper mouse event management
### Swap Button Implementation
- **Position Calculation**: Dynamic positioning based on node size
- **State Management**: Visual feedback for button interactions
- **Preset Intelligence**: Smart switching between compatible presets
- **Fallback Logic**: Custom dimension swapping when preset not available
@@ -0,0 +1,82 @@
# Image to Multiple Of
## Overview
The **Image to Multiple Of** node adjusts image dimensions to be multiples of a specified value. This is particularly useful for models that require input dimensions to be multiples of certain values (e.g., 8, 16, 32, 64) for optimal performance or compatibility.
## Purpose
Many AI models, especially diffusion models and VAEs, require input dimensions to be multiples of specific values due to their architecture (e.g., downsampling layers). This node ensures your images meet these requirements without manual calculation.
## Inputs
- **image** (IMAGE, required): The input image to process
- **multiple_of** (INT, required): The value that dimensions should be multiple of
- Default: 64
- Range: 1-256
- Step: 16
- **method** (COMBO, required): Processing method
- Options: "center crop", "rescale"
## Outputs
- **image** (IMAGE): Processed image with dimensions adjusted to multiples of the specified value
## Processing Methods
### Center Crop
- Crops the image from the center to achieve the target dimensions
- Preserves image quality but may lose edge content
- Best for images where the important content is centered
### Rescale
- Resizes the image to the target dimensions using bilinear interpolation
- Keeps all content but may slightly affect image quality
- Best when you need to preserve all image content
## Usage Examples
### Example 1: Prepare for VAE Encoding
```
Load Image → Image to Multiple Of (multiple_of: 64) → VAE Encode
```
### Example 2: Prepare for Specific Model Requirements
```
Load Image → Image to Multiple Of (multiple_of: 32) → Model Processing
```
### Example 3: Batch Processing
```
Load Images → Image to Multiple Of (multiple_of: 16, method: rescale) → Batch Process
```
## Technical Details
- Supports batch processing (processes all images in a batch)
- Works with any number of channels (RGB, RGBA, grayscale, etc.)
- Calculates the largest dimensions that are less than or equal to the original size
- For center crop: crops equally from all sides to maintain centering
- For rescale: uses bilinear interpolation with align_corners=False
## Common Use Cases
1. **VAE Preprocessing**: Ensure images are compatible with VAE encoders that require dimensions divisible by 64
2. **Model Compatibility**: Adjust images for models with specific architectural requirements
3. **Batch Uniformity**: Ensure all images in a batch have dimensions that meet model requirements
4. **Performance Optimization**: Some models perform better with dimensions that are powers of 2
## Tips
- Use **center crop** when your subject is centered and you don't mind losing edge details
- Use **rescale** when you need to preserve all image content
- Common multiple_of values: 8, 16, 32, 64, 128
- For Stable Diffusion models, 64 is typically recommended
- For some upscaling models, 32 or 16 may be sufficient
## Error Handling
The node will raise an error if:
- The image dimensions are smaller than the specified multiple_of value
- Invalid input types are provided
- The resulting dimensions would be 0 or negative
@@ -98,4 +98,4 @@ The Resolution Calculator integrates seamlessly with:
- Standard ComfyUI image loaders
- VAE encode/decode operations
- Upscaler nodes (ESRGAN, Real-ESRGAN, etc.)
- Custom latent processing workflows
- Custom latent processing workflows
+208
View File
@@ -0,0 +1,208 @@
# Sampler Combo Documentation
## Overview
The Sampler Combo is a unified ComfyUI node that combines sampler, scheduler, steps, and CFG settings into a single interface. It reduces workflow complexity while ensuring compatible parameter combinations and providing optimization recommendations.
## Features
### 🎯 **Unified Configuration**
- Single node for all sampling parameters
- Compatible sampler + scheduler combinations
- Optimized steps and CFG recommendations
- Reduced workflow complexity
### 🧠 **Smart Recommendations**
- Scheduler suggestions based on selected sampler
- Optimal steps range for each sampler
- CFG scale recommendations
- Compatibility warnings and suggestions
### ✅ **Built-in Validation**
- Parameter validation and sanitization
- Error handling with safe defaults
- Performance optimization hints
- Real-time compatibility checking
### 📊 **Analysis Tools**
- Combo configuration analysis
- Performance assessment
- Optimization recommendations
- Compatibility scoring
## Node Interface
### Inputs
- **sampler_name**: Dropdown with available sampling algorithms
- **scheduler**: Dropdown with compatible schedulers
- **steps**: Integer slider (1-100 steps)
- **cfg**: Float slider (0.0-20.0 CFG scale)
### Outputs
- **sampler_name**: Selected sampler algorithm
- **scheduler**: Selected scheduler algorithm
- **steps**: Number of sampling steps
- **cfg**: CFG scale value
## Available Samplers
### Primary Samplers
| Sampler | Type | Speed | Quality | Best For |
|---------|------|-------|---------|----------|
| euler | Deterministic | Fast | Good | General use |
| euler_ancestral | Stochastic | Fast | Good | Creative variation |
| heun | Higher-order | Medium | Better | Quality focus |
| dpm_2 | Multi-step | Medium | Good | Balanced |
| dpm_2_ancestral | Stochastic | Medium | Good | Creative quality |
| lms | Linear | Fast | Good | Simple scenes |
| dpm_fast | Optimized | Very Fast | Good | Speed priority |
| dpm_adaptive | Adaptive | Variable | Best | Automatic tuning |
### Advanced Samplers
| Sampler | Type | Speed | Quality | Best For |
|---------|------|-------|---------|----------|
| dpmpp_2s_ancestral | Advanced | Medium | Better | High quality |
| dpmpp_2m | Optimized | Fast | Better | Speed + quality |
| dpmpp_2m_sde | Stochastic | Medium | Best | Maximum quality |
| dpmpp_3m_sde | Latest | Medium | Best | Cutting edge |
| ddim | Classic | Fast | Good | Compatibility |
| uni_pc | Unified | Fast | Better | Efficiency |
## Available Schedulers
### Linear Schedulers
- **normal**: Standard linear schedule
- **linear**: Basic linear distribution
- **sgm_uniform**: Uniform distribution
### Advanced Schedulers
- **karras**: Karras noise schedule (recommended)
- **exponential**: Exponential decay
- **polyexponential**: Polynomial exponential
- **beta**: Beta distribution schedule
### Specialized Schedulers
- **cosine**: Cosine annealing schedule
- **simple**: Simplified schedule
- **ddim_uniform**: DDIM uniform schedule
- **laplace**: Laplace distribution
## Optimization Guidelines
### Recommended Combinations
#### Speed Optimized
```
Sampler: euler or dpm_fast
Scheduler: normal or simple
Steps: 15-25
CFG: 6.0-8.0
```
#### Quality Optimized
```
Sampler: dpmpp_2m_sde or dpmpp_3m_sde
Scheduler: karras
Steps: 25-35
CFG: 7.0-9.0
```
#### Balanced
```
Sampler: dpmpp_2m or heun
Scheduler: karras or normal
Steps: 20-30
CFG: 7.0-8.5
```
### Steps Recommendations
| Sampler Type | Min Steps | Optimal | Max Steps |
|--------------|-----------|---------|-----------|
| Fast (euler, dpm_fast) | 10 | 20 | 30 |
| Standard (heun, dpm_2) | 15 | 25 | 40 |
| Advanced (dpmpp_*) | 20 | 30 | 50 |
| Adaptive | 10 | 25 | 100 |
### CFG Scale Guidelines
| Content Type | CFG Range | Recommended |
|--------------|-----------|-------------|
| Photorealistic | 5.0-8.0 | 7.0 |
| Artistic/Stylized | 7.0-12.0 | 9.0 |
| Abstract/Creative | 8.0-15.0 | 11.0 |
| Text/Details | 10.0-20.0 | 13.0 |
## Usage Examples
### Basic Configuration
```
sampler_name: euler
scheduler: normal
steps: 20
cfg: 7.0
```
### High Quality Setup
```
sampler_name: dpmpp_2m_sde
scheduler: karras
steps: 30
cfg: 8.0
```
### Speed Priority
```
sampler_name: dpm_fast
scheduler: simple
steps: 15
cfg: 6.5
```
## Advanced Features
### Compatibility Analysis
The node provides real-time analysis of parameter compatibility:
- Scheduler compatibility with selected sampler
- Steps optimization for sampler type
- CFG scale recommendations
- Performance impact assessment
### Error Handling
- Invalid samplers default to 'euler'
- Invalid schedulers default to 'normal'
- Out-of-range steps clamped to valid range
- Invalid CFG values sanitized to safe defaults
### Performance Tips
1. **Use Karras scheduler** for most samplers (better quality)
2. **Start with 20-30 steps** for most use cases
3. **Keep CFG 6.0-9.0** for realistic images
4. **Try dpmpp_2m** for best speed/quality balance
5. **Use euler** for fastest generation
## Troubleshooting
### Common Issues
- **Slow generation**: Try euler or dpm_fast samplers
- **Poor quality**: Increase steps or try dpmpp_2m_sde
- **Overcooked images**: Lower CFG scale
- **Underdetailed**: Increase CFG or steps
- **Artifacts**: Try karras scheduler or different sampler
### Performance Optimization
- **GPU Memory**: Lower steps if running out of VRAM
- **Speed**: Use euler + normal + 15-20 steps
- **Quality**: Use dpmpp_2m_sde + karras + 25-30 steps
- **Compatibility**: Stick to euler/heun for broad model support
## Integration
The Sampler Combo node outputs are compatible with all standard ComfyUI sampling nodes:
- KSampler
- KSamplerAdvanced
- Custom sampling workflows
- Upscaling pipelines
- Img2img workflows
Connect the outputs directly to your sampling node inputs for streamlined configuration.
+1 -1
View File
@@ -164,4 +164,4 @@ See the `examples/workflows/` directory for complete workflow examples demonstra
- Basic seed tracking workflow
- Creative iteration with history
- Technical reproducibility setup
- Batch processing with seed management
- Batch processing with seed management
@@ -147,7 +147,7 @@ Width Height Selector → EmptyLatentImage → Resolution Calculator → Upscale
### Aspect Ratio Considerations
- **Portrait**: 3:4, 2:3, 13:19 work well for people
- **Landscape**: 16:9, 19:13, 7:4 for scenes and objects
- **Landscape**: 16:9, 19:13, 7:4 for scenes and objects
- **Square**: 1:1 for centered compositions
- **Ultra-wide**: 21:9+ for panoramic and cinematic shots
@@ -192,4 +192,4 @@ Width Height Selector → EmptyLatentImage → Resolution Calculator → Upscale
### Preset Organization
- Categorized by model optimization
- Sorted by aspect ratio within categories
- Comprehensive tooltips for each preset
- Comprehensive tooltips for each preset
@@ -0,0 +1,123 @@
{
"last_node_id": 4,
"last_link_id": 3,
"nodes": [
{
"id": 1,
"type": "LoadImage",
"pos": [100, 200],
"size": [315, 314],
"flags": {},
"order": 0,
"mode": 0,
"outputs": [
{
"name": "IMAGE",
"type": "IMAGE",
"links": [1],
"shape": 3,
"label": "IMAGE"
},
{
"name": "MASK",
"type": "MASK",
"links": null,
"shape": 3
}
],
"properties": {
"Node name for S&R": "LoadImage"
},
"widgets_values": ["example.png", "image"]
},
{
"id": 2,
"type": "ImageToMultipleOf",
"pos": [500, 200],
"size": [315, 106],
"flags": {},
"order": 1,
"mode": 0,
"inputs": [
{
"name": "image",
"type": "IMAGE",
"link": 1
}
],
"outputs": [
{
"name": "image",
"type": "IMAGE",
"links": [2, 3],
"shape": 3,
"label": "image"
}
],
"properties": {
"Node name for S&R": "ImageToMultipleOf"
},
"widgets_values": [64, "center crop"]
},
{
"id": 3,
"type": "PreviewImage",
"pos": [900, 100],
"size": [210, 246],
"flags": {},
"order": 2,
"mode": 0,
"inputs": [
{
"name": "images",
"type": "IMAGE",
"link": 2
}
],
"properties": {
"Node name for S&R": "PreviewImage"
}
},
{
"id": 4,
"type": "VAEEncode",
"pos": [900, 400],
"size": [210, 46],
"flags": {},
"order": 3,
"mode": 0,
"inputs": [
{
"name": "pixels",
"type": "IMAGE",
"link": 3
},
{
"name": "vae",
"type": "VAE",
"link": null
}
],
"outputs": [
{
"name": "LATENT",
"type": "LATENT",
"links": null,
"shape": 3
}
],
"properties": {
"Node name for S&R": "VAEEncode"
}
}
],
"links": [
[1, 1, 0, 2, 0, "IMAGE"],
[2, 2, 0, 3, 0, "IMAGE"],
[3, 2, 0, 4, 0, "IMAGE"]
],
"groups": [],
"config": {},
"extra": {},
"version": 0.4
}
@@ -1,47 +1,259 @@
{
"last_node_id": 3,
"last_link_id": 2,
"id": "41469b2d-d616-479d-879a-95cdc6074a37",
"revision": 0,
"last_node_id": 6,
"last_link_id": 5,
"nodes": [
{
"id": 1,
"type": "ResolutionCalculator",
"pos": [100, 100],
"size": {"0": 315, "1": 126},
"pos": [
60,
430
],
"size": [
315,
126
],
"flags": {},
"order": 2,
"mode": 0,
"inputs": [
{
"name": "image",
"shape": 7,
"type": "IMAGE",
"link": 5
},
{
"name": "latent",
"shape": 7,
"type": "LATENT",
"link": null
}
],
"outputs": [
{
"name": "width",
"type": "INT",
"slot_index": 0,
"links": [
1,
3
]
},
{
"name": "height",
"type": "INT",
"slot_index": 1,
"links": [
2,
4
]
}
],
"properties": {
"aux_id": "ComfyAssets/ComfyUI-KikoTools",
"ver": "965ad60c74d7f25b1acce890d9c06518e46e6d0b",
"Node name for S&R": "ResolutionCalculator",
"widget_ue_connectable": {}
},
"widgets_values": [
2.5
]
},
{
"id": 6,
"type": "LoadImage",
"pos": [
-250,
430
],
"size": [
274.080078125,
314
],
"flags": {},
"order": 0,
"mode": 0,
"inputs": [
{"name": "image", "type": "IMAGE", "link": null},
{"name": "latent", "type": "LATENT", "link": null}
],
"inputs": [],
"outputs": [
{"name": "width", "type": "INT", "links": [1], "slot_index": 0},
{"name": "height", "type": "INT", "links": [2], "slot_index": 1}
{
"name": "IMAGE",
"type": "IMAGE",
"links": [
5
]
},
{
"name": "MASK",
"type": "MASK",
"links": null
}
],
"properties": {},
"widgets_values": [2.0],
"category": "ComfyAssets"
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"widget_ue_connectable": {},
"Node name for S&R": "LoadImage"
},
"widgets_values": [
"image-2025-06-13-105737.jpg",
"image"
]
},
{
"id": 4,
"type": "Display Int (rgthree)",
"pos": [
420,
360
],
"size": [
210,
88
],
"flags": {},
"order": 3,
"mode": 0,
"inputs": [
{
"dir": 3,
"name": "input",
"type": "INT",
"link": 3
}
],
"outputs": [],
"properties": {
"cnr_id": "rgthree-comfy",
"ver": "1.0.2506081210",
"Node name for S&R": "Display Int (rgthree)",
"widget_ue_connectable": {}
},
"widgets_values": [
""
]
},
{
"id": 5,
"type": "Display Int (rgthree)",
"pos": [
430,
530
],
"size": [
210,
88
],
"flags": {},
"order": 4,
"mode": 0,
"inputs": [
{
"dir": 3,
"name": "input",
"type": "INT",
"link": 4
}
],
"outputs": [],
"properties": {
"cnr_id": "rgthree-comfy",
"ver": "1.0.2506081210",
"widget_ue_connectable": {},
"Node name for S&R": "Display Int (rgthree)"
},
"widgets_values": [
""
]
},
{
"id": 2,
"type": "Note",
"pos": [450, 100],
"size": {"0": 400, "1": 200},
"pos": [
-150,
170
],
"size": [
400,
200
],
"flags": {},
"order": 1,
"mode": 0,
"inputs": [],
"outputs": [],
"properties": {"text": "Resolution Calculator Example\n\nThis node calculates upscaled dimensions from:\n- IMAGE tensors (connect from image loaders)\n- LATENT tensors (connect from VAE encode/generation)\n\nUse cases:\n- Calculate target dimensions for upscalers\n- Plan memory usage for large generations\n- Ensure dimensions are divisible by 8\n\nScale factors optimized for SDXL and FLUX models."},
"widgets_values": ["Resolution Calculator Example\n\nThis node calculates upscaled dimensions from:\n- IMAGE tensors (connect from image loaders)\n- LATENT tensors (connect from VAE encode/generation)\n\nUse cases:\n- Calculate target dimensions for upscalers\n- Plan memory usage for large generations\n- Ensure dimensions are divisible by 8\n\nScale factors optimized for SDXL and FLUX models."]
"properties": {
"text": "Resolution Calculator Example\n\nThis node calculates upscaled dimensions from:\n- IMAGE tensors (connect from image loaders)\n- LATENT tensors (connect from VAE encode/generation)\n\nUse cases:\n- Calculate target dimensions for upscalers\n- Plan memory usage for large generations\n- Ensure dimensions are divisible by 8\n\nScale factors optimized for SDXL and FLUX models.",
"widget_ue_connectable": {}
},
"widgets_values": [
"Resolution Calculator Example\n\nThis node calculates upscaled dimensions from:\n- IMAGE tensors (connect from image loaders)\n- LATENT tensors (connect from VAE encode/generation)\n\nUse cases:\n- Calculate target dimensions for upscalers\n- Plan memory usage for large generations\n- Ensure dimensions are divisible by 8\n\nScale factors optimized for SDXL and FLUX models."
],
"color": "#432",
"bgcolor": "#653"
}
],
"links": [
[1, 1, 0, 3, 0, "INT"],
[2, 1, 1, 3, 1, "INT"]
[
1,
1,
0,
3,
0,
"INT"
],
[
2,
1,
1,
3,
1,
"INT"
],
[
3,
1,
0,
4,
0,
"INT"
],
[
4,
1,
1,
5,
0,
"INT"
],
[
5,
6,
0,
1,
0,
"IMAGE"
]
],
"groups": [],
"config": {},
"extra": {},
"extra": {
"ue_links": [],
"ds": {
"scale": 0.7972024500000015,
"offset": [
709.6391289161842,
-90.0127389290854
]
},
"links_added_by_ue": [],
"frontendVersion": "1.21.7",
"VHS_latentpreview": true,
"VHS_latentpreviewrate": 0,
"VHS_MetadataImage": true,
"VHS_KeepIntermediate": true
},
"version": 0.4
}
}
@@ -0,0 +1,537 @@
{
"id": "972425bd-9910-484d-ad09-f142f534fc61",
"revision": 0,
"last_node_id": 10,
"last_link_id": 13,
"nodes": [
{
"id": 7,
"type": "CLIPTextEncode",
"pos": [
120,
390
],
"size": [
425.27801513671875,
180.6060791015625
],
"flags": {},
"order": 4,
"mode": 0,
"inputs": [
{
"name": "clip",
"type": "CLIP",
"link": 5
}
],
"outputs": [
{
"name": "CONDITIONING",
"type": "CONDITIONING",
"slot_index": 0,
"links": [
6
]
}
],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "CLIPTextEncode",
"widget_ue_connectable": {}
},
"widgets_values": [
"text, watermark"
]
},
{
"id": 5,
"type": "EmptyLatentImage",
"pos": [
180,
610
],
"size": [
315,
106
],
"flags": {},
"order": 0,
"mode": 0,
"inputs": [],
"outputs": [
{
"name": "LATENT",
"type": "LATENT",
"slot_index": 0,
"links": [
2
]
}
],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "EmptyLatentImage",
"widget_ue_connectable": {}
},
"widgets_values": [
512,
512,
1
]
},
{
"id": 3,
"type": "KSampler",
"pos": [
863,
186
],
"size": [
315,
571
],
"flags": {},
"order": 5,
"mode": 0,
"inputs": [
{
"name": "model",
"type": "MODEL",
"link": 1
},
{
"name": "positive",
"type": "CONDITIONING",
"link": 4
},
{
"name": "negative",
"type": "CONDITIONING",
"link": 6
},
{
"name": "latent_image",
"type": "LATENT",
"link": 2
},
{
"name": "steps",
"type": "INT",
"widget": {
"name": "steps"
},
"link": 12
},
{
"name": "cfg",
"type": "FLOAT",
"widget": {
"name": "cfg"
},
"link": 13
},
{
"name": "sampler_name",
"type": "COMBO",
"widget": {
"name": "sampler_name"
},
"link": 10
},
{
"name": "scheduler",
"type": "COMBO",
"widget": {
"name": "scheduler"
},
"link": 11
}
],
"outputs": [
{
"name": "LATENT",
"type": "LATENT",
"slot_index": 0,
"links": [
7
]
}
],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "KSampler",
"widget_ue_connectable": {}
},
"widgets_values": [
555950987049067,
"randomize",
20,
8,
"euler",
"normal",
1,
""
]
},
{
"id": 8,
"type": "VAEDecode",
"pos": [
1209,
188
],
"size": [
210,
46
],
"flags": {},
"order": 6,
"mode": 0,
"inputs": [
{
"name": "samples",
"type": "LATENT",
"link": 7
},
{
"name": "vae",
"type": "VAE",
"link": 8
}
],
"outputs": [
{
"name": "IMAGE",
"type": "IMAGE",
"slot_index": 0,
"links": [
9
]
}
],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "VAEDecode",
"widget_ue_connectable": {}
},
"widgets_values": []
},
{
"id": 9,
"type": "SaveImage",
"pos": [
1451,
189
],
"size": [
210,
270
],
"flags": {},
"order": 7,
"mode": 0,
"inputs": [
{
"name": "images",
"type": "IMAGE",
"link": 9
}
],
"outputs": [],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "SaveImage",
"widget_ue_connectable": {}
},
"widgets_values": [
"ComfyUI"
]
},
{
"id": 6,
"type": "CLIPTextEncode",
"pos": [
120,
180
],
"size": [
422.84503173828125,
164.31304931640625
],
"flags": {},
"order": 3,
"mode": 0,
"inputs": [
{
"name": "clip",
"type": "CLIP",
"link": 3
}
],
"outputs": [
{
"name": "CONDITIONING",
"type": "CONDITIONING",
"slot_index": 0,
"links": [
4
]
}
],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "CLIPTextEncode",
"widget_ue_connectable": {}
},
"widgets_values": [
"beautiful scenery nature glass bottle landscape, , purple galaxy bottle,"
]
},
{
"id": 10,
"type": "SamplerCombo",
"pos": [
550,
290
],
"size": [
300,
200
],
"flags": {},
"order": 1,
"mode": 0,
"inputs": [],
"outputs": [
{
"name": "sampler_name",
"type": "COMBO",
"slot_index": 0,
"links": [
10
]
},
{
"name": "scheduler",
"type": "COMBO",
"slot_index": 1,
"links": [
11
]
},
{
"name": "steps",
"type": "INT",
"slot_index": 2,
"links": [
12
]
},
{
"name": "cfg",
"type": "FLOAT",
"slot_index": 3,
"links": [
13
]
}
],
"properties": {
"aux_id": "ComfyAssets/ComfyUI-KikoTools",
"ver": "dcf2d679c1a1091c54c2aa8cc04724236723227d",
"widget_ue_connectable": {},
"Node name for S&R": "SamplerCombo"
},
"widgets_values": [
"dpmpp_2m",
"karras",
25,
7.5
]
},
{
"id": 4,
"type": "CheckpointLoaderSimple",
"pos": [
-220,
180
],
"size": [
315,
98
],
"flags": {},
"order": 2,
"mode": 0,
"inputs": [],
"outputs": [
{
"name": "MODEL",
"type": "MODEL",
"slot_index": 0,
"links": [
1
]
},
{
"name": "CLIP",
"type": "CLIP",
"slot_index": 1,
"links": [
3,
5
]
},
{
"name": "VAE",
"type": "VAE",
"slot_index": 2,
"links": [
8
]
}
],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "CheckpointLoaderSimple",
"widget_ue_connectable": {}
},
"widgets_values": [
"sdxl_ckpt/realvisxlV40_v40LightningBakedvae.safetensors"
]
}
],
"links": [
[
1,
4,
0,
3,
0,
"MODEL"
],
[
2,
5,
0,
3,
3,
"LATENT"
],
[
3,
4,
1,
6,
0,
"CLIP"
],
[
4,
6,
0,
3,
1,
"CONDITIONING"
],
[
5,
4,
1,
7,
0,
"CLIP"
],
[
6,
7,
0,
3,
2,
"CONDITIONING"
],
[
7,
3,
0,
8,
0,
"LATENT"
],
[
8,
4,
2,
8,
1,
"VAE"
],
[
9,
8,
0,
9,
0,
"IMAGE"
],
[
10,
10,
0,
3,
6,
"COMBO"
],
[
11,
10,
1,
3,
7,
"COMBO"
],
[
12,
10,
2,
3,
4,
"INT"
],
[
13,
10,
3,
3,
5,
"FLOAT"
]
],
"groups": [],
"config": {},
"extra": {
"ue_links": [],
"links_added_by_ue": [],
"ds": {
"scale": 0.9740024562304554,
"offset": [
75.10666660323399,
-252.18018113111526
]
},
"frontendVersion": "1.21.7",
"VHS_latentpreview": true,
"VHS_latentpreviewrate": 0,
"VHS_MetadataImage": true,
"VHS_KeepIntermediate": true
},
"version": 0.4
}
+489 -254
View File
@@ -1,192 +1,111 @@
{
"last_node_id": 8,
"last_link_id": 7,
"id": "972425bd-9910-484d-ad09-f142f534fc61",
"revision": 0,
"last_node_id": 11,
"last_link_id": 14,
"nodes": [
{
"id": 1,
"type": "SeedHistory",
"id": 7,
"type": "CLIPTextEncode",
"pos": [
100,
100
120,
390
],
"size": {
"0": 280,
"1": 320
"size": [
425.27801513671875,
180.6060791015625
],
"flags": {},
"order": 5,
"mode": 0,
"inputs": [
{
"name": "clip",
"type": "CLIP",
"link": 5
}
],
"outputs": [
{
"name": "CONDITIONING",
"type": "CONDITIONING",
"slot_index": 0,
"links": [
6
]
}
],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "CLIPTextEncode",
"widget_ue_connectable": {}
},
"widgets_values": [
"text, watermark"
]
},
{
"id": 5,
"type": "EmptyLatentImage",
"pos": [
180,
610
],
"size": [
315,
106
],
"flags": {},
"order": 0,
"mode": 0,
"inputs": [],
"outputs": [
{
"name": "seed",
"type": "INT",
"links": [
1
],
"shape": 3
}
],
"properties": {
"Node name for S&R": "SeedHistory"
},
"widgets_values": [
12345
],
"color": "#2a363b",
"bgcolor": "#3f5159"
},
{
"id": 2,
"type": "CheckpointLoaderSimple",
"pos": [
100,
450
],
"size": {
"0": 315,
"1": 98
},
"flags": {},
"order": 1,
"mode": 0,
"outputs": [
{
"name": "MODEL",
"type": "MODEL",
"name": "LATENT",
"type": "LATENT",
"slot_index": 0,
"links": [
2
],
"shape": 3
},
{
"name": "CLIP",
"type": "CLIP",
"links": [
3
],
"shape": 3
},
{
"name": "VAE",
"type": "VAE",
"links": [
4
],
"shape": 3
]
}
],
"properties": {
"Node name for S&R": "CheckpointLoaderSimple"
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "EmptyLatentImage",
"widget_ue_connectable": {}
},
"widgets_values": [
"sd_xl_base_1.0.safetensors"
512,
512,
1
]
},
{
"id": 3,
"type": "CLIPTextEncode",
"pos": [
450,
100
],
"size": {
"0": 400,
"1": 200
},
"flags": {},
"order": 2,
"mode": 0,
"inputs": [
{
"name": "clip",
"type": "CLIP",
"link": 3
}
],
"outputs": [
{
"name": "CONDITIONING",
"type": "CONDITIONING",
"links": [
5
],
"shape": 3
}
],
"properties": {
"Node name for S&R": "CLIPTextEncode"
},
"widgets_values": [
"a beautiful landscape with mountains and lakes, sunset, detailed, photorealistic"
],
"color": "#232",
"bgcolor": "#353"
},
{
"id": 4,
"type": "CLIPTextEncode",
"pos": [
450,
350
],
"size": {
"0": 400,
"1": 200
},
"flags": {},
"order": 3,
"mode": 0,
"inputs": [
{
"name": "clip",
"type": "CLIP",
"link": 3
}
],
"outputs": [
{
"name": "CONDITIONING",
"type": "CONDITIONING",
"links": [
6
],
"shape": 3
}
],
"properties": {
"Node name for S&R": "CLIPTextEncode"
},
"widgets_values": [
"blurry, low quality, distorted, ugly, deformed"
],
"color": "#322",
"bgcolor": "#533"
},
{
"id": 5,
"type": "KSampler",
"pos": [
900,
100
863,
186
],
"size": [
315,
571
],
"size": {
"0": 315,
"1": 262
},
"flags": {},
"order": 4,
"order": 6,
"mode": 0,
"inputs": [
{
"name": "model",
"type": "MODEL",
"link": 2
"link": 1
},
{
"name": "positive",
"type": "CONDITIONING",
"link": 5
"link": 4
},
{
"name": "negative",
@@ -196,84 +115,89 @@
{
"name": "latent_image",
"type": "LATENT",
"link": null
"link": 2
},
{
"name": "seed",
"type": "INT",
"link": 1,
"widget": {
"name": "seed"
}
},
"link": 14
},
{
"name": "steps",
"type": "INT",
"widget": {
"name": "steps"
},
"link": 12
},
{
"name": "cfg",
"type": "FLOAT",
"widget": {
"name": "cfg"
},
"link": 13
},
{
"name": "sampler_name",
"type": "COMBO",
"widget": {
"name": "sampler_name"
},
"link": 10
},
{
"name": "scheduler",
"type": "COMBO",
"widget": {
"name": "scheduler"
},
"link": 11
}
],
"outputs": [
{
"name": "LATENT",
"type": "LATENT",
"slot_index": 0,
"links": [
7
],
"shape": 3
]
}
],
"properties": {
"Node name for S&R": "KSampler"
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "KSampler",
"widget_ue_connectable": {}
},
"widgets_values": [
12345,
231413202715030,
"randomize",
20,
8,
"euler",
"normal",
1
1,
""
]
},
{
"id": 6,
"type": "EmptyLatentImage",
"pos": [
900,
400
],
"size": {
"0": 315,
"1": 106
},
"flags": {},
"order": 5,
"mode": 0,
"outputs": [
{
"name": "LATENT",
"type": "LATENT",
"links": [],
"shape": 3
}
],
"properties": {
"Node name for S&R": "EmptyLatentImage"
},
"widgets_values": [
1024,
1024,
1
]
},
{
"id": 7,
"id": 8,
"type": "VAEDecode",
"pos": [
1300,
100
1209,
188
],
"size": [
210,
46
],
"size": {
"0": 210,
"1": 46
},
"flags": {},
"order": 6,
"order": 7,
"mode": 0,
"inputs": [
{
@@ -284,126 +208,437 @@
{
"name": "vae",
"type": "VAE",
"link": 4
"link": 8
}
],
"outputs": [
{
"name": "IMAGE",
"type": "IMAGE",
"links": [],
"shape": 3
"slot_index": 0,
"links": [
9
]
}
],
"properties": {
"Node name for S&R": "VAEDecode"
}
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "VAEDecode",
"widget_ue_connectable": {}
},
"widgets_values": []
},
{
"id": 8,
"id": 9,
"type": "SaveImage",
"pos": [
1300,
200
1451,
189
],
"size": [
210,
270
],
"size": {
"0": 315,
"1": 270
},
"flags": {},
"order": 7,
"order": 8,
"mode": 0,
"inputs": [
{
"name": "images",
"type": "IMAGE",
"link": null
"link": 9
}
],
"outputs": [],
"properties": {
"Node name for S&R": "SaveImage"
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "SaveImage",
"widget_ue_connectable": {}
},
"widgets_values": [
"ComfyUI"
]
},
{
"id": 6,
"type": "CLIPTextEncode",
"pos": [
120,
180
],
"size": [
422.84503173828125,
164.31304931640625
],
"flags": {},
"order": 4,
"mode": 0,
"inputs": [
{
"name": "clip",
"type": "CLIP",
"link": 3
}
],
"outputs": [
{
"name": "CONDITIONING",
"type": "CONDITIONING",
"slot_index": 0,
"links": [
4
]
}
],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "CLIPTextEncode",
"widget_ue_connectable": {}
},
"widgets_values": [
"beautiful scenery nature glass bottle landscape, , purple galaxy bottle,"
]
},
{
"id": 4,
"type": "CheckpointLoaderSimple",
"pos": [
-220,
180
],
"size": [
315,
98
],
"flags": {},
"order": 1,
"mode": 0,
"inputs": [],
"outputs": [
{
"name": "MODEL",
"type": "MODEL",
"slot_index": 0,
"links": [
1
]
},
{
"name": "CLIP",
"type": "CLIP",
"slot_index": 1,
"links": [
3,
5
]
},
{
"name": "VAE",
"type": "VAE",
"slot_index": 2,
"links": [
8
]
}
],
"properties": {
"cnr_id": "comfy-core",
"ver": "0.3.40",
"Node name for S&R": "CheckpointLoaderSimple",
"widget_ue_connectable": {}
},
"widgets_values": [
"sdxl_ckpt/realvisxlV40_v40LightningBakedvae.safetensors"
]
},
{
"id": 10,
"type": "SamplerCombo",
"pos": [
550,
360
],
"size": [
300,
200
],
"flags": {},
"order": 2,
"mode": 0,
"inputs": [],
"outputs": [
{
"name": "sampler_name",
"type": "COMBO",
"slot_index": 0,
"links": [
10
]
},
{
"name": "scheduler",
"type": "COMBO",
"slot_index": 1,
"links": [
11
]
},
{
"name": "steps",
"type": "INT",
"slot_index": 2,
"links": [
12
]
},
{
"name": "cfg",
"type": "FLOAT",
"slot_index": 3,
"links": [
13
]
}
],
"properties": {
"aux_id": "ComfyAssets/ComfyUI-KikoTools",
"ver": "dcf2d679c1a1091c54c2aa8cc04724236723227d",
"Node name for S&R": "SamplerCombo",
"widget_ue_connectable": {}
},
"widgets_values": [
"dpmpp_2m",
"karras",
25,
7.5
]
},
{
"id": 11,
"type": "SeedHistory",
"pos": [
550,
100
],
"size": [
290,
220
],
"flags": {},
"order": 3,
"mode": 0,
"inputs": [],
"outputs": [
{
"name": "seed",
"type": "INT",
"links": [
14
]
}
],
"properties": {
"aux_id": "ComfyAssets/ComfyUI-KikoTools",
"ver": "dcf2d679c1a1091c54c2aa8cc04724236723227d",
"widget_ue_connectable": {},
"Node name for S&R": "SeedHistory"
},
"widgets_values": [
893082183398485,
"randomize",
""
],
"color": "#2a363b",
"bgcolor": "#3f5159",
"hasBeenResized": true,
"seedHistory": [
{
"seed": 893082183398485,
"timestamp": 1750032481153,
"dateString": "6/15/2025, 5:08:01 PM"
},
{
"seed": 267914687236135,
"timestamp": 1750014787315,
"dateString": "6/15/2025, 12:13:07 PM"
},
{
"seed": 267914687236134,
"timestamp": 1750014721305,
"dateString": "6/15/2025, 12:12:01 PM"
},
{
"seed": 267914687236133,
"timestamp": 1750012659402,
"dateString": "6/15/2025, 11:37:39 AM"
},
{
"seed": 267914687236132,
"timestamp": 1750011284415,
"dateString": "6/15/2025, 11:14:44 AM"
},
{
"seed": 267914687236131,
"timestamp": 1750011223416,
"dateString": "6/15/2025, 11:13:43 AM"
},
{
"seed": 267914687236130,
"timestamp": 1750011181407,
"dateString": "6/15/2025, 11:13:01 AM"
},
{
"seed": 267914687236129,
"timestamp": 1750005515384,
"dateString": "6/15/2025, 9:38:35 AM"
},
{
"seed": 267914687236128,
"timestamp": 1750005462384,
"dateString": "6/15/2025, 9:37:42 AM"
},
{
"seed": 267914687236127,
"timestamp": 1750005354713,
"dateString": "6/15/2025, 9:35:54 AM"
}
]
}
],
"links": [
[
1,
1,
0,
5,
4,
"INT"
],
[
2,
2,
0,
5,
3,
0,
"MODEL"
],
[
3,
2,
1,
5,
0,
3,
3,
"LATENT"
],
[
3,
4,
1,
6,
0,
"CLIP"
],
[
4,
2,
2,
6,
0,
3,
1,
"CONDITIONING"
],
[
5,
4,
1,
7,
0,
"CLIP"
],
[
6,
7,
0,
3,
2,
"CONDITIONING"
],
[
7,
3,
0,
8,
0,
"LATENT"
],
[
8,
4,
2,
8,
1,
"VAE"
],
[
5,
9,
8,
0,
9,
0,
"IMAGE"
],
[
10,
10,
0,
3,
0,
5,
7,
"COMBO"
],
[
11,
10,
1,
"CONDITIONING"
3,
8,
"COMBO"
],
[
6,
4,
0,
5,
12,
10,
2,
"CONDITIONING"
3,
5,
"INT"
],
[
7,
5,
13,
10,
3,
3,
6,
"FLOAT"
],
[
14,
11,
0,
7,
0,
"LATENT"
3,
4,
"INT"
]
],
"groups": [],
"config": {},
"extra": {
"ue_links": [],
"links_added_by_ue": [],
"ds": {
"scale": 0.9090909090909091,
"scale": 0.9740024562304554,
"offset": [
-45.45454545454545,
-9.090909090909092
2.9611945935278796,
36.50023864466208
]
},
"info": {
"name": "Seed History Example",
"author": "ComfyUI-KikoTools",
"description": "Example workflow demonstrating the Seed History tool for tracking and managing seed values with an interactive UI.",
"version": "1.0",
"created": "2024-06-14",
"modified": "2024-06-14"
}
"frontendVersion": "1.21.7",
"VHS_latentpreview": true,
"VHS_latentpreviewrate": 0,
"VHS_MetadataImage": true,
"VHS_KeepIntermediate": true
},
"version": 0.4
}
}
File diff suppressed because it is too large Load Diff
+14
View File
@@ -6,18 +6,32 @@ Handles automatic discovery and registration of all ComfyAssets tools
from .tools.resolution_calculator import ResolutionCalculatorNode
from .tools.width_height_selector import WidthHeightSelectorNode
from .tools.seed_history import SeedHistoryNode
from .tools.sampler_combo import SamplerComboNode, SamplerComboCompactNode
from .tools.empty_latent_batch import EmptyLatentBatchNode
from .tools.kiko_save_image import KikoSaveImageNode
from .tools.image_to_multiple_of import ImageToMultipleOfNode
# ComfyUI node registration mappings
NODE_CLASS_MAPPINGS = {
"ResolutionCalculator": ResolutionCalculatorNode,
"WidthHeightSelector": WidthHeightSelectorNode,
"SeedHistory": SeedHistoryNode,
"SamplerCombo": SamplerComboNode,
"SamplerComboCompact": SamplerComboCompactNode,
"EmptyLatentBatch": EmptyLatentBatchNode,
"KikoSaveImage": KikoSaveImageNode,
"ImageToMultipleOf": ImageToMultipleOfNode,
}
NODE_DISPLAY_NAME_MAPPINGS = {
"ResolutionCalculator": "Resolution Calculator",
"WidthHeightSelector": "Width Height Selector",
"SeedHistory": "Seed History",
"SamplerCombo": "Sampler Combo",
"SamplerComboCompact": "Sampler Combo (Compact)",
"EmptyLatentBatch": "Empty Latent Batch",
"KikoSaveImage": "Kiko Save Image",
"ImageToMultipleOf": "Image to Multiple of",
}
__all__ = ["NODE_CLASS_MAPPINGS", "NODE_DISPLAY_NAME_MAPPINGS"]
+1 -3
View File
@@ -35,9 +35,7 @@ class ComfyAssetsBaseNode:
"""
pass
def handle_error(
self, error_msg: str, exception: Optional[Exception] = None
) -> None:
def handle_error(self, error_msg: str, exception: Optional[Exception] = None) -> None:
"""
Standardized error handling with logging
@@ -0,0 +1,5 @@
"""Empty Latent Batch tool for ComfyUI."""
from .node import EmptyLatentBatchNode
__all__ = ["EmptyLatentBatchNode"]
@@ -0,0 +1,97 @@
"""Logic for creating empty latent tensors with batch support."""
import torch
from typing import Dict, Tuple
def create_empty_latent_batch(width: int, height: int, batch_size: int = 1) -> Dict[str, torch.Tensor]:
"""
Create empty latent tensor with batch support.
Args:
width: Width in pixels (will be divided by 8 for latent space)
height: Height in pixels (will be divided by 8 for latent space)
batch_size: Number of latents in the batch
Returns:
Dictionary containing the latent samples tensor
Raises:
ValueError: If dimensions are invalid
"""
# Validate inputs
if width <= 0 or height <= 0:
raise ValueError(f"Width and height must be positive, got {width}x{height}")
if batch_size <= 0:
raise ValueError(f"Batch size must be positive, got {batch_size}")
# Ensure dimensions are divisible by 8 (VAE requirement)
if width % 8 != 0 or height % 8 != 0:
raise ValueError(f"Width and height must be divisible by 8, got {width}x{height}")
# Convert pixel dimensions to latent space (divide by 8)
latent_width = width // 8
latent_height = height // 8
# Create empty latent tensor
# ComfyUI latent format: [batch, channels, height, width]
# Standard VAE uses 4 channels
latent_tensor = torch.zeros(batch_size, 4, latent_height, latent_width)
return {"samples": latent_tensor}
def validate_dimensions(width: int, height: int) -> bool:
"""
Validate that dimensions are suitable for latent creation.
Args:
width: Width in pixels
height: Height in pixels
Returns:
True if dimensions are valid
"""
# Check basic constraints
if width <= 0 or height <= 0:
return False
# Check divisibility by 8
if width % 8 != 0 or height % 8 != 0:
return False
# Check reasonable size limits (64x64 to 8192x8192)
if width < 64 or height < 64:
return False
if width > 8192 or height > 8192:
return False
return True
def sanitize_dimensions(width: int, height: int) -> Tuple[int, int]:
"""
Sanitize dimensions to ensure they meet latent requirements.
Args:
width: Input width
height: Input height
Returns:
Tuple of (sanitized_width, sanitized_height)
"""
# Ensure minimum dimensions
width = max(64, width)
height = max(64, height)
# Ensure maximum dimensions
width = min(8192, width)
height = min(8192, height)
# Round to nearest multiple of 8
width = (width + 7) // 8 * 8
height = (height + 7) // 8 * 8
return width, height
+292
View File
@@ -0,0 +1,292 @@
"""Empty Latent Batch node for ComfyUI."""
import torch
from typing import Dict, Tuple
from ...base.base_node import ComfyAssetsBaseNode
from .logic import (
create_empty_latent_batch,
validate_dimensions,
sanitize_dimensions,
)
from ..width_height_selector.logic import get_preset_dimensions
from ..width_height_selector.presets import (
PRESET_OPTIONS,
PRESET_METADATA,
)
class EmptyLatentBatchNode(ComfyAssetsBaseNode):
"""
Empty Latent Batch node for creating empty latent tensors with batch support.
Creates empty latent tensors with specified dimensions and batch size,
compatible with ComfyUI's latent format for use with VAE and diffusion models.
"""
@classmethod
def INPUT_TYPES(cls):
"""Define the input types for the ComfyUI node."""
# Create formatted preset options with metadata
preset_options = ["custom"] # Custom first
# Add formatted presets with metadata
for preset_name in PRESET_OPTIONS.keys():
if preset_name != "custom":
metadata = PRESET_METADATA.get(preset_name)
if metadata:
formatted_option = (
f"{preset_name} - {metadata.aspect_ratio} " f"({metadata.megapixels:.1f}MP) - {metadata.model_group}"
)
preset_options.append(formatted_option)
else:
preset_options.append(preset_name)
return {
"required": {
"preset": (
preset_options,
{
"default": "custom",
"tooltip": "Select from optimized resolution presets or use "
"custom dimensions. SDXL presets are ~1MP, FLUX presets are "
"higher resolution, Ultra-wide presets support modern "
"aspect ratios.",
},
),
"width": (
"INT",
{
"default": 1024,
"min": 64,
"max": 8192,
"step": 8,
"tooltip": "Custom width in pixels (must be multiple of 8). "
"Used when preset is 'custom' or as fallback for invalid "
"presets. This will be converted to latent space dimensions.",
},
),
"height": (
"INT",
{
"default": 1024,
"min": 64,
"max": 8192,
"step": 8,
"tooltip": "Custom height in pixels (must be multiple of 8). "
"Used when preset is 'custom' or as fallback for invalid "
"presets. This will be converted to latent space dimensions.",
},
),
"batch_size": (
"INT",
{
"default": 1,
"min": 1,
"max": 64,
"step": 1,
"tooltip": "Number of empty latents to create in the batch. " "Useful for batch processing workflows.",
},
),
}
}
RETURN_TYPES = ("LATENT", "INT", "INT")
RETURN_NAMES = ("latent", "width", "height")
FUNCTION = "create_empty_latent"
CATEGORY = "ComfyAssets"
def create_empty_latent(
self, preset: str, width: int, height: int, batch_size: int
) -> Tuple[Dict[str, torch.Tensor], int, int]:
"""
Create empty latent tensor with specified dimensions and batch size.
Args:
preset: Selected preset name or formatted preset string
width: Custom width value
height: Custom height value
batch_size: Number of latents in the batch
Returns:
Tuple containing (latent dictionary with 'samples' tensor, width, height)
"""
try:
# Extract original preset name from formatted string if needed
original_preset = self._extract_preset_name(preset)
# Get base dimensions from preset or custom input
base_width, base_height = get_preset_dimensions(original_preset, width, height)
# Sanitize dimensions to ensure they meet requirements
final_width, final_height = sanitize_dimensions(base_width, base_height)
# Log if dimensions were changed from the base dimensions
if final_width != base_width or final_height != base_height:
self.log_info(
f"Dimensions adjusted from {base_width}×{base_height} to "
f"{final_width}×{final_height} to meet VAE requirements"
)
# Validate final dimensions
if not validate_dimensions(final_width, final_height):
self.handle_error(f"Invalid dimensions after sanitization: {final_width}×{final_height}")
# Validate batch size
if batch_size <= 0:
self.handle_error(f"Batch size must be positive, got {batch_size}")
if batch_size > 64:
self.log_info(f"Large batch size ({batch_size}) may use significant memory")
# Create the empty latent batch
latent_dict = create_empty_latent_batch(final_width, final_height, batch_size)
# Log the operation
latent_height = final_height // 8
latent_width = final_width // 8
self.log_info(
f"Created empty latent batch: {batch_size}×4×{latent_height}×{latent_width} "
f"(pixel dims: {final_width}×{final_height})"
)
return (latent_dict, final_width, final_height)
except Exception as e:
# Handle any unexpected errors gracefully
error_msg = f"Error creating empty latent batch: {str(e)}"
self.handle_error(error_msg, e)
def _extract_preset_name(self, formatted_preset: str) -> str:
"""
Extract the original preset name from a formatted preset string.
Args:
formatted_preset: Either original preset name or formatted string
Returns:
Original preset name
"""
# If it's already "custom", return as-is
if formatted_preset == "custom":
return formatted_preset
# If it contains formatting metadata, extract the resolution part
if " - " in formatted_preset:
# Format is: "1024×1024 - 1:1 (1.0MP) - SDXL"
# Extract the first part (resolution)
resolution_part = formatted_preset.split(" - ")[0]
# Verify this is a valid preset name
if resolution_part in PRESET_OPTIONS:
return resolution_part
# If no formatting or not found, check if it's directly a valid preset
if formatted_preset in PRESET_OPTIONS:
return formatted_preset
# Default to "custom" if we can't parse it
return "custom"
def validate_inputs(self, preset: str, width: int, height: int, batch_size: int) -> bool:
"""
Validate node inputs.
Args:
preset: Preset name or formatted preset string
width: Width value
height: Height value
batch_size: Batch size value
Returns:
True if inputs are valid
"""
# Extract original preset name
original_preset = self._extract_preset_name(preset)
# Check if preset exists or is custom
if original_preset != "custom" and original_preset not in PRESET_OPTIONS:
return False
# Get dimensions from preset or use custom
base_width, base_height = get_preset_dimensions(original_preset, width, height)
# Check dimension validity (after sanitization)
sanitized_width, sanitized_height = sanitize_dimensions(base_width, base_height)
if not validate_dimensions(sanitized_width, sanitized_height):
return False
# Check batch size
if batch_size <= 0 or batch_size > 64:
return False
return True
def get_latent_info(self, width: int, height: int, batch_size: int) -> str:
"""
Get descriptive information about the latent that will be created.
Args:
width: Width in pixels
height: Height in pixels
batch_size: Batch size
Returns:
Description string for the latent
"""
sanitized_width, sanitized_height = sanitize_dimensions(width, height)
latent_width = sanitized_width // 8
latent_height = sanitized_height // 8
return (
f"Empty latent batch: {batch_size} × 4 × {latent_height} × {latent_width} "
f"(pixel dimensions: {sanitized_width}×{sanitized_height})"
)
def get_memory_estimate(self, width: int, height: int, batch_size: int) -> str:
"""
Estimate memory usage for the latent batch.
Args:
width: Width in pixels
height: Height in pixels
batch_size: Batch size
Returns:
Memory estimate string
"""
sanitized_width, sanitized_height = sanitize_dimensions(width, height)
latent_width = sanitized_width // 8
latent_height = sanitized_height // 8
# Calculate tensor size in bytes (float32 = 4 bytes per element)
elements = batch_size * 4 * latent_height * latent_width
bytes_size = elements * 4 # 4 bytes per float32
# Convert to human-readable format
if bytes_size < 1024:
return f"{bytes_size} bytes"
elif bytes_size < 1024 * 1024:
return f"{bytes_size / 1024:.1f} KB"
elif bytes_size < 1024 * 1024 * 1024:
return f"{bytes_size / (1024 * 1024):.1f} MB"
else:
return f"{bytes_size / (1024 * 1024 * 1024):.1f} GB"
def __str__(self) -> str:
"""String representation of the node."""
return "EmptyLatentBatchNode"
def __repr__(self) -> str:
"""Detailed string representation of the node."""
return f"EmptyLatentBatchNode(" f"category='{self.CATEGORY}', " f"function='{self.FUNCTION}'" f")"
# Node class mappings for ComfyUI registration
NODE_CLASS_MAPPINGS = {
"EmptyLatentBatch": EmptyLatentBatchNode,
}
NODE_DISPLAY_NAME_MAPPINGS = {
"EmptyLatentBatch": "Empty Latent Batch",
}
@@ -0,0 +1,5 @@
"""ImageToMultipleOf tool for ComfyUI-KikoTools."""
from .node import ImageToMultipleOfNode
__all__ = ["ImageToMultipleOfNode"]
@@ -0,0 +1,61 @@
"""Core logic for ImageToMultipleOf tool."""
from typing import Tuple
import torch.nn.functional as F
from torch import Tensor
def calculate_dimensions_to_multiple(
height: int, width: int, multiple_of: int
) -> Tuple[int, int]:
"""Calculate new dimensions that are multiples of the specified value.
Args:
height: Original height
width: Original width
multiple_of: Value that dimensions should be multiple of
Returns:
Tuple of (new_height, new_width)
"""
new_height = height - (height % multiple_of)
new_width = width - (width % multiple_of)
return new_height, new_width
def process_image_to_multiple_of(
image: Tensor, multiple_of: int, method: str
) -> Tensor:
"""Process image to ensure dimensions are multiples of specified value.
Args:
image: Input image tensor of shape (batch, height, width, channels)
multiple_of: Value that dimensions should be multiple of
method: Processing method - "center crop" or "rescale"
Returns:
Processed image tensor
"""
_, height, width, _ = image.shape
new_height, new_width = calculate_dimensions_to_multiple(height, width, multiple_of)
if method == "rescale":
# Rescale the image to the new dimensions
# Convert from BHWC to BCHW for interpolation
image_chw = image.permute(0, 3, 1, 2)
rescaled = F.interpolate(
image_chw,
size=(new_height, new_width),
mode="bilinear",
align_corners=False,
)
# Convert back to BHWC
return rescaled.permute(0, 2, 3, 1)
else: # center crop
# Calculate crop offsets to center the crop
top = (height - new_height) // 2
left = (width - new_width) // 2
bottom = top + new_height
right = left + new_width
return image[:, top:bottom, left:right, :]
@@ -0,0 +1,102 @@
"""ComfyUI node implementation for ImageToMultipleOf."""
from typing import Dict, Any, Tuple
from torch import Tensor
from ...base import ComfyAssetsBaseNode
from .logic import process_image_to_multiple_of
class ImageToMultipleOfNode(ComfyAssetsBaseNode):
"""
Adjusts image dimensions to be multiples of a specified value.
Useful for models that require specific dimension constraints.
Supports both center cropping and rescaling methods.
"""
@classmethod
def INPUT_TYPES(cls) -> Dict[str, Any]:
return {
"required": {
"image": ("IMAGE",),
"multiple_of": (
"INT",
{
"default": 64,
"min": 1,
"max": 256,
"step": 16,
"display": "number",
},
),
"method": (["center crop", "rescale"],),
}
}
RETURN_TYPES = ("IMAGE",)
RETURN_NAMES = ("image",)
FUNCTION = "process"
def process(self, image: Tensor, multiple_of: int, method: str) -> Tuple[Tensor]:
"""
Process image to ensure dimensions are multiples of specified value.
Args:
image: Input image tensor
multiple_of: Value that dimensions should be multiple of
method: Processing method - "center crop" or "rescale"
Returns:
Tuple containing processed image tensor
"""
try:
self.validate_inputs(image=image, multiple_of=multiple_of, method=method)
# Process the image
processed_image = process_image_to_multiple_of(image, multiple_of, method)
_, new_height, new_width, _ = processed_image.shape
self.log_info(
f"Processed image from {image.shape[1]}x{image.shape[2]} "
f"to {new_height}x{new_width} (multiple of {multiple_of}) "
f"using {method}"
)
return (processed_image,)
except Exception as e:
self.handle_error(f"Failed to process image: {str(e)}", e)
def validate_inputs(self, **kwargs) -> None:
"""Validate inputs for ImageToMultipleOf node."""
image = kwargs.get("image")
multiple_of = kwargs.get("multiple_of")
method = kwargs.get("method")
if image is None:
raise ValueError("Image input is required")
if not isinstance(image, Tensor) or len(image.shape) != 4:
raise ValueError(
f"Expected image tensor with shape (batch, height, width, channels), "
f"got shape {image.shape if isinstance(image, Tensor) else 'non-tensor'}"
)
if multiple_of <= 0:
raise ValueError(f"multiple_of must be positive, got {multiple_of}")
if method not in ["center crop", "rescale"]:
raise ValueError(f"Invalid method: {method}")
# Check if resulting dimensions would be too small
_, height, width, _ = image.shape
new_height = height - (height % multiple_of)
new_width = width - (width % multiple_of)
if new_height <= 0 or new_width <= 0:
raise ValueError(
f"Image dimensions ({height}x{width}) are too small "
f"to be adjusted to multiple of {multiple_of}"
)
@@ -0,0 +1,8 @@
"""
KikoSaveImage tool module
Enhanced image saving with format selection, quality control, and clickable previews
"""
from .node import KikoSaveImageNode
__all__ = ["KikoSaveImageNode"]
+344
View File
@@ -0,0 +1,344 @@
"""
KikoSaveImage core logic
Enhanced image saving functionality with multiple format support
"""
import os
import json
import numpy as np
from PIL import Image
from PIL.PngImagePlugin import PngInfo
import torch
from typing import Dict, List, Any, Optional, Tuple
import time
try:
import folder_paths
except ImportError:
# Fallback for testing without ComfyUI
class folder_paths:
@staticmethod
def get_output_directory():
return "./output"
def get_save_image_path(
filename_prefix: str,
batch_number: int,
format_ext: str,
output_dir: str,
subfolder: str = "",
) -> Tuple[str, str]:
"""
Generate save path for image with proper filename handling
Args:
filename_prefix: Base filename prefix
batch_number: Batch index for multiple images
format_ext: File extension (.png, .jpg, .webp)
output_dir: Output directory path
subfolder: Optional subfolder within output directory
Returns:
Tuple of (full_path, relative_filename)
"""
# Split filename_prefix into directory path and actual filename prefix
# This allows for directory structures like "kittybear/anime/images/kittybear"
prefix_dir = os.path.dirname(filename_prefix)
prefix_name = os.path.basename(filename_prefix)
# Sanitize only the filename part (not the directory path)
safe_prefix = prefix_name.replace(":", "_") # Only sanitize problematic chars for filenames
safe_prefix = "".join(c for c in safe_prefix if c.isalnum() or c in "._-")
# Create unique filename with timestamp to avoid conflicts
timestamp = int(time.time())
filename = f"{safe_prefix}_{timestamp:010d}_{batch_number:05d}{format_ext}"
# Handle subfolder and prefix directory (but not the filename part)
path_components = []
path_components.append(output_dir)
if subfolder:
path_components.append(subfolder)
# Only add prefix_dir if it exists (the directory part, not the filename part)
if prefix_dir:
path_components.append(prefix_dir)
full_output_folder = os.path.join(*path_components)
# Ensure directory exists
os.makedirs(full_output_folder, exist_ok=True)
full_path = os.path.join(full_output_folder, filename)
# For the preview, ComfyUI needs the filename and subfolder separately
# The subfolder needs to be relative to the output directory root
# Build the relative subfolder path including prefix directory (but not filename part)
relative_path_components = []
if subfolder:
relative_path_components.append(subfolder.strip("/\\"))
if prefix_dir:
relative_path_components.append(prefix_dir.strip("/\\"))
if relative_path_components:
relative_subfolder = os.path.join(*relative_path_components)
else:
relative_subfolder = ""
preview_filename = filename
return full_path, preview_filename, relative_subfolder
def convert_tensor_to_pil(image_tensor: torch.Tensor) -> Image.Image:
"""
Convert ComfyUI image tensor to PIL Image
Args:
image_tensor: Tensor in format [height, width, channels] with values 0-1
Returns:
PIL Image in RGB/RGBA format
"""
# Convert tensor (0-1 float) to 0-255 numpy array
i = 255.0 * image_tensor.cpu().numpy()
img_array = np.clip(i, 0, 255).astype(np.uint8)
# Create PIL image from numpy array
img = Image.fromarray(img_array)
return img
def create_png_metadata(prompt: Optional[Dict] = None, extra_pnginfo: Optional[Dict] = None) -> Optional[PngInfo]:
"""
Create PNG metadata with workflow information
Args:
prompt: ComfyUI prompt data
extra_pnginfo: Additional PNG metadata
Returns:
PngInfo object or None if no metadata
"""
if prompt is None and extra_pnginfo is None:
return None
metadata = PngInfo()
if prompt is not None:
metadata.add_text("prompt", json.dumps(prompt))
if extra_pnginfo is not None:
for key, value in extra_pnginfo.items():
metadata.add_text(key, json.dumps(value))
return metadata
def save_image_with_format(
img: Image.Image,
filepath: str,
format_type: str,
quality: int = 90,
png_compress_level: int = 4,
webp_lossless: bool = False,
metadata: Optional[PngInfo] = None,
) -> Dict[str, Any]:
"""
Save PIL image with specified format and quality settings
Args:
img: PIL Image to save
filepath: Full path to save file
format_type: Image format (PNG, JPEG, WEBP)
quality: JPEG/WebP quality (1-100)
png_compress_level: PNG compression level (0-9)
webp_lossless: Use lossless WebP compression
metadata: PNG metadata to embed
Returns:
Dict with save information
"""
save_kwargs = {}
if format_type == "PNG":
if metadata:
save_kwargs["pnginfo"] = metadata
save_kwargs["compress_level"] = png_compress_level
elif format_type == "JPEG":
# Convert RGBA to RGB for JPEG (no transparency support)
if img.mode == "RGBA":
# Create white background
background = Image.new("RGB", img.size, (255, 255, 255))
background.paste(img, mask=img.split()[-1]) # Use alpha channel as mask
img = background
elif img.mode != "RGB":
img = img.convert("RGB")
save_kwargs["quality"] = quality
save_kwargs["optimize"] = True
elif format_type == "WEBP":
save_kwargs["quality"] = quality if not webp_lossless else 100
save_kwargs["lossless"] = webp_lossless
else:
raise ValueError(f"Unsupported format: {format_type}")
# Save the image
img.save(filepath, **save_kwargs)
# Get file size for info
file_size = os.path.getsize(filepath)
return {
"filepath": filepath,
"format": format_type,
"file_size": file_size,
"quality": quality if format_type != "PNG" else None,
"compress_level": png_compress_level if format_type == "PNG" else None,
"lossless": webp_lossless if format_type == "WEBP" else None,
}
def process_image_batch(
images: torch.Tensor,
filename_prefix: str = "KikoSave",
format_type: str = "PNG",
quality: int = 90,
png_compress_level: int = 4,
webp_lossless: bool = False,
popup: bool = True,
prompt: Optional[Dict] = None,
extra_pnginfo: Optional[Dict] = None,
) -> List[Dict[str, Any]]:
"""
Process and save a batch of images with specified format settings
Args:
images: Batch of image tensors [batch, height, width, channels]
filename_prefix: Prefix for saved filenames
format_type: Image format (PNG, JPEG, WEBP)
quality: JPEG/WebP quality (1-100)
png_compress_level: PNG compression level (0-9)
webp_lossless: Use lossless WebP compression
popup: Enable popup windows in UI
prompt: ComfyUI prompt data for metadata
extra_pnginfo: Additional PNG metadata
Returns:
List of saved image information dicts
"""
# Get output directory
output_dir = folder_paths.get_output_directory()
# Determine file extension
format_extensions = {"PNG": ".png", "JPEG": ".jpg", "WEBP": ".webp"}
if format_type not in format_extensions:
raise ValueError(f"Unsupported format: {format_type}. " f"Supported: {list(format_extensions.keys())}")
format_ext = format_extensions[format_type]
# Create metadata for PNG
metadata = None
if format_type == "PNG":
metadata = create_png_metadata(prompt, extra_pnginfo)
# Process each image in the batch
results = []
enhanced_data = []
for batch_number, image_tensor in enumerate(images):
# Convert tensor to PIL Image
img = convert_tensor_to_pil(image_tensor)
# Generate save path
filepath, preview_filename, relative_subfolder = get_save_image_path(
filename_prefix, batch_number, format_ext, output_dir, ""
)
# Save with format-specific settings
save_info = save_image_with_format(
img,
filepath,
format_type,
quality,
png_compress_level,
webp_lossless,
metadata,
)
# Build result info for ComfyUI preview
# ONLY the core fields that ComfyUI expects - no extra metadata
result = {
"filename": preview_filename,
"subfolder": relative_subfolder,
"type": "output",
}
# Store enhanced data separately
enhanced_info = {
"filename": preview_filename,
"subfolder": relative_subfolder,
"popup": popup,
"type": "output",
"format": format_type,
"file_size": save_info["file_size"],
"dimensions": f"{img.width}x{img.height}",
}
# Add format-specific info to enhanced data
if format_type == "PNG":
enhanced_info["compress_level"] = png_compress_level
elif format_type in ["JPEG", "WEBP"]:
enhanced_info["quality"] = quality
if format_type == "WEBP":
enhanced_info["lossless"] = webp_lossless
results.append(result)
enhanced_data.append(enhanced_info)
return results, enhanced_data
def validate_save_inputs(images: torch.Tensor, format_type: str, quality: int, png_compress_level: int) -> None:
"""
Validate inputs for image saving
Args:
images: Image tensor batch to validate
format_type: Image format to validate
quality: Quality setting to validate
png_compress_level: PNG compression level to validate
Raises:
ValueError: If validation fails
"""
# Validate images tensor
if not isinstance(images, torch.Tensor):
raise ValueError(f"images must be a torch.Tensor, got {type(images).__name__}")
if len(images.shape) != 4:
raise ValueError(f"images tensor must have 4 dimensions [batch, height, width, channels], " f"got {len(images.shape)}")
# Validate format
supported_formats = ["PNG", "JPEG", "WEBP"]
if format_type not in supported_formats:
raise ValueError(f"format must be one of {supported_formats}, got {format_type}")
# Validate quality (for JPEG/WebP)
if format_type in ["JPEG", "WEBP"]:
if not isinstance(quality, int) or not (1 <= quality <= 100):
raise ValueError(f"quality must be an integer between 1 and 100, got {quality}")
# Validate PNG compression level
if format_type == "PNG":
if not isinstance(png_compress_level, int) or not (0 <= png_compress_level <= 9):
raise ValueError(f"png_compress_level must be an integer between 0 and 9, " f"got {png_compress_level}")
+220
View File
@@ -0,0 +1,220 @@
"""
KikoSaveImage ComfyUI Node
Enhanced image saving with format selection, quality control, and clickable previews
"""
import torch
from typing import Dict, Any, Optional
from ...base import ComfyAssetsBaseNode
from .logic import process_image_batch, validate_save_inputs
class KikoSaveImageNode(ComfyAssetsBaseNode):
"""
Enhanced ComfyUI image saving node with multiple format support
Features:
- Multiple format support (PNG, JPEG, WebP)
- Quality/compression controls
- Clickable image previews
- Metadata preservation
- Batch processing
Inputs:
- images (IMAGE): Images to save
- filename_prefix (STRING): Prefix for saved filenames
- format (COMBO): Output format (PNG, JPEG, WebP)
- quality (INT): JPEG/WebP quality (1-100)
- png_compress_level (INT): PNG compression level (0-9)
- webp_lossless (BOOLEAN): Use lossless WebP compression
- subfolder (STRING): Optional subfolder for organization
Outputs:
- UI: Image preview data for ComfyUI interface
"""
@classmethod
def INPUT_TYPES(cls) -> Dict[str, Any]:
"""
Define ComfyUI input interface with enhanced save options
Returns:
Dict with required and optional input specifications
"""
return {
"required": {
"images": ("IMAGE", {"tooltip": "The images to save"}),
"filename_prefix": (
"STRING",
{"default": "KikoSave", "tooltip": "Prefix for saved filenames"},
),
"format": (
["PNG", "JPEG", "WEBP"],
{"default": "PNG", "tooltip": "Output image format"},
),
},
"optional": {
"quality": (
"INT",
{
"default": 90,
"min": 1,
"max": 100,
"step": 1,
"tooltip": "JPEG/WebP quality (1-100, higher = better quality)",
},
),
"png_compress_level": (
"INT",
{
"default": 4,
"min": 0,
"max": 9,
"step": 1,
"tooltip": "PNG compression level (0-9, higher = smaller file)",
},
),
"webp_lossless": (
"BOOLEAN",
{
"default": False,
"tooltip": "Use lossless WebP compression " "(ignores quality setting)",
},
),
"popup": (
"BOOLEAN",
{
"default": True,
"tooltip": "Enable popup windows when clicking on images in the viewer",
},
),
},
"hidden": {"prompt": "PROMPT", "extra_pnginfo": "EXTRA_PNGINFO"},
}
RETURN_TYPES = ()
FUNCTION = "save_images"
OUTPUT_NODE = True
def save_images(
self,
images: torch.Tensor,
filename_prefix: str = "KikoSave",
format: str = "PNG",
quality: int = 90,
png_compress_level: int = 4,
webp_lossless: bool = False,
popup: bool = True,
prompt: Optional[Dict] = None,
extra_pnginfo: Optional[Dict] = None,
) -> Dict[str, Any]:
"""
Save images with enhanced format and quality options
Args:
images: Batch of image tensors to save
filename_prefix: Prefix for saved filenames
format: Output format (PNG, JPEG, WebP)
quality: JPEG/WebP quality setting
png_compress_level: PNG compression level
webp_lossless: Use lossless WebP compression
popup: Enable popup windows when clicking on images
prompt: ComfyUI prompt data for metadata
extra_pnginfo: Additional PNG metadata
Returns:
Dict with UI data for image previews
Raises:
ValueError: If validation fails
"""
try:
# Validate inputs
self.validate_inputs(
images=images,
format=format,
quality=quality,
png_compress_level=png_compress_level,
webp_lossless=webp_lossless,
popup=popup,
)
# Log the save operation
self.log_info(
f"Saving {len(images)} images as {format} "
f"(quality={quality if format != 'PNG' else 'N/A'}, "
f"png_compress={png_compress_level if format == 'PNG' else 'N/A'})"
)
# Process and save images
results, enhanced_data = process_image_batch(
images=images,
filename_prefix=filename_prefix,
format_type=format,
quality=quality,
png_compress_level=png_compress_level,
webp_lossless=webp_lossless,
popup=popup,
prompt=prompt,
extra_pnginfo=extra_pnginfo,
)
# Log results
total_size = sum(data["file_size"] for data in enhanced_data)
self.log_info(f"Successfully saved {len(results)} images " f"(total size: {total_size / 1024:.1f} KB)")
# Return UI data for ComfyUI preview (clean) + enhanced data for our JS
return {
"ui": {
"images": results, # Clean data for ComfyUI
"kiko_enhanced": enhanced_data, # Enhanced data for our JavaScript
}
}
except Exception as e:
error_msg = f"Failed to save images: {str(e)}"
self.handle_error(error_msg, e)
def validate_inputs(
self,
images: torch.Tensor,
format: str,
quality: int,
png_compress_level: int,
webp_lossless: bool,
popup: bool,
) -> None:
"""
Validate inputs specific to KikoSaveImage
Args:
images: Image tensor batch
format: Image format
quality: Quality setting
png_compress_level: PNG compression level
webp_lossless: WebP lossless setting
popup: Enable popup windows
Raises:
ValueError: If validation fails
"""
# Use logic module validation
validate_save_inputs(images, format, quality, png_compress_level)
# Additional node-specific validation
if not isinstance(webp_lossless, bool):
raise ValueError(f"webp_lossless must be a boolean, got {type(webp_lossless).__name__}")
if not isinstance(popup, bool):
raise ValueError(f"popup must be a boolean, got {type(popup).__name__}")
# Node class mappings for ComfyUI registration
NODE_CLASS_MAPPINGS = {
"KikoSaveImage": KikoSaveImageNode,
}
NODE_DISPLAY_NAME_MAPPINGS = {
"KikoSaveImage": "Kiko Save Image",
}
+11 -26
View File
@@ -4,7 +4,7 @@ Pure functions for dimension extraction and scaling calculations
"""
import torch
from typing import Tuple, Optional, Union, Dict, Any
from typing import Tuple, Optional, Dict
def extract_dimensions(
@@ -16,7 +16,8 @@ def extract_dimensions(
Args:
image: Optional IMAGE tensor in ComfyUI format [batch, height, width, channels]
latent: Optional LATENT dict with 'samples' tensor [batch, channels, height/8, width/8]
latent: Optional LATENT dict with 'samples' tensor
[batch, channels, height/8, width/8]
Returns:
Tuple of (width, height) as integers
@@ -27,9 +28,7 @@ def extract_dimensions(
if image is not None:
# IMAGE tensor format: [batch, height, width, channels]
if len(image.shape) != 4:
raise ValueError(
f"Expected IMAGE tensor with 4 dimensions, got {len(image.shape)}"
)
raise ValueError(f"Expected IMAGE tensor with 4 dimensions, got {len(image.shape)}")
_, height, width, _ = image.shape
return int(width), int(height)
@@ -41,9 +40,7 @@ def extract_dimensions(
samples = latent["samples"]
if len(samples.shape) != 4:
raise ValueError(
f"Expected LATENT samples tensor with 4 dimensions, got {len(samples.shape)}"
)
raise ValueError(f"Expected LATENT samples tensor with 4 dimensions, " f"got {len(samples.shape)}")
_, _, latent_height, latent_width = samples.shape
@@ -77,9 +74,7 @@ def ensure_divisible_by_8(width: int, height: int) -> Tuple[int, int]:
return int(new_width), int(new_height)
def calculate_scaled_dimensions(
width: int, height: int, scale_factor: float
) -> Tuple[int, int]:
def calculate_scaled_dimensions(width: int, height: int, scale_factor: float) -> Tuple[int, int]:
"""
Calculate new dimensions with scale factor and ensure divisible by 8
@@ -102,9 +97,7 @@ def calculate_scaled_dimensions(
return ensure_divisible_by_8(new_width, new_height)
def validate_scale_factor(
scale_factor: float, min_scale: float = 0.1, max_scale: float = 8.0
) -> None:
def validate_scale_factor(scale_factor: float, min_scale: float = 0.1, max_scale: float = 8.0) -> None:
"""
Validate scale factor is within reasonable bounds
@@ -117,19 +110,13 @@ def validate_scale_factor(
ValueError: If scale factor is out of bounds
"""
if not isinstance(scale_factor, (int, float)):
raise ValueError(
f"Scale factor must be a number, got {type(scale_factor).__name__}"
)
raise ValueError(f"Scale factor must be a number, got {type(scale_factor).__name__}")
if scale_factor < min_scale:
raise ValueError(
f"Scale factor {scale_factor} is too small (minimum: {min_scale})"
)
raise ValueError(f"Scale factor {scale_factor} is too small (minimum: {min_scale})")
if scale_factor > max_scale:
raise ValueError(
f"Scale factor {scale_factor} is too large (maximum: {max_scale})"
)
raise ValueError(f"Scale factor {scale_factor} is too large (maximum: {max_scale})")
def calculate_resolution_from_input(
@@ -159,8 +146,6 @@ def calculate_resolution_from_input(
original_width, original_height = extract_dimensions(image=image, latent=latent)
# Calculate scaled dimensions
new_width, new_height = calculate_scaled_dimensions(
original_width, original_height, scale_factor
)
new_width, new_height = calculate_scaled_dimensions(original_width, original_height, scale_factor)
return new_width, new_height
+33 -39
View File
@@ -38,11 +38,11 @@ class ResolutionCalculatorNode(ComfyAssetsBaseNode):
"FLOAT",
{
"default": 2.0,
"min": 1.0,
"min": 0.1,
"max": 8.0,
"step": 0.1,
"display": "slider",
"tooltip": "Factor to scale the resolution by (e.g., 2.0 for 2x upscale)",
"tooltip": "Factor to scale the resolution by " "(e.g., 2.0 for 2x, 0.5 for half scale)",
},
),
},
@@ -87,19 +87,11 @@ class ResolutionCalculatorNode(ComfyAssetsBaseNode):
self.validate_inputs(scale_factor=scale_factor, image=image, latent=latent)
# Log the operation
input_type = (
"IMAGE"
if image is not None
else "LATENT" if latent is not None else "NONE"
)
self.log_info(
f"Calculating resolution with scale_factor={scale_factor}, input_type={input_type}"
)
input_type = "IMAGE" if image is not None else "LATENT" if latent is not None else "NONE"
self.log_info(f"Calculating resolution with scale_factor={scale_factor}, " f"input_type={input_type}")
# Calculate the resolution
width, height = calculate_resolution_from_input(
scale_factor=scale_factor, image=image, latent=latent
)
width, height = calculate_resolution_from_input(scale_factor=scale_factor, image=image, latent=latent)
# Log the result
self.log_info(f"Calculated resolution: {width}x{height}")
@@ -134,39 +126,41 @@ class ResolutionCalculatorNode(ComfyAssetsBaseNode):
# Validate scale factor type
if not isinstance(scale_factor, (int, float)):
raise ValueError(
f"scale_factor must be a number, got {type(scale_factor).__name__}"
)
raise ValueError(f"scale_factor must be a number, got {type(scale_factor).__name__}")
# Additional tensor validation
# Validate tensors using helper methods
if image is not None:
if not isinstance(image, torch.Tensor):
raise ValueError(
f"image must be a torch.Tensor, got {type(image).__name__}"
)
if len(image.shape) != 4:
raise ValueError(
f"image tensor must have 4 dimensions [batch, height, width, channels], got {len(image.shape)}"
)
self._validate_image_tensor(image)
if latent is not None:
if not isinstance(latent, dict):
raise ValueError(f"latent must be a dict, got {type(latent).__name__}")
self._validate_latent_dict(latent)
if "samples" not in latent:
raise ValueError("latent dict must contain 'samples' key")
def _validate_image_tensor(self, image: torch.Tensor) -> None:
"""Validate image tensor format"""
if not isinstance(image, torch.Tensor):
raise ValueError(f"image must be a torch.Tensor, got {type(image).__name__}")
samples = latent["samples"]
if not isinstance(samples, torch.Tensor):
raise ValueError(
f"latent['samples'] must be a torch.Tensor, got {type(samples).__name__}"
)
if len(image.shape) != 4:
raise ValueError(
f"image tensor must have 4 dimensions " f"[batch, height, width, channels], got {len(image.shape)}"
)
if len(samples.shape) != 4:
raise ValueError(
f"latent samples tensor must have 4 dimensions [batch, channels, height, width], got {len(samples.shape)}"
)
def _validate_latent_dict(self, latent: Dict[str, torch.Tensor]) -> None:
"""Validate latent dictionary format"""
if not isinstance(latent, dict):
raise ValueError(f"latent must be a dict, got {type(latent).__name__}")
if "samples" not in latent:
raise ValueError("latent dict must contain 'samples' key")
samples = latent["samples"]
if not isinstance(samples, torch.Tensor):
raise ValueError(f"latent['samples'] must be a torch.Tensor, " f"got {type(samples).__name__}")
if len(samples.shape) != 4:
raise ValueError(
f"latent samples tensor must have 4 dimensions " f"[batch, channels, height, width], got {len(samples.shape)}"
)
# Node class mappings for ComfyUI registration
@@ -0,0 +1,6 @@
"""Sampler Combo tool for ComfyUI."""
from .node import SamplerComboNode
from .compact_node import SamplerComboCompactNode
__all__ = ["SamplerComboNode", "SamplerComboCompactNode"]
@@ -0,0 +1,112 @@
"""Compact Sampler Combo node for ComfyUI with minimal interface."""
from typing import Tuple
from ...base.base_node import ComfyAssetsBaseNode
from .logic import (
get_sampler_combo,
SAMPLERS,
SCHEDULERS,
)
class SamplerComboCompactNode(ComfyAssetsBaseNode):
"""
Compact Sampler Combo node with minimal interface.
Provides essential sampling parameters in a space-efficient layout
with shorter parameter names and reduced visual footprint.
"""
@classmethod
def INPUT_TYPES(cls):
"""Define compact input types for the ComfyUI node."""
return {
"required": {
"sampler": (
SAMPLERS,
{
"default": "euler",
"tooltip": "Sampler",
},
),
"sched": (
SCHEDULERS,
{
"default": "normal",
"tooltip": "Scheduler",
},
),
"steps": (
"INT",
{
"default": 20,
"min": 1,
"max": 50,
"step": 1,
"tooltip": "Steps",
},
),
"cfg": (
"FLOAT",
{
"default": 7.0,
"min": 1.0,
"max": 15.0,
"step": 0.5,
"display": "slider",
"tooltip": "CFG",
},
),
}
}
RETURN_TYPES = ("SAMPLER", SCHEDULERS, "INT", "FLOAT")
RETURN_NAMES = ("sampler", "scheduler", "steps", "cfg")
FUNCTION = "get_combo"
CATEGORY = "ComfyAssets"
def get_combo(self, sampler: str, sched: str, steps: int, cfg: float) -> Tuple[object, str, int, float]:
"""
Get compact sampler combo configuration.
Args:
sampler: The sampler algorithm name
sched: The scheduler algorithm name
steps: Number of sampling steps
cfg: CFG scale value
Returns:
Tuple of (sampler_object, scheduler, steps, cfg)
"""
try:
# Use the same validation logic but with compact interface
result = get_sampler_combo(sampler, sched, steps, cfg)
# Create the sampler object
try:
import comfy.samplers
sampler_obj = comfy.samplers.sampler_object(result[0])
except ImportError:
# Return sampler name for testing
sampler_obj = result[0]
return (sampler_obj, result[1], result[2], result[3])
except Exception as e:
# Graceful fallback
self.handle_error(f"Error in compact combo: {str(e)}")
try:
import comfy.samplers
sampler_obj = comfy.samplers.sampler_object("euler")
except ImportError:
# Return sampler name for testing
sampler_obj = "euler"
return (sampler_obj, "normal", 20, 7.0)
def __str__(self) -> str:
"""String representation of the compact node."""
return "SamplerComboCompactNode"
def __repr__(self) -> str:
"""Detailed string representation of the compact node."""
return f"SamplerComboCompactNode(category='{self.CATEGORY}')"
+216
View File
@@ -0,0 +1,216 @@
"""Logic module for Sampler Combo node."""
from typing import Tuple, Dict, Any, List
import logging
logger = logging.getLogger(__name__)
# Import ComfyUI samplers - will be available when running in ComfyUI
try:
import comfy.samplers
SAMPLERS = comfy.samplers.KSampler.SAMPLERS
SCHEDULERS = comfy.samplers.KSampler.SCHEDULERS
except ImportError:
# Fallback for testing/development environment
SAMPLERS = [
"euler",
"euler_ancestral",
"heun",
"dpm_2",
"dpm_2_ancestral",
"lms",
"dpm_fast",
"dpm_adaptive",
"dpmpp_2s_ancestral",
"dpmpp_sde",
"dpmpp_2m",
"ddim",
"uni_pc",
"uni_pc_bh2",
]
SCHEDULERS = [
"normal",
"karras",
"exponential",
"sgm_uniform",
"simple",
"ddim_uniform",
"beta",
]
def validate_sampler_settings(sampler_name: str, scheduler: str, steps: int, cfg: float) -> bool:
"""
Validate sampler configuration settings.
Args:
sampler_name: The sampler algorithm name
scheduler: The scheduler algorithm name
steps: Number of sampling steps
cfg: CFG (classifier-free guidance) scale value
Returns:
True if all settings are valid
"""
try:
# Validate sampler
if sampler_name not in SAMPLERS:
logger.error(f"Invalid sampler: {sampler_name}")
return False
# Validate scheduler
if scheduler not in SCHEDULERS:
logger.error(f"Invalid scheduler: {scheduler}")
return False
# Validate steps
if not isinstance(steps, int) or steps < 1 or steps > 1000:
logger.error(f"Invalid steps: {steps} (must be 1-1000)")
return False
# Validate CFG
if not isinstance(cfg, (int, float)) or cfg < 0 or cfg > 30:
logger.error(f"Invalid CFG: {cfg} (must be 0-30)")
return False
return True
except Exception as e:
logger.error(f"Error validating sampler settings: {e}")
return False
def get_sampler_combo(sampler_name: str, scheduler: str, steps: int, cfg: float) -> Tuple[str, str, int, float]:
"""
Process and return sampler combo settings.
Args:
sampler_name: The sampler algorithm name
scheduler: The scheduler algorithm name
steps: Number of sampling steps
cfg: CFG scale value
Returns:
Tuple of (sampler_name, scheduler, steps, cfg)
"""
try:
# Validate inputs
if not validate_sampler_settings(sampler_name, scheduler, steps, cfg):
# Return safe defaults if validation fails
logger.warning("Invalid settings provided, using safe defaults")
return ("euler", "normal", 20, 7.0)
# Sanitize values
steps = max(1, min(1000, int(steps)))
cfg = max(0.0, min(30.0, float(cfg)))
return (sampler_name, scheduler, steps, cfg)
except Exception as e:
logger.error(f"Error processing sampler combo: {e}")
# Return safe defaults on any error
return ("euler", "normal", 20, 7.0)
def get_compatible_scheduler_suggestions(sampler_name: str) -> List[str]:
"""
Get scheduler suggestions that work well with specific samplers.
Args:
sampler_name: The sampler algorithm name
Returns:
List of recommended scheduler names
"""
# Scheduler compatibility recommendations
compatibility_map = {
"euler": ["normal", "simple", "sgm_uniform"],
"euler_ancestral": ["normal", "karras", "exponential"],
"heun": ["normal", "karras"],
"dpm_2": ["normal", "karras"],
"dpm_2_ancestral": ["normal", "karras", "exponential"],
"dpmpp_2s_ancestral": ["normal", "karras", "exponential"],
"dpmpp_sde": ["normal", "karras", "exponential"],
"dpmpp_2m": ["normal", "karras", "sgm_uniform"],
"ddim": ["ddim_uniform", "normal"],
"uni_pc": ["normal", "sgm_uniform"],
"uni_pc_bh2": ["normal", "sgm_uniform"],
}
return compatibility_map.get(sampler_name, ["normal", "karras"])
def get_recommended_steps_range(sampler_name: str) -> Tuple[int, int, int]:
"""
Get recommended steps range for specific samplers.
Args:
sampler_name: The sampler algorithm name
Returns:
Tuple of (min_steps, max_steps, default_steps)
"""
# Steps recommendations by sampler
steps_map = {
"euler": (10, 30, 20),
"euler_ancestral": (15, 40, 25),
"heun": (10, 25, 15),
"dpm_2": (10, 30, 22),
"dpm_2_ancestral": (15, 35, 25),
"dpmpp_2s_ancestral": (15, 40, 28),
"dpmpp_sde": (15, 35, 25),
"dpmpp_2m": (15, 30, 20),
"ddim": (20, 50, 30),
"uni_pc": (10, 25, 15),
"uni_pc_bh2": (10, 25, 15),
}
return steps_map.get(sampler_name, (10, 50, 20))
def get_recommended_cfg_range(sampler_name: str) -> Tuple[float, float, float]:
"""
Get recommended CFG range for specific samplers.
Args:
sampler_name: The sampler algorithm name
Returns:
Tuple of (min_cfg, max_cfg, default_cfg)
"""
# CFG recommendations by sampler
cfg_map = {
"euler": (3.0, 15.0, 7.0),
"euler_ancestral": (5.0, 20.0, 8.0),
"heun": (3.0, 12.0, 6.0),
"dpm_2": (4.0, 15.0, 7.5),
"dpm_2_ancestral": (5.0, 18.0, 8.5),
"dpmpp_2s_ancestral": (6.0, 20.0, 9.0),
"dpmpp_sde": (5.0, 18.0, 8.0),
"dpmpp_2m": (4.0, 15.0, 7.0),
"ddim": (3.0, 12.0, 6.0),
"uni_pc": (3.0, 12.0, 6.5),
"uni_pc_bh2": (3.0, 12.0, 6.5),
}
return cfg_map.get(sampler_name, (1.0, 20.0, 7.0))
def get_sampler_info() -> Dict[str, Any]:
"""
Get information about available samplers and schedulers.
Returns:
Dictionary containing sampler/scheduler information
"""
return {
"samplers": SAMPLERS,
"schedulers": SCHEDULERS,
"sampler_count": len(SAMPLERS),
"scheduler_count": len(SCHEDULERS),
"default_sampler": "euler",
"default_scheduler": "normal",
"default_steps": 20,
"default_cfg": 7.0,
}
+278
View File
@@ -0,0 +1,278 @@
"""Sampler Combo node for ComfyUI."""
from typing import Tuple
from ...base.base_node import ComfyAssetsBaseNode
from .logic import (
get_sampler_combo,
validate_sampler_settings,
get_compatible_scheduler_suggestions,
get_recommended_steps_range,
get_recommended_cfg_range,
SAMPLERS,
SCHEDULERS,
)
class SamplerComboNode(ComfyAssetsBaseNode):
"""
Sampler Combo node for selecting sampling configuration.
Provides a unified interface for selecting sampler, scheduler, steps,
and CFG settings in a single node, reducing workflow complexity and
ensuring compatible parameter combinations.
"""
@classmethod
def INPUT_TYPES(cls):
"""Define the input types for the ComfyUI node."""
return {
"required": {
"sampler_name": (
SAMPLERS,
{
"default": "euler",
"tooltip": "Sampling algorithm",
},
),
"scheduler": (
SCHEDULERS,
{
"default": "normal",
"tooltip": "Step distribution schedule",
},
),
"steps": (
"INT",
{
"default": 20,
"min": 1,
"max": 100,
"step": 1,
"tooltip": "Sampling steps (1-100)",
},
),
"cfg": (
"FLOAT",
{
"default": 7.0,
"min": 0.0,
"max": 20.0,
"step": 0.5,
"display": "slider",
"tooltip": "CFG scale (0-20)",
},
),
}
}
RETURN_TYPES = ("SAMPLER", SCHEDULERS, "INT", "FLOAT")
RETURN_NAMES = ("sampler_name", "scheduler", "steps", "cfg")
FUNCTION = "get_sampler_combo"
CATEGORY = "ComfyAssets"
def get_sampler_combo(self, sampler_name: str, scheduler: str, steps: int, cfg: float) -> Tuple[object, str, int, float]:
"""
Get sampler combo configuration.
Args:
sampler_name: The sampler algorithm name
scheduler: The scheduler algorithm name
steps: Number of sampling steps
cfg: CFG scale value
Returns:
Tuple of (sampler_object, scheduler, steps, cfg)
"""
try:
# Validate inputs
if not validate_sampler_settings(sampler_name, scheduler, steps, cfg):
# Log the validation error but don't raise
import logging
logger = logging.getLogger(__name__)
logger.error(
f"{self.__class__.__name__}: Invalid sampler settings: "
f"sampler={sampler_name}, scheduler={scheduler}, "
f"steps={steps}, cfg={cfg}. "
f"Using safe defaults: euler, normal, 20 steps, CFG 7.0"
)
try:
import comfy.samplers
sampler = comfy.samplers.sampler_object("euler")
except ImportError:
# Return mock object for testing
sampler = "euler"
return (sampler, "normal", 20, 7.0)
# Process and return the combo
result = get_sampler_combo(sampler_name, scheduler, steps, cfg)
# Create the sampler object
try:
import comfy.samplers
sampler = comfy.samplers.sampler_object(result[0])
except ImportError:
# Return sampler name for testing
sampler = result[0]
self.log_info(f"Configured sampler combo: {result[0]}, {result[1]}, " f"{result[2]} steps, CFG {result[3]}")
return (sampler, result[1], result[2], result[3])
except Exception as e:
# Handle any unexpected errors gracefully
import logging
logger = logging.getLogger(__name__)
logger.error(
f"{self.__class__.__name__}: Error processing sampler combo: {str(e)}. "
f"Using safe defaults: euler, normal, 20 steps, CFG 7.0"
)
try:
import comfy.samplers
sampler = comfy.samplers.sampler_object("euler")
except ImportError:
# Return mock object for testing
sampler = "euler"
return (sampler, "normal", 20, 7.0)
def validate_inputs(self, sampler_name: str, scheduler: str, steps: int, cfg: float) -> None:
"""
Validate sampler combo inputs.
Args:
sampler_name: The sampler algorithm name
scheduler: The scheduler algorithm name
steps: Number of sampling steps
cfg: CFG scale value
Raises:
ValueError: If validation fails
"""
if not validate_sampler_settings(sampler_name, scheduler, steps, cfg):
self.handle_error(
f"Invalid sampler settings: sampler={sampler_name}, " f"scheduler={scheduler}, steps={steps}, cfg={cfg}"
)
def get_scheduler_suggestions(self, sampler_name: str) -> list:
"""
Get scheduler suggestions compatible with the selected sampler.
Args:
sampler_name: The sampler algorithm name
Returns:
List of recommended scheduler names
"""
return get_compatible_scheduler_suggestions(sampler_name)
def get_steps_recommendation(self, sampler_name: str) -> dict:
"""
Get steps recommendation for the selected sampler.
Args:
sampler_name: The sampler algorithm name
Returns:
Dictionary with min, max, and default steps
"""
min_steps, max_steps, default_steps = get_recommended_steps_range(sampler_name)
return {
"min": min_steps,
"max": max_steps,
"default": default_steps,
"recommendation": f"Range: {min_steps}-{max_steps} steps",
}
def get_cfg_recommendation(self, sampler_name: str) -> dict:
"""
Get CFG recommendation for the selected sampler.
Args:
sampler_name: The sampler algorithm name
Returns:
Dictionary with min, max, and default CFG values
"""
min_cfg, max_cfg, default_cfg = get_recommended_cfg_range(sampler_name)
return {
"min": min_cfg,
"max": max_cfg,
"default": default_cfg,
"recommendation": f"Recommended range: {min_cfg}-{max_cfg} CFG",
}
def get_combo_analysis(self, sampler_name: str, scheduler: str, steps: int, cfg: float) -> dict:
"""
Analyze the sampler combo configuration and provide recommendations.
Args:
sampler_name: The sampler algorithm name
scheduler: The scheduler algorithm name
steps: Number of sampling steps
cfg: CFG scale value
Returns:
Dictionary containing analysis and recommendations
"""
analysis = {
"sampler": sampler_name,
"scheduler": scheduler,
"steps": steps,
"cfg": cfg,
"valid": validate_sampler_settings(sampler_name, scheduler, steps, cfg),
"scheduler_suggestions": self.get_scheduler_suggestions(sampler_name),
"steps_rec": self.get_steps_recommendation(sampler_name),
"cfg_rec": self.get_cfg_recommendation(sampler_name),
}
# Add compatibility assessment
suggested_schedulers = self.get_scheduler_suggestions(sampler_name)
analysis["scheduler_compatible"] = scheduler in suggested_schedulers
# Add performance assessment
steps_rec = self.get_steps_recommendation(sampler_name)
analysis["steps_optimal"] = steps_rec["min"] <= steps <= steps_rec["max"]
cfg_rec = self.get_cfg_recommendation(sampler_name)
analysis["cfg_optimal"] = cfg_rec["min"] <= cfg <= cfg_rec["max"]
return analysis
@classmethod
def get_available_samplers(cls) -> list:
"""
Get list of available samplers.
Returns:
List of sampler names
"""
return list(SAMPLERS)
@classmethod
def get_available_schedulers(cls) -> list:
"""
Get list of available schedulers.
Returns:
List of scheduler names
"""
return list(SCHEDULERS)
def __str__(self) -> str:
"""String representation of the node."""
return f"SamplerComboNode(samplers={len(SAMPLERS)}, " f"schedulers={len(SCHEDULERS)})"
def __repr__(self) -> str:
"""Detailed string representation of the node."""
return (
f"SamplerComboNode("
f"samplers={len(SAMPLERS)}, "
f"schedulers={len(SCHEDULERS)}, "
f"category='{self.CATEGORY}', "
f"function='{self.FUNCTION}'"
f")"
)
+3 -10
View File
@@ -66,9 +66,7 @@ def sanitize_seed_value(seed: Any) -> int:
raise ValueError(f"Invalid seed value: {seed}") from e
def create_history_entry(
seed: int, timestamp: Optional[float] = None
) -> Dict[str, Any]:
def create_history_entry(seed: int, timestamp: Optional[float] = None) -> Dict[str, Any]:
"""
Create a standardized history entry for a seed.
@@ -89,9 +87,7 @@ def create_history_entry(
}
def filter_duplicate_seeds(
history: List[Dict[str, Any]], new_seed: int, dedup_window_ms: int = 500
) -> bool:
def filter_duplicate_seeds(history: List[Dict[str, Any]], new_seed: int, dedup_window_ms: int = 500) -> bool:
"""
Check if a seed should be filtered as a duplicate.
@@ -107,7 +103,6 @@ def filter_duplicate_seeds(
return False
current_time = time.time() * 1000 # Convert to milliseconds
dedup_window_sec = dedup_window_ms / 1000.0
# Check most recent entry for duplicates within window
latest_entry = history[0]
@@ -194,9 +189,7 @@ def format_time_ago(timestamp: float) -> str:
return f"{seconds}s ago"
def search_history_by_seed(
history: List[Dict[str, Any]], seed: int
) -> Optional[Dict[str, Any]]:
def search_history_by_seed(history: List[Dict[str, Any]], seed: int) -> Optional[Dict[str, Any]]:
"""
Search history for a specific seed value.
+10 -7
View File
@@ -28,8 +28,7 @@ class SeedHistoryNode(ComfyAssetsBaseNode):
"default": 12345,
"min": 0,
"max": 0xFFFFFFFFFFFFFFFF,
"tooltip": "Seed value for generation processes. "
"History UI tracks all changes automatically.",
"tooltip": "Seed value for generation processes. " "History UI tracks all changes automatically.",
},
),
}
@@ -53,9 +52,11 @@ class SeedHistoryNode(ComfyAssetsBaseNode):
try:
# Validate and sanitize the seed
if not validate_seed_value(seed):
self.handle_error(
f"Invalid seed value: {seed}. Using fallback seed 12345."
)
# Log the validation error but don't raise
import logging
logger = logging.getLogger(__name__)
logger.error(f"{self.__class__.__name__}: Invalid seed value: {seed}. " f"Using fallback seed 12345.")
return (12345,)
clean_seed = sanitize_seed_value(seed)
@@ -64,8 +65,10 @@ class SeedHistoryNode(ComfyAssetsBaseNode):
except Exception as e:
# Handle any unexpected errors gracefully
error_msg = f"Error processing seed: {str(e)}. Using fallback seed 12345."
self.handle_error(error_msg)
import logging
logger = logging.getLogger(__name__)
logger.error(f"{self.__class__.__name__}: Error processing seed: {str(e)}. " f"Using fallback seed 12345.")
return (12345,)
def generate_new_seed(self) -> int:
@@ -5,9 +5,7 @@ from math import gcd
from .presets import PRESET_OPTIONS
def get_preset_dimensions(
preset: str, custom_width: int, custom_height: int
) -> Tuple[int, int]:
def get_preset_dimensions(preset: str, custom_width: int, custom_height: int) -> Tuple[int, int]:
"""
Get dimensions from preset name or use custom dimensions.
@@ -114,9 +112,7 @@ def sanitize_dimensions(width: int, height: int) -> Tuple[int, int]:
return width, height
def get_dimension_info(
preset: str, width: int, height: int, swap_enabled: bool
) -> dict:
def get_dimension_info(preset: str, width: int, height: int, swap_enabled: bool) -> dict:
"""
Get comprehensive dimension information including metadata.
@@ -205,9 +201,7 @@ def parse_dimension_string(dimension_str: str) -> Tuple[int, int]:
raise ValueError(f"Could not parse dimensions from {dimension_str}: {e}")
def get_optimal_scale_factor(
current_width: int, current_height: int, target_width: int, target_height: int
) -> float:
def get_optimal_scale_factor(current_width: int, current_height: int, target_width: int, target_height: int) -> float:
"""
Calculate optimal scale factor to get from current to target dimensions.
+119 -28
View File
@@ -4,14 +4,15 @@ from typing import Tuple
from ...base.base_node import ComfyAssetsBaseNode
from .logic import (
get_preset_dimensions,
calculate_aspect_ratio,
validate_dimensions,
sanitize_dimensions,
)
from .presets import (
PRESET_OPTIONS,
PRESET_DESCRIPTIONS,
PRESET_METADATA,
get_model_recommendation,
get_preset_metadata,
get_presets_by_model_group,
)
@@ -26,18 +27,31 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
@classmethod
def INPUT_TYPES(cls):
"""Define the input types for the ComfyUI node."""
# Get all preset options excluding the custom tuple
preset_keys = [key for key in PRESET_OPTIONS.keys()]
# Create formatted preset options with metadata
preset_options = ["custom"] # Custom first
# Add formatted presets with metadata
for preset_name in PRESET_OPTIONS.keys():
if preset_name != "custom":
metadata = PRESET_METADATA.get(preset_name)
if metadata:
formatted_option = (
f"{preset_name} - {metadata.aspect_ratio} " f"({metadata.megapixels:.1f}MP) - {metadata.model_group}"
)
preset_options.append(formatted_option)
else:
preset_options.append(preset_name)
return {
"required": {
"preset": (
preset_keys,
preset_options,
{
"default": "custom",
"tooltip": "Select from optimized resolution presets or use custom dimensions. "
"SDXL presets are ~1MP, FLUX presets are higher resolution, "
"Ultra-wide presets support modern aspect ratios.",
"tooltip": "Select from optimized resolution presets or use "
"custom dimensions. SDXL presets are ~1MP, FLUX presets are "
"higher resolution, Ultra-wide presets support modern "
"aspect ratios.",
},
),
"width": (
@@ -48,7 +62,8 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
"max": 8192,
"step": 8,
"tooltip": "Custom width in pixels (must be multiple of 8). "
"Used when preset is 'custom' or as fallback for invalid presets.",
"Used when preset is 'custom' or as fallback for invalid "
"presets.",
},
),
"height": (
@@ -59,7 +74,8 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
"max": 8192,
"step": 8,
"tooltip": "Custom height in pixels (must be multiple of 8). "
"Used when preset is 'custom' or as fallback for invalid presets.",
"Used when preset is 'custom' or as fallback for invalid "
"presets.",
},
),
}
@@ -75,7 +91,7 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
Get width and height dimensions with preset and swap support.
Args:
preset: Selected preset name or "custom"
preset: Selected preset name or formatted preset string
width: Custom width value
height: Custom height value
@@ -83,8 +99,11 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
Tuple of (width, height)
"""
try:
# Extract original preset name from formatted string if needed
original_preset = self._extract_preset_name(preset)
# Get base dimensions from preset or custom input
final_width, final_height = get_preset_dimensions(preset, width, height)
final_width, final_height = get_preset_dimensions(original_preset, width, height)
# Sanitize dimensions to ensure they meet ComfyUI requirements
final_width, final_height = sanitize_dimensions(final_width, final_height)
@@ -93,8 +112,7 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
if not validate_dimensions(final_width, final_height):
# This should not happen after sanitization, but handle gracefully
self.handle_error(
f"Generated invalid dimensions: {final_width}×{final_height}. "
f"Using fallback dimensions 1024×1024."
f"Generated invalid dimensions: {final_width}×{final_height}. " f"Using fallback dimensions 1024×1024."
)
final_width, final_height = 1024, 1024
@@ -102,12 +120,41 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
except Exception as e:
# Handle any unexpected errors gracefully
error_msg = (
f"Error processing dimensions: {str(e)}. Using fallback 1024×1024."
)
error_msg = f"Error processing dimensions: {str(e)}. Using fallback 1024×1024."
self.handle_error(error_msg)
return (1024, 1024)
def _extract_preset_name(self, formatted_preset: str) -> str:
"""
Extract the original preset name from a formatted preset string.
Args:
formatted_preset: Either original preset name or formatted string
Returns:
Original preset name
"""
# If it's already "custom", return as-is
if formatted_preset == "custom":
return formatted_preset
# If it contains formatting metadata, extract the resolution part
if " - " in formatted_preset:
# Format is: "1024×1024 - 1:1 (1.0MP) - SDXL"
# Extract the first part (resolution)
resolution_part = formatted_preset.split(" - ")[0]
# Verify this is a valid preset name
if resolution_part in PRESET_OPTIONS:
return resolution_part
# If no formatting or not found, check if it's directly a valid preset
if formatted_preset in PRESET_OPTIONS:
return formatted_preset
# Default to "custom" if we can't parse it
return "custom"
def get_preset_info(self, preset: str) -> str:
"""
Get descriptive information about a preset.
@@ -121,14 +168,9 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
if preset == "custom":
return "Custom dimensions - use the width and height inputs below"
if preset in PRESET_DESCRIPTIONS:
return PRESET_DESCRIPTIONS[preset]
# Fallback for unknown presets
if preset in PRESET_OPTIONS:
width, height = PRESET_OPTIONS[preset]
aspect_ratio = calculate_aspect_ratio(width, height)
return f"{preset} - {aspect_ratio} aspect ratio"
metadata = get_preset_metadata(preset)
if metadata.width > 0: # Valid metadata
return f"{preset} - {metadata.aspect_ratio} ({metadata.megapixels:.1f}MP) - " f"{metadata.description}"
return f"Unknown preset: {preset}"
@@ -149,19 +191,22 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
Validate node inputs.
Args:
preset: Preset name
preset: Preset name or formatted preset string
width: Width value
height: Height value
Returns:
True if inputs are valid
"""
# Extract original preset name
original_preset = self._extract_preset_name(preset)
# Check if preset exists or is custom
if preset != "custom" and preset not in PRESET_OPTIONS:
if original_preset != "custom" and original_preset not in PRESET_OPTIONS:
return False
# For custom preset, validate dimensions
if preset == "custom":
if original_preset == "custom":
if not validate_dimensions(width, height):
return False
@@ -192,6 +237,52 @@ class WidthHeightSelectorNode(ComfyAssetsBaseNode):
return PRESET_OPTIONS[preset]
return (0, 0)
@classmethod
def get_presets_by_model(cls, model_group: str) -> dict:
"""
Get all presets for a specific model group with metadata.
Args:
model_group: Model group name ("SDXL", "FLUX", "Ultra-Wide")
Returns:
Dictionary of presets with metadata
"""
return get_presets_by_model_group(model_group)
@classmethod
def get_preset_metadata_static(cls, preset: str) -> dict:
"""
Get metadata for a preset as a dictionary.
Args:
preset: Preset name
Returns:
Dictionary with metadata information
"""
metadata = get_preset_metadata(preset)
return {
"width": metadata.width,
"height": metadata.height,
"aspect_ratio": metadata.aspect_ratio,
"aspect_decimal": metadata.aspect_decimal,
"megapixels": metadata.megapixels,
"model_group": metadata.model_group,
"category": metadata.category,
"description": metadata.description,
}
@classmethod
def get_model_groups(cls) -> list:
"""
Get list of available model groups.
Returns:
List of model group names
"""
return list(set(metadata.model_group for metadata in PRESET_METADATA.values()))
def __str__(self) -> str:
"""String representation of the node."""
return f"WidthHeightSelectorNode(presets={len(PRESET_OPTIONS)})"
+378 -96
View File
@@ -1,114 +1,377 @@
"""Preset definitions for Width Height Selector."""
from typing import Dict, Tuple
from typing import Dict, Tuple, NamedTuple
from fractions import Fraction
# SDXL optimized presets (~1 megapixel, dimensions divisible by 8)
class PresetMetadata(NamedTuple):
"""Metadata for a resolution preset."""
width: int
height: int
aspect_ratio: str
aspect_decimal: float
megapixels: float
model_group: str
category: str
description: str
def calculate_aspect_ratio(width: int, height: int) -> Tuple[str, float]:
"""Calculate aspect ratio as string and decimal."""
fraction = Fraction(width, height)
decimal = width / height
return f"{fraction.numerator}:{fraction.denominator}", decimal
# Enhanced preset definitions with full metadata
PRESET_METADATA: Dict[str, PresetMetadata] = {
# SDXL Presets - Square
"1024×1024": PresetMetadata(
1024,
1024,
"1:1",
1.0,
1.05,
"SDXL",
"Square",
"SDXL base resolution - perfect square",
),
# SDXL Presets - Portrait
"896×1152": PresetMetadata(
896,
1152,
"7:9",
0.778,
1.03,
"SDXL",
"Portrait",
"SDXL portrait 7:9 - moderate portrait",
),
"832×1216": PresetMetadata(
832,
1216,
"13:19",
0.684,
1.01,
"SDXL",
"Portrait",
"SDXL portrait 13:19 - standard portrait",
),
"768×1344": PresetMetadata(
768,
1344,
"4:7",
0.571,
1.03,
"SDXL",
"Portrait",
"SDXL portrait 4:7 - tall portrait",
),
"640×1536": PresetMetadata(
640,
1536,
"5:12",
0.417,
0.98,
"SDXL",
"Portrait",
"SDXL portrait 5:12 - very tall portrait",
),
# SDXL Presets - Landscape
"1152×896": PresetMetadata(
1152,
896,
"9:7",
1.286,
1.03,
"SDXL",
"Landscape",
"SDXL landscape 9:7 - moderate landscape",
),
"1216×832": PresetMetadata(
1216,
832,
"19:13",
1.462,
1.01,
"SDXL",
"Landscape",
"SDXL landscape 19:13 - standard landscape",
),
"1344×768": PresetMetadata(
1344,
768,
"7:4",
1.750,
1.03,
"SDXL",
"Landscape",
"SDXL landscape 7:4 - wide landscape",
),
"1536×640": PresetMetadata(
1536,
640,
"12:5",
2.400,
0.98,
"SDXL",
"Landscape",
"SDXL landscape 12:5 - very wide landscape",
),
# FLUX Presets - High Quality
"1920×1080": PresetMetadata(
1920,
1080,
"16:9",
1.778,
2.07,
"FLUX",
"Cinematic",
"FLUX Full HD 16:9 - best quality/speed balance",
),
"1536×1536": PresetMetadata(
1536,
1536,
"1:1",
1.0,
2.36,
"FLUX",
"Square",
"FLUX high-res square - premium quality",
),
"1280×768": PresetMetadata(
1280,
768,
"5:3",
1.667,
0.98,
"FLUX",
"Cinematic",
"FLUX 5:3 landscape - cinematic wide",
),
"768×1280": PresetMetadata(
768,
1280,
"3:5",
0.600,
0.98,
"FLUX",
"Portrait",
"FLUX 3:5 portrait - mobile optimized",
),
# FLUX Presets - Alternative
"1440×1080": PresetMetadata(
1440,
1080,
"4:3",
1.333,
1.56,
"FLUX",
"Classic",
"FLUX 4:3 classic - traditional aspect ratio",
),
"1080×1440": PresetMetadata(
1080,
1440,
"3:4",
0.750,
1.56,
"FLUX",
"Portrait",
"FLUX 3:4 portrait - classic portrait",
),
"1728×1152": PresetMetadata(
1728,
1152,
"3:2",
1.500,
1.99,
"FLUX",
"Photography",
"FLUX 3:2 photo - photography standard",
),
"1152×1728": PresetMetadata(
1152,
1728,
"2:3",
0.667,
1.99,
"FLUX",
"Portrait",
"FLUX 2:3 portrait - portrait photography",
),
# Ultra-Wide Presets - Landscape
"2560×1080": PresetMetadata(
2560,
1080,
"64:27",
2.370,
2.76,
"Ultra-Wide",
"Gaming",
"Ultra-wide 64:27 - gaming/panoramic",
),
"2048×768": PresetMetadata(
2048,
768,
"8:3",
2.667,
1.57,
"Ultra-Wide",
"Cinematic",
"Wide cinematic 8:3 - movie aspect",
),
"1792×768": PresetMetadata(
1792,
768,
"7:3",
2.333,
1.38,
"Ultra-Wide",
"Panoramic",
"Panoramic 7:3 - landscape vista",
),
"2304×768": PresetMetadata(
2304,
768,
"3:1",
3.000,
1.77,
"Ultra-Wide",
"Banner",
"Banner 3:1 - extreme wide banner",
),
# Ultra-Wide Presets - Portrait
"1080×2560": PresetMetadata(
1080,
2560,
"27:64",
0.422,
2.76,
"Ultra-Wide",
"Mobile",
"Mobile ultra-tall 27:64 - modern phones",
),
"768×2048": PresetMetadata(
768,
2048,
"3:8",
0.375,
1.57,
"Ultra-Wide",
"Vertical",
"Vertical cinematic 3:8 - portrait video",
),
"768×1792": PresetMetadata(
768,
1792,
"3:7",
0.429,
1.38,
"Ultra-Wide",
"Vertical",
"Vertical panoramic 3:7 - tall vista",
),
"768×2304": PresetMetadata(
768,
2304,
"1:3",
0.333,
1.77,
"Ultra-Wide",
"Banner",
"Vertical banner 1:3 - extreme tall banner",
),
}
# Legacy compatibility - maintain old preset dictionaries
SDXL_PRESETS: Dict[str, Tuple[int, int]] = {
# Square
"1024×1024": (1024, 1024), # 1:1 - Base SDXL resolution
# Portrait ratios
"896×1152": (896, 1152), # 7:9 - Moderate portrait
"832×1216": (832, 1216), # 13:19 - Standard portrait
"768×1344": (768, 1344), # 4:7 - Tall portrait
"640×1536": (640, 1536), # 5:12 - Very tall portrait
# Landscape ratios
"1152×896": (1152, 896), # 9:7 - Moderate landscape
"1216×832": (1216, 832), # 19:13 - Standard landscape
"1344×768": (1344, 768), # 7:4 - Wide landscape
"1536×640": (1536, 640), # 12:5 - Very wide landscape
k: (v.width, v.height) for k, v in PRESET_METADATA.items() if v.model_group == "SDXL"
}
# FLUX optimized presets (higher resolution, flexible ratios)
FLUX_PRESETS: Dict[str, Tuple[int, int]] = {
# Recommended high-quality resolutions
"1920×1080": (1920, 1080), # 16:9 - Full HD landscape
"1536×1536": (1536, 1536), # 1:1 - High-res square
"1280×768": (1280, 768), # 5:3 - Wide landscape
"768×1280": (768, 1280), # 3:5 - Tall portrait
# Alternative quality resolutions
"1440×1080": (1440, 1080), # 4:3 - Classic aspect ratio
"1080×1440": (1080, 1440), # 3:4 - Classic portrait
"1728×1152": (1728, 1152), # 3:2 - Photography standard
"1152×1728": (1152, 1728), # 2:3 - Portrait photography
k: (v.width, v.height) for k, v in PRESET_METADATA.items() if v.model_group == "FLUX"
}
# Ultra-wide and modern aspect ratios
ULTRA_WIDE_PRESETS: Dict[str, Tuple[int, int]] = {
# Ultra-wide landscape (21:9 and variants)
"2560×1080": (2560, 1080), # 64:27 - Ultra-wide gaming
"2048×768": (2048, 768), # 8:3 - Wide cinematic
"1792×768": (1792, 768), # 7:3 - Panoramic
# Ultra-wide portrait
"1080×2560": (1080, 2560), # 27:64 - Mobile ultra-tall
"768×2048": (768, 2048), # 3:8 - Vertical cinematic
"768×1792": (768, 1792), # 3:7 - Vertical panoramic
# Extreme ratios
"2304×768": (2304, 768), # 3:1 - Banner landscape
"768×2304": (768, 2304), # 1:3 - Banner portrait
k: (v.width, v.height) for k, v in PRESET_METADATA.items() if v.model_group == "Ultra-Wide"
}
# Combined preset options for ComfyUI dropdown
PRESET_OPTIONS: Dict[str, Tuple[int, int]] = {
"custom": (0, 0), # Special case for custom dimensions
**SDXL_PRESETS,
**FLUX_PRESETS,
**ULTRA_WIDE_PRESETS,
**{k: (v.width, v.height) for k, v in PRESET_METADATA.items()},
}
# Organized preset categories for better UX
# Enhanced preset categories organized by model groups and aspect ratios
PRESET_CATEGORIES = {
"Custom": ["custom"],
"SDXL Square": ["1024×1024"],
"SDXL Portrait": ["896×1152", "832×1216", "768×1344", "640×1536"],
"SDXL Landscape": ["1152×896", "1216×832", "1344×768", "1536×640"],
"FLUX Recommended": ["1920×1080", "1536×1536", "1280×768", "768×1280"],
"FLUX Alternative": ["1440×1080", "1080×1440", "1728×1152", "1152×1728"],
"Ultra-Wide Landscape": ["2560×1080", "2048×768", "1792×768", "2304×768"],
"Ultra-Wide Portrait": ["1080×2560", "768×2048", "768×1792", "768×2304"],
# SDXL Categories
"SDXL Square": [k for k, v in PRESET_METADATA.items() if v.model_group == "SDXL" and v.category == "Square"],
"SDXL Portrait": [k for k, v in PRESET_METADATA.items() if v.model_group == "SDXL" and v.category == "Portrait"],
"SDXL Landscape": [k for k, v in PRESET_METADATA.items() if v.model_group == "SDXL" and v.category == "Landscape"],
# FLUX Categories
"FLUX Square": [k for k, v in PRESET_METADATA.items() if v.model_group == "FLUX" and v.category == "Square"],
"FLUX Portrait": [k for k, v in PRESET_METADATA.items() if v.model_group == "FLUX" and v.category == "Portrait"],
"FLUX Cinematic": [k for k, v in PRESET_METADATA.items() if v.model_group == "FLUX" and v.category == "Cinematic"],
"FLUX Classic": [k for k, v in PRESET_METADATA.items() if v.model_group == "FLUX" and v.category == "Classic"],
"FLUX Photography": [k for k, v in PRESET_METADATA.items() if v.model_group == "FLUX" and v.category == "Photography"],
# Ultra-Wide Categories
"Ultra-Wide Gaming": [k for k, v in PRESET_METADATA.items() if v.model_group == "Ultra-Wide" and v.category == "Gaming"],
"Ultra-Wide Cinematic": [
k for k, v in PRESET_METADATA.items() if v.model_group == "Ultra-Wide" and v.category == "Cinematic"
],
"Ultra-Wide Panoramic": [
k for k, v in PRESET_METADATA.items() if v.model_group == "Ultra-Wide" and v.category == "Panoramic"
],
"Ultra-Wide Mobile": [k for k, v in PRESET_METADATA.items() if v.model_group == "Ultra-Wide" and v.category == "Mobile"],
"Ultra-Wide Vertical": [
k for k, v in PRESET_METADATA.items() if v.model_group == "Ultra-Wide" and v.category == "Vertical"
],
"Ultra-Wide Banner": [k for k, v in PRESET_METADATA.items() if v.model_group == "Ultra-Wide" and v.category == "Banner"],
}
# Preset descriptions for tooltips
PRESET_DESCRIPTIONS = {
# SDXL presets
"1024×1024": "SDXL base resolution - perfect square",
"896×1152": "SDXL portrait 7:9 - moderate portrait",
"832×1216": "SDXL portrait 13:19 - standard portrait",
"768×1344": "SDXL portrait 4:7 - tall portrait",
"640×1536": "SDXL portrait 5:12 - very tall portrait",
"1152×896": "SDXL landscape 9:7 - moderate landscape",
"1216×832": "SDXL landscape 19:13 - standard landscape",
"1344×768": "SDXL landscape 7:4 - wide landscape",
"1536×640": "SDXL landscape 12:5 - very wide landscape",
# FLUX presets
"1920×1080": "FLUX Full HD 16:9 - best quality/speed balance",
"1536×1536": "FLUX high-res square - premium quality",
"1280×768": "FLUX 5:3 landscape - cinematic wide",
"768×1280": "FLUX 3:5 portrait - mobile optimized",
"1440×1080": "FLUX 4:3 classic - traditional aspect ratio",
"1080×1440": "FLUX 3:4 portrait - classic portrait",
"1728×1152": "FLUX 3:2 photo - photography standard",
"1152×1728": "FLUX 2:3 portrait - portrait photography",
# Ultra-wide presets
"2560×1080": "Ultra-wide 64:27 - gaming/panoramic",
"2048×768": "Wide cinematic 8:3 - movie aspect",
"1792×768": "Panoramic 7:3 - landscape vista",
"2304×768": "Banner 3:1 - extreme wide banner",
"1080×2560": "Mobile ultra-tall 27:64 - modern phones",
"768×2048": "Vertical cinematic 3:8 - portrait video",
"768×1792": "Vertical panoramic 3:7 - tall vista",
"768×2304": "Vertical banner 1:3 - extreme tall banner",
}
# Legacy compatibility - preset descriptions
PRESET_DESCRIPTIONS = {k: v.description for k, v in PRESET_METADATA.items()}
# Model-specific recommendations
# Model-specific recommendations with metadata
MODEL_RECOMMENDATIONS = {
"SDXL": list(SDXL_PRESETS.keys()),
"FLUX": list(FLUX_PRESETS.keys()),
"Ultra-Wide": list(ULTRA_WIDE_PRESETS.keys()),
"SDXL": [k for k, v in PRESET_METADATA.items() if v.model_group == "SDXL"],
"FLUX": [k for k, v in PRESET_METADATA.items() if v.model_group == "FLUX"],
"Ultra-Wide": [k for k, v in PRESET_METADATA.items() if v.model_group == "Ultra-Wide"],
}
# New metadata-aware helper functions
def get_presets_by_model_group(model_group: str) -> Dict[str, PresetMetadata]:
"""Get all presets for a specific model group."""
return {k: v for k, v in PRESET_METADATA.items() if v.model_group == model_group}
def get_presets_by_aspect_ratio(aspect_ratio: str) -> Dict[str, PresetMetadata]:
"""Get all presets with a specific aspect ratio."""
return {k: v for k, v in PRESET_METADATA.items() if v.aspect_ratio == aspect_ratio}
def get_presets_by_category(category: str) -> Dict[str, PresetMetadata]:
"""Get all presets in a specific category."""
return {k: v for k, v in PRESET_METADATA.items() if v.category == category}
def get_preset_metadata(preset_name: str) -> PresetMetadata:
"""Get metadata for a specific preset."""
return PRESET_METADATA.get(
preset_name,
PresetMetadata(0, 0, "1:1", 1.0, 0.0, "Custom", "Custom", "Custom dimensions"),
)
def get_preset_category(preset_name: str) -> str:
"""Get the category for a given preset name."""
metadata = PRESET_METADATA.get(preset_name)
if metadata:
return metadata.category
for category, presets in PRESET_CATEGORIES.items():
if preset_name in presets:
return category
@@ -117,26 +380,20 @@ def get_preset_category(preset_name: str) -> str:
def get_model_recommendation(preset_name: str) -> str:
"""Get model recommendation for a given preset."""
if preset_name in SDXL_PRESETS:
return "Optimized for SDXL"
elif preset_name in FLUX_PRESETS:
return "Optimized for FLUX"
elif preset_name in ULTRA_WIDE_PRESETS:
return "Modern ultra-wide ratios"
else:
return "Custom dimensions"
metadata = PRESET_METADATA.get(preset_name)
if metadata:
return f"Optimized for {metadata.model_group}"
return "Custom dimensions"
def validate_preset_dimensions() -> bool:
"""Validate that all presets meet ComfyUI requirements."""
all_presets = {**SDXL_PRESETS, **FLUX_PRESETS, **ULTRA_WIDE_PRESETS}
for preset_name, metadata in PRESET_METADATA.items():
width, height = metadata.width, metadata.height
for preset_name, (width, height) in all_presets.items():
# Check divisible by 8
if width % 8 != 0 or height % 8 != 0:
print(
f"ERROR: {preset_name} dimensions not divisible by 8: {width}×{height}"
)
print(f"ERROR: {preset_name} dimensions not divisible by 8: {width}×{height}")
return False
# Check reasonable bounds
@@ -147,6 +404,31 @@ def validate_preset_dimensions() -> bool:
return True
# Additional validation for metadata consistency
def validate_metadata_consistency() -> bool:
"""Validate metadata consistency and completeness."""
for preset_name, metadata in PRESET_METADATA.items():
# Verify aspect ratio calculation
expected_ratio, expected_decimal = calculate_aspect_ratio(metadata.width, metadata.height)
if abs(metadata.aspect_decimal - expected_decimal) > 0.001:
print(
f"ERROR: {preset_name} aspect ratio mismatch: "
f"expected {expected_decimal:.3f}, got {metadata.aspect_decimal}"
)
return False
# Verify megapixel calculation
expected_mp = (metadata.width * metadata.height) / 1_000_000
if abs(metadata.megapixels - expected_mp) > 0.1:
print(f"ERROR: {preset_name} megapixel mismatch: " f"expected {expected_mp:.2f}, got {metadata.megapixels}")
return False
return True
# Validate presets on import
if not validate_preset_dimensions():
raise ValueError("Preset validation failed - check console for details")
if not validate_metadata_consistency():
raise ValueError("Metadata validation failed - check console for details")
+23
View File
@@ -0,0 +1,23 @@
[mypy]
python_version = 3.10
warn_return_any = True
warn_unused_configs = True
disallow_untyped_defs = False
ignore_missing_imports = True
no_strict_optional = True
files = kikotools
exclude = tests
# Ignore import errors from ComfyUI
[mypy-comfy.*]
ignore_errors = True
# Ignore errors for torch imports
[mypy-torch.*]
ignore_missing_imports = True
[mypy-numpy.*]
ignore_missing_imports = True
[mypy-PIL.*]
ignore_missing_imports = True
+95
View File
@@ -0,0 +1,95 @@
[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "kikotools"
description = "Simple tools for ComfyUI"
version = "1.0.7"
license = {text = "MIT"}
dependencies = []
[project.optional-dependencies]
dev = [
# Testing framework
"pytest>=7.0.0",
"pytest-cov>=4.0.0",
"pytest-mock>=3.10.0",
# Code quality
"black>=23.0.0",
"flake8>=6.0.0",
"mypy>=1.0.0",
# Development utilities
"pre-commit>=3.0.0",
# ComfyUI testing (mock dependencies for unit tests)
"torch>=2.0.0",
"numpy>=1.24.0",
"pillow>=9.0.0"
]
[project.urls]
Repository = "https://github.com/ComfyAssets/ComfyUI-KikoTools"
# Used by Comfy Registry https://registry.comfy.org
[tool.setuptools.packages.find]
include = ["kikotools*"]
exclude = ["tests*", "web*"]
[tool.comfy]
PublisherId = "kiko9"
DisplayName = "ComfyUI-KikoTools"
Icon = "https://avatars.githubusercontent.com/u/213204677?s=200"
includes = []
[tool.black]
line-length = 88
target-version = ['py310']
include = '\.pyi?$'
extend-exclude = '''
/(
# directories
\.eggs
| \.git
| \.hg
| \.mypy_cache
| \.tox
| \.venv
| build
| dist
)/
'''
[tool.mypy]
python_version = "3.10"
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = false
ignore_missing_imports = true
no_strict_optional = true
files = ["kikotools"]
exclude = ["tests"]
[tool.pytest.ini_options]
minversion = "7.0"
testpaths = ["tests"]
addopts = "-ra -q --strict-markers"
markers = [
"unit: Unit tests",
"integration: Integration tests",
"slow: Slow tests"
]
[tool.coverage.run]
source = ["kikotools"]
omit = ["*/tests/*", "*/__init__.py"]
[tool.coverage.report]
exclude_lines = [
"pragma: no cover",
"def __repr__",
"if __name__ == .__main__.:",
"raise AssertionError",
"raise NotImplementedError",
"if 0:",
"if False:"
]
+1 -1
View File
@@ -2,4 +2,4 @@
testpaths = tests
python_paths = .
norecursedirs = venv .git __pycache__
addopts = --ignore=__init__.py --ignore=venv
addopts = --ignore=__init__.py --ignore=venv
+1 -1
View File
@@ -16,4 +16,4 @@ pre-commit>=3.0.0
# ComfyUI testing (mock dependencies for unit tests)
torch>=2.0.0
numpy>=1.24.0
pillow>=9.0.0
pillow>=9.0.0
+4
View File
@@ -0,0 +1,4 @@
# Runtime dependencies for ComfyUI-KikoTools
# Gemini API integration (optional - only needed for Gemini Prompt node)
google-generativeai>=0.3.0
+16
View File
@@ -0,0 +1,16 @@
#!/bin/bash
# Run mypy type checking on kikotools package
# This is used as an alternative to pre-commit due to package name issues
set -e
echo "Running mypy type checking..."
cd "$(dirname "$0")/.."
# Run mypy with the configuration
python -m mypy kikotools/ --ignore-missing-imports --no-strict-optional || {
echo "❌ Mypy type checking failed"
exit 1
}
echo "✓ Mypy type checking passed"
+3 -11
View File
@@ -5,8 +5,6 @@ Provides mock ComfyUI environments and test data
import pytest
import torch
import numpy as np
from typing import Dict, Any
from unittest.mock import MagicMock
@@ -104,18 +102,12 @@ def assert_divisible_by_8(width: int, height: int) -> None:
assert height % 8 == 0, f"Height {height} must be divisible by 8"
def assert_reasonable_dimensions(
width: int, height: int, min_size: int = 64, max_size: int = 8192
) -> None:
def assert_reasonable_dimensions(width: int, height: int, min_size: int = 64, max_size: int = 8192) -> None:
"""
Helper function to assert dimensions are within reasonable bounds
"""
assert (
min_size <= width <= max_size
), f"Width {width} out of reasonable range [{min_size}, {max_size}]"
assert (
min_size <= height <= max_size
), f"Height {height} out of reasonable range [{min_size}, {max_size}]"
assert min_size <= width <= max_size, f"Width {width} out of reasonable range [{min_size}, {max_size}]"
assert min_size <= height <= max_size, f"Height {height} out of reasonable range [{min_size}, {max_size}]"
# Make helper functions available as pytest fixtures
+3 -10
View File
@@ -4,8 +4,7 @@ Tests the shared functionality for all ComfyAssets tools
"""
import pytest
import logging
from unittest.mock import patch, MagicMock
from unittest.mock import patch
from kikotools.base import ComfyAssetsBaseNode
@@ -33,10 +32,7 @@ class TestComfyAssetsBaseNode:
node.handle_error("Test error message")
mock_logger.error.assert_called_once()
assert (
"ComfyAssetsBaseNode: Test error message"
in mock_logger.error.call_args[0][0]
)
assert "ComfyAssetsBaseNode: Test error message" in mock_logger.error.call_args[0][0]
def test_handle_error_with_exception_logs_exception(self):
"""Test error handling with original exception logs both messages"""
@@ -59,10 +55,7 @@ class TestComfyAssetsBaseNode:
node.log_info("Test information")
mock_logger.info.assert_called_once()
assert (
"ComfyAssetsBaseNode: Test information"
in mock_logger.info.call_args[0][0]
)
assert "ComfyAssetsBaseNode: Test information" in mock_logger.info.call_args[0][0]
def test_get_node_info_returns_metadata(self):
"""Test get_node_info returns correct metadata"""
+219
View File
@@ -0,0 +1,219 @@
"""Tests for Empty Latent Batch node and logic."""
import pytest
import torch
from kikotools.tools.empty_latent_batch.node import EmptyLatentBatchNode
from kikotools.tools.empty_latent_batch.logic import (
create_empty_latent_batch,
validate_dimensions,
sanitize_dimensions,
)
class TestEmptyLatentBatchLogic:
"""Test the logic functions for empty latent batch creation."""
def test_create_empty_latent_batch_basic(self):
"""Test basic empty latent creation."""
result = create_empty_latent_batch(512, 512, 1)
assert "samples" in result
samples = result["samples"]
assert isinstance(samples, torch.Tensor)
assert samples.shape == (1, 4, 64, 64) # 512/8 = 64
assert torch.all(samples == 0) # Should be all zeros
def test_create_empty_latent_batch_with_batch_size(self):
"""Test empty latent creation with larger batch size."""
batch_size = 4
result = create_empty_latent_batch(1024, 768, batch_size)
assert "samples" in result
samples = result["samples"]
assert isinstance(samples, torch.Tensor)
assert samples.shape == (4, 4, 96, 128) # 768/8=96, 1024/8=128
assert torch.all(samples == 0)
def test_create_empty_latent_batch_invalid_dimensions(self):
"""Test error handling for invalid dimensions."""
with pytest.raises(ValueError, match="Width and height must be positive"):
create_empty_latent_batch(0, 512, 1)
with pytest.raises(ValueError, match="Width and height must be positive"):
create_empty_latent_batch(512, -100, 1)
def test_create_empty_latent_batch_not_divisible_by_8(self):
"""Test error handling for dimensions not divisible by 8."""
with pytest.raises(ValueError, match="must be divisible by 8"):
create_empty_latent_batch(513, 512, 1)
with pytest.raises(ValueError, match="must be divisible by 8"):
create_empty_latent_batch(512, 515, 1)
def test_create_empty_latent_batch_invalid_batch_size(self):
"""Test error handling for invalid batch size."""
with pytest.raises(ValueError, match="Batch size must be positive"):
create_empty_latent_batch(512, 512, 0)
with pytest.raises(ValueError, match="Batch size must be positive"):
create_empty_latent_batch(512, 512, -1)
def test_validate_dimensions_valid(self):
"""Test dimension validation with valid inputs."""
assert validate_dimensions(512, 512) is True
assert validate_dimensions(1024, 768) is True
assert validate_dimensions(64, 64) is True # Minimum size
assert validate_dimensions(8192, 8192) is True # Maximum size
def test_validate_dimensions_invalid(self):
"""Test dimension validation with invalid inputs."""
assert validate_dimensions(0, 512) is False # Zero dimension
assert validate_dimensions(512, -100) is False # Negative dimension
assert validate_dimensions(513, 512) is False # Not divisible by 8
assert validate_dimensions(32, 32) is False # Too small
assert validate_dimensions(8200, 8200) is False # Too large
def test_sanitize_dimensions_basic(self):
"""Test basic dimension sanitization."""
width, height = sanitize_dimensions(512, 512)
assert width == 512
assert height == 512
def test_sanitize_dimensions_not_divisible_by_8(self):
"""Test sanitization of dimensions not divisible by 8."""
width, height = sanitize_dimensions(513, 515)
assert width == 512 # Rounds down to nearest multiple of 8
assert height == 512
width, height = sanitize_dimensions(517, 519)
assert width == 520 # Rounds up to nearest multiple of 8
assert height == 520
def test_sanitize_dimensions_too_small(self):
"""Test sanitization of dimensions that are too small."""
width, height = sanitize_dimensions(32, 16)
assert width == 64 # Minimum size
assert height == 64
def test_sanitize_dimensions_too_large(self):
"""Test sanitization of dimensions that are too large."""
width, height = sanitize_dimensions(10000, 9000)
assert width == 8192 # Maximum size
assert height == 8192
class TestEmptyLatentBatchNode:
"""Test the EmptyLatentBatchNode ComfyUI node."""
def setup_method(self):
"""Set up test fixtures."""
self.node = EmptyLatentBatchNode()
def test_input_types_structure(self):
"""Test that INPUT_TYPES returns proper structure."""
input_types = EmptyLatentBatchNode.INPUT_TYPES()
assert "required" in input_types
required = input_types["required"]
assert "width" in required
assert "height" in required
assert "batch_size" in required
# Check width parameter
width_spec = required["width"]
assert width_spec[0] == "INT"
assert width_spec[1]["default"] == 1024
assert width_spec[1]["min"] == 64
assert width_spec[1]["max"] == 8192
assert width_spec[1]["step"] == 8
def test_node_attributes(self):
"""Test node class attributes."""
assert EmptyLatentBatchNode.RETURN_TYPES == ("LATENT",)
assert EmptyLatentBatchNode.RETURN_NAMES == ("latent",)
assert EmptyLatentBatchNode.FUNCTION == "create_empty_latent"
assert EmptyLatentBatchNode.CATEGORY == "ComfyAssets"
def test_create_empty_latent_basic(self):
"""Test basic empty latent creation through node."""
result = self.node.create_empty_latent(512, 512, 1)
assert isinstance(result, tuple)
assert len(result) == 1
latent_dict = result[0]
assert isinstance(latent_dict, dict)
assert "samples" in latent_dict
samples = latent_dict["samples"]
assert isinstance(samples, torch.Tensor)
assert samples.shape == (1, 4, 64, 64)
def test_create_empty_latent_with_batch(self):
"""Test empty latent creation with batch size."""
batch_size = 3
result = self.node.create_empty_latent(1024, 768, batch_size)
latent_dict = result[0]
samples = latent_dict["samples"]
assert samples.shape == (3, 4, 96, 128) # batch=3, 768/8=96, 1024/8=128
def test_create_empty_latent_dimension_adjustment(self):
"""Test that dimensions are adjusted when not divisible by 8."""
# Input dimensions not divisible by 8
result = self.node.create_empty_latent(513, 515, 1)
latent_dict = result[0]
samples = latent_dict["samples"]
# Should be adjusted to 512x512 -> 64x64 latent
assert samples.shape == (1, 4, 64, 64)
def test_validate_inputs_valid(self):
"""Test input validation with valid parameters."""
assert self.node.validate_inputs(512, 512, 1) is True
assert self.node.validate_inputs(1024, 768, 4) is True
def test_validate_inputs_invalid_batch_size(self):
"""Test input validation with invalid batch size."""
assert self.node.validate_inputs(512, 512, 0) is False
assert self.node.validate_inputs(512, 512, 100) is False # Too large
def test_get_latent_info(self):
"""Test latent info generation."""
info = self.node.get_latent_info(512, 512, 2)
assert "Empty latent batch" in info
assert "2 × 4 × 64 × 64" in info
assert "512×512" in info
def test_get_memory_estimate(self):
"""Test memory estimation."""
estimate = self.node.get_memory_estimate(512, 512, 1)
assert "KB" in estimate or "MB" in estimate
# Larger batch should show larger estimate
large_estimate = self.node.get_memory_estimate(1024, 1024, 8)
assert "MB" in large_estimate
def test_node_registration_mappings(self):
"""Test that node registration mappings are properly defined."""
from kikotools.tools.empty_latent_batch.node import (
NODE_CLASS_MAPPINGS,
NODE_DISPLAY_NAME_MAPPINGS,
)
assert "EmptyLatentBatch" in NODE_CLASS_MAPPINGS
assert NODE_CLASS_MAPPINGS["EmptyLatentBatch"] == EmptyLatentBatchNode
assert "EmptyLatentBatch" in NODE_DISPLAY_NAME_MAPPINGS
assert NODE_DISPLAY_NAME_MAPPINGS["EmptyLatentBatch"] == "Empty Latent Batch"
def test_node_inheritance(self):
"""Test that node properly inherits from base class."""
from kikotools.base.base_node import ComfyAssetsBaseNode
assert isinstance(self.node, ComfyAssetsBaseNode)
assert hasattr(self.node, "handle_error")
assert hasattr(self.node, "log_info")
assert hasattr(self.node, "validate_inputs")
@@ -0,0 +1,193 @@
"""Unit tests for ImageToMultipleOf tool."""
import pytest
import torch
import sys
from pathlib import Path
# Add the project root to the Python path for tests
sys.path.insert(0, str(Path(__file__).parent.parent.parent.parent))
from kikotools.tools.image_to_multiple_of.logic import (
calculate_dimensions_to_multiple,
process_image_to_multiple_of,
)
from kikotools.tools.image_to_multiple_of.node import ImageToMultipleOfNode
class TestImageToMultipleOfLogic:
"""Test core logic functions."""
def test_calculate_dimensions_to_multiple(self):
"""Test dimension calculation for various inputs."""
# Test exact multiples
assert calculate_dimensions_to_multiple(256, 512, 64) == (256, 512)
# Test non-exact multiples
assert calculate_dimensions_to_multiple(300, 400, 64) == (256, 384)
assert calculate_dimensions_to_multiple(150, 200, 32) == (128, 192)
# Test small values
assert calculate_dimensions_to_multiple(10, 20, 8) == (8, 16)
# Test with multiple_of = 1 (should return original)
assert calculate_dimensions_to_multiple(123, 456, 1) == (123, 456)
def test_process_image_center_crop(self):
"""Test center crop processing."""
# Create test image (batch=1, height=300, width=400, channels=3)
image = torch.rand(1, 300, 400, 3)
# Process with center crop
result = process_image_to_multiple_of(image, 64, "center crop")
# Check dimensions
assert result.shape == (1, 256, 384, 3)
# Check that center portion is preserved
# The crop should start at (22, 8) and end at (278, 392)
# This is a rough check that values are from the center
assert result.dtype == image.dtype
def test_process_image_rescale(self):
"""Test rescale processing."""
# Create test image
image = torch.rand(1, 300, 400, 3)
# Process with rescale
result = process_image_to_multiple_of(image, 64, "rescale")
# Check dimensions
assert result.shape == (1, 256, 384, 3)
assert result.dtype == image.dtype
def test_process_image_batch(self):
"""Test processing with batch of images."""
# Create batch of images
batch_size = 4
image = torch.rand(batch_size, 300, 400, 3)
# Process with center crop
result_crop = process_image_to_multiple_of(image, 32, "center crop")
assert result_crop.shape == (batch_size, 288, 384, 3)
# Process with rescale
result_rescale = process_image_to_multiple_of(image, 32, "rescale")
assert result_rescale.shape == (batch_size, 288, 384, 3)
def test_process_image_different_channels(self):
"""Test with different channel counts."""
# Test with 1 channel (grayscale)
image_gray = torch.rand(1, 256, 256, 1)
result = process_image_to_multiple_of(image_gray, 64, "center crop")
assert result.shape == (1, 256, 256, 1)
# Test with 4 channels (RGBA)
image_rgba = torch.rand(1, 300, 400, 4)
result = process_image_to_multiple_of(image_rgba, 64, "rescale")
assert result.shape == (1, 256, 384, 4)
class TestImageToMultipleOfNode:
"""Test ComfyUI node implementation."""
def test_node_input_types(self):
"""Test node input type definitions."""
input_types = ImageToMultipleOfNode.INPUT_TYPES()
assert "required" in input_types
assert "image" in input_types["required"]
assert "multiple_of" in input_types["required"]
assert "method" in input_types["required"]
# Check multiple_of configuration
multiple_config = input_types["required"]["multiple_of"][1]
assert multiple_config["default"] == 64
assert multiple_config["min"] == 1
assert multiple_config["max"] == 256
assert multiple_config["step"] == 16
# Check method options
methods = input_types["required"]["method"][0]
assert "center crop" in methods
assert "rescale" in methods
def test_node_metadata(self):
"""Test node metadata."""
assert ImageToMultipleOfNode.RETURN_TYPES == ("IMAGE",)
assert ImageToMultipleOfNode.RETURN_NAMES == ("image",)
assert ImageToMultipleOfNode.FUNCTION == "process"
assert ImageToMultipleOfNode.CATEGORY == "ComfyAssets"
def test_node_process_center_crop(self):
"""Test node processing with center crop."""
node = ImageToMultipleOfNode()
image = torch.rand(1, 300, 400, 3)
result = node.process(image, 64, "center crop")
assert isinstance(result, tuple)
assert len(result) == 1
assert result[0].shape == (1, 256, 384, 3)
def test_node_process_rescale(self):
"""Test node processing with rescale."""
node = ImageToMultipleOfNode()
image = torch.rand(1, 300, 400, 3)
result = node.process(image, 32, "rescale")
assert isinstance(result, tuple)
assert len(result) == 1
assert result[0].shape == (1, 288, 384, 3)
def test_node_validation_errors(self):
"""Test input validation error handling."""
node = ImageToMultipleOfNode()
# Test with None image
with pytest.raises(ValueError, match="Image input is required"):
node.validate_inputs(image=None, multiple_of=64, method="center crop")
# Test with invalid image shape
invalid_image = torch.rand(300, 400, 3) # Missing batch dimension
with pytest.raises(ValueError, match="Expected image tensor with shape"):
node.validate_inputs(
image=invalid_image, multiple_of=64, method="center crop"
)
# Test with negative multiple_of
image = torch.rand(1, 300, 400, 3)
with pytest.raises(ValueError, match="multiple_of must be positive"):
node.validate_inputs(image=image, multiple_of=-64, method="center crop")
# Test with invalid method
with pytest.raises(ValueError, match="Invalid method"):
node.validate_inputs(image=image, multiple_of=64, method="invalid")
# Test with image too small
small_image = torch.rand(1, 30, 40, 3)
with pytest.raises(ValueError, match="too small to be adjusted"):
node.validate_inputs(
image=small_image, multiple_of=64, method="center crop"
)
def test_node_edge_cases(self):
"""Test edge cases."""
node = ImageToMultipleOfNode()
# Test with already multiple dimensions
image = torch.rand(1, 256, 512, 3)
result = node.process(image, 64, "center crop")
assert result[0].shape == image.shape
# Test with multiple_of = 1
image = torch.rand(1, 123, 456, 3)
result = node.process(image, 1, "center crop")
assert result[0].shape == image.shape
# Test with very large multiple_of
image = torch.rand(1, 1024, 1024, 3)
result = node.process(image, 256, "rescale")
assert result[0].shape == (1, 1024, 1024, 3)
+536
View File
@@ -0,0 +1,536 @@
"""
Unit tests for KikoSaveImage tool
Tests image saving functionality with multiple formats and quality settings
"""
import pytest
import torch
import tempfile
import os
from PIL import Image
from unittest.mock import patch
from kikotools.tools.kiko_save_image.node import KikoSaveImageNode
from kikotools.tools.kiko_save_image.logic import (
convert_tensor_to_pil,
process_image_batch,
validate_save_inputs,
save_image_with_format,
get_save_image_path,
create_png_metadata,
)
class TestKikoSaveImageLogic:
"""Test core logic functions"""
def test_convert_tensor_to_pil(self):
"""Test tensor to PIL conversion"""
# Create test tensor [height, width, channels] with values 0-1
tensor = torch.rand(64, 64, 3)
# Convert to PIL
pil_image = convert_tensor_to_pil(tensor)
# Verify conversion
assert isinstance(pil_image, Image.Image)
assert pil_image.size == (64, 64) # PIL uses (width, height)
assert pil_image.mode in ["RGB", "RGBA"]
def test_convert_tensor_to_pil_rgba(self):
"""Test tensor to PIL conversion with alpha channel"""
# Create RGBA tensor
tensor = torch.rand(32, 32, 4)
pil_image = convert_tensor_to_pil(tensor)
assert isinstance(pil_image, Image.Image)
assert pil_image.size == (32, 32)
assert pil_image.mode == "RGBA"
def test_get_save_image_path(self):
"""Test save path generation"""
with tempfile.TemporaryDirectory() as temp_dir:
# Test basic path generation
full_path, filename = get_save_image_path("test_prefix", 0, ".png", temp_dir)
assert full_path.startswith(temp_dir)
assert filename.startswith("test_prefix_")
assert filename.endswith("_00000.png")
# Test with empty subfolder (standard behavior)
full_path, filename = get_save_image_path("test", 1, ".jpg", temp_dir, "")
assert full_path.startswith(temp_dir)
assert filename.startswith("test_")
assert filename.endswith("_00001.jpg")
def test_create_png_metadata(self):
"""Test PNG metadata creation"""
# Test with no metadata
metadata = create_png_metadata()
assert metadata is None
# Test with prompt data
prompt_data = {"test": "value"}
metadata = create_png_metadata(prompt=prompt_data)
assert metadata is not None
# Check that metadata contains our data (implementation detail)
assert hasattr(metadata, "text")
@patch("kikotools.tools.kiko_save_image.logic.folder_paths")
def test_process_image_batch_png(self, mock_folder_paths):
"""Test batch processing with PNG format"""
with tempfile.TemporaryDirectory() as temp_dir:
mock_folder_paths.get_output_directory.return_value = temp_dir
# Create test image batch [batch, height, width, channels]
images = torch.rand(2, 32, 32, 3)
# Process batch
results, enhanced_data = process_image_batch(
images=images,
filename_prefix="test_batch",
format_type="PNG",
png_compress_level=6,
)
# Verify results (clean data)
assert len(results) == 2
for i, result in enumerate(results):
assert "filename" in result
assert "subfolder" in result
assert "type" in result
assert result["type"] == "output"
# Verify enhanced data
assert len(enhanced_data) == 2
for i, enhanced in enumerate(enhanced_data):
assert enhanced["format"] == "PNG"
assert enhanced["compress_level"] == 6
assert enhanced["dimensions"] == "32x32"
assert enhanced["popup"] is True # Default popup value
assert "file_size" in enhanced
# Verify file was saved
filepath = os.path.join(temp_dir, enhanced["filename"])
assert os.path.exists(filepath)
# Verify image can be loaded
saved_img = Image.open(filepath)
assert saved_img.size == (32, 32)
@patch("kikotools.tools.kiko_save_image.logic.folder_paths")
def test_process_image_batch_jpeg(self, mock_folder_paths):
"""Test batch processing with JPEG format"""
with tempfile.TemporaryDirectory() as temp_dir:
mock_folder_paths.get_output_directory.return_value = temp_dir
# Create test image batch
images = torch.rand(1, 64, 64, 3)
# Process batch
results, enhanced_data = process_image_batch(
images=images,
filename_prefix="test_jpeg",
format_type="JPEG",
quality=85,
)
# Verify results
assert len(results) == 1
assert len(enhanced_data) == 1
enhanced = enhanced_data[0]
assert enhanced["format"] == "JPEG"
assert enhanced["quality"] == 85
assert enhanced["filename"].endswith(".jpg")
# Verify file exists and can be loaded
filepath = os.path.join(temp_dir, results[0]["filename"])
assert os.path.exists(filepath)
saved_img = Image.open(filepath)
assert saved_img.size == (64, 64)
assert saved_img.mode == "RGB" # JPEG converts to RGB
@patch("kikotools.tools.kiko_save_image.logic.folder_paths")
def test_process_image_batch_webp(self, mock_folder_paths):
"""Test batch processing with WebP format"""
with tempfile.TemporaryDirectory() as temp_dir:
mock_folder_paths.get_output_directory.return_value = temp_dir
# Create test image batch
images = torch.rand(1, 48, 48, 3)
# Test lossless WebP
results = process_image_batch(
images=images,
filename_prefix="test_webp",
format_type="WEBP",
quality=90,
webp_lossless=True,
)
assert len(results) == 1
result = results[0]
assert result["format"] == "WEBP"
assert result["lossless"] is True
assert result["filename"].endswith(".webp")
def test_validate_save_inputs_valid(self):
"""Test input validation with valid inputs"""
images = torch.rand(2, 64, 64, 3)
# Should not raise exception
validate_save_inputs(images, "PNG", 90, 4)
validate_save_inputs(images, "JPEG", 85, 4)
validate_save_inputs(images, "WEBP", 95, 6)
def test_validate_save_inputs_invalid_tensor(self):
"""Test validation with invalid tensor"""
# Wrong tensor dimensions
invalid_tensor = torch.rand(64, 64) # Missing batch and channel dims
with pytest.raises(ValueError, match="4 dimensions"):
validate_save_inputs(invalid_tensor, "PNG", 90, 4)
# Non-tensor input
with pytest.raises(ValueError, match="torch.Tensor"):
validate_save_inputs("not_a_tensor", "PNG", 90, 4)
def test_validate_save_inputs_invalid_format(self):
"""Test validation with invalid format"""
images = torch.rand(1, 32, 32, 3)
with pytest.raises(ValueError, match="format must be one of"):
validate_save_inputs(images, "BMP", 90, 4)
def test_validate_save_inputs_invalid_quality(self):
"""Test validation with invalid quality"""
images = torch.rand(1, 32, 32, 3)
# Quality out of range
with pytest.raises(ValueError, match="quality must be an integer between 1 and 100"):
validate_save_inputs(images, "JPEG", 0, 4)
with pytest.raises(ValueError, match="quality must be an integer between 1 and 100"):
validate_save_inputs(images, "JPEG", 101, 4)
def test_validate_save_inputs_invalid_compress_level(self):
"""Test validation with invalid PNG compression level"""
images = torch.rand(1, 32, 32, 3)
with pytest.raises(ValueError, match="png_compress_level must be an integer between 0 and 9"):
validate_save_inputs(images, "PNG", 90, -1)
with pytest.raises(ValueError, match="png_compress_level must be an integer between 0 and 9"):
validate_save_inputs(images, "PNG", 90, 10)
def test_save_image_with_format_png(self):
"""Test saving with PNG format"""
with tempfile.NamedTemporaryFile(suffix=".png", delete=False) as temp_file:
temp_path = temp_file.name
try:
# Create test PIL image
img = Image.new("RGB", (32, 32), color="red")
# Save with PNG format
result = save_image_with_format(img, temp_path, "PNG", png_compress_level=8)
assert result["format"] == "PNG"
assert result["compress_level"] == 8
assert os.path.exists(temp_path)
# Verify saved image
saved_img = Image.open(temp_path)
assert saved_img.size == (32, 32)
finally:
if os.path.exists(temp_path):
os.unlink(temp_path)
def test_save_image_with_format_jpeg_rgba_conversion(self):
"""Test JPEG saving with RGBA to RGB conversion"""
with tempfile.NamedTemporaryFile(suffix=".jpg", delete=False) as temp_file:
temp_path = temp_file.name
try:
# Create RGBA image
img = Image.new("RGBA", (32, 32), color=(255, 0, 0, 128))
# Save as JPEG (should convert to RGB)
result = save_image_with_format(img, temp_path, "JPEG", quality=95)
assert result["format"] == "JPEG"
assert result["quality"] == 95
# Verify saved image is RGB
saved_img = Image.open(temp_path)
assert saved_img.mode == "RGB"
finally:
if os.path.exists(temp_path):
os.unlink(temp_path)
class TestKikoSaveImageNode:
"""Test KikoSaveImageNode class"""
def setup_method(self):
"""Setup test fixtures"""
self.node = KikoSaveImageNode()
def test_input_types(self):
"""Test INPUT_TYPES class method"""
input_types = KikoSaveImageNode.INPUT_TYPES()
# Check required inputs
required = input_types["required"]
assert "images" in required
assert "filename_prefix" in required
assert "format" in required
# Check format options
format_options = required["format"][0]
assert "PNG" in format_options
assert "JPEG" in format_options
assert "WEBP" in format_options
# Check optional inputs
optional = input_types["optional"]
assert "quality" in optional
assert "png_compress_level" in optional
assert "webp_lossless" in optional
assert "popup" in optional
# Check hidden inputs
hidden = input_types["hidden"]
assert "prompt" in hidden
assert "extra_pnginfo" in hidden
def test_node_attributes(self):
"""Test node class attributes"""
assert KikoSaveImageNode.RETURN_TYPES == ()
assert KikoSaveImageNode.FUNCTION == "save_images"
assert KikoSaveImageNode.OUTPUT_NODE is True
assert KikoSaveImageNode.CATEGORY == "ComfyAssets"
@patch("kikotools.tools.kiko_save_image.node.process_image_batch")
def test_save_images_success(self, mock_process):
"""Test successful image saving"""
# Setup mock - new return format (results, enhanced_data)
mock_results = [
{
"filename": "test_00001_00000.png",
"subfolder": "",
"type": "output",
}
]
mock_enhanced = [
{
"filename": "test_00001_00000.png",
"popup": True,
"type": "output",
"format": "PNG",
"file_size": 1024,
"dimensions": "64x64",
}
]
mock_process.return_value = (mock_results, mock_enhanced)
# Create test input
images = torch.rand(1, 64, 64, 3)
# Call save_images
result = self.node.save_images(
images=images,
filename_prefix="test",
format="PNG",
quality=90,
png_compress_level=4,
)
# Verify mock was called
mock_process.assert_called_once()
# Verify result format
assert "ui" in result
assert "images" in result["ui"]
assert "kiko_enhanced" in result["ui"]
assert result["ui"]["images"] == mock_results
assert result["ui"]["kiko_enhanced"] == mock_enhanced
def test_validate_inputs_success(self):
"""Test input validation with valid inputs"""
images = torch.rand(1, 32, 32, 3)
# Should not raise exception
self.node.validate_inputs(
images=images,
format="PNG",
quality=90,
png_compress_level=4,
webp_lossless=False,
popup=True,
)
def test_validate_inputs_invalid_webp_lossless(self):
"""Test validation with invalid webp_lossless type"""
images = torch.rand(1, 32, 32, 3)
with pytest.raises(ValueError, match="webp_lossless must be a boolean"):
self.node.validate_inputs(
images=images,
format="PNG",
quality=90,
png_compress_level=4,
webp_lossless="not_boolean",
popup=True,
)
def test_validate_inputs_invalid_popup(self):
"""Test validation with invalid popup"""
images = torch.rand(1, 32, 32, 3)
# Non-boolean popup
with pytest.raises(ValueError, match="popup must be a boolean"):
self.node.validate_inputs(
images=images,
format="PNG",
quality=90,
png_compress_level=4,
webp_lossless=False,
popup="not_boolean",
)
@patch("kikotools.tools.kiko_save_image.node.process_image_batch")
def test_save_images_error_handling(self, mock_process):
"""Test error handling in save_images method"""
# Setup mock to raise exception
mock_process.side_effect = Exception("Test error")
images = torch.rand(1, 32, 32, 3)
# Should handle error and re-raise with context
with pytest.raises(ValueError, match="Failed to save images"):
self.node.save_images(images=images)
def test_node_info(self):
"""Test get_node_info method"""
info = self.node.get_node_info()
assert info["class_name"] == "KikoSaveImageNode"
assert info["category"] == "ComfyAssets"
assert info["function"] == "save_images"
class TestNodeRegistration:
"""Test node registration mappings"""
def test_node_class_mappings(self):
"""Test NODE_CLASS_MAPPINGS contains KikoSaveImage"""
from kikotools.tools.kiko_save_image.node import NODE_CLASS_MAPPINGS
assert "KikoSaveImage" in NODE_CLASS_MAPPINGS
assert NODE_CLASS_MAPPINGS["KikoSaveImage"] is KikoSaveImageNode
def test_node_display_name_mappings(self):
"""Test NODE_DISPLAY_NAME_MAPPINGS contains KikoSaveImage"""
from kikotools.tools.kiko_save_image.node import NODE_DISPLAY_NAME_MAPPINGS
assert "KikoSaveImage" in NODE_DISPLAY_NAME_MAPPINGS
assert NODE_DISPLAY_NAME_MAPPINGS["KikoSaveImage"] == "Kiko Save Image"
# Integration test fixtures
@pytest.fixture
def sample_image_tensor():
"""Create sample image tensor for testing"""
# Create a colorful test image [batch, height, width, channels]
batch_size, height, width, channels = 2, 64, 64, 3
# Create gradient pattern
tensor = torch.zeros(batch_size, height, width, channels)
for b in range(batch_size):
for h in range(height):
for w in range(width):
# Create RGB gradient pattern
tensor[b, h, w, 0] = h / height # Red gradient
tensor[b, h, w, 1] = w / width # Green gradient
tensor[b, h, w, 2] = (b + 1) * 0.5 # Blue varies by batch
return tensor
class TestIntegration:
"""Integration tests using sample data"""
@patch("kikotools.tools.kiko_save_image.logic.folder_paths")
def test_full_pipeline_png(self, mock_folder_paths, sample_image_tensor):
"""Test complete pipeline with PNG format"""
with tempfile.TemporaryDirectory() as temp_dir:
mock_folder_paths.get_output_directory.return_value = temp_dir
node = KikoSaveImageNode()
# Save images
result = node.save_images(
images=sample_image_tensor,
filename_prefix="integration_test",
format="PNG",
png_compress_level=6,
)
# Verify result structure
assert "ui" in result
assert "images" in result["ui"]
assert len(result["ui"]["images"]) == 2
# Verify files were created
for image_info in result["ui"]["images"]:
filepath = os.path.join(temp_dir, image_info["filename"])
assert os.path.exists(filepath)
# Verify image properties
img = Image.open(filepath)
assert img.size == (64, 64)
assert img.format == "PNG"
@patch("kikotools.tools.kiko_save_image.logic.folder_paths")
def test_full_pipeline_all_formats(self, mock_folder_paths, sample_image_tensor):
"""Test complete pipeline with all supported formats"""
with tempfile.TemporaryDirectory() as temp_dir:
mock_folder_paths.get_output_directory.return_value = temp_dir
node = KikoSaveImageNode()
# Test each format
formats_to_test = [
("PNG", {"png_compress_level": 8}),
("JPEG", {"quality": 85}),
("WEBP", {"quality": 90, "webp_lossless": False}),
("WEBP", {"quality": 100, "webp_lossless": True}),
]
for format_type, kwargs in formats_to_test:
result = node.save_images(
images=sample_image_tensor,
filename_prefix=f"test_{format_type.lower()}",
format=format_type,
**kwargs,
)
# Verify results
assert len(result["ui"]["images"]) == 2
for image_info in result["ui"]["images"]:
assert image_info["format"] == format_type
# Verify file exists and can be opened
filepath = os.path.join(temp_dir, image_info["filename"])
assert os.path.exists(filepath)
img = Image.open(filepath)
assert img.size == (64, 64)
+8 -27
View File
@@ -5,7 +5,6 @@ Following TDD principles - these tests define the expected behavior
import pytest
import torch
from unittest.mock import patch, MagicMock
# Import the modules we're going to test (they don't exist yet - TDD!)
from kikotools.tools.resolution_calculator.logic import (
@@ -57,13 +56,9 @@ class TestDimensionExtraction:
with pytest.raises(ValueError, match="Either image or latent must be provided"):
extract_dimensions()
def test_extract_dimensions_both_inputs_prefers_image(
self, mock_image_tensor, mock_latent_tensor
):
def test_extract_dimensions_both_inputs_prefers_image(self, mock_image_tensor, mock_latent_tensor):
"""Test that when both inputs provided, image takes precedence"""
width, height = extract_dimensions(
image=mock_image_tensor, latent=mock_latent_tensor
)
width, height = extract_dimensions(image=mock_image_tensor, latent=mock_latent_tensor)
# Should return image dimensions, not latent
assert width == 832
@@ -94,9 +89,7 @@ class TestScaledDimensionsCalculation:
original_width, original_height = 832, 1216
scale_factor = 1.5
new_width, new_height = calculate_scaled_dimensions(
original_width, original_height, scale_factor
)
new_width, new_height = calculate_scaled_dimensions(original_width, original_height, scale_factor)
# Check aspect ratio is preserved (within floating point precision)
original_ratio = original_width / original_height
@@ -108,9 +101,7 @@ class TestScaledDimensionsCalculation:
base_width, base_height = 1024, 1024
for scale_factor in sample_scale_factors:
width, height = calculate_scaled_dimensions(
base_width, base_height, scale_factor
)
width, height = calculate_scaled_dimensions(base_width, base_height, scale_factor)
expected_width = int(base_width * scale_factor)
expected_height = int(base_height * scale_factor)
@@ -172,8 +163,6 @@ class TestResolutionCalculatorNode:
def test_node_has_correct_comfyui_attributes(self):
"""Test node has all required ComfyUI attributes"""
node = ResolutionCalculatorNode()
# Check class attributes exist
assert hasattr(ResolutionCalculatorNode, "INPUT_TYPES")
assert hasattr(ResolutionCalculatorNode, "RETURN_TYPES")
@@ -216,9 +205,7 @@ class TestResolutionCalculatorNode:
"""Test node calculation with IMAGE input"""
node = ResolutionCalculatorNode()
width, height = node.calculate_resolution(
scale_factor=2.0, image=mock_image_tensor
)
width, height = node.calculate_resolution(scale_factor=2.0, image=mock_image_tensor)
# Original: 832x1216, 2x scale = 1664x2432
assert isinstance(width, int)
@@ -233,9 +220,7 @@ class TestResolutionCalculatorNode:
"""Test node calculation with LATENT input"""
node = ResolutionCalculatorNode()
width, height = node.calculate_resolution(
scale_factor=1.5, latent=mock_latent_tensor
)
width, height = node.calculate_resolution(scale_factor=1.5, latent=mock_latent_tensor)
# Original: 832x1216, 1.5x scale = 1248x1824
assert isinstance(width, int)
@@ -253,16 +238,12 @@ class TestResolutionCalculatorNode:
with pytest.raises(ValueError):
node.calculate_resolution(scale_factor=2.0)
def test_calculate_resolution_with_various_scale_factors(
self, mock_image_tensor_square, sample_scale_factors
):
def test_calculate_resolution_with_various_scale_factors(self, mock_image_tensor_square, sample_scale_factors):
"""Test calculation with various scale factors"""
node = ResolutionCalculatorNode()
for scale_factor in sample_scale_factors:
width, height = node.calculate_resolution(
scale_factor=scale_factor, image=mock_image_tensor_square
)
width, height = node.calculate_resolution(scale_factor=scale_factor, image=mock_image_tensor_square)
# All results should be integers divisible by 8
assert isinstance(width, int)
+350
View File
@@ -0,0 +1,350 @@
"""Tests for Sampler Combo node."""
import pytest
from unittest.mock import patch
from kikotools.tools.sampler_combo.node import SamplerComboNode
from kikotools.tools.sampler_combo.logic import (
validate_sampler_settings,
get_sampler_combo,
get_compatible_scheduler_suggestions,
get_recommended_steps_range,
get_recommended_cfg_range,
get_sampler_info,
SAMPLERS,
SCHEDULERS,
)
class TestSamplerComboLogic:
"""Test cases for sampler combo logic functions."""
def test_validate_sampler_settings_valid(self):
"""Test validation with valid settings."""
assert validate_sampler_settings("euler", "normal", 20, 7.0) is True
assert validate_sampler_settings("dpmpp_2m", "karras", 15, 8.5) is True
assert validate_sampler_settings("ddim", "ddim_uniform", 30, 6.0) is True
def test_validate_sampler_settings_invalid_sampler(self):
"""Test validation with invalid sampler."""
assert validate_sampler_settings("invalid_sampler", "normal", 20, 7.0) is False
def test_validate_sampler_settings_invalid_scheduler(self):
"""Test validation with invalid scheduler."""
assert validate_sampler_settings("euler", "invalid_scheduler", 20, 7.0) is False
def test_validate_sampler_settings_invalid_steps(self):
"""Test validation with invalid steps."""
assert validate_sampler_settings("euler", "normal", 0, 7.0) is False
assert validate_sampler_settings("euler", "normal", 1001, 7.0) is False
assert validate_sampler_settings("euler", "normal", -5, 7.0) is False
def test_validate_sampler_settings_invalid_cfg(self):
"""Test validation with invalid CFG."""
assert validate_sampler_settings("euler", "normal", 20, -1.0) is False
assert validate_sampler_settings("euler", "normal", 20, 31.0) is False
def test_get_sampler_combo_valid(self):
"""Test getting sampler combo with valid inputs."""
result = get_sampler_combo("euler", "normal", 20, 7.0)
assert result == ("euler", "normal", 20, 7.0)
result = get_sampler_combo("dpmpp_2m", "karras", 25, 8.5)
assert result == ("dpmpp_2m", "karras", 25, 8.5)
def test_get_sampler_combo_invalid_returns_defaults(self):
"""Test that invalid inputs return safe defaults."""
result = get_sampler_combo("invalid", "normal", 20, 7.0)
assert result == ("euler", "normal", 20, 7.0)
result = get_sampler_combo("euler", "invalid", 20, 7.0)
assert result == ("euler", "normal", 20, 7.0)
def test_get_sampler_combo_sanitizes_values(self):
"""Test that values are sanitized to valid ranges."""
# Test steps clamping
result = get_sampler_combo("euler", "normal", 0, 7.0)
assert result[2] >= 1 # steps should be at least 1
result = get_sampler_combo("euler", "normal", 1500, 7.0)
assert result[2] <= 1000 # steps should be at most 1000
# Test CFG clamping
result = get_sampler_combo("euler", "normal", 20, -5.0)
assert result[3] >= 0.0 # CFG should be at least 0
result = get_sampler_combo("euler", "normal", 20, 50.0)
assert result[3] <= 30.0 # CFG should be at most 30
def test_get_compatible_scheduler_suggestions(self):
"""Test getting scheduler suggestions for different samplers."""
suggestions = get_compatible_scheduler_suggestions("euler")
assert isinstance(suggestions, list)
assert len(suggestions) > 0
assert "normal" in suggestions
suggestions = get_compatible_scheduler_suggestions("ddim")
assert "ddim_uniform" in suggestions
# Test unknown sampler returns defaults
suggestions = get_compatible_scheduler_suggestions("unknown_sampler")
assert "normal" in suggestions
assert "karras" in suggestions
def test_get_recommended_steps_range(self):
"""Test getting recommended steps range for samplers."""
min_steps, max_steps, default_steps = get_recommended_steps_range("euler")
assert isinstance(min_steps, int)
assert isinstance(max_steps, int)
assert isinstance(default_steps, int)
assert min_steps <= default_steps <= max_steps
assert min_steps > 0
# Test unknown sampler returns defaults
min_steps, max_steps, default_steps = get_recommended_steps_range("unknown")
assert min_steps == 10
assert max_steps == 50
assert default_steps == 20
def test_get_recommended_cfg_range(self):
"""Test getting recommended CFG range for samplers."""
min_cfg, max_cfg, default_cfg = get_recommended_cfg_range("euler")
assert isinstance(min_cfg, float)
assert isinstance(max_cfg, float)
assert isinstance(default_cfg, float)
assert min_cfg <= default_cfg <= max_cfg
assert min_cfg >= 0.0
# Test unknown sampler returns defaults
min_cfg, max_cfg, default_cfg = get_recommended_cfg_range("unknown")
assert min_cfg == 1.0
assert max_cfg == 20.0
assert default_cfg == 7.0
def test_get_sampler_info(self):
"""Test getting sampler information."""
info = get_sampler_info()
assert isinstance(info, dict)
assert "samplers" in info
assert "schedulers" in info
assert "sampler_count" in info
assert "scheduler_count" in info
assert info["sampler_count"] == len(SAMPLERS)
assert info["scheduler_count"] == len(SCHEDULERS)
class TestSamplerComboNode:
"""Test cases for SamplerComboNode."""
def setup_method(self):
"""Set up test fixtures."""
self.node = SamplerComboNode()
def test_input_types_structure(self):
"""Test that INPUT_TYPES returns correct structure."""
input_types = SamplerComboNode.INPUT_TYPES()
assert "required" in input_types
required = input_types["required"]
# Check all required inputs are present
assert "sampler_name" in required
assert "scheduler" in required
assert "steps" in required
assert "cfg" in required
# Check sampler input structure
sampler_input = required["sampler_name"]
assert sampler_input[0] == SAMPLERS
assert isinstance(sampler_input[1], dict)
assert "default" in sampler_input[1]
assert "tooltip" in sampler_input[1]
# Check scheduler input structure
scheduler_input = required["scheduler"]
assert scheduler_input[0] == SCHEDULERS
assert isinstance(scheduler_input[1], dict)
# Check steps input structure
steps_input = required["steps"]
assert steps_input[0] == "INT"
assert steps_input[1]["min"] == 1
assert steps_input[1]["max"] == 100
# Check CFG input structure
cfg_input = required["cfg"]
assert cfg_input[0] == "FLOAT"
assert cfg_input[1]["min"] == 0.0
assert cfg_input[1]["max"] == 20.0
def test_return_types_structure(self):
"""Test that return types are correctly defined."""
assert SamplerComboNode.RETURN_TYPES == ("SAMPLER", SCHEDULERS, "INT", "FLOAT")
assert SamplerComboNode.RETURN_NAMES == (
"sampler_name",
"scheduler",
"steps",
"cfg",
)
assert SamplerComboNode.FUNCTION == "get_sampler_combo"
assert SamplerComboNode.CATEGORY == "ComfyAssets"
def test_get_sampler_combo_valid_inputs(self):
"""Test get_sampler_combo with valid inputs."""
result = self.node.get_sampler_combo("euler", "normal", 20, 7.0)
assert result == ("euler", "normal", 20, 7.0)
result = self.node.get_sampler_combo("dpmpp_2m", "karras", 15, 8.5)
assert result == ("dpmpp_2m", "karras", 15, 8.5)
def test_get_sampler_combo_invalid_inputs_returns_defaults(self):
"""Test that invalid inputs return safe defaults."""
with patch.object(self.node, "handle_error") as mock_error:
mock_error.side_effect = ValueError("Invalid settings")
try:
result = self.node.get_sampler_combo("invalid", "normal", 20, 7.0)
except ValueError:
pass # Expected when handle_error raises
# Test with exception handling bypassed
with patch(
"kikotools.tools.sampler_combo.node.validate_sampler_settings",
return_value=False,
):
result = self.node.get_sampler_combo("invalid", "normal", 20, 7.0)
assert result == ("euler", "normal", 20, 7.0)
def test_validate_inputs_valid(self):
"""Test input validation with valid inputs."""
# Should not raise any exception
self.node.validate_inputs("euler", "normal", 20, 7.0)
def test_validate_inputs_invalid(self):
"""Test input validation with invalid inputs."""
with pytest.raises(ValueError):
self.node.validate_inputs("invalid", "normal", 20, 7.0)
def test_get_scheduler_suggestions(self):
"""Test getting scheduler suggestions."""
suggestions = self.node.get_scheduler_suggestions("euler")
assert isinstance(suggestions, list)
assert len(suggestions) > 0
suggestions = self.node.get_scheduler_suggestions("ddim")
assert "ddim_uniform" in suggestions
def test_get_steps_recommendation(self):
"""Test getting steps recommendations."""
rec = self.node.get_steps_recommendation("euler")
assert isinstance(rec, dict)
assert "min" in rec
assert "max" in rec
assert "default" in rec
assert "recommendation" in rec
def test_get_cfg_recommendation(self):
"""Test getting CFG recommendations."""
rec = self.node.get_cfg_recommendation("euler")
assert isinstance(rec, dict)
assert "min" in rec
assert "max" in rec
assert "default" in rec
assert "recommendation" in rec
def test_get_combo_analysis(self):
"""Test getting combo analysis."""
analysis = self.node.get_combo_analysis("euler", "normal", 20, 7.0)
assert isinstance(analysis, dict)
assert "sampler" in analysis
assert "scheduler" in analysis
assert "steps" in analysis
assert "cfg" in analysis
assert "valid" in analysis
assert "scheduler_suggestions" in analysis
assert "scheduler_compatible" in analysis
assert "steps_optimal" in analysis
assert "cfg_optimal" in analysis
def test_get_available_samplers(self):
"""Test getting available samplers."""
samplers = SamplerComboNode.get_available_samplers()
assert isinstance(samplers, list)
assert len(samplers) > 0
assert "euler" in samplers
def test_get_available_schedulers(self):
"""Test getting available schedulers."""
schedulers = SamplerComboNode.get_available_schedulers()
assert isinstance(schedulers, list)
assert len(schedulers) > 0
assert "normal" in schedulers
def test_string_representations(self):
"""Test string representations of the node."""
str_repr = str(self.node)
assert "SamplerComboNode" in str_repr
assert "samplers=" in str_repr
assert "schedulers=" in str_repr
repr_str = repr(self.node)
assert "SamplerComboNode" in repr_str
assert "category=" in repr_str
assert "function=" in repr_str
def test_node_inheritance(self):
"""Test that node properly inherits from base class."""
from kikotools.base.base_node import ComfyAssetsBaseNode
assert isinstance(self.node, ComfyAssetsBaseNode)
assert hasattr(self.node, "validate_inputs")
assert hasattr(self.node, "handle_error")
assert hasattr(self.node, "log_info")
class TestSamplerComboIntegration:
"""Integration tests for Sampler Combo functionality."""
def test_full_workflow_valid_settings(self):
"""Test complete workflow with valid settings."""
node = SamplerComboNode()
# Test with different sampler/scheduler combinations
test_cases = [
("euler", "normal", 20, 7.0),
("dpmpp_2m", "karras", 15, 8.0),
("euler_ancestral", "exponential", 25, 9.0),
("ddim", "ddim_uniform", 30, 6.0),
]
for sampler, scheduler, steps, cfg in test_cases:
result = node.get_sampler_combo(sampler, scheduler, steps, cfg)
assert result == (sampler, scheduler, steps, cfg)
def test_recommendation_compatibility(self):
"""Test that recommendations are compatible with actual functionality."""
node = SamplerComboNode()
for sampler in SAMPLERS[:5]: # Test first 5 samplers
suggestions = node.get_scheduler_suggestions(sampler)
steps_rec = node.get_steps_recommendation(sampler)
cfg_rec = node.get_cfg_recommendation(sampler)
# Test that recommendations work with the node
for scheduler in suggestions[:2]: # Test first 2 suggestions
result = node.get_sampler_combo(sampler, scheduler, steps_rec["default"], cfg_rec["default"])
assert result[0] == sampler
assert result[1] == scheduler
assert result[2] == steps_rec["default"]
assert result[3] == cfg_rec["default"]
def test_error_recovery(self):
"""Test error recovery with malformed inputs."""
node = SamplerComboNode()
# These should all return safe defaults due to error handling
with patch(
"kikotools.tools.sampler_combo.logic.validate_sampler_settings",
side_effect=Exception("Simulated error"),
):
result = node.get_sampler_combo("euler", "normal", 20, 7.0)
assert result == ("euler", "normal", 20, 7.0) # Safe defaults
-3
View File
@@ -1,7 +1,6 @@
"""Tests for Seed History tool."""
import time
from unittest.mock import Mock
from kikotools.tools.seed_history.node import SeedHistoryNode
from kikotools.tools.seed_history.logic import (
@@ -24,8 +23,6 @@ class TestSeedHistoryNode:
def test_node_structure(self):
"""Test that node has correct ComfyUI structure."""
node = SeedHistoryNode()
# Test class attributes
assert hasattr(SeedHistoryNode, "INPUT_TYPES")
assert hasattr(SeedHistoryNode, "RETURN_TYPES")
+289 -22
View File
@@ -1,7 +1,5 @@
"""Tests for Width Height Selector tool."""
import pytest
from unittest.mock import Mock
from kikotools.tools.width_height_selector.node import WidthHeightSelectorNode
from kikotools.tools.width_height_selector.logic import (
get_preset_dimensions,
@@ -10,9 +8,12 @@ from kikotools.tools.width_height_selector.logic import (
)
from kikotools.tools.width_height_selector.presets import (
PRESET_OPTIONS,
PRESET_METADATA,
SDXL_PRESETS,
FLUX_PRESETS,
ULTRA_WIDE_PRESETS,
get_preset_metadata,
get_presets_by_model_group,
)
@@ -44,7 +45,8 @@ class TestWidthHeightSelectorNode:
assert result == (1920, 1080)
def test_sdxl_square_preset(self):
"""Test SDXL square preset."""
"""Test SDXL square preset (supports both raw and formatted)."""
# Test raw preset
result = self.node.get_dimensions(
preset="1024×1024",
width=512, # Should be ignored
@@ -52,45 +54,88 @@ class TestWidthHeightSelectorNode:
)
assert result == (1024, 1024)
# Test formatted preset
result = self.node.get_dimensions(
preset="1024×1024 - 1:1 (1.1MP) - SDXL",
width=512, # Should be ignored
height=512, # Should be ignored
)
assert result == (1024, 1024)
def test_sdxl_portrait_preset(self):
"""Test SDXL portrait preset."""
"""Test SDXL portrait preset (supports both raw and formatted)."""
# Test raw preset
result = self.node.get_dimensions(preset="832×1216", width=512, height=512)
assert result == (832, 1216)
# Test formatted preset if available
formatted_preset = "832×1216 - 13:19 (1.0MP) - SDXL"
result = self.node.get_dimensions(preset=formatted_preset, width=512, height=512)
assert result == (832, 1216)
def test_sdxl_landscape_preset(self):
"""Test SDXL landscape preset."""
"""Test SDXL landscape preset (supports both raw and formatted)."""
# Test raw preset
result = self.node.get_dimensions(preset="1216×832", width=512, height=512)
assert result == (1216, 832)
# Test formatted preset if available
formatted_preset = "1216×832 - 19:13 (1.0MP) - SDXL"
result = self.node.get_dimensions(preset=formatted_preset, width=512, height=512)
assert result == (1216, 832)
def test_flux_preset(self):
"""Test FLUX preset."""
"""Test FLUX preset (supports both raw and formatted)."""
# Test raw preset
result = self.node.get_dimensions(preset="1920×1080", width=512, height=512)
assert result == (1920, 1080)
# Test formatted preset
formatted_preset = "1920×1080 - 16:9 (2.1MP) - FLUX"
result = self.node.get_dimensions(preset=formatted_preset, width=512, height=512)
assert result == (1920, 1080)
def test_ultra_wide_preset(self):
"""Test ultra-wide preset."""
"""Test ultra-wide preset (supports both raw and formatted)."""
# Test raw preset
result = self.node.get_dimensions(preset="2560×1080", width=512, height=512)
assert result == (2560, 1080)
# Test formatted preset if available
formatted_preset = "2560×1080 - 64:27 (2.8MP) - Ultra-Wide"
result = self.node.get_dimensions(preset=formatted_preset, width=512, height=512)
assert result == (2560, 1080)
def test_all_presets_available(self):
"""Test that all presets are available in INPUT_TYPES."""
input_types = self.node.INPUT_TYPES()
available_presets = input_types["required"]["preset"][0]
# Check that all major preset categories are available
# Check that custom is available
assert "custom" in available_presets
assert "1024×1024" in available_presets # SDXL square
assert "832×1216" in available_presets # SDXL portrait
assert "1216×832" in available_presets # SDXL landscape
assert "1920×1080" in available_presets # FLUX
assert "2560×1080" in available_presets # Ultra-wide
# Check that formatted presets are available (with metadata)
# Extract raw preset names from formatted options
raw_presets = []
for option in available_presets:
if option == "custom":
raw_presets.append(option)
elif " - " in option:
raw_presets.append(option.split(" - ")[0])
else:
raw_presets.append(option)
# Check that all major preset categories are available
assert "1024×1024" in raw_presets # SDXL square
assert "832×1216" in raw_presets # SDXL portrait
assert "1216×832" in raw_presets # SDXL landscape
assert "1920×1080" in raw_presets # FLUX
assert "2560×1080" in raw_presets # Ultra-wide
def test_invalid_preset_fallback(self):
"""Test handling of invalid preset."""
# Should fall back to custom dimensions
result = self.node.get_dimensions(
preset="invalid_preset", width=800, height=600
)
result = self.node.get_dimensions(preset="invalid_preset", width=800, height=600)
assert result == (800, 600)
@@ -213,18 +258,14 @@ class TestPresetDefinitions:
for preset_dict in [SDXL_PRESETS, FLUX_PRESETS, ULTRA_WIDE_PRESETS]:
for preset_name, (width, height) in preset_dict.items():
assert width % 8 == 0, f"{preset_name} width {width} not divisible by 8"
assert (
height % 8 == 0
), f"{preset_name} height {height} not divisible by 8"
assert height % 8 == 0, f"{preset_name} height {height} not divisible by 8"
def test_preset_dimensions_within_limits(self):
"""Test that all preset dimensions are within acceptable limits."""
for preset_dict in [SDXL_PRESETS, FLUX_PRESETS, ULTRA_WIDE_PRESETS]:
for preset_name, (width, height) in preset_dict.items():
assert 64 <= width <= 8192, f"{preset_name} width {width} out of range"
assert (
64 <= height <= 8192
), f"{preset_name} height {height} out of range"
assert 64 <= height <= 8192, f"{preset_name} height {height} out of range"
class TestEdgeCases:
@@ -261,3 +302,229 @@ class TestEdgeCases:
# Prime number dimensions
ratio = calculate_aspect_ratio(1920, 1080)
assert ratio == "16:9"
class TestPresetMetadata:
"""Test preset metadata functionality."""
def test_preset_metadata_structure(self):
"""Test that metadata has correct structure."""
for preset_name, metadata in PRESET_METADATA.items():
assert hasattr(metadata, "width")
assert hasattr(metadata, "height")
assert hasattr(metadata, "aspect_ratio")
assert hasattr(metadata, "aspect_decimal")
assert hasattr(metadata, "megapixels")
assert hasattr(metadata, "model_group")
assert hasattr(metadata, "category")
assert hasattr(metadata, "description")
def test_metadata_aspect_ratios(self):
"""Test that aspect ratios are correctly calculated."""
for preset_name, metadata in PRESET_METADATA.items():
expected_decimal = metadata.width / metadata.height
assert abs(metadata.aspect_decimal - expected_decimal) < 0.001
# Common aspect ratios should match expected values
if preset_name == "1024×1024":
assert metadata.aspect_ratio == "1:1"
assert metadata.aspect_decimal == 1.0
elif preset_name == "1920×1080":
assert metadata.aspect_ratio == "16:9"
assert abs(metadata.aspect_decimal - 1.778) < 0.01
def test_metadata_megapixels(self):
"""Test that megapixel calculations are correct."""
for preset_name, metadata in PRESET_METADATA.items():
expected_mp = (metadata.width * metadata.height) / 1_000_000
assert abs(metadata.megapixels - expected_mp) < 0.1
def test_model_groups(self):
"""Test that model groups are properly assigned."""
sdxl_presets = get_presets_by_model_group("SDXL")
flux_presets = get_presets_by_model_group("FLUX")
ultra_wide_presets = get_presets_by_model_group("Ultra-Wide")
assert len(sdxl_presets) > 0
assert len(flux_presets) > 0
assert len(ultra_wide_presets) > 0
# Check specific presets are in correct groups
assert "1024×1024" in [k for k, v in sdxl_presets.items()]
assert "1920×1080" in [k for k, v in flux_presets.items()]
assert "2560×1080" in [k for k, v in ultra_wide_presets.items()]
def test_get_preset_metadata_function(self):
"""Test get_preset_metadata function."""
# Valid preset
metadata = get_preset_metadata("1024×1024")
assert metadata.width == 1024
assert metadata.height == 1024
assert metadata.model_group == "SDXL"
# Invalid preset returns default
metadata = get_preset_metadata("invalid_preset")
assert metadata.width == 0
assert metadata.height == 0
assert metadata.model_group == "Custom"
class TestNodeMetadataIntegration:
"""Test node integration with metadata."""
def setup_method(self):
"""Set up test fixtures."""
self.node = WidthHeightSelectorNode()
def test_get_preset_info_with_metadata(self):
"""Test that preset info includes metadata."""
info = self.node.get_preset_info("1024×1024")
assert "1:1" in info # Aspect ratio
assert "1.0MP" in info or "1.1MP" in info # Megapixels
assert "SDXL" in info # Description
def test_get_presets_by_model_static(self):
"""Test static method for getting presets by model."""
sdxl_presets = self.node.get_presets_by_model("SDXL")
assert isinstance(sdxl_presets, dict)
assert len(sdxl_presets) > 0
# Check that returned values are metadata objects
for preset_name, metadata in sdxl_presets.items():
assert metadata.model_group == "SDXL"
def test_get_preset_metadata_static(self):
"""Test static method for getting preset metadata."""
metadata_dict = self.node.get_preset_metadata_static("1920×1080")
assert metadata_dict["width"] == 1920
assert metadata_dict["height"] == 1080
assert metadata_dict["aspect_ratio"] == "16:9"
assert metadata_dict["model_group"] == "FLUX"
def test_get_model_groups(self):
"""Test static method for getting model groups."""
groups = self.node.get_model_groups()
assert "SDXL" in groups
assert "FLUX" in groups
assert "Ultra-Wide" in groups
class TestMetadataValidation:
"""Test metadata validation functions."""
def test_dimensions_validation(self):
"""Test dimensions validation from metadata."""
from kikotools.tools.width_height_selector.presets import (
validate_preset_dimensions,
)
assert validate_preset_dimensions() is True
def test_metadata_consistency_validation(self):
"""Test metadata consistency validation."""
from kikotools.tools.width_height_selector.presets import (
validate_metadata_consistency,
)
assert validate_metadata_consistency() is True
class TestFormattedPresets:
"""Test formatted preset functionality."""
def setup_method(self):
"""Set up test fixtures."""
self.node = WidthHeightSelectorNode()
def test_formatted_preset_generation(self):
"""Test that INPUT_TYPES generates formatted presets."""
input_types = self.node.INPUT_TYPES()
available_presets = input_types["required"]["preset"][0]
# Should have custom first
assert available_presets[0] == "custom"
# Should have formatted presets with metadata
formatted_count = 0
for option in available_presets[1:]: # Skip custom
if " - " in option and "MP" in option:
formatted_count += 1
assert formatted_count > 0, "No formatted presets found"
assert formatted_count == len(PRESET_METADATA), "Not all presets are formatted"
def test_preset_name_extraction(self):
"""Test extraction of raw preset names from formatted strings."""
test_cases = [
("custom", "custom"),
("1024×1024 - 1:1 (1.1MP) - SDXL", "1024×1024"),
("1920×1080 - 16:9 (2.1MP) - FLUX", "1920×1080"),
("832×1216 - 13:19 (1.0MP) - SDXL", "832×1216"),
("1024×1024", "1024×1024"), # Raw preset name
("invalid_preset", "custom"), # Invalid fallback
]
for formatted_preset, expected in test_cases:
result = self.node._extract_preset_name(formatted_preset)
assert result == expected, f"Expected {expected}, got {result} for input {formatted_preset}"
def test_formatted_preset_dimensions(self):
"""Test that formatted presets return correct dimensions."""
# Test with formatted preset string
formatted_preset = "1024×1024 - 1:1 (1.1MP) - SDXL"
result = self.node.get_dimensions(formatted_preset, 512, 512)
assert result == (1024, 1024)
# Test with FLUX formatted preset
formatted_preset = "1920×1080 - 16:9 (2.1MP) - FLUX"
result = self.node.get_dimensions(formatted_preset, 512, 512)
assert result == (1920, 1080)
def test_formatted_preset_validation(self):
"""Test validation of formatted presets."""
# Valid formatted preset
assert self.node.validate_inputs("1024×1024 - 1:1 (1.1MP) - SDXL", 1024, 1024)
# Valid raw preset
assert self.node.validate_inputs("1024×1024", 1024, 1024)
# Custom preset
assert self.node.validate_inputs("custom", 1024, 1024)
# Invalid formatted preset should still work (fallback to custom)
assert self.node.validate_inputs("invalid - formatted", 1024, 1024)
def test_backwards_compatibility(self):
"""Test that raw preset names still work."""
# Raw preset names should still work for backwards compatibility
raw_presets = ["1024×1024", "1920×1080", "832×1216"]
for raw_preset in raw_presets:
if raw_preset in PRESET_OPTIONS:
result = self.node.get_dimensions(raw_preset, 512, 512)
expected = PRESET_OPTIONS[raw_preset]
assert result == expected, f"Raw preset {raw_preset} failed"
def test_formatted_preset_metadata_accuracy(self):
"""Test that formatted presets contain accurate metadata."""
input_types = self.node.INPUT_TYPES()
formatted_presets = [opt for opt in input_types["required"]["preset"][0] if " - " in opt]
for formatted_preset in formatted_presets:
# Extract components
parts = formatted_preset.split(" - ")
assert len(parts) == 3, f"Formatted preset should have 3 parts: {formatted_preset}"
resolution = parts[0]
aspect_and_mp = parts[1]
model_group = parts[2]
# Verify resolution exists in metadata
assert resolution in PRESET_METADATA, f"Resolution {resolution} not in metadata"
# Verify metadata matches format
metadata = PRESET_METADATA[resolution]
assert metadata.model_group == model_group, f"Model group mismatch for {resolution}"
assert metadata.aspect_ratio in aspect_and_mp, f"Aspect ratio not in {aspect_and_mp}"
assert f"{metadata.megapixels:.1f}MP" in aspect_and_mp, f"Megapixels not in {aspect_and_mp}"
+393
View File
@@ -0,0 +1,393 @@
// ComfyUI-KikoTools - Empty Latent Batch with Swap Button
import { app } from "../../scripts/app.js";
app.registerExtension({
name: "comfyassets.EmptyLatentBatch",
async beforeRegisterNodeDef(nodeType, nodeData, _app) {
if (nodeData.name === "EmptyLatentBatch") {
const onNodeCreated = nodeType.prototype.onNodeCreated;
nodeType.prototype.onNodeCreated = function () {
if (onNodeCreated) onNodeCreated.apply(this, []);
// Track button click state for visual feedback
this.swapButtonPressed = false;
// Helper function to extract resolution from formatted preset string
this.extractResolutionFromPreset = function (presetValue) {
if (presetValue === "custom") return null;
// If it contains formatting metadata, extract the resolution part
if (presetValue.includes(" - ")) {
// Format is: "1024×1024 - 1:1 (1.0MP) - SDXL"
return presetValue.split(" - ")[0];
}
// Otherwise assume it's already a raw resolution
return presetValue;
};
// Override preset callback to update width/height widgets when preset changes
const presetWidget = this.widgets.find((w) => w.name === "preset");
if (presetWidget) {
const originalCallback = presetWidget.callback;
presetWidget.callback = function (
value,
graphcanvas,
node,
pos,
event,
) {
// Call original callback first
if (originalCallback) {
originalCallback.call(this, value, graphcanvas, node, pos, event);
}
// Update width/height widgets based on preset
const widthWidget = node.widgets.find((w) => w.name === "width");
const heightWidget = node.widgets.find((w) => w.name === "height");
if (widthWidget && heightWidget && value !== "custom") {
// Extract raw resolution from formatted preset
const rawResolution = node.extractResolutionFromPreset(value);
// Define all available presets from our preset system
const presetDimensions = {
// SDXL Presets
"1024×1024": [1024, 1024],
"896×1152": [896, 1152],
"832×1216": [832, 1216],
"768×1344": [768, 1344],
"640×1536": [640, 1536],
"1152×896": [1152, 896],
"1216×832": [1216, 832],
"1344×768": [1344, 768],
"1536×640": [1536, 640],
// FLUX Presets
"1920×1080": [1920, 1080],
"1536×1536": [1536, 1536],
"1280×768": [1280, 768],
"768×1280": [768, 1280],
"1440×1080": [1440, 1080],
"1080×1440": [1080, 1440],
"1728×1152": [1728, 1152],
"1152×1728": [1152, 1728],
// Ultra-Wide Presets
"2560×1080": [2560, 1080],
"2048×768": [2048, 768],
"1792×768": [1792, 768],
"2304×768": [2304, 768],
"1080×2560": [1080, 2560],
"768×2048": [768, 2048],
"768×1792": [768, 1792],
"768×2304": [768, 2304],
};
if (rawResolution && presetDimensions[rawResolution]) {
const [w, h] = presetDimensions[rawResolution];
widthWidget.value = w;
heightWidget.value = h;
// Trigger widget callbacks to update the UI
if (widthWidget.callback) {
widthWidget.callback(w, graphcanvas, node, pos, event);
}
if (heightWidget.callback) {
heightWidget.callback(h, graphcanvas, node, pos, event);
}
}
}
};
}
// Add swap functionality
this.swapDimensions = function () {
const widthWidget = this.widgets.find((w) => w.name === "width");
const heightWidget = this.widgets.find((w) => w.name === "height");
const presetWidget = this.widgets.find((w) => w.name === "preset");
if (widthWidget && heightWidget && presetWidget) {
// Handle preset swapping first
if (presetWidget.value !== "custom") {
const currentPreset = presetWidget.value;
// Extract raw resolution from formatted preset
const rawResolution =
this.extractResolutionFromPreset(currentPreset);
if (!rawResolution) return;
// Parse current preset dimensions (handle both × and x separators)
let w, h;
if (rawResolution.includes("×")) {
[w, h] = rawResolution.split("×").map((v) => parseInt(v));
} else if (rawResolution.includes("x")) {
[w, h] = rawResolution.split("x").map((v) => parseInt(v));
} else {
return; // Invalid preset format
}
const swappedRawPreset = `${h}×${w}`;
// Find the formatted version of the swapped preset from available options
const availablePresets =
presetWidget.options.values || presetWidget.options;
let swappedFormattedPreset = null;
for (const option of availablePresets) {
if (option === "custom") continue;
const extractedRes = this.extractResolutionFromPreset(option);
if (extractedRes === swappedRawPreset) {
swappedFormattedPreset = option;
break;
}
}
if (swappedFormattedPreset) {
// Swapped preset exists, use the formatted version
presetWidget.value = swappedFormattedPreset;
widthWidget.value = h;
heightWidget.value = w;
if (presetWidget.callback) {
presetWidget.callback(
swappedFormattedPreset,
this,
presetWidget,
);
}
if (widthWidget.callback) {
widthWidget.callback(h, this, widthWidget);
}
if (heightWidget.callback) {
heightWidget.callback(w, this, heightWidget);
}
} else {
// Swapped preset doesn't exist, switch to custom and swap manual values
presetWidget.value = "custom";
widthWidget.value = h;
heightWidget.value = w;
if (presetWidget.callback) {
presetWidget.callback("custom", this, presetWidget);
}
if (widthWidget.callback) {
widthWidget.callback(h, this, widthWidget);
}
if (heightWidget.callback) {
heightWidget.callback(w, this, heightWidget);
}
}
} else {
// Custom preset - just swap the width and height values
const tempWidth = widthWidget.value;
widthWidget.value = heightWidget.value;
heightWidget.value = tempWidth;
// Trigger widget change events
if (widthWidget.callback) {
widthWidget.callback(widthWidget.value, this, widthWidget);
}
if (heightWidget.callback) {
heightWidget.callback(heightWidget.value, this, heightWidget);
}
}
// Mark the graph as changed
this.graph?.setDirtyCanvas(true, true);
}
};
// Override onResize to refresh button position
const originalOnResize = this.onResize;
this.onResize = function (size) {
if (originalOnResize) {
originalOnResize.call(this, size);
}
// Force redraw to update button position
this.setDirtyCanvas(true, true);
// Also mark the graph as dirty
if (this.graph) {
this.graph.setDirtyCanvas(true, true);
}
};
// Override onBounding to ensure proper updates
const originalOnBounding = this.onBounding;
this.onBounding = function (out) {
if (originalOnBounding) {
originalOnBounding.call(this, out);
}
// Force redraw when bounds change
this.setDirtyCanvas(true, true);
};
};
const onDrawForeground = nodeType.prototype.onDrawForeground;
nodeType.prototype.onDrawForeground = function (ctx) {
if (onDrawForeground) {
onDrawForeground.apply(this, arguments);
}
if (this.flags.collapsed) return;
// Draw swap button with consistent spacing from widgets
const swapButtonSize = 24;
const margin = 6;
const swapButtonX = this.size[0] - swapButtonSize - margin;
// Calculate button position based on widget spacing rather than bottom margin
// Estimate widget area height and add consistent spacing
const estimatedWidgetHeight = 90; // Approximate height for 3 widgets
const topMargin = 35; // Space from top to first widget
const buttonSpacing = 40; // Space between last widget and button (moved down 5)
const swapButtonY = topMargin + estimatedWidgetHeight + buttonSpacing;
// Button background - change color based on pressed state
if (this.swapButtonPressed) {
// Darker when pressed
ctx.fillStyle = "rgba(30, 120, 200, 0.9)"; // Darker blue when clicked
} else {
// Normal state
ctx.fillStyle = "rgba(66, 165, 245, 0.8)"; // Material blue
}
ctx.beginPath();
ctx.roundRect(
swapButtonX,
swapButtonY,
swapButtonSize,
swapButtonSize,
4,
);
ctx.fill();
// Button border with subtle highlight
ctx.strokeStyle = this.swapButtonPressed
? "rgba(20, 100, 180, 1.0)"
: "rgba(33, 150, 243, 0.9)";
ctx.lineWidth = 1;
ctx.stroke();
// Draw swap icon - modern double arrow design
ctx.strokeStyle = "rgba(255, 255, 255, 0.95)";
ctx.lineWidth = 2;
ctx.lineCap = "round";
const centerX = swapButtonX + 12;
const centerY = swapButtonY + 12;
// Top arrow (pointing right) - width to height
ctx.beginPath();
ctx.moveTo(centerX - 7, centerY - 3);
ctx.lineTo(centerX + 5, centerY - 3);
ctx.stroke();
// Top arrow head
ctx.beginPath();
ctx.moveTo(centerX + 5, centerY - 3);
ctx.lineTo(centerX + 2, centerY - 5);
ctx.moveTo(centerX + 5, centerY - 3);
ctx.lineTo(centerX + 2, centerY - 1);
ctx.stroke();
// Bottom arrow (pointing left) - height to width
ctx.beginPath();
ctx.moveTo(centerX + 5, centerY + 3);
ctx.lineTo(centerX - 7, centerY + 3);
ctx.stroke();
// Bottom arrow head
ctx.beginPath();
ctx.moveTo(centerX - 7, centerY + 3);
ctx.lineTo(centerX - 4, centerY + 1);
ctx.moveTo(centerX - 7, centerY + 3);
ctx.lineTo(centerX - 4, centerY + 5);
ctx.stroke();
};
const onMouseDown = nodeType.prototype.onMouseDown;
nodeType.prototype.onMouseDown = function (e) {
// Check if click is on swap button
const swapButtonSize = 24;
const margin = 6;
const swapButtonX =
this.pos[0] + this.size[0] - swapButtonSize - margin;
// Use same positioning logic as drawing
const estimatedWidgetHeight = 90;
const topMargin = 35;
const buttonSpacing = 40;
const swapButtonY =
this.pos[1] + topMargin + estimatedWidgetHeight + buttonSpacing;
if (
e.canvasX >= swapButtonX &&
e.canvasX <= swapButtonX + swapButtonSize &&
e.canvasY >= swapButtonY &&
e.canvasY <= swapButtonY + swapButtonSize
) {
// Visual feedback - set button as pressed
this.swapButtonPressed = true;
this.setDirtyCanvas(true, true);
// Execute swap
this.swapDimensions();
// Reset button state after a short delay for visual feedback
setTimeout(() => {
this.swapButtonPressed = false;
this.setDirtyCanvas(true, true);
}, 150);
return true; // Consume the event
}
// Call original onMouseDown if not clicking swap button
if (onMouseDown) {
return onMouseDown.apply(this, arguments);
}
};
// Optional: Add hover effect for better user feedback
const onMouseMove = nodeType.prototype.onMouseMove;
nodeType.prototype.onMouseMove = function (e) {
// Check if hovering over swap button
const swapButtonSize = 24;
const margin = 6;
const swapButtonX =
this.pos[0] + this.size[0] - swapButtonSize - margin;
// Use same positioning logic as drawing
const estimatedWidgetHeight = 90;
const topMargin = 35;
const buttonSpacing = 40;
const swapButtonY =
this.pos[1] + topMargin + estimatedWidgetHeight + buttonSpacing;
const isHovering =
e.canvasX >= swapButtonX &&
e.canvasX <= swapButtonX + swapButtonSize &&
e.canvasY >= swapButtonY &&
e.canvasY <= swapButtonY + swapButtonSize;
// Update cursor style for better UX (safely)
if (
isHovering &&
this.graph &&
this.graph.canvas &&
this.graph.canvas.canvas
) {
this.graph.canvas.canvas.style.cursor = "pointer";
} else if (
this.graph &&
this.graph.canvas &&
this.graph.canvas.canvas
) {
this.graph.canvas.canvas.style.cursor = "default";
}
// Call original onMouseMove
if (onMouseMove) {
return onMouseMove.apply(this, arguments);
}
};
}
},
});
File diff suppressed because it is too large Load Diff
+25 -25
View File
@@ -22,11 +22,11 @@ app.registerExtension({
this.seedHistory = this.loadSeedHistory();
this.hideTimer = null;
this.mouseOverHistory = false;
// Register this node in global registry
window.seedHistoryNodes = window.seedHistoryNodes || [];
window.seedHistoryNodes.push(this);
// Create UI container
const uiContainer = document.createElement("div");
uiContainer.style.padding = "8px";
@@ -62,14 +62,14 @@ app.registerExtension({
setTimeout(() => {
this.setupSeedWidgetCallbacks();
}, 100);
// Hook directly into widget value changes
const originalOnWidgetChange = this.onWidgetChange;
this.onWidgetChange = function(name, value, oldValue, widget) {
if (name === "seed" && value !== oldValue) {
this.addSeedToHistory(value);
}
if (originalOnWidgetChange) {
return originalOnWidgetChange.call(this, name, value, oldValue, widget);
}
@@ -105,12 +105,12 @@ app.registerExtension({
clearInterval(this.seedValueWatcher);
this.seedValueWatcher = null;
}
// Clean up deduplication tracking
if (this.lastAddedSeed) {
this.lastAddedSeed = null;
}
// Remove from global registry
if (window.seedHistoryNodes) {
const index = window.seedHistoryNodes.indexOf(this);
@@ -118,7 +118,7 @@ app.registerExtension({
window.seedHistoryNodes.splice(index, 1);
}
}
if (originalOnRemoved) {
originalOnRemoved.call(this);
}
@@ -220,7 +220,7 @@ app.registerExtension({
this.mouseOverHistory = true;
this.cancelAutoHide();
});
historyDiv.addEventListener("mouseleave", () => {
this.mouseOverHistory = false;
this.startAutoHide();
@@ -257,38 +257,38 @@ app.registerExtension({
const numSeed = typeof seed === 'string' ? parseInt(seed) : seed;
const now = Date.now();
// Deduplication: prevent adding the same seed within 500ms window
if (!this.lastAddedSeed) {
this.lastAddedSeed = { seed: null, timestamp: 0 };
}
const timeSinceLastAdd = now - this.lastAddedSeed.timestamp;
const isSameSeed = this.lastAddedSeed.seed === numSeed;
const isWithinDupeWindow = timeSinceLastAdd < 500; // 500ms window
if (isSameSeed && isWithinDupeWindow) {
return;
}
// Update deduplication tracking
this.lastAddedSeed = { seed: numSeed, timestamp: now };
// Remove if already exists in history
this.seedHistory = this.seedHistory.filter(item => item.seed !== numSeed);
// Add to front
this.seedHistory.unshift({
seed: numSeed,
timestamp: now,
dateString: new Date().toLocaleString()
});
// Keep only last 10
if (this.seedHistory.length > 10) {
this.seedHistory = this.seedHistory.slice(0, 10);
}
this.saveSeedHistory();
this.refreshHistoryDisplay();
this.startAutoHide();
@@ -297,7 +297,7 @@ app.registerExtension({
// Generate new random seed
nodeType.prototype.generateRandomSeed = function () {
const newSeed = Math.floor(Math.random() * 0xFFFFFFFFFFFFFFFF);
const seedWidget = this.widgets?.find(w => w.name === "seed");
if (seedWidget) {
seedWidget.value = newSeed;
@@ -305,7 +305,7 @@ app.registerExtension({
seedWidget.callback(newSeed, this, seedWidget);
}
}
this.addSeedToHistory(newSeed);
this.setDirtyCanvas(true, true);
this.showMessage(`Generated: ${newSeed}`, "success");
@@ -320,7 +320,7 @@ app.registerExtension({
seedWidget.callback(historyItem.seed, this, seedWidget);
}
}
this.highlightHistoryEntry(index);
this.setDirtyCanvas(true, true);
this.startAutoHide();
@@ -340,7 +340,7 @@ app.registerExtension({
if (!this.historyDisplay) return;
if (!this.seedHistory || this.seedHistory.length === 0) {
this.historyDisplay.innerHTML =
this.historyDisplay.innerHTML =
'<div style="color: #888; text-align: center; padding: 15px;">No seeds tracked<br><small>Generate seeds to build history</small></div>';
return;
}
@@ -382,7 +382,7 @@ app.registerExtension({
this.historyDisplay.appendChild(entryDiv);
});
this.startAutoHide();
};
@@ -420,7 +420,7 @@ app.registerExtension({
nodeType.prototype.hideHistorySection = function () {
if (this.historyDisplay && !this.mouseOverHistory) {
this.historyDisplay.style.display = "none";
if (!this.restoreButton) {
const restoreDiv = document.createElement("div");
restoreDiv.style.padding = "10px";
@@ -458,12 +458,12 @@ app.registerExtension({
nodeType.prototype.showHistorySection = function () {
if (this.historyDisplay) {
this.historyDisplay.style.display = "block";
if (this.restoreButton && this.restoreButton.parentNode) {
this.restoreButton.parentNode.removeChild(this.restoreButton);
this.restoreButton = null;
}
this.startAutoHide();
}
};
@@ -521,4 +521,4 @@ app.registerExtension({
};
}
},
});
});
+90 -70
View File
@@ -2,16 +2,30 @@
import { app } from "../../scripts/app.js";
app.registerExtension({
name: "comfyassets.WidthHeightSelector",
name: "comfyassets.WidthHeightSelector",
async beforeRegisterNodeDef(nodeType, nodeData, _app) {
if (nodeData.name === "WidthHeightSelector") {
const onNodeCreated = nodeType.prototype.onNodeCreated;
nodeType.prototype.onNodeCreated = function () {
if (onNodeCreated) onNodeCreated.apply(this, []);
// Track button click state for visual feedback
this.swapButtonPressed = false;
// Helper function to extract resolution from formatted preset string
this.extractResolutionFromPreset = function(presetValue) {
if (presetValue === "custom") return null;
// If it contains formatting metadata, extract the resolution part
if (presetValue.includes(" - ")) {
// Format is: "1024×1024 - 1:1 (1.0MP) - SDXL"
return presetValue.split(" - ")[0];
}
// Otherwise assume it's already a raw resolution
return presetValue;
};
// Override preset callback to update width/height widgets when preset changes
const presetWidget = this.widgets.find(w => w.name === "preset");
if (presetWidget) {
@@ -21,33 +35,36 @@ app.registerExtension({
if (originalCallback) {
originalCallback.call(this, value, graphcanvas, node, pos, event);
}
// Update width/height widgets based on preset
const widthWidget = node.widgets.find(w => w.name === "width");
const heightWidget = node.widgets.find(w => w.name === "height");
if (widthWidget && heightWidget && value !== "custom") {
// Extract raw resolution from formatted preset
const rawResolution = node.extractResolutionFromPreset(value);
// Define all available presets from our preset system
const presetDimensions = {
// SDXL Presets
"1024×1024": [1024, 1024], "896×1152": [896, 1152], "832×1216": [832, 1216],
"768×1344": [768, 1344], "640×1536": [640, 1536], "1152×896": [1152, 896],
"1024×1024": [1024, 1024], "896×1152": [896, 1152], "832×1216": [832, 1216],
"768×1344": [768, 1344], "640×1536": [640, 1536], "1152×896": [1152, 896],
"1216×832": [1216, 832], "1344×768": [1344, 768], "1536×640": [1536, 640],
// FLUX Presets
"1920×1080": [1920, 1080], "1536×1536": [1536, 1536], "1280×768": [1280, 768],
"768×1280": [768, 1280], "1440×1080": [1440, 1080], "1080×1440": [1080, 1440],
// FLUX Presets
"1920×1080": [1920, 1080], "1536×1536": [1536, 1536], "1280×768": [1280, 768],
"768×1280": [768, 1280], "1440×1080": [1440, 1080], "1080×1440": [1080, 1440],
"1728×1152": [1728, 1152], "1152×1728": [1152, 1728],
// Ultra-Wide Presets
"2560×1080": [2560, 1080], "2048×768": [2048, 768], "1792×768": [1792, 768],
"2304×768": [2304, 768], "1080×2560": [1080, 2560], "768×2048": [768, 2048],
"2560×1080": [2560, 1080], "2048×768": [2048, 768], "1792×768": [1792, 768],
"2304×768": [2304, 768], "1080×2560": [1080, 2560], "768×2048": [768, 2048],
"768×1792": [768, 1792], "768×2304": [768, 2304]
};
if (presetDimensions[value]) {
const [w, h] = presetDimensions[value];
if (rawResolution && presetDimensions[rawResolution]) {
const [w, h] = presetDimensions[rawResolution];
widthWidget.value = w;
heightWidget.value = h;
// Trigger widget callbacks to update the UI
if (widthWidget.callback) {
widthWidget.callback(w, graphcanvas, node, pos, event);
@@ -59,51 +76,54 @@ app.registerExtension({
}
};
}
// Add swap functionality
this.swapDimensions = function() {
const widthWidget = this.widgets.find(w => w.name === "width");
const heightWidget = this.widgets.find(w => w.name === "height");
const presetWidget = this.widgets.find(w => w.name === "preset");
if (widthWidget && heightWidget && presetWidget) {
// Handle preset swapping first
if (presetWidget.value !== "custom") {
const currentPreset = presetWidget.value;
// Extract raw resolution from formatted preset
const rawResolution = this.extractResolutionFromPreset(currentPreset);
if (!rawResolution) return;
// Parse current preset dimensions (handle both × and x separators)
let w, h;
if (currentPreset.includes('×')) {
[w, h] = currentPreset.split('×').map(v => parseInt(v));
} else if (currentPreset.includes('x')) {
[w, h] = currentPreset.split('x').map(v => parseInt(v));
if (rawResolution.includes('×')) {
[w, h] = rawResolution.split('×').map(v => parseInt(v));
} else if (rawResolution.includes('x')) {
[w, h] = rawResolution.split('x').map(v => parseInt(v));
} else {
return; // Invalid preset format
}
const swappedPreset = `${h}×${w}`;
// Define all available presets from our preset system
const availablePresets = [
"custom",
// SDXL Presets
"1024×1024", "896×1152", "832×1216", "768×1344", "640×1536",
"1152×896", "1216×832", "1344×768", "1536×640",
// FLUX Presets
"1920×1080", "1536×1536", "1280×768", "768×1280",
"1440×1080", "1080×1440", "1728×1152", "1152×1728",
// Ultra-Wide Presets
"2560×1080", "2048×768", "1792×768", "2304×768",
"1080×2560", "768×2048", "768×1792", "768×2304"
];
if (availablePresets.includes(swappedPreset)) {
// Swapped preset exists, use it
presetWidget.value = swappedPreset;
const swappedRawPreset = `${h}×${w}`;
// Find the formatted version of the swapped preset from available options
const availablePresets = presetWidget.options.values || presetWidget.options;
let swappedFormattedPreset = null;
for (const option of availablePresets) {
if (option === "custom") continue;
const extractedRes = this.extractResolutionFromPreset(option);
if (extractedRes === swappedRawPreset) {
swappedFormattedPreset = option;
break;
}
}
if (swappedFormattedPreset) {
// Swapped preset exists, use the formatted version
presetWidget.value = swappedFormattedPreset;
widthWidget.value = h;
heightWidget.value = w;
if (presetWidget.callback) {
presetWidget.callback(swappedPreset, this, presetWidget);
presetWidget.callback(swappedFormattedPreset, this, presetWidget);
}
if (widthWidget.callback) {
widthWidget.callback(h, this, widthWidget);
@@ -116,7 +136,7 @@ app.registerExtension({
presetWidget.value = "custom";
widthWidget.value = h;
heightWidget.value = w;
if (presetWidget.callback) {
presetWidget.callback("custom", this, presetWidget);
}
@@ -132,7 +152,7 @@ app.registerExtension({
const tempWidth = widthWidget.value;
widthWidget.value = heightWidget.value;
heightWidget.value = tempWidth;
// Trigger widget change events
if (widthWidget.callback) {
widthWidget.callback(widthWidget.value, this, widthWidget);
@@ -141,7 +161,7 @@ app.registerExtension({
heightWidget.callback(heightWidget.value, this, heightWidget);
}
}
// Mark the graph as changed
this.graph?.setDirtyCanvas(true, true);
}
@@ -153,21 +173,21 @@ app.registerExtension({
if (onDrawForeground) {
onDrawForeground.apply(this, arguments);
}
if (this.flags.collapsed) return;
// Draw swap button with consistent spacing from widgets
const swapButtonSize = 24;
const margin = 6;
const swapButtonX = this.size[0] - swapButtonSize - margin;
// Calculate button position based on widget spacing rather than bottom margin
// Estimate widget area height and add consistent spacing
const estimatedWidgetHeight = 90; // Approximate height for 3 widgets
const topMargin = 35; // Space from top to first widget
const buttonSpacing = 10; // Space between last widget and button
const swapButtonY = topMargin + estimatedWidgetHeight + buttonSpacing;
// Button background - change color based on pressed state
if (this.swapButtonPressed) {
// Darker when pressed
@@ -179,26 +199,26 @@ app.registerExtension({
ctx.beginPath();
ctx.roundRect(swapButtonX, swapButtonY, swapButtonSize, swapButtonSize, 4);
ctx.fill();
// Button border with subtle highlight
ctx.strokeStyle = this.swapButtonPressed ? "rgba(20, 100, 180, 1.0)" : "rgba(33, 150, 243, 0.9)";
ctx.lineWidth = 1;
ctx.stroke();
// Draw swap icon - modern double arrow design
ctx.strokeStyle = "rgba(255, 255, 255, 0.95)";
ctx.lineWidth = 2;
ctx.lineCap = "round";
const centerX = swapButtonX + 12;
const centerY = swapButtonY + 12;
// Top arrow (pointing right) - width to height
ctx.beginPath();
ctx.moveTo(centerX - 7, centerY - 3);
ctx.lineTo(centerX + 5, centerY - 3);
ctx.stroke();
// Top arrow head
ctx.beginPath();
ctx.moveTo(centerX + 5, centerY - 3);
@@ -206,13 +226,13 @@ app.registerExtension({
ctx.moveTo(centerX + 5, centerY - 3);
ctx.lineTo(centerX + 2, centerY - 1);
ctx.stroke();
// Bottom arrow (pointing left) - height to width
ctx.beginPath();
ctx.moveTo(centerX + 5, centerY + 3);
ctx.lineTo(centerX - 7, centerY + 3);
ctx.stroke();
// Bottom arrow head
ctx.beginPath();
ctx.moveTo(centerX - 7, centerY + 3);
@@ -220,7 +240,7 @@ app.registerExtension({
ctx.moveTo(centerX - 7, centerY + 3);
ctx.lineTo(centerX - 4, centerY + 5);
ctx.stroke();
// Add subtle tooltip text when hovering (if we had hover state)
// This could be extended with hover detection for better UX
};
@@ -231,13 +251,13 @@ app.registerExtension({
const swapButtonSize = 24;
const margin = 6;
const swapButtonX = this.pos[0] + this.size[0] - swapButtonSize - margin;
// Use same positioning logic as drawing
const estimatedWidgetHeight = 90;
const topMargin = 35;
const buttonSpacing = 10;
const swapButtonY = this.pos[1] + topMargin + estimatedWidgetHeight + buttonSpacing;
if (
e.canvasX >= swapButtonX &&
e.canvasX <= swapButtonX + swapButtonSize &&
@@ -247,19 +267,19 @@ app.registerExtension({
// Visual feedback - set button as pressed
this.swapButtonPressed = true;
this.setDirtyCanvas(true, true);
// Execute swap
this.swapDimensions();
// Reset button state after a short delay for visual feedback
setTimeout(() => {
this.swapButtonPressed = false;
this.setDirtyCanvas(true, true);
}, 150);
return true; // Consume the event
}
// Call original onMouseDown if not clicking swap button
if (onMouseDown) {
return onMouseDown.apply(this, arguments);
@@ -273,27 +293,27 @@ app.registerExtension({
const swapButtonSize = 24;
const margin = 6;
const swapButtonX = this.pos[0] + this.size[0] - swapButtonSize - margin;
// Use same positioning logic as drawing
const estimatedWidgetHeight = 90;
const topMargin = 35;
const buttonSpacing = 10;
const swapButtonY = this.pos[1] + topMargin + estimatedWidgetHeight + buttonSpacing;
const isHovering = (
e.canvasX >= swapButtonX &&
e.canvasX <= swapButtonX + swapButtonSize &&
e.canvasY >= swapButtonY &&
e.canvasY <= swapButtonY + swapButtonSize
);
// Update cursor style for better UX (safely)
if (isHovering && this.graph && this.graph.canvas && this.graph.canvas.canvas) {
this.graph.canvas.canvas.style.cursor = "pointer";
} else if (this.graph && this.graph.canvas && this.graph.canvas.canvas) {
this.graph.canvas.canvas.style.cursor = "default";
}
// Call original onMouseMove
if (onMouseMove) {
return onMouseMove.apply(this, arguments);
@@ -301,4 +321,4 @@ app.registerExtension({
};
}
},
});
});