release 2.46

- bug discovered with *rgthree's Ksampler Config*: using `steps_total` as an input to a Ksampler, will issue the index of the output, instead of the steps value ("\[nodeNum, 0]" instead of steps value). FIX: use `steps_total` instead of `steps`!
- uncommented \_\_all\_\_ in init.py
- potential bugfix in splitKey, `len(splitKey) = 2` to identify actual "node.widget" format
	modified:   README.md
	modified:   __init__.py
	new file:   assets/bug-rgthree-ksampler_config-steps_total.png
	modified:   save_image_extended.py

.gitignore

@@ -2,6 +2,7 @@ backup/
 *.7z
 *.zip
 gitsync*
+commit.*
 *.url
 *.lnk
 desktop.ini

README.md

@@ -1,5 +1,5 @@
-# Save Image Extended for ComfyUI
-version = 2.43 - **AVIF** support!
+# 💾 Save Image Extended for ComfyUI
+**AVIF** and **WebP** support!
 
 <p align="center">
  <img src="assets/save-image-extended-comfyui-example.png" />
@@ -8,7 +8,7 @@ version = 2.43 - **AVIF** support!
 * Customize the folder, sub-folders, and filenames of your images! 
 * Save data about the generated job (sampler, prompts, models) as entries in a `json` (text) file, in each folder.
 * Use the values of ANY node's widget, by simply adding its badge number in the form _id.widget_name_: 
-* Oh btw... also saves your output as **WebP** or **JPEG**... And yes the prompt is included :) ComfyUI can load it but a PR approval is needed.
+* Oh btw... also saves your output as **WebP** / **JPEG** / **AVIP** ... And yes the prompt is included :) ComfyUI can load it but a PR approval is needed to fix a bug on their side.
 
 
 <br>
@@ -22,6 +22,8 @@ version = 2.43 - **AVIF** support!
 
 ## Installation
 ### Requirements:
+There is a requirements.txt that will take care of that, but just in case:
+
 - python 10.6
 - piexif
 - pillow
@@ -32,7 +34,7 @@ pip install piexif pillow pillow-avif-plugin
 ```
 
 
-### Installation
+### Manual Download
 1. Open a terminal inside the 'custom_nodes' folder located in your ComfyUI installation dir
 2. Use the `git clone` command to clone the [save-image-extended-comfyui](https://github.com/audioscavenger/save-image-extended-comfyui) repo.
 ```
@@ -75,11 +77,18 @@ Disclaimer: Does not check for illegal characters entered in file or folder name
 Tested and working with default samplers, Efficiency nodes, UltimateSDUpscale, ComfyRoll, composer, NegiTools, and 45 other nodes.
 
 #
-* WebP and JPEG quality are fixed at 91.
+Quality and compression settings:
+
+* AVIF quality is fixed at 60.
+* WebP quality is fixed at 75.
+* JPEG quality is fixed at 91.
 * PNG is maxed compressed (9)
 
+Start a discussion or a poll if you want to change output quality, and add another attribute in the node. There's so many already, some complain about the node being too tall.
+
+
 #
-About extensions WebP AVIF JPEG: ComfyUI cannot load it atm... Feel free to ask ComfyUI team to add support for AVIF WebP Jpeg!
+About extensions WebP AVIF JPEG: ComfyUI cannot load it atm... Feel free to ask ComfyUI team to add support for AVIF/WebP/jpeg!
 
 The prompt is included under the **EXIF** tag `UserComment` (IFD0 / 0x9286) as defined [here](https://exiftool.org/TagNames/EXIF.html).
 It is saved in this form: `UserComment = {"prompt": {"1": {"inputs": {...}}}}`.
@@ -112,16 +121,33 @@ jobs.json sample:
 
 ## RoadMap
 
-I won't promise anything, just like @thedyze did not promise anything when they released this custom node. Then disappeared for good 3 months later. That's fine, I do that too. 
+I won't promise anything, just like @thedyze did not promise anything when they released this custom node. 
+Then disappeared for good 3 months later. That's fine, I do that too somtimes :)
 
-However, I do provide a way to contact me, and will accept PR and collabs. Once I feel like I don't have time to work on it, I will gladly transfer ownership or let collabs maintain it.
+However, I do provide a way to contact me, and will accept PR and collabs. 
+Once I feel like I don't have time to work on it, I will gladly transfer ownership or let collabs maintain it.
 
-- [ ] save_job_to_json is pretty much useless actually, since it only saves the last value found for each node
-- [ ] bugfix: when using /name in foldername_keys, Comfy thinks you want to save outside the output folder
-- [ ] what is job_custom_text?
-- [ ] what is jobs.json? History, alraight. What do you do with that? Can we disable it?
+- [ ] ComfyRoll CR XY Save Grid Image: it offers jpeg webp tif - check how it embeds prompt and see if that works better with Comfy!
+- [ ] offer quality setting in the node?
+- [ ] remove save_job_to_json? thisis pretty much useless actually, since it only saves the last value found for each node.
+- [ ] remove job_custom_text? what is this for?
+- [ ] remove jobs.json? jobs history, alright. What do you do with that? images contain the prompt, what is this for?
 - [ ] improve get_latest_counter: fails when user renames files: appends text after counter
 - [ ] offer to place the counter anywhere, as a key in filename_keys
+- [ ] files can get out of order if prefixes change... that is expected, but is this what we want? another reason to have the counter place anywhere we want
+
+### release 2.46 💾
+- bug discovered with *rgthree's Ksampler Config*: using `steps_total` as an input to a Ksampler, will issue the index of the output, instead of the steps value ("\[nodeNum, 0]" instead of steps value). FIX: use `steps_total` instead of `steps`!
+- uncommented \_\_all\_\_ in init.py
+- potential bugfix in splitKey, `len(splitKey) = 2` to identify actual "node.widget" format
+
+### release 2.45 💾
+- added 💾 in the name
+
+### release 2.44
+- so many bugfixes
+- complete rework of generate_custom_name to handle ALL the possible scenarios
+- [x] bugfix: when using /name in foldername_keys, Comfy thinks you want to save outside the output folder
 
 ### release 2.43
 - [x] support for AVIF

__init__.py

@@ -13,4 +13,4 @@
 
 from .save_image_extended import NODE_CLASS_MAPPINGS, NODE_DISPLAY_NAME_MAPPINGS
 
-# __all__ = ['NODE_CLASS_MAPPINGS', 'NODE_DISPLAY_NAME_MAPPINGS']
+__all__ = ['NODE_CLASS_MAPPINGS', 'NODE_DISPLAY_NAME_MAPPINGS']

commit.gitsync

@@ -1 +0,0 @@
-WIP = =.txt

save_image_extended.py

@@ -26,19 +26,18 @@ original_locale = locale.setlocale(locale.LC_TIME, '')
 
 # class SaveImageExtended -------------------------------------------------------------------------------
 class SaveImageExtended:
-  #Version: 2.43
-  version                 = 2.43
+  version                 = 2.46
   type                    = 'output'
   
   png_compress_level      = 9
-  avif_quality            = 100
-  webp_quality            = 91
+  avif_quality            = 60
+  webp_quality            = 75
   jpeg_quality            = 91
   
-  filename_prefix         = 'myFile'
+  filename_prefix         = 'ComfyUI'
   filename_keys           = 'sampler_name, scheduler, cfg, steps'
-  foldername_prefix       = 'myFolder'
-  foldername_keys         = 'ckpt_name, ./exampleSubfolder'
+  foldername_prefix       = ''
+  foldername_keys         = 'ckpt_name, ./subfolder'
   delimiter               = '_'
   save_job_data           = 'basic, models, sampler, prompt'
   job_data_per_image      = False
@@ -49,13 +48,13 @@ class SaveImageExtended:
   counter_positions       = ['last', 'first']
   one_counter_per_folder  = True
   image_preview           = True
-  extToRemove             = ['.safetensors', '.ckpt', '.pt']
+  extToRemove             = ['.safetensors', '.ckpt', '.pt', '.bin', '.pth']
 
   print(f"\033[92m[save_image_extended]\033[0m version: {version}\033[0m")
   if pillow_avif not in sys.modules:
     output_ext              = '.avif'
     output_exts             = ['.avif', '.png', '.webp', '.jpg']
-    print(f"\033[92m[save_image_extended] AVIF is supported! Woohoo!\033[0m") 
+    print(f"\033[92m[save_image_extended] AVIF is supported! Woohoo!\033[0m\n") 
   else:
     output_ext              = '.png'
     output_exts             = ['.png', '.webp', '.jpg']
@@ -95,7 +94,7 @@ class SaveImageExtended:
           'basic, prompt', 
           'basic, sampler, prompt', 
           'basic, models, sampler, prompt'
-        ],{'default': self.save_job_data}),
+        ], {'default': self.save_job_data}),
         'job_data_per_image': ([False, True], {'default': self.job_data_per_image}),
         'job_custom_text': ('STRING', {'default': self.job_custom_text, 'multiline': False}),
         'save_metadata': ([True, False], {'default': self.save_metadata}),
@@ -147,9 +146,9 @@ class SaveImageExtended:
         if counter_position not in self.counter_positions: counter_position = self.counter_position
         if counter_position == 'last':
           # BUG: this works only if extension is 3 letters like png, this will break with webp and avif:
-          counters = [int(file[-(extLen + counter_digits):-extLen]) if file[-(extLen + counter_digits):-extLen].isdigit() else 0 for file in files if one_counter_per_folder or file.startswith(filename_prefix)]
+          counters = [int(file[-(extLen + counter_digits):-extLen]) if file[-(extLen + counter_digits):-extLen].isdecimal() else 0 for file in files if one_counter_per_folder or file.startswith(filename_prefix)]
         else:
-          counters = [int(file[:counter_digits]) if file[:counter_digits].isdigit() else 0 for file in files if one_counter_per_folder or file[counter_digits +1:].startswith(filename_prefix)]
+          counters = [int(file[:counter_digits]) if file[:counter_digits].isdecimal() else 0 for file in files if one_counter_per_folder or file[counter_digits +1:].startswith(filename_prefix)]
         
         if counters:
           counter = max(counters) + 1
@@ -160,7 +159,8 @@ class SaveImageExtended:
     return counter
   
   
-  def find_keys_recursively(self, prompt, keys_to_find, found_values):
+  # find_keys_recursively is a self-updating recursive method, that will update the dict found_values
+  def find_keys_recursively(self, prompt={}, keys_to_find=[], found_values={}):
     for key, value in prompt.items():
       if key in keys_to_find:
         found_values[key] = value
@@ -168,15 +168,17 @@ class SaveImageExtended:
         self.find_keys_recursively(value, keys_to_find, found_values)
   
   
-  def cleanup_fileName(self, value):
-    if isinstance(value, str):
+  def cleanup_fileName(self, file='', extToRemove=extToRemove):
+    if isinstance(file, str):
       # takes care of all the possible safetensor extensions under the sun
-      value = os.path.splitext(os.path.basename(value))[0]
-    return value
+      # cannot do that... maybe the user want a string.string fixed value to use, that does not end with extToRemove
+      # file = os.path.splitext(os.path.basename(file))[0]
+      for ext in extToRemove: file = file.removesuffix(ext)
+    return file
   
   
   # this method pretty much does the same as find_keys_recursively, except it's for job.json export
-  def find_parameter_values(self, target_keys, prompt, found_values={}):
+  def find_parameter_values(self, target_keys, prompt={}, found_values={}):
     loras_string = ''
     for key, value in prompt.items():
       # print(f"debug find_parameter_values: key={key} value={value}")
@@ -204,14 +206,19 @@ class SaveImageExtended:
     return found_values
   
   
-  def generate_custom_name(self, keys_to_extract, prefix, delimiter, resolution, prompt):
+  # String Type                 Example   isdecimal() isdigit() isnumeric()
+  # --------------------------- --------- ----------- --------- -----------
+  # Base 10 Numbers             '0123'    True        True      True
+  # Fractions and Superscripts  '⅔','2²'  False       True      True
+  # Roman Numerals              'ↁ'       False       False     True
+  # --------------------------- --------- ----------- --------- -----------
+  def generate_custom_name(self, keys_to_extract, prefix, delimiter, prompt):
     custom_name = prefix
-    if prompt is not None and len(keys_to_extract) > 0:
+    if prompt is not None and keys_to_extract != ['']:
       found_values = {}
       # print(f"debug generate_custom_name: --prefix: {prefix}")
       # print(f"debug generate_custom_name: --keys_to_extract: {keys_to_extract}")
       # print(f"debug generate_custom_name: --prompt:")
-      # pprint.pprint(prompt)
       
       # now separating numbered keys from non-numbered keys:
       #   37.ckpt_name = i want the ckpt_name from node #37
@@ -221,51 +228,82 @@ class SaveImageExtended:
       #   'inputs': {'cfg': 1.6, 
       #     'denoise': 1.0, ...
       for key in keys_to_extract:
+        value = None
         node, nodeKey = None, None
-        splitKey = key.split('.')
-        if len(splitKey) > 1:
-          node, nodeKey = splitKey[0], splitKey[1]
-          if node in prompt:
-            # print(f"debug generate_custom_name: --node.nodeKey = {node}.{nodeKey}")
-            # splitKey[0] = #node number found in prompt, we will recurse only in that node:
-            value = self.find_keys_recursively(prompt[node], [nodeKey], found_values)
-          else:
-            # if splitKey[0] = #node number not found in prompt, we will just inform the user
-            print(f"SaveImageExtended info: node #{node} not found")
-        else:
-          # from now on we will wotk with nodeKey, that will save us tons of if then else
-          nodeKey = key
-          # we just try and find the last value for that key, whichever node it's in:
-          value = self.find_keys_recursively(prompt, [nodeKey], found_values)
         
-        # at this point we have a nodeKey but maybe no value
-        # now we analyze each value found and format them accordingly:
-        value = found_values[nodeKey]
-        # print(f"debug generate_custom_name: ----key: {nodeKey}")
+        # check if this is a subfolder: starts with ./ or /, can also end with /
+        if '/' in key:
+          # key is a subfolder: ./subfolder or ../subfolder or /subfolder
+          value = key
+        else:
+          splitKey = key.split('.')
+          # we also exclude cases like "..string" or "sting.string.x" etc
+          if len(splitKey) == 2:
+            # key has the form string.string
+            if '' not in splitKey:
+              # key has the form string.string
+              if splitKey[0].isdecimal():
+                # key has the form num.widget_name like 123.widget_name, we will then look for widget_name value in node #123
+                node, nodeKey = splitKey[0], splitKey[1]
+                if node in prompt:
+                  # print(f"debug generate_custom_name: --node.nodeKey = {node}.{nodeKey}")
+                  # splitKey[0] = #node number found in prompt, we will recurse only in that node:
+                  self.find_keys_recursively(prompt[node], [nodeKey], found_values)
+                else:
+                  # if splitKey[0] = #num node not found in prompt; #num could have changed or user made a typo
+                  print(f"SaveImageExtended info: node #{node} not found")
+                  self.find_keys_recursively(prompt, [nodeKey], found_values)
+              else:
+                # key is in the form string.string = fixed string
+                value = self.cleanup_fileName(key)
+            else:
+              # key is in the form ".string" or "string." or "." - we won't clean that up and keep as is, maybe it's a separator
+              value = key
+          else:
+            # nodeKey is not a folder, has no dot, or multiple dots, could be a valid key to find, could be a fixed string - keep as is
+            nodeKey = key
+            self.find_keys_recursively(prompt, [nodeKey], found_values)
+          # is key num.widget_name
+        # is key subfolder
+        
+        # at this point we have a nodeKey, or a value, or both
+        # print(f"debug generate_custom_name: ----key:   {nodeKey}")
         # print(f"debug generate_custom_name: ----value: {value}")
-
         if value is None:
-          # key not found = it's a fixed string
-          # print(f"debug generate_custom_name: ------value=key: {nodeKey}")
-          value = nodeKey
+          if nodeKey is not None:
+            if nodeKey in found_values: value = found_values[nodeKey]
+            if value is None:
+              value = nodeKey
+            else:
+              value = self.cleanup_fileName(value)
+        
+        # at this point, value is not None anymore
+        # now we analyze each value found and format them accordingly:
+        # print(f"debug generate_custom_name: ----value: {value}")
+        delim = delimiter
+        
+        # now we build the custom_name:
+        if isinstance(value, str):
+          # prefix and keys can very well be subfolders ending or starting with a /
+          if custom_name.endswith('/'):
+            # for subfolders, do not start filename with a delimiter...
+            delim = ''
+          else:
+            # for subfolders in keys, do not clean the filename...
+            if '/' in value and not value.endswith('/'):
+              # print(f"debug generate_custom_name: ---------: folder")
+              delim= ''
+          # ".string" case
+          if value.startswith('.'):
+            delim = ''
         
         if isinstance(value, float):
           value = round(float(value), 1)
         
-        # now we build the custom_name:
-        if isinstance(value, str):
-          value = self.cleanup_fileName(value)
-          # prefix and keys can very well be subfolders ending or starting with a /
-          if (value.startswith('./') or value.startswith('/') or custom_name.endswith('/')):
-            # for subfolders, do not start filename with a delimiter...
-            custom_name += f"{value}"
-          else:
-            custom_name += f"{delimiter}{value}"
-        else:
-          # could be int or float, can't be anything else
-          custom_name += f"{delimiter}{value}"
+        custom_name += f"{delim}{value}"
         # print(f"debug generate_custom_name: ------custom_name: {custom_name}")
-    return custom_name.strip(delimiter)
+      # for each key
+    return custom_name.strip(delimiter).strip('.').strip('/').strip(delimiter)
   
   
   def save_job_to_json(self, save_job_data, prompt, filename_prefix, positive_text_opt, negative_text_opt, job_custom_text, resolution, output_path, filename):
@@ -459,39 +497,56 @@ class SaveImageExtended:
 # class SaveImageExtended -------------------------------------------------------------------------------
 
 
+  # node will never return None values, except for optional input. Impossible.
   def save_images(self,
-      counter_digits,
-      counter_position,
-      one_counter_per_folder,
-      delimiter,
-      filename_keys,
-      foldername_keys,
       images,
-      image_preview,
+      filename_prefix,
+      filename_keys,
+      foldername_prefix,
+      foldername_keys,
+      delimiter,
       save_job_data,
       job_data_per_image,
       job_custom_text,
       save_metadata,
-      filename_prefix=filename_prefix,
-      foldername_prefix=foldername_prefix,
-      extra_pnginfo=None,
+      counter_digits,
+      counter_position,
+      one_counter_per_folder,
+      image_preview,
+      output_ext,
       negative_text_opt=None,
       positive_text_opt=None,
+      extra_pnginfo=None,
       prompt=None,
-      output_ext=output_ext
     ):
     
+    # print(f"filename_prefix = x{filename_prefix}x")
+    # print(f"filename_keys = x{filename_keys}x")
+    # print(f"foldername_prefix = x{foldername_prefix}x")
+    # print(f"foldername_keys = x{foldername_keys}x")
+    # print(f"delimiter = x{delimiter}x")
+    # print(f"save_job_data = x{save_job_data}x")
+    # print(f"job_data_per_image = x{job_data_per_image}x")
+    # print(f"output_ext = x{output_ext}x")
+
+    # apply default values: we replicate the default save image box
+    if not filename_prefix and not filename_keys: filename_prefix=self.filename_prefix
+    if delimiter: delimiter = delimiter[0]
+    
+    filename_keys_to_extract = [item.strip() for item in filename_keys.split(',')]
+    foldername_keys_to_extract = [item.strip() for item in foldername_keys.split(',')]
+    
+    ################################## UNCOMMENT HERE TO SEE THE ENTIRE PROMPT
+    # pprint.pprint(prompt)
+    ##########################################################################
+    custom_filename = self.generate_custom_name(filename_keys_to_extract, filename_prefix, delimiter, prompt)
+    custom_foldername = self.generate_custom_name(foldername_keys_to_extract, foldername_prefix, delimiter, prompt)
+    
     # Get set resolution value
     i = 255. * images[0].cpu().numpy()
     img = Image.fromarray(np.clip(i, 0, 255).astype(np.uint8))
     resolution = f'{img.width}x{img.height}'
     
-    delimiter = delimiter[0]
-    filename_keys_to_extract = [item.strip() for item in filename_keys.split(',')]
-    foldername_keys_to_extract = [item.strip() for item in foldername_keys.split(',')]
-    custom_filename = self.generate_custom_name(filename_keys_to_extract, filename_prefix, delimiter, resolution, prompt)
-    custom_foldername = self.generate_custom_name(foldername_keys_to_extract, foldername_prefix, delimiter, resolution, prompt)
-    
     # Create folders, count images, save images
     try:
       full_output_folder, filename, _, _, custom_filename = folder_paths.get_save_image_path(custom_filename, self.output_dir, images[0].shape[1], images[0].shape[0])
@@ -540,7 +595,7 @@ NODE_CLASS_MAPPINGS = {
 
 
 NODE_DISPLAY_NAME_MAPPINGS = {
-  'SaveImageExtended': 'Save Image Extended',
+  'SaveImageExtended': '💾 Save Image Extended',
 }