- Updated Description and Code
This commit is contained in:
@@ -1 +1,46 @@
|
||||
# ComfyUI-FilePathCreator
|
||||
# ComfyUI-FilePathCreator
|
||||
|
||||
## Overview
|
||||
The `ComfyUI-FilePathCreator` is a custom node extension for ComfyUI designed to generate dynamic filenames based on user-defined parameters. This node helps streamline the process of creating organized and timestamped filenames, ideal for saving output files in a structured manner.
|
||||
|
||||
## Features
|
||||
- **Customizable Filename Prefix**: Define a custom prefix for your filenames to easily identify and categorize your files.
|
||||
- **Dynamic Timestamps**: Generate filenames with current timestamps using customizable time formats.
|
||||
- **Optional Output Folder**: Specify an output folder where files should be saved. If not specified, a default local output folder is used.
|
||||
- **File Type Specification**: Choose the file extension for the generated filenames. If the file type is left empty, the filename is generated without an extension.
|
||||
|
||||
## Inputs
|
||||
1. **file_prefix** (required):
|
||||
- Type: STRING
|
||||
- Default: `"output"`
|
||||
- Description: The prefix to be used for the generated filename.
|
||||
|
||||
2. **time_format** (required):
|
||||
- Type: STRING
|
||||
- Default: `"%Y-%m-%d-%H%M%S"`
|
||||
- Description: The format for the timestamp in the filename. Uses Python's `datetime` format codes.
|
||||
|
||||
3. **output_folder** (optional):
|
||||
- Type: STRING
|
||||
- Default: `""`
|
||||
- Description: The folder path where the file should be saved. Defaults to a local "output" folder if left empty.
|
||||
|
||||
4. **filetype** (optional):
|
||||
- Type: STRING
|
||||
- Default: `"txt"`
|
||||
- Description: The file extension for the generated filename. If left empty, no file extension is added.
|
||||
|
||||
## Outputs
|
||||
1. **Filename**: The generated filename based on the prefix and timestamp.
|
||||
2. **Folder Path**: The path of the output folder.
|
||||
3. **Combined Path**: The full path combining the output folder and filename.
|
||||
|
||||
## Example Usage
|
||||
After installing the `ComfyUI-FilePathCreator`, you can use it to generate filenames like `output_2023-07-07-143022.txt` and save them in a specified folder. This is particularly useful for batch processing or saving results from automated workflows in a consistent and organized manner.
|
||||
|
||||
|
||||
Licensing
|
||||
This project is licensed under the MIT License. See the LICENSE file for more details.
|
||||
|
||||
Contributions
|
||||
Contributions are welcome! Please feel free to submit a pull request or open an issue on the GitHub repository.
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
from .file_path_creator import FilePathCreator
|
||||
|
||||
NODE_CLASS_MAPPINGS = {
|
||||
"FilePathCreator": FilePathCreator
|
||||
}
|
||||
|
||||
NODE_DISPLAY_NAME_MAPPINGS = {
|
||||
"FilePathCreator": "File Path Creator"
|
||||
}
|
||||
|
||||
__all__ = ['NODE_CLASS_MAPPINGS', 'NODE_DISPLAY_NAME_MAPPINGS']
|
||||
@@ -0,0 +1,33 @@
|
||||
import os
|
||||
from datetime import datetime
|
||||
|
||||
class FilePathCreator:
|
||||
@classmethod
|
||||
def INPUT_TYPES(cls):
|
||||
return {
|
||||
"required": {
|
||||
"file_prefix": ("STRING", {"default": "output"}),
|
||||
"time_format": ("STRING", {"default": "%Y-%m-%d-%H%M%S"})
|
||||
},
|
||||
"optional": {
|
||||
"output_folder": ("STRING", {"default": ""}),
|
||||
"filetype": ("STRING", {"default": "txt"})
|
||||
}
|
||||
}
|
||||
|
||||
CATEGORY = "Custom Nodes"
|
||||
RETURN_TYPES = ("STRING", "STRING", "STRING")
|
||||
RETURN_NAMES = ("Filename", "Folder Path", "Combined Path")
|
||||
FUNCTION = "process"
|
||||
|
||||
def process(self, file_prefix, time_format, output_folder, filetype):
|
||||
output_folder = output_folder or os.path.abspath("output")
|
||||
current_time = datetime.now().strftime(time_format)
|
||||
|
||||
if filetype:
|
||||
filename = f"{file_prefix}_{current_time}.{filetype}"
|
||||
else:
|
||||
filename = f"{file_prefix}_{current_time}"
|
||||
|
||||
combined_path = os.path.join(output_folder, filename)
|
||||
return filename, output_folder, combined_path
|
||||
Reference in New Issue
Block a user