* Better processing of interruptions using an exception.

* New option on_warning to stop on invalid content.
* New option cleanup_extra_separators_include_eol to choose whether to also remove adjacent EOLs when removing extra separators or not. Default is not to do it. In previous versions it was forced.
* Refactoring of the cleanup method.
* Only simplify attention modifiers when the merge attention option is set.
* A1111: avoid logging about HR prompts and avoid saving them in extra metadata when not different.
* A1111: consider options and environment info in the caching of results.
* Some refactorings.

Author: acorderob

.gitignore

@@ -3,3 +3,5 @@
 .vscode/**/*
 !.vscode/settings.json
 !.vscode/launch.json
+
+tests/tests_local.py

README.md

@@ -2,12 +2,12 @@
 
 The Prompt PostProcessor (PPP), formerly known as "sd-webui-sendtonegative", is an extension designed to process the prompt, possibly after other extensions have modified it. This extension is compatible with:
 
+* [ComfyUI](https://github.com/comfyanonymous/ComfyUI)
 * [AUTOMATIC1111 Stable Diffusion WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui)
 * [Forge](https://github.com/lllyasviel/stable-diffusion-webui-forge)
 * [reForge](https://github.com/Panchovix/stable-diffusion-webui-reForge)
 * [SD.Next](https://github.com/vladmandic/automatic)
 * ...and probably other forks
-* [ComfyUI](https://github.com/comfyanonymous/ComfyUI)
 
 Currently this extension has these functions:
 

docs/CONFIG.md

@@ -33,6 +33,7 @@ With this prompt: `__quality__, 1girl, ${head:__eyes__, __hair__, __expression__
 ### General settings
 
 * **Debug level**: what to write to the console. Note: in *SD.Next* debug messages only show if you launch it with the `--debug` argument.
+* **What to do on invalid content warnings?**: warn on the console or stop the generation.
 * **Model variant definitions**: definitions for model variants to be recognized based on strings found in the full filename.
 
     The format for each line is (with *kind* being one of the base model identifiers or not defined):
@@ -65,6 +66,7 @@ With this prompt: `__quality__, 1girl, ${head:__eyes__, __hair__, __expression__
 * **Remove empty constructs**: removes attention/scheduling/alternation constructs when they are invalid.
 * **Remove extra separators**: removes unnecessary separators. This applies to the configured separator and regular commas.
 * **Remove additional extra separators**: removes unnecessary separators at start or end of lines. This applies to the configured separator and regular commas.
+* **The extra separators options also remove EOLs**: in the previous two options it also removes EOLs attached to the separators.
 * **Clean up around BREAKs**: removes consecutive BREAKs and unnecessary commas and space around them.
 * **Use EOL instead of Space before BREAKs**: add a newline before BREAKs.
 * **Clean up around ANDs**: removes consecutive ANDs and unnecessary commas and space around them.

ppp.py

@@ -87,6 +87,13 @@ def INPUT_TYPES(cls):
                         "tooltip": "Debug level",
                     },
                 ),
+                "on_warnings": (
+                    [e.value for e in PromptPostProcessor.ONWARNING_CHOICES],
+                    {
+                        "default": PromptPostProcessor.ONWARNING_CHOICES.warn.value,
+                        "tooltip": "How to handle invalid content warnings",
+                    },
+                ),
                 "variants_definitions": (
                     "STRING",
                     {
@@ -201,6 +208,15 @@ def INPUT_TYPES(cls):
                         "label_off": "No",
                     },
                 ),
+                "cleanup_extra_separators_include_eol": (
+                    "BOOLEAN",
+                    {
+                        "default": False,
+                        "tooltip": "Extra separators options also remove EOLs",
+                        "label_on": "Yes",
+                        "label_off": "No",
+                    },
+                ),
                 "cleanup_breaks": (
                     "BOOLEAN",
                     {
@@ -304,6 +320,7 @@ def IS_CHANGED(
         neg_prompt,
         seed,
         debug_level,  # pylint: disable=unused-argument
+        on_warnings,
         variants_definitions,
         wc_process_wildcards,
         wc_wildcards_folders,
@@ -317,6 +334,7 @@ def IS_CHANGED(
         cleanup_empty_constructs,
         cleanup_extra_separators,
         cleanup_extra_separators2,
+        cleanup_extra_separators_include_eol,
         cleanup_breaks,
         cleanup_breaks_eol,
         cleanup_ands,
@@ -335,6 +353,7 @@ def IS_CHANGED(
             "pos_prompt": pos_prompt,
             "neg_prompt": neg_prompt,
             "seed": seed,
+            "on_warnings": on_warnings,
             "variants_definitions": variants_definitions,
             "process_wildcards": wc_process_wildcards,
             "wildcards_folders": wc_wildcards_folders,
@@ -348,6 +367,7 @@ def IS_CHANGED(
             "cleanup_empty_constructs": cleanup_empty_constructs,
             "cleanup_extra_separators": cleanup_extra_separators,
             "cleanup_extra_separators2": cleanup_extra_separators2,
+            "cleanup_extra_separators_include_eol": cleanup_extra_separators_include_eol,
             "cleanup_breaks": cleanup_breaks,
             "cleanup_breaks_eol": cleanup_breaks_eol,
             "cleanup_ands": cleanup_ands,
@@ -367,6 +387,7 @@ def process(
         neg_prompt,
         seed,
         debug_level,
+        on_warnings,
         variants_definitions,
         wc_process_wildcards,
         wc_wildcards_folders,
@@ -380,6 +401,7 @@ def process(
         cleanup_empty_constructs,
         cleanup_extra_separators,
         cleanup_extra_separators2,
+        cleanup_extra_separators_include_eol,
         cleanup_breaks,
         cleanup_breaks_eol,
         cleanup_ands,
@@ -436,6 +458,7 @@ def process(
             raise ValueError("Invalid variants_definitions format")
         options = {
             "debug_level": debug_level,
+            "on_warnings": on_warnings,
             "variants_definitions": variants_definitions,
             "process_wildcards": wc_process_wildcards,
             "if_wildcards": wc_if_wildcards,
@@ -447,6 +470,7 @@ def process(
             "cleanup_empty_constructs": cleanup_empty_constructs,
             "cleanup_extra_separators": cleanup_extra_separators,
             "cleanup_extra_separators2": cleanup_extra_separators2,
+            "cleanup_extra_separators_include_eol": cleanup_extra_separators_include_eol,
             "cleanup_breaks": cleanup_breaks,
             "cleanup_breaks_eol": cleanup_breaks_eol,
             "cleanup_ands": cleanup_ands,

ppp_comfyui.py

@@ -91,8 +91,8 @@ def refresh_wildcards(
         """
         self.__debug_level = debug_level
         self.__wildcards_folders = wildcards_folders or []
-        # if self.debug_level != DEBUG_LEVEL.none:
-        #     self.logger.info("Refreshing wildcards...")
+        # if self.__debug_level != DEBUG_LEVEL.none:
+        #     self.__logger.info("Refreshing wildcards...")
         # t1 = time.time()
         for fullpath in list(self.__wildcard_files.keys()):
             if fullpath != self.LOCALINPUT_FILENAME:
@@ -113,8 +113,8 @@ def refresh_wildcards(
             self.wildcards = {}
             self.__wildcard_files = {}
         # t2 = time.time()
-        # if self.debug_level != DEBUG_LEVEL.none:
-        #     self.logger.info(f"Wildcards refresh time: {t2 - t1:.3f} seconds")
+        # if self.__debug_level != DEBUG_LEVEL.none:
+        #     self.__logger.info(f"Wildcards refresh time: {t2 - t1:.3f} seconds")
 
     def get_wildcards(self, key: str) -> list[PPPWildcard]:
         """

ppp_wildcards.py

@@ -1,7 +1,7 @@
 [project]
 name = "sd-webui-prompt-postprocessor"
 description = "Stable Diffusion WebUI & ComfyUI extension to post-process the prompt, including sending content from the prompt to the negative prompt and wildcards."
-version = "2.10.0"
+version = "2.11.0"
 license = { file = "LICENSE.txt" }
 dependencies = ["lark", "numpy", "pyyaml"]
 

pyproject.toml

@@ -4,9 +4,10 @@
 import sys
 import os
 import time
+from pathlib import Path
 import numpy as np
 
-sys.path.append(os.path.join(os.path.realpath(__file__), ".."))  # base path for the extension
+sys.path.append(str(Path(__file__).parent))  # base path for the extension
 
 from modules import scripts, shared, script_callbacks  # pylint: disable=import-error
 from modules.processing import StableDiffusionProcessing  # pylint: disable=import-error
@@ -279,6 +280,7 @@ def process(
             env_info["is_sd3"] = getattr(p.sd_model, "is_sd3", False)
             env_info["is_flux"] = False
             env_info["is_auraflow"] = False
+        hash_envinfo = hash(tuple(sorted(env_info.items())))
         wc_wildcards_folders = getattr(opts, "ppp_wil_wildcardsfolders", "")
         if wc_wildcards_folders == "":
             wc_wildcards_folders = os.getenv("WILDCARD_DIR", PPPWildcards.DEFAULT_WILDCARDS_FOLDER)
@@ -289,6 +291,7 @@ def process(
         ]
         options = {
             "debug_level": getattr(opts, "ppp_gen_debug_level", DEBUG_LEVEL.none.value),
+            "on_warning": getattr(opts, "ppp_gen_onwarning", PromptPostProcessor.ONWARNING_CHOICES.warn.value),
             "variants_definitions": getattr(
                 opts, "ppp_gen_variantsdefinitions", PromptPostProcessor.DEFAULT_VARIANTS_DEFINITIONS
             ),
@@ -302,6 +305,7 @@ def process(
             "cleanup_empty_constructs": getattr(opts, "ppp_cup_emptyconstructs", True),
             "cleanup_extra_separators": getattr(opts, "ppp_cup_extraseparators", True),
             "cleanup_extra_separators2": getattr(opts, "ppp_cup_extraseparators2", True),
+            "cleanup_extra_separators_include_eol": getattr(opts, "ppp_cup_extraseparators_include_eol", True),
             "cleanup_breaks": getattr(opts, "ppp_cup_breaks", True),
             "cleanup_breaks_eol": getattr(opts, "ppp_cup_breaks_eol", False),
             "cleanup_ands": getattr(opts, "ppp_cup_ands", True),
@@ -310,6 +314,7 @@ def process(
             "cleanup_merge_attention": getattr(opts, "ppp_cup_mergeattention", True),
             "remove_extranetwork_tags": getattr(opts, "ppp_rem_removeextranetworktags", False),
         }
+        hash_options = hash(tuple(sorted(options.items())))
         self.wildcards_obj.refresh_wildcards(
             self.ppp_debug_level, wildcards_folders if options["process_wildcards"] else None
         )
@@ -367,7 +372,7 @@ def process(
         # make it compatible with A1111 hires fix
         rph: list[str] = getattr(p, "all_hr_prompts", None)
         rnh: list[str] = getattr(p, "all_hr_negative_prompts", None)
-        if rph is not None and rnh is not None:
+        if rph is not None and rnh is not None and (rph != rpr or rnh != rnr):
             prompts_list += [
                 ("hiresfix", seed, prompt, negative_prompt)
                 for seed, prompt, negative_prompt in zip(calculated_seeds, rph, rnh)
@@ -378,22 +383,35 @@ def process(
         for i, (prompttype, seed, prompt, negative_prompt) in enumerate(prompts_list):
             if self.ppp_debug_level != DEBUG_LEVEL.none:
                 self.ppp_logger.info(f"processing prompts[{i+1}] ({prompttype})")
-            if self.lru_cache.get((seed, hash(self.wildcards_obj), prompt, negative_prompt)) is None:
+            if (
+                self.lru_cache.get(
+                    (hash_envinfo, hash_options, seed, hash(self.wildcards_obj), prompt, negative_prompt)
+                )
+                is None
+            ):
                 posp, negp, _ = ppp.process_prompt(prompt, negative_prompt, seed)
-                self.lru_cache.put((seed, hash(self.wildcards_obj), prompt, negative_prompt), (posp, negp))
+                self.lru_cache.put(
+                    (hash_envinfo, hash_options, seed, hash(self.wildcards_obj), prompt, negative_prompt), (posp, negp)
+                )
                 # adds also the result so i2i doesn't process it unnecessarily
-                self.lru_cache.put((seed, hash(self.wildcards_obj), posp, negp), (posp, negp))
+                self.lru_cache.put(
+                    (hash_envinfo, hash_options, seed, hash(self.wildcards_obj), posp, negp), (posp, negp)
+                )
             elif self.ppp_debug_level != DEBUG_LEVEL.none:
                 self.ppp_logger.info("result already in cache")
 
         # updates the prompts
+        rpr_copy = None
+        rnr_copy = None
         if rpr is not None and rnr is not None:
             rpr_changes = False
             rnr_changes = False
             rpr_copy = rpr.copy()
             rnr_copy = rnr.copy()
             for i, (seed, prompt, negative_prompt) in enumerate(zip(calculated_seeds, rpr, rnr)):
-                found = self.lru_cache.get((seed, hash(self.wildcards_obj), prompt, negative_prompt))
+                found = self.lru_cache.get(
+                    (hash_envinfo, hash_options, seed, hash(self.wildcards_obj), prompt, negative_prompt)
+                )
                 if found is not None:
                     if rpr[i].strip() != found[0].strip():
                         rpr_changes = True
@@ -412,11 +430,13 @@ def process(
             rph_copy = rph.copy()
             rnh_copy = rnh.copy()
             for i, (seed, prompt, negative_prompt) in enumerate(zip(calculated_seeds, rph, rnh)):
-                found = self.lru_cache.get((seed, hash(self.wildcards_obj), prompt, negative_prompt))
+                found = self.lru_cache.get(
+                    (hash_envinfo, hash_options, seed, hash(self.wildcards_obj), prompt, negative_prompt)
+                )
                 if found is not None:
-                    if rph[i].strip() != found[0].strip():
+                    if rph[i].strip() != found[0].strip() and (not rpr_copy or rph[i].strip() != rpr_copy[i].strip()):
                         rph_changes = True
-                    if rnh[i].strip() != found[1].strip():
+                    if rnh[i].strip() != found[1].strip() and (not rnr_copy or rnh[i].strip() != rnr_copy[i].strip()):
                         rnh_changes = True
                     rph[i] = found[0]
                     rnh[i] = found[1]
@@ -502,6 +522,21 @@ def new_html_title(title):
             section=section,
         ),
     )
+    shared.opts.add_option(
+        key="ppp_gen_onwarning",
+        info=shared.OptionInfo(
+            default=PromptPostProcessor.ONWARNING_CHOICES.warn.value,
+            label="What to do on invalid content warnings?",
+            component=gr.Radio,
+            component_args={
+                "choices": (
+                    ("Show warning in console", PromptPostProcessor.ONWARNING_CHOICES.warn.value),
+                    ("Stop the generation", PromptPostProcessor.ONWARNING_CHOICES.stop.value),
+                )
+            },
+            section=section,
+        ),
+    )
     shared.opts.add_option(
         key="ppp_gen_variantsdefinitions",
         info=shared.OptionInfo(
@@ -656,6 +691,14 @@ def new_html_title(title):
             section=section,
         ),
     )
+    shared.opts.add_option(
+        key="ppp_cup_extraseparators_include_eol",
+        info=shared.OptionInfo(
+            False,
+            label="The extra separators options also remove EOLs",
+            section=section,
+        ),
+    )
     shared.opts.add_option(
         key="ppp_cup_breaks",
         info=shared.OptionInfo(