* Fix loading widget values in recent ComfyUI versions.

* Fix cleaning constructs with only whitespace.
* Logging supports saving to file (used optionally in tests).
* Fix en refresh wildcards.

.gitignore

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

README.md

@@ -2,12 +2,11 @@
 
 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:
 
@@ -15,6 +14,7 @@ Currently this extension has these functions:
 * Set and modify local variables.
 * Filter content based on the loaded SD model or a variable.
 * Process wildcards. Compatible with Dynamic Prompts formats. Can also detect invalid wildcards and act as you choose.
+* Map extranetworks (LoRAs) depending on conditions (like the loaded model variant).
 * Clean up the prompt and negative prompt.
 
 Note: when used in an *A1111* compatible webui, the extension must be loaded after any other extension that modifies the prompt (like another wildcards extension). Usually extensions load by their folder name in alphanumeric order, so if the extensions are not loading in the correct order just rename this extension's folder so the ordering works out. When in doubt, just rename this extension's folder with a "z" in front (for example) so that it is the last one to load, or manually set such folder name when installing it.
@@ -49,7 +49,7 @@ On *A1111* compatible webuis:
 3. Click the Install button
 4. Restart the webui
 
-On *SD.Next* I recommend you disable the native wildcard processing.
+On *SD.Next* I recommend you to disable the native wildcard processing and use the old UI.
 
 On *ComfyUI*:
 

docs/CONFIG.md

@@ -10,6 +10,7 @@
 * **pos_prompt**: Connect here the prompt text, or fill it as a widget.
 * **neg_prompt**: Connect here the negative prompt text, or fill it as a widget.
 * **wc_wildcards_input**: Wildcards definitions (in yaml or json format). Direct input added to the ones found in the wildcards folders. Allows wildcards to be included in the workflow.
+* **en_mappings_input**: Extranetwork Mappings definitions (in yaml format). Direct input added to the ones found in the extranetwork mappings folders. Allows the mappings to be included in the workflow.
 
 Other common settings (see [below](#common-settings)) also appear as inputs or widgets.
 
@@ -33,6 +34,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):
@@ -42,12 +44,13 @@ With this prompt: `__quality__, 1girl, ${head:__eyes__, __hair__, __expression__
     The default value defines strings for *Pony* and *Illustrious* models.
 * **Apply in img2img**: check if you want to do the processing in img2img processes (*does not apply to the ComfyUI node*).
 * **Add original prompts to metadata**: adds original prompts to the metadata if they have changed (*does not apply to the ComfyUI node*).
+* **Extranetwork Mappings folders**: you can enter multiple folders separated by commas. In *ComfyUI* you can leave it empty and add a `ppp_extranetworkmappings` entry in the **extra_model_paths.yaml** file.
 
 ### Wildcard settings
 
-* **Process wildcards**: you can choose to process them with this extension or use a different one.
+* **Process wildcards**: you can choose to process wildcards and choices with this extension or use a different one.
-* **Wildcards folders**: you can enter multiple folders separated by commas. In *ComfyUI* you can leave it empty and add a `wildcards` entry in the **extra_model_paths.yaml** file.
+* **Wildcards folders**: you can enter multiple folders separated by commas. In *ComfyUI* you can leave it empty and add a `ppp_wildcards` or `wildcards` entry in the **extra_model_paths.yaml** file.
-* **What to do with remaining wildcards?**: select what do you want to do with any found wildcards.
+* **What to do with remaining wildcards?**: select what do you want to do with any found wildcards/choices (when process wildcards is off or after the processing).
   * **Ignore**: do not try to detect wildcards.
   * **Remove**: detect wildcards and remove them.
   * **Add visible warning**: detect wildcards and add a warning text to the prompt, that hopefully produces a noticeable generation.
@@ -65,6 +68,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.

docs/SYNTAX.md

@@ -4,7 +4,7 @@
 
 The extension uses a format for its commands similar to an extranetwork, but it has a "ppp:" prefix followed by the command, and then a space and any parameters (if any).
 
-`<ppp:command parameters>`
+`<ppp:command parameters/>`
 
 When a command is associated with any content, it will be between an opening and a closing command:
 
@@ -24,19 +24,25 @@ The construct parameters can be written with the following options (all are opti
 
 * "**~**" or "**@**": sampler (for compatibility with *Dynamic Prompts*), but only "**~**" (random) is supported.
 * "**r**": means it allows repetition of the choices.
+* "**o**": means it is "optional", and no error will be raised if there are no choices to select from.
 * "**n**" or "**n-m**" or "**n-**" or "**-m**": number or range of choices to select. Allows zero as the start of a range. Default is 1.
 * "**$$sep**": separator when multiple choices are selected. Default is set in settings.
-* "**$$**": end of the parameters.
+* "**$$**": end of the parameters (not optional if any parameters).
+
+Regarding the "optional" flag, consider this scenario: due to their conditions no choice is available. It will raise an error. If you add the `o` then it will just return an empty string. This is only necessary if all choices have conditions and they could all be false. It is not the same as setting a range starting at 0, because that would be an allowed number of returned choices. If you do this and no choices are available, no error is raised.
 
 The choice options are as follows:
 
+* "**%**": indicates that the content of the choice is a command
 * "**'identifiers'**": comma separated labels for the choice (optional, quotes can be single or double). Only makes sense inside a wildcard definition. Can be used when specifying the wildcard to select this specific choice. It's case insensitive.
 * "**n**": weight of the choice (optional, default 1).
 * "**if condition**": filters out the choice if the condition is false (optional; this is an extension to the *Dynamic Prompts* syntax). Same conditions as in the `if` command.
-* "**::**": end of choice options
+* "**::**": end of choice options (not optional if any options)
 
 Whitespace is allowed between parameters/options.
 
+The only command available is `include wildcard`, which will include the choices of the specified wildcard in place of this choice. This allows composing choices from multiple wildcards. It also works in the choices of a wildcard, but note that in yaml you cannot start an array element with "%" and you will have to put the full choice in quotes, or use the object format.
+
 These are examples of formats you can use to insert a choice construct:
 
 | Construct                                      | Result |
@@ -46,10 +52,12 @@ These are examples of formats you can use to insert a choice construct:
 | `{2-3$$2::choice1\|choice2\|choice3}`          | select 2 to 3 choices, one of them has a weight |
 | `{r2-3$$choice1\|choice2\|choice3}`            | select 2 to 3 choices allowing repetition |
 | `{2-3$$ / $$choice1\|choice2\|choice3}`        | select 2 to 3 choices with separator " / " |
+| `{o$$if _is_sd1::choice1\|if _is_sd2::choice2}`| select 1 choice, both have conditions, if none matches it is allowed because we indicate that it is optional |
+| `{choice1\|choice2\|%0.5::path/wildcard}`      | select 1 choice from the two specified and the ones inside the path/wildcard wildcard, which will be weighted with half their weights |
 
 Notes:
 
-* The *Dynamic Prompts* format `{2$$__flavours__}` does not work as expected. It will only output one value. You can write is as `{r2$$__flavours__}` to get two values, but they may repeat since the evaluation of the wildcard is independent of the choices selection.
+* The *Dynamic Prompts* format `{2$$__flavours__}` does not work as expected because the wildcard is considered only one possible choice (it will only output one value). You can write it instead as a wildcard with parameters `__2$$flavours__`.
 * Whitespace around the choices is not ignored like in *Dynamic Prompts*, but will be cleaned up if the appropriate cleaning settings are selected.
 
 ## Wildcards
@@ -58,26 +66,40 @@ The generic format is: `__parameters$$wildcard'filter'(var=value)__`
 
 The parameters, the filter, and the setting of a variable are optional. The parameters follow the same format as for the choices.
 
-The wildcard identifier can have a relative path and contain globbing formatting, to read multiple wildcards and merge their choices. Note that if there are no parameters specified, the globbing will use the ones from the first wildcard that matches and have parameters (sorted by keys), so if you don't want that you might want to specify them. Also note that, unlike with *Dynamic Prompts*, the wildcard name has to be specified with its full path (unless you use globbing).
+Wildcards cannot be used inside an extranetwork tag (because some lora names contain double underscores). If you need to choose from multiple loras put the whole extranetwork tag inside a wildcard, or use choices.
 
-The filter can be used to filter specific choices from the wildcard. The filtering works before applying the choice conditions (if any). The surrounding quotes can be single or double. The filter is a comma separated list of an integer (positional choice index; zero-based) or choice label. You can also compound them with `+`. That is, the comma separated items act as an OR and the `+` inside them as an AND. Using labels can simplify the definitions of complex wildcards where you want to have direct access to specific choices on occasion (you don't need to create wildcards for each individual choice). There are some additional formats when using filters. You can specify `^wildcard` as a filter to use the filter of a previous wildcard in the chain. You can start the filter (regular or inherited) with `#` and it will not be applied to the current wildcard choices, but the filter will remain in memory to use by other descendant wildcards. You use `#` and `^` when you want to pass a filter to inner wildcards (see the test files).
+### Identifier
+
+* Allowed characters are letters, numbers, underscore (`_`), dash (`-`), dot (`.`), and the path separators (`/` and `\`). It cannot start with an underscore because it would be ambiguous whether it's part of the name or just precedes the wildcard.
+* Can have a relative path and contain globbing formatting, to read multiple wildcards and merge their choices. Note that if there are no parameters specified, the globbing will use the ones from the first wildcard that matches and have parameters (sorted by keys), so if you don't want that you might want to specify them. Also note that, unlike with *Dynamic Prompts*, the wildcard name has to be specified with its full path (unless you use globbing).
+* You can use variables, with the `${name}`, `${name:default}`, `<ppp:echo name/>` or `<ppp:echo name>default<ppp:/>echo>` formats, to build a dynamic identifier.
+
+### Filter
+
+The filter can be used to filter specific choices from the wildcard. The filtering works before applying the choice conditions (if any). The surrounding quotes can be single or double.
+
+The filter is a comma separated list of an integer (positional choice index, zero-based) or choice label. You can also compound them with `+`. That is, the comma separated items act as an OR and the `+` inside them as an AND. Using labels can simplify the definitions of complex wildcards where you want to have direct access to specific choices on occasion (you don't need to create wildcards for each individual choice). There are some additional formats when using filters. You can specify `^wildcard` as a filter to use the filter of a previous wildcard in the chain. You can start the filter (regular or inherited) with `#` and it will not be applied to the current wildcard choices, but the filter will remain in memory to use by other descendant wildcards. You use `#` and `^` when you want to pass a filter to inner wildcards (see the test files).
+
+### Variable
 
 The variable value only applies during the evaluation of the selected choices and is discarded afterward (the variable keeps its original value if there was one).
 
+### Examples
+
 These are examples of formats you can use to insert a wildcard:
 
-| Construct                            | Result |
+| Construct                            | Result                                                                   |
-| ---------                            | ------ |
+| ---------                            | ------                                                                   |
-| `__wildcard__`                       | select 1 choice |
+| `__wildcard__`                       | select 1 choice                                                          |
-| `__path/wildcard'0'__`               | select the first choice |
+| `__path/wildcard'0'__`               | select the first choice                                                  |
-| `__path/wildcard'label'__`           | select the choices with label "label" |
+| `__path/wildcard'label'__`           | select the choices with label "label"                                    |
-| `__path/wildcard'0,label1,label2'__` | select the first choice and those with labels "label1" or "label2" |
+| `__path/wildcard'0,label1,label2'__` | select the first choice and those with labels "label1" or "label2"       |
 | `__path/wildcard'0,label1+label2'__` | select the first choice and those with both labels "label1" and "label2" |
-| `__3$$path/wildcard__`               | select 3 choices |
+| `__3$$path/wildcard__`               | select 3 choices                                                         |
-| `__2-3$$path/wildcard__`             | select 2 to 3 choices |
+| `__2-3$$path/wildcard__`             | select 2 to 3 choices                                                    |
-| `__r2-3$$path/wildcard__`            | select 2 to 3 choices allowing repetition |
+| `__r2-3$$path/wildcard__`            | select 2 to 3 choices allowing repetition                                |
-| `__2-3$$ / $$path/wildcard__`        | select 2 to 3 choices with separator " / " |
+| `__2-3$$ / $$path/wildcard__`        | select 2 to 3 choices with separator " / "                               |
-| `__path/wildcard(var=value)__`       | select 1 choice using the specified variable value in the evaluation. |
+| `__path/wildcard(var=value)__`       | select 1 choice using the specified variable value in the evaluation.    |
 
 ### Wildcard definitions
 
@@ -90,17 +112,17 @@ The best format is a yaml file with a dictionary of wildcards inside. An editor
 
 In a choice, the content after a `#`  is ignored.
 
-If the first choice follows the format of wildcard parameters, it will be used as default parameters for that wildcard (see examples in the tests folder). The choices of the wildcard follow the same format as in the choices construct, or the object format of *Dynamic Prompts* (only in structured files). If using the object format for a choice you can use a new `if` property for the condition, and the `labels` property (an array of strings) in addition to the standard `weight` and `text`/`content`.
+If the first choice follows the format of wildcard parameters (*including the final `$$`*), it will be used as default parameters for that wildcard (see examples in the tests folder). The choices of the wildcard follow the same format as in the choices construct, or the object format of *Dynamic Prompts* (only in structured files). If using the object format for a choice you can use a new `if` property for the condition, and the `labels` property (an array of strings) and `command` property (a boolean) in addition to the standard `weight` and `text`/`content`.
 
 ```yaml
-{ labels: ["some_label"], weight: 2, if: "_is_pony", content: "the text" } # "text" property can be used instead of "content"
+{ command: false, labels: ["some_label"], weight: 2, if: "_is_pony", content: "the text" } # "text" property can be used instead of "content"
 ```
 
 Wildcard parameters in a json/yaml file can also be in object format, and support two additional properties, prefix and suffix:
 
 ```yaml
-{ sampler: "~", repeating: false, count: 2, prefix: "prefix-", suffix: "-suffix", separator: "/" }
+{ sampler: "~", repeating: false, optional: false, count: 2, prefix: "prefix-", suffix: "-suffix", separator: "/" }
-{ sampler: "~", repeating: false, from: 2, to: 3, prefix: "prefix-", suffix: "-suffix", separator: "/" }
+{ sampler: "~", repeating: false, optional: false, from: 2, to: 3, prefix: "prefix-", suffix: "-suffix", separator: "/" }
 ```
 
 The prefix and suffix are added to the result along with the selected choices and separators. They can contain other constructs, but the separator can't.
@@ -111,6 +133,12 @@ Wildcards can contain just one choice. In json and yaml formats this allows the
 
 A choice inside a wildcard can also be a list or a dictionary of one element containing a list. These are considered anonymous wildcards. With a list it will be an anonymous wildcard with no choice options, and with a dictionary the key will be the options for the choice containing the anonymous wildcard and the value the choices of the anonymous wildcard. Anonymous wildcards can help formatting complex choice values that are used in only one place and thus creating a regular wildcard is not necessary. See test.yaml for examples.
 
+Remember you can use the include command on choices to compose a wildcard from other wildcards' choices.
+
+Note: the files should have UTF-8 encoding. The extension will also try with windows-1252 if that fails.
+
+Wildcard definitions are reloaded automatically on each generation if they change.
+
 ### Detection of remaining wildcards
 
 This extension should run after any other wildcard extensions, so if you don't use the internal wildcards processing, any remaining wildcards present in the prompt or negative_prompt at this point must be invalid. Usually you might not notice this problem until you check the image metadata, so this option gives you some ways to detect and treat the problem.
@@ -131,18 +159,18 @@ The `add` and `ifundefined` modifiers are mutually exclusive and cannot be used
 
 The *Dynamic Prompts* format also works:
 
-| Construct       | Meaning |
+| Construct       | Meaning              |
-| ---------       | ------- |
+| ---------       | -------              |
-| `${var=value}`  | regular evaluation |
+| `${var=value}`  | regular evaluation   |
 | `${var=!value}` | immediate evaluation |
 
 If also supports the addition and undefined check as an extension of the *Dynamic Prompts* format:
 
-| Construct        | Meaning |
+| Construct        | Meaning                              |
-| ---------        | ------- |
+| ---------        | -------                              |
-| `${var+=value}`  | equivalent to "add" |
+| `${var+=value}`  | equivalent to "add"                  |
-| `${var+=!value}` | equivalent to "evaluate add" |
+| `${var+=!value}` | equivalent to "evaluate add"         |
-| `${var?=value}`  | equivalent to "ifundefined" |
+| `${var?=value}`  | equivalent to "ifundefined"          |
 | `${var?=!value}` | equivalent to "evaluate ifundefined" |
 
 ## Echo command
@@ -153,7 +181,7 @@ The format is:
 
 | Construct                              |
 | ---------                              |
-| `<ppp:echo varname>`                   |
+| `<ppp:echo varname/>`                  |
 | `<ppp:echo varname>default<ppp:/echo>` |
 
 The *Dynamic Prompts* format is:
@@ -175,10 +203,10 @@ Any `elif`s (there can be multiple) and the `else` are optional.
 
 The `conditionN` can be:
 
-| Construct                                      | Meaning |
+| Construct                                      | Meaning                                     |
-| ---------                                      | ------- |
+| ---------                                      | -------                                     |
-| `variable`                                     | check truthyness of the variable |
+| `variable`                                     | check truthyness of the variable            |
-| `variable [not] operation value`               | check the variable against a value |
+| `variable [not] operation value`               | check the variable against a value          |
 | `variable [not] operation (value1,value2,...)` | check the variable against a list of values |
 
 For a simple value the allowed operations are `eq`, `ne`, `gt`, `lt`, `ge`, `le`, `contains` and the value can be a quoted string or an integer. For a list of values the allowed operations are `contains`, `in` and the value of the variable is checked against all the elements of the list until one matches. The operation can be preceded by `not` for readability, instead of using it in the front.
@@ -221,14 +249,91 @@ The variable can be one set with the `set` or `add` commands (user variables) or
 
 Only one of the options will end up in the prompt, depending on the loaded model.
 
+## ExtraNetwork command
+
+This command is a shortcut to add an extranetwork (usually a lora), and its triggers, with conditions. More legible and sometimes shorter than adding regular extranetworks inside if commands.
+
+The full format is:
+
+`<ppp:ext type name [parameters] [if condition]>[triggers]<ppp:/ext>`
+`<ppp:ext type name [parameters] [if condition]/>`
+
+The `type` is the kind of extranetwork, like `lora` or `hypernet`.
+
+The `name` is the extranetwork identifier. If it is not a regular identifier (i.e. starts with a number or contains spaces or symbols) it should be inside quotes.
+
+The `parameters` is optional and its format depends on the extranetwork type. With loras or hypernets it is usually a single weight number, so if the type is one of those and there are no parameters it will default to `1`. If it is not a number it should go inside quotes.
+
+The `condition` uses the same format as in the `if` command, and it is also optional.
+
+The `triggers` are also optional, and can be any content. If there are no triggers the command ending can be omitted.
+
+If the condition passes (or if there is no condition) the extranetwork tag will be built and added to the result along with any triggers.
+
+### Examples
+
+(multiline to be easier to read)
+
+```text
+<ppp:ext lora test_sd1 if _is_sd1>test sd1x<ppp:/ext>
+<ppp:ext lora test_pony 0.5 if _is_pony>test pony<ppp:/ext>
+<ppp:ext lora test_ilxl if _is_illustrious/>
+<ppp:ext lora 'test sdxl' '1:0.8' if _is_pure_sdxl>test sdxl<ppp:/ext>
+```
+
+Will turn into one of these (or none) depending on the model:
+
+* `<lora:test_sd1:1>test sd1x`
+* `<lora:test_pony:0.5>test pony`
+* `<lora:test_illustrious:1>`
+* `<lora:test sdxl:1:0.8>test sdxl`
+
+### Extranetworks mappings
+
+The extranetwork command supports specifying mappings of extranetworks (like LoRAs), so, for example, a different one can be used depending on the loaded model.
+
+If the type of extranetwork is prefixed with a `$` the command will look for a mapping.
+
+The mappings are configured in yaml files in any of the configured extranetwork mappings folders. The format is like this:
+
+```yaml
+extnettype:
+  mappingname:
+    - condition: "<a supported condition>"
+      name: "<name of the extranetwork>"
+      parameters: "<parameters of the extranetwork>"
+      triggers: [<list of triggers>]
+      weight: 1.0
+    ...
+```
+
+Used like this:
+
+```text
+<ppp:ext $lora mappingname/>
+<ppp:ext $lora mappingname>inline triggers<ppp:/ext>
+```
+
+Each mapping can have any number of elements in its list of mappings. There are no mandatory properties for a mapping. The properties mean the following:
+
+* `extnettype`: the kind of extranetwork, for example `lora`.
+* `mappingname`: the name you want to give to the mapping, to be referenced in the command.
+* `condition`: the condition to check for this mapping to be used (usually it should be one of the `_is_*` variables). If the conditions of multiple mappings evaluate to True, one will be chosen randomly. If the condition is missing it is considered True, to be used in the last mapping to catch as an "else" condition, and will be used if no other mapping applies.
+* `name`: name of the real extranetwork. If it is missing no extranetwork tag will be added.
+* `parameters`: parameters for the real extranetwork. If it is missing it is assumed "1" for loras and hypernets. If both this parameter and the parameter in the ext command are numbers they are multiplied for the result. In other case the parameter of the ext command, if it exists, is used.
+* `triggers`: list of trigger strings. If it is missing, only the inline triggers in the ext command will be added.
+* `weight`: weight for this variant, in case multiple of them apply, to choose one. Default is 1.
+
+See the file in the tests folder as an example.
+
 ## Sending content to the negative prompt
 
 The new format for this command is like this:
 
-| Construct                             | Meaning |
+| Construct                             | Meaning                                                                              |
-| ---------                             | ------- |
+| ---------                             | -------                                                                              |
-| `<ppp:stn position>content<ppp:/stn>` | send to negative prompt |
+| `<ppp:stn position>content<ppp:/stn>` | send to negative prompt                                                              |
-| `<ppp:stn iN>`                        | insertion point to be used in the negative prompt as destination for the pN position |
+| `<ppp:stn iN/>`                       | insertion point to be used in the negative prompt as destination for the pN position |
 
 Where position is optional (defaults to the start) and can be:
 

grammar.lark

@@ -1,12 +1,13 @@
 %import common (LETTER, DIGIT, INT, CNAME, SIGNED_NUMBER, NUMBER)
 
-_WHITESPACE:   /\s+/
+_WHITESPACE:         /\s+/
-STRING:        /("(?!"").*?(?<!\\)(\\\\)*?"|'(?!'').*?(?<!\\)(\\\\)*?')/i
+STRING:              /("(?!"").*?(?<!\\)(\\\\)*?"|'(?!'').*?(?<!\\)(\\\\)*?')/i // string with single or double quotes
-BOOLEAN:       /true|false/i
+BOOLEAN:             /true|false/i
-WILDCARD_NAME: /(?:(?!__|\$\$|[('"])\S)+/
+WC_NAME_PLAIN_START: /(?:(?!__|\$\$|\$\{|<ppp:|[('"])[a-zA-Z0-9\-.\\\/])+/u // starting characters, excluding end and other inside constructs
-INDEX:         INT | IDENTIFIER
+WC_NAME_PLAIN:       /(?:(?!__|\$\$|\$\{|<ppp:|[('"])[a-zA-Z0-9\-.\\\/_#\*\?\[!\]])+/u // continuing characters, including globbing characters and anonymous wildcard mark, excluding end and other inside constructs
-IDENTIFIER:    CNAME
+INDEX:               INT | IDENTIFIER
-SIMPLEVALUE:   STRING | NUMBER | BOOLEAN
+IDENTIFIER:          CNAME
+SIMPLEVALUE:         STRING | SIGNED_NUMBER | BOOLEAN
 
 // plain text and weights
 ?plain:                  /((?!__|\bAND\b|\${)[^\\()\[\]:<>${]|\\.)+/s // exclude only the starting ones
@@ -27,15 +28,56 @@ promptcomp.4: promptcomppart ( [ ":" numpar ] ( /\bAND\b/ promptcomppart [ ":" n
 promptcomppart: content
 
 // simple prompts
-?content.2: ( old_content | new_content | plain | specialchars )*
+
-?inside_content.2: ( new_content | plain | specialchars )*
-?content_choice.2: ( old_content | new_content | plain_choice | specialchars_choice )*
-?content_var.2: ( old_content | new_content | plain_var | specialchars_var )*
-?content_negtag.2: ( old_content | new_content_negtag | plain | specialchars_negtag )*
-?content_alternate.2: ( old_content | new_content | plain_alternate | specialchars_alternate )*
 ?old_content.2: ( attention | scheduled | alternate | extranetworktag )+
-?new_content.3: ( variableset | variableuse | commandstn | commandstni | commandset | commandecho | commandif | wildcard | choices )+
+//#if ALLOW_NEW_CONTENT
-?new_content_negtag.3: ( variableset | variableuse | commandset | commandecho | commandif | wildcard | choices )+
+    ?content.2: ( old_content | new_content | plain | specialchars )*
+    ?content_choice.2: ( old_content | new_content | plain_choice | specialchars_choice )*
+    ?content_var.2: ( old_content | new_content | plain_var | specialchars_var )*
+    ?content_negtag.2: ( old_content | new_content_negtag | plain | specialchars_negtag )*
+    ?content_alternate.2: ( old_content | new_content | plain_alternate | specialchars_alternate )*
+    ?content_en.2: (new_content_en | plain | specialchars )*
+    //#if ALLOW_WILDCARDS ALLOW_CHOICES ALLOW_COMMVARS
+        ?new_content.3: ( variableset | variableuse | commandstn | commandstni | commandset | commandecho | commandif | commandext | wildcard | choices )+
+        ?new_content_negtag.3: ( variableset | variableuse | commandset | commandecho | commandif | commandext | wildcard | choices )+
+        ?new_content_en.3: ( variableset | variableuse | commandset | commandecho | commandif | choices )+
+    //#elif ALLOW_WILDCARDS !ALLOW_CHOICES ALLOW_COMMVARS
+        ?new_content.3: ( variableset | variableuse | commandstn | commandstni | commandset | commandecho | commandif | commandext | wildcard )+
+        ?new_content_negtag.3: ( variableset | variableuse | commandset | commandecho | commandif | commandext | wildcard )+
+        ?new_content_en.3: ( variableset | variableuse | commandset | commandecho | commandif )+
+    //#elif !ALLOW_WILDCARDS ALLOW_CHOICES ALLOW_COMMVARS
+        ?new_content.3: ( variableset | variableuse | commandstn | commandstni | commandset | commandecho | commandif | commandext | choices )+
+        ?new_content_negtag.3: ( variableset | variableuse | commandset | commandecho | commandif | commandext | choices )+
+        ?new_content_en.3: ( variableset | variableuse | commandset | commandecho | commandif | choices )+
+    //#elif ALLOW_WILDCARDS ALLOW_CHOICES !ALLOW_COMMVARS
+        ?new_content.3: ( wildcard | choices )+
+        ?new_content_negtag.3: ( wildcard | choices )+
+        ?new_content_en.3: ( choices )+
+    //#elif ALLOW_WILDCARDS !ALLOW_CHOICES !ALLOW_COMMVARS
+        ?new_content.3: ( wildcard )+
+        ?new_content_negtag.3: ( wildcard )+
+        ?new_content_en.3: /(?!)./ // never matches
+    //#elif !ALLOW_WILDCARDS ALLOW_CHOICES !ALLOW_COMMVARS
+        ?new_content.3: ( choices )+
+        ?new_content_negtag.3: ( choices )+
+        ?new_content_en.3: ( choices )+
+    //#elif !ALLOW_WILDCARDS !ALLOW_CHOICES ALLOW_COMMVARS
+        ?new_content.3: ( variableset | variableuse | commandstn | commandstni | commandset | commandecho | commandif | commandext )+
+        ?new_content_negtag.3: ( variableset | variableuse | commandset | commandecho | commandif | commandext )+
+        ?new_content_en.3: ( variableset | variableuse | commandset | commandecho | commandif )+
+    //#else
+        ?new_content.3: ( variableset | variableuse | commandstn | commandstni | commandset | commandecho | commandif | commandext | wildcard | choices )+
+        ?new_content_negtag.3: ( variableset | variableuse | commandset | commandecho | commandif | wildcard | commandext | choices )+
+        ?new_content_en.3: ( variableset | variableuse | commandset | commandecho | commandif | choices )+
+    //#endif
+//#else
+    ?content.2: ( old_content | plain | specialchars )*
+    ?content_choice.2: ( old_content | plain_choice | specialchars_choice )*
+    ?content_var.2: ( old_content | plain_var | specialchars_var )*
+    ?content_negtag.2: ( old_content | plain | specialchars_negtag )*
+    ?content_alternate.2: ( old_content | plain_alternate | specialchars_alternate )*
+    ?content_en.2: (plain | specialchars )*
+//#endif
 
 // attention modifiers
 attention: ( "(" content [ ":" numpar ] ")" ) | ( "[" content "]" )
@@ -46,23 +88,24 @@ alternateoption: content_alternate
 scheduled: "[" [ content ":" ] content ":" numpar "]"
 
 // extra network tags
-extranetworktag: "<" /(?!ppp:)\w+:/ inside_content ">"
+extranetworktag: "<" /(?!ppp:)\w+:/ encontent ">"
+?encontent.3: content_en
 
 // command: stn (send to negative)
 commandstn: "<ppp:stn" [ _WHITESPACE /s|e|p\d/ ] _WHITESPACE? ">" content_negtag "<ppp:/stn>"
-commandstni: "<ppp:stn" _WHITESPACE /i\d/ _WHITESPACE? ">"
+commandstni: "<ppp:stn" _WHITESPACE /i\d/ _WHITESPACE? ( "/>" | ">" )
 
 // command: if
 commandif.2: commandif_if commandif_elif* commandif_else? "<ppp:/if>"
 commandif_if: "<ppp:if" _WHITESPACE condition _WHITESPACE? ">" ifvalue
 commandif_elif: "<ppp:elif" _WHITESPACE condition _WHITESPACE? ">" ifvalue
 commandif_else: "<ppp:else" _WHITESPACE? ">" ifvalue
-ifvalue: content
+ifvalue.3: content
 
 // conditions
 ?condition: grouped_condition | ungrouped_condition
 ?ungrouped_condition: operation | basic_condition
-?grouped_condition: "(" _WHITESPACE? condition _WHITESPACE? ")"
+?grouped_condition.8: "(" _WHITESPACE? condition _WHITESPACE? ")"
 ?basic_condition: comparison_simple_value | comparison_list_value | truthy_operand
 ?operation: operation_not | operation_and | operation_or
 operation_and: condition _WHITESPACE "and" _WHITESPACE condition
@@ -71,14 +114,24 @@ operation_not: "not" ( ( _WHITESPACE ungrouped_condition ) | ( _WHITESPACE? grou
 truthy_operand: IDENTIFIER
 comparison_simple_value: IDENTIFIER _WHITESPACE ( /not/ _WHITESPACE )? /eq|ne|gt|lt|ge|le|contains/ _WHITESPACE SIMPLEVALUE
 comparison_list_value: IDENTIFIER _WHITESPACE ( /not/ _WHITESPACE )? /contains|in/ _WHITESPACE listvalue
-listvalue: "(" _WHITESPACE? SIMPLEVALUE ( _WHITESPACE? "," _WHITESPACE? SIMPLEVALUE )* _WHITESPACE? ")"
+listvalue.9: "(" _WHITESPACE? SIMPLEVALUE ( _WHITESPACE? "," _WHITESPACE? SIMPLEVALUE )* _WHITESPACE? ")"
 
 // command: set
-commandset: "<ppp:set" _WHITESPACE IDENTIFIER [ commandsetmodifiers ] _WHITESPACE? ">" content "<ppp:/set>"
+commandset: "<ppp:set" _WHITESPACE IDENTIFIER [ commandsetmodifiers ] _WHITESPACE? ">" commandsetcontent "<ppp:/set>"
 commandsetmodifiers: (_WHITESPACE /evaluate|ifundefined|add/ )+
+?commandsetcontent.3: content
 
 // command: echo
-commandecho: "<ppp:echo" _WHITESPACE IDENTIFIER _WHITESPACE? ">" [ content "<ppp:/echo>" ]
+commandecho: "<ppp:echo" _WHITESPACE IDENTIFIER _WHITESPACE? ( ">" [ commandechodefault "<ppp:/echo>" ] | "/>" )
+?commandechodefault.3: content
+
+// command: ext
+commandext: "<ppp:ext" _WHITESPACE commandexttype _WHITESPACE commandextid [ _WHITESPACE? commandextparams ] [ _WHITESPACE? commandextif ] _WHITESPACE? ( ">" [ commandexttriggers "<ppp:/ext>" ] | "/>" )
+commandexttype: [/\$/] IDENTIFIER
+?commandextid: STRING | CNAME
+?commandextparams: STRING | SIGNED_NUMBER
+?commandextif: "if" _WHITESPACE condition
+?commandexttriggers.3: content
 
 // variable set
 variableset.2: "${" _WHITESPACE? IDENTIFIER [ variablesetmodifiers ] _WHITESPACE? "=" [ /!/ ] varvalue "}"
@@ -89,24 +142,26 @@ variableuse.2: "${" _WHITESPACE? IDENTIFIER _WHITESPACE? [ ":" varvalue ] "}"
 varvalue: content_var
 
 // wildcards
-wildcard.2: "__" [ choicesoptions_sampler | ( choicesoptions _WHITESPACE? "$$" ) ] WILDCARD_NAME [ wc_filter ] [ wildcardvar ] "__"
+wildcard.2: "__" [ choicesoptions_sampler | ( choicesoptions _WHITESPACE? "$$" ) ] wildcard_name [ wc_filter ] [ wildcardvar ] "__"
-wc_filter: /["']/ ( [ /#/ ] wc_filter_or | ( /#?\^/ WILDCARD_NAME ) ) /["']/
+wildcard_name.2: ( WC_NAME_PLAIN_START | variableuse | commandecho ) ( WC_NAME_PLAIN | variableuse | commandecho )*
+wc_filter: /["']/ ( [ /#/ ] wc_filter_or | ( /#?\^/ wildcard_name ) ) /["']/
 wc_filter_or: wc_filter_and ( _WHITESPACE? "," _WHITESPACE? wc_filter_and )*
 wc_filter_and: INDEX ( _WHITESPACE? "+" _WHITESPACE? INDEX )*
-wildcardvar: "(" _WHITESPACE? IDENTIFIER _WHITESPACE? "=" varvalue ")"
+wildcardvar.7: "(" _WHITESPACE? IDENTIFIER _WHITESPACE? "=" varvalue ")"
 
 // choices
 choices.2: "{" [ choicesoptions_sampler | ( choicesoptions _WHITESPACE? "$$" ) ] choice ( "|" choice )* "}"
 
-choicesoptions: [ choicesoptions_sampler ] [ _WHITESPACE? choicesoptions_rep ] ( ( [ _WHITESPACE? choicesoptions_from ] "-" [ _WHITESPACE? choicesoptions_to ] ) | [ _WHITESPACE? choicesoptions_num ] ) [ _WHITESPACE? choicesoptions_sep ]
+choicesoptions: [ choicesoptions_sampler ] [ _WHITESPACE? choicesoptions_flags ] ( ( [ _WHITESPACE? choicesoptions_from ] "-" [ _WHITESPACE? choicesoptions_to ] ) | [ _WHITESPACE? choicesoptions_num ] ) [ _WHITESPACE? choicesoptions_sep ]
 choicesoptions_sampler: /[~@]/ // ~ for random, @ for cyclical
-choicesoptions_rep: /r/
+choicesoptions_flags: /[ro]{1,2}/ // r for repeating, o for optional
 choicesoptions_num: INT
 choicesoptions_from: INT
 choicesoptions_to: INT
 choicesoptions_sep: "$$" plain
 
-choice: [ [ _WHITESPACE? choicelabels ] [ _WHITESPACE? choiceweight ] [ _WHITESPACE? choiceif ] _WHITESPACE? "::" ] choicevalue
+choice: [ [ _WHITESPACE? choiceiscmd ] [ _WHITESPACE? choicelabels ] [ _WHITESPACE? choiceweight ] [ _WHITESPACE? choiceif ] _WHITESPACE? "::" ] choicevalue
+choiceiscmd: /%/ // the option text is a special command
 choicelabels: /["']/ IDENTIFIER ( _WHITESPACE? "," _WHITESPACE? IDENTIFIER )* /["']/
 choiceweight: NUMBER
 choiceif: "if" _WHITESPACE condition

ppp_comfyui.py

@@ -5,8 +5,10 @@ import folder_paths  # type: ignore
 import nodes  # type: ignore
 
 from .ppp import PromptPostProcessor
+from .ppp_hosts import SUPPORTED_APPS
 from .ppp_logging import DEBUG_LEVEL, PromptPostProcessorLogFactory
 from .ppp_wildcards import PPPWildcards
+from .ppp_enmappings import PPPExtraNetworkMappings
 
 if __name__ == "__main__":
     raise SystemExit("This script must be run from ComfyUI")
@@ -20,12 +22,13 @@ class PromptPostProcessorComfyUINode:
     logger = None
 
     def __init__(self):
-        lf = PromptPostProcessorLogFactory()
+        lf = PromptPostProcessorLogFactory(SUPPORTED_APPS.comfyui)
         self.logger = lf.log
         grammar_filename = os.path.join(os.path.dirname(os.path.realpath(__file__)), "grammar.lark")
         with open(grammar_filename, "r", encoding="utf-8") as file:
             self.grammar_content = file.read()
         self.wildcards_obj = PPPWildcards(lf.log)
+        self.extranetwork_mappings_obj = PPPExtraNetworkMappings(lf.log)
         self.logger.info(f"{PromptPostProcessor.NAME} {PromptPostProcessor.VERSION} initialized")
 
     class SmartType(str):
@@ -63,7 +66,6 @@ class PromptPostProcessorComfyUINode:
                     {
                         "default": "",
                         "placeholder": "internal model class name",
-                        "forceInput": True,
                     },
                 ),
                 "modelname": (
@@ -87,6 +89,13 @@ class PromptPostProcessorComfyUINode:
                         "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 +210,15 @@ class PromptPostProcessorComfyUINode:
                         "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",
                     {
@@ -264,6 +282,24 @@ class PromptPostProcessorComfyUINode:
                         "label_off": "No",
                     },
                 ),
+                "en_mappings_folders": (
+                    "STRING",
+                    {
+                        "default": "",
+                        "tooltip": "Comma separated list of extranetwork mappings folders",
+                        "dynamicPrompts": False,
+                    },
+                ),
+                "en_mappings_input": (
+                    "STRING",
+                    {
+                        "default": "",
+                        "multiline": True,
+                        "placeholder": "extranetwork mappings definitions",
+                        "tooltip": "Extranetwork mappings definitions in yaml format",
+                        "dynamicPrompts": False,
+                    },
+                ),
             },
         }
 
@@ -304,6 +340,7 @@ class PromptPostProcessorComfyUINode:
         neg_prompt,
         seed,
         debug_level,  # pylint: disable=unused-argument
+        on_warnings,
         variants_definitions,
         wc_process_wildcards,
         wc_wildcards_folders,
@@ -317,6 +354,7 @@ class PromptPostProcessorComfyUINode:
         cleanup_empty_constructs,
         cleanup_extra_separators,
         cleanup_extra_separators2,
+        cleanup_extra_separators_include_eol,
         cleanup_breaks,
         cleanup_breaks_eol,
         cleanup_ands,
@@ -324,6 +362,8 @@ class PromptPostProcessorComfyUINode:
         cleanup_extranetwork_tags,
         cleanup_merge_attention,
         remove_extranetwork_tags,
+        en_mappings_folders,
+        en_mappings_input,
     ):
         if wc_process_wildcards:
             return float(
@@ -335,6 +375,7 @@ class PromptPostProcessorComfyUINode:
             "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 +389,7 @@ class PromptPostProcessorComfyUINode:
             "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,
@@ -355,6 +397,8 @@ class PromptPostProcessorComfyUINode:
             "cleanup_extranetwork_tags": cleanup_extranetwork_tags,
             "cleanup_merge_attention": cleanup_merge_attention,
             "remove_extranetwork_tags": remove_extranetwork_tags,
+            "en_mappings_folders": en_mappings_folders,
+            "en_mappings_input": en_mappings_input,
         }
         return new_run.__hash__
         # return float("NaN")
@@ -367,6 +411,7 @@ class PromptPostProcessorComfyUINode:
         neg_prompt,
         seed,
         debug_level,
+        on_warnings,
         variants_definitions,
         wc_process_wildcards,
         wc_wildcards_folders,
@@ -380,6 +425,7 @@ class PromptPostProcessorComfyUINode:
         cleanup_empty_constructs,
         cleanup_extra_separators,
         cleanup_extra_separators2,
+        cleanup_extra_separators_include_eol,
         cleanup_breaks,
         cleanup_breaks_eol,
         cleanup_ands,
@@ -387,6 +433,8 @@ class PromptPostProcessorComfyUINode:
         cleanup_extranetwork_tags,
         cleanup_merge_attention,
         remove_extranetwork_tags,
+        en_mappings_folders,
+        en_mappings_input,
     ):
         modelclass = (
             model.model.model_config.__class__.__name__ if model is not None and not isinstance(model, str) else model
@@ -397,7 +445,7 @@ class PromptPostProcessorComfyUINode:
             self.logger.warning("Modelname is not provided. System variables will not be properly set.")
         # model class values in ComfyUI\comfy\supported_models.py
         env_info = {
-            "app": "comfyui",
+            "app": SUPPORTED_APPS.comfyui.value,
             "models_path": folder_paths.models_dir,
             "model_filename": modelname or "",  # path is relative to checkpoints folder
             "model_class": modelclass,
@@ -424,7 +472,15 @@ class PromptPostProcessorComfyUINode:
         # Also supported: SVD_img2vid, SVD3D_u, SVD3_p, Stable_Zero123, SD_X4Upscaler, Stable_Cascade_C, Stable_Cascade_B, StableAudio
 
         if wc_wildcards_folders == "":
-            wc_wildcards_folders = ",".join(folder_paths.get_folder_paths("wildcards") or [])
+            try:
+                fp1 = folder_paths.get_folder_paths("ppp_wildcards")
+            except Exception:  # pylint: disable=W0718
+                fp1 = None
+            try:
+                fp2 = folder_paths.get_folder_paths("wildcards")
+            except Exception:  # pylint: disable=W0718
+                fp2 = None
+            wc_wildcards_folders = ",".join(fp1 or fp2 or [])
         if wc_wildcards_folders == "":
             wc_wildcards_folders = os.getenv("WILDCARD_DIR", PPPWildcards.DEFAULT_WILDCARDS_FOLDER)
         wildcards_folders = [
@@ -432,10 +488,27 @@ class PromptPostProcessorComfyUINode:
             for f in wc_wildcards_folders.split(",")
             if f.strip() != ""
         ]
+        if en_mappings_folders == "":
+            try:
+                fp3 = folder_paths.get_folder_paths("ppp_extranetworkmappings")
+            except Exception:  # pylint: disable=W0718
+                fp3 = None
+            en_mappings_folders = ",".join(fp3 or [])
+        if en_mappings_folders == "":
+            en_mappings_folders = os.getenv(
+                "EXTRANETWORKMAPPINGS_DIR", PPPExtraNetworkMappings.DEFAULT_ENMAPPINGS_FOLDER
+            )
+        enmappings_folders = [
+            (f if os.path.isabs(f) else os.path.abspath(os.path.join(folder_paths.models_dir, f)))
+            for f in en_mappings_folders.split(",")
+            if f.strip() != ""
+        ]
+
         if variants_definitions != "" and not "=" in variants_definitions:  # mainly to warn about the old format
             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 +520,7 @@ class PromptPostProcessorComfyUINode:
             "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,
@@ -460,8 +534,19 @@ class PromptPostProcessorComfyUINode:
             wildcards_folders if options["process_wildcards"] else None,
             wc_wildcards_input,
         )
+        self.extranetwork_mappings_obj.refresh_extranetwork_mappings(
+            debug_level,
+            enmappings_folders,
+            en_mappings_input,
+        )
         ppp = PromptPostProcessor(
-            self.logger, self.interrupt, env_info, options, self.grammar_content, self.wildcards_obj
+            self.logger,
+            self.interrupt,
+            env_info,
+            options,
+            self.grammar_content,
+            self.wildcards_obj,
+            self.extranetwork_mappings_obj,
         )
         pos_prompt, neg_prompt, variables = ppp.process_prompt(pos_prompt, neg_prompt, seed if seed is not None else 1)
         return (

ppp_enmappings.py

@@ -0,0 +1,272 @@
+import os
+from typing import Optional
+import logging
+import yaml
+
+from ppp_logging import DEBUG_LEVEL  # pylint: disable=import-error
+from ppp_utils import deep_freeze  # pylint: disable=import-error
+
+
+class PPPENMappingVariant:
+    """
+    A class to represent a variant of an extra network mapping.
+
+    Attributes:
+        condition (str): The condition for the variant.
+        name (str): The name of the variant.
+        parameters (float|str): The parameters for the variant.
+        triggers (list[str]): The triggers for the variant.
+        weight (float): The weight for the variant when multiple variants apply.
+    """
+
+    def __init__(self, condition: str, name: str, parameters: float | str, triggers: list[str], weight: float):
+        self.condition: str = condition
+        self.name: str = name
+        self.parameters: float | str = parameters
+        self.triggers: list[str] = triggers
+        self.weight: float = weight
+
+
+class PPPENMapping:
+    """
+    A extra network mapping object.
+
+    Attributes:
+        kind (str): The kind of the extra network.
+        name (str): The name of the extra network mapping.
+        file (str): The path to the file where the extranetwork mapping is defined.
+        variants (list[PPPENMappingVariant]): The processed variants of the extranetwork mapping.
+    """
+
+    def __init__(self, fullpath: str, kind: str, name: str, variants: list[dict]):
+        self.file: str = fullpath
+        self.kind: str = kind
+        self.name: str = name
+        self.variants: list[PPPENMappingVariant] = [
+            PPPENMappingVariant(
+                **{**{"condition": None, "name": None, "parameters": None, "triggers": None, "weight": 1.0}, **v}
+            )
+            for v in variants
+        ]
+
+    def __hash__(self) -> int:
+        t = (self.kind, self.name, deep_freeze(self.variants))
+        return hash(t)
+
+    def __sizeof__(self):
+        return self.kind.__sizeof__() + self.name.__sizeof__() + self.file.__sizeof__() + self.variants.__sizeof__()
+
+
+class PPPExtraNetworkMappings:
+    """
+    A class to manage extra network mappings.
+
+    Attributes:
+        extranetwork_maps (dict[str, PPPENMapping]): The extra network mappings.
+    """
+
+    DEFAULT_ENMAPPINGS_FOLDER = "extranetworkmappings"
+    LOCALINPUT_FILENAME = "#INPUT"
+
+    def __init__(self, logger):
+        self.__logger: logging.Logger = logger
+        self.__debug_level = DEBUG_LEVEL.none
+        self.__enmappings_folders = []
+        self.__enmappings_files = {}
+        self.extranetwork_mappings: dict[str, PPPENMapping] = {}
+        self.cached_mappings = {}
+
+    def __hash__(self) -> int:
+        return hash(deep_freeze(self.extranetwork_mappings))
+
+    def __sizeof__(self):
+        return (
+            self.extranetwork_mappings.__sizeof__()
+            + self.__enmappings_folders.__sizeof__()
+            + self.__enmappings_files.__sizeof__()
+            + self.cached_mappings.__sizeof__()
+        )
+
+    def refresh_extranetwork_mappings(
+        self, debug_level: DEBUG_LEVEL, enmappings_folders: Optional[list[str]], enmappings_input: str = None
+    ):
+        """
+        Initialize the extra network mappings.
+        """
+        self.__debug_level = debug_level
+        self.__enmappings_folders = enmappings_folders or []
+        # if self.__debug_level != DEBUG_LEVEL.none:
+        #     self.__logger.info("Refreshing extra network mappings...")
+        # t1 = time.monotonic_ns()
+        self.cached_mappings = {}
+        for fullpath in list(self.__enmappings_files.keys()):
+            if fullpath != self.LOCALINPUT_FILENAME:
+                path = os.path.dirname(fullpath)
+                if not os.path.exists(fullpath) or not any(
+                    os.path.commonpath([path, folder]) == folder for folder in self.__enmappings_folders
+                ):
+                    self.__remove_extranetwork_mappings_from_path(fullpath)
+            elif enmappings_input is None:
+                self.__remove_extranetwork_mappings_from_path(fullpath)
+        if enmappings_folders is not None or enmappings_input is not None:
+            if enmappings_folders is not None:
+                for f in self.__enmappings_folders:
+                    self.__get_extranetwork_mappings_in_directory(f)
+            if enmappings_input is not None:
+                self.__get_extranetwork_mappings_in_input(enmappings_input)
+        else:
+            self.extranetwork_mappings = {}
+            self.__enmappings_files = {}
+        # t2 = time.monotonic_ns()
+        # if self.__debug_level != DEBUG_LEVEL.none:
+        #     self.__logger.info(f"Extra network mappings refresh time: {(t2 - t1) / 1_000_000_000:.3f} seconds")
+
+    # def get_extranetwork_mappings(self, key: str) -> list[PPPENMapping]:
+    #     """
+    #     Get all extra network mappings that match a key.
+    #
+    #     Args:
+    #         key (str): The key to match (kind:name).
+    #
+    #     Returns:
+    #         list: A list of all extra network mappings that match the key.
+    #     """
+    #     keys = sorted(fnmatch.filter(self.extranetwork_mappings.keys(), key))
+    #     return [self.extranetwork_mappings[k] for k in keys]
+
+    def __remove_extranetwork_mappings_from_path(self, full_path: str, debug=True):
+        """
+        Clear all extra network mappings in a file.
+
+        Args:
+            full_path (str): The path to the file.
+            debug (bool): Whether to print debug messages or not.
+        """
+        last_modified_cached = self.__enmappings_files.get(full_path, None)  # a time or a hash
+        if debug and last_modified_cached is not None and self.__debug_level != DEBUG_LEVEL.none:
+            if full_path == self.LOCALINPUT_FILENAME:
+                self.__logger.debug("Removing extra network mappings from input")
+            else:
+                self.__logger.debug(f"Removing extra network mappings from file: {full_path}")
+        if full_path in self.__enmappings_files.keys():
+            del self.__enmappings_files[full_path]
+        for key in list(self.extranetwork_mappings.keys()):
+            if self.extranetwork_mappings[key].file == full_path:
+                del self.extranetwork_mappings[key]
+
+    def __get_extranetwork_mappings_in_file(self, full_path: str):
+        """
+        Get all extra network mappings in a file.
+
+        Args:
+            full_path (str): The path to the file.
+        """
+        last_modified = os.path.getmtime(full_path)
+        last_modified_cached = self.__enmappings_files.get(full_path, None)
+        if last_modified_cached is not None and last_modified == self.__enmappings_files[full_path]:
+            return
+        filename = os.path.basename(full_path)
+        _, extension = os.path.splitext(filename)
+        if extension not in (".yaml", ".yml", ".json"):
+            return
+        self.__remove_extranetwork_mappings_from_path(full_path, False)
+        if last_modified_cached is not None and self.__debug_level != DEBUG_LEVEL.none:
+            self.__logger.debug(f"Updating extra network mappings from file: {full_path}")
+        self.__get_extranetwork_mappings_in_structured_file(full_path)
+        self.__enmappings_files[full_path] = last_modified
+
+    def __get_extranetwork_mappings_in_input(self, enmappings_input: str):
+        """
+        Get all extra network mappings in the string.
+
+        Args:
+            enmappings_input (str): The input string containing extra network mappings in yaml format.
+        """
+        new_h = hash(enmappings_input)
+        h = self.__enmappings_files.get(self.LOCALINPUT_FILENAME, None)
+        if h == new_h:
+            return
+        self.__remove_extranetwork_mappings_from_path(self.LOCALINPUT_FILENAME, False)
+        if h is not None and self.__debug_level != DEBUG_LEVEL.none:
+            self.__logger.debug("Updating extra network mappings from input")
+        enmappings_input = enmappings_input.strip()
+        if enmappings_input != "":
+            try:
+                content = yaml.safe_load(enmappings_input)
+            except yaml.YAMLError as e:
+                self.__logger.warning(f"Invalid format for input extra network mappings: {e}")
+                return
+            if content is not None:
+                self.__add_extranetwork_mapping(content, self.LOCALINPUT_FILENAME)
+        self.__enmappings_files[self.LOCALINPUT_FILENAME] = new_h
+
+    def __add_extranetwork_mapping(self, content: dict[str, dict[str, list[dict]]], full_path: str):
+        """
+        Add an extra network mapping to the extra network mappings dictionary.
+
+        Args:
+            content (object): The content of the extra network mapping.
+            full_path (str): The path to the file that contains it.
+        """
+        if not isinstance(content, dict):
+            self.__logger.warning(f"Invalid extra network mapping in file '{full_path}'!")
+            return
+        for kind, maps in content.items():
+            if not isinstance(maps, dict):
+                self.__logger.warning(f"Invalid extra network mapping definition for '{kind}:*' in file '{full_path}'!")
+            else:
+                for name, variants in maps.items():
+                    key = f"{kind}:{name}"
+                    if not isinstance(variants, list):
+                        self.__logger.warning(
+                            f"Invalid extra network mapping definition for '{key}' in file '{full_path}'!"
+                        )
+                    elif self.extranetwork_mappings.get(key, None) is not None:
+                        self.__logger.warning(
+                            f"Duplicate extra network mapping '{key}' in file '{full_path}' and '{self.extranetwork_mappings[key].file}'!"
+                        )
+                    elif not isinstance(variants, list) or not all(isinstance(v, dict) for v in variants):
+                        self.__logger.warning(
+                            f"Invalid extra network mapping definition for '{key}' in file '{full_path}'!"
+                        )
+                    else:
+                        self.extranetwork_mappings[key] = PPPENMapping(full_path, kind, name, variants)
+
+    def __get_extranetwork_mappings_in_structured_file(self, full_path):
+        """
+        Get all extra network mappings in a structured file.
+
+        Args:
+            full_path (str): The path to the file.
+            base (str): The base path for the extra network mappings.
+        """
+        try:
+            try:
+                with open(full_path, "r", encoding="utf-8") as file:
+                    content = yaml.safe_load(file)
+            except:  # pylint: disable=bare-except
+                self.__logger.warning(f"Could not read file '{full_path}' with utf-8 encoding, trying windows-1252...")
+                with open(full_path, "r", encoding="windows-1252") as file:
+                    content = yaml.safe_load(file)
+            self.__add_extranetwork_mapping(content, full_path)
+        except Exception as e:  # pylint: disable=broad-except
+            self.__logger.error(f"Error reading extra network mappings from file '{full_path}': {e}")
+
+    def __get_extranetwork_mappings_in_directory(self, directory: str):
+        """
+        Get all extra network mappings in a directory.
+
+        Args:
+            directory (str): The path to the directory.
+        """
+        if not os.path.exists(directory):
+            self.__logger.warning(f"Extra network mappings directory '{directory}' does not exist!")
+            return
+        for filename in os.listdir(directory):
+            full_path = os.path.abspath(os.path.join(directory, filename))
+            if os.path.basename(full_path).startswith("."):
+                continue
+            if os.path.isdir(full_path):
+                self.__get_extranetwork_mappings_in_directory(full_path)
+            elif os.path.isfile(full_path):
+                self.__get_extranetwork_mappings_in_file(full_path)

ppp_hosts.py

@@ -0,0 +1,17 @@
+from enum import Enum
+
+
+class SUPPORTED_APPS(Enum):
+    comfyui = "comfyui"
+    a1111 = "a1111"
+    forge = "forge"
+    reforge = "reforge"
+    sdnext = "sdnext"
+
+SUPPORTED_APPS_NAMES = {
+    SUPPORTED_APPS.comfyui: "ComfyUI",
+    SUPPORTED_APPS.sdnext: "SD.Next",
+    SUPPORTED_APPS.forge: "Forge",
+    SUPPORTED_APPS.reforge: "reForge",
+    SUPPORTED_APPS.a1111: "A1111 (or compatible)",
+}

ppp_logging.py

@@ -2,6 +2,7 @@ from enum import Enum
 import logging
 import sys
 import copy
+from ppp_hosts import SUPPORTED_APPS  # pylint: disable=import-error
 
 
 class DEBUG_LEVEL(Enum):
@@ -52,14 +53,15 @@ class PromptPostProcessorLogFactory:  # pylint: disable=too-few-public-methods
             colored_record.levelname = f"{seq}{levelname:8s}{self.COLORS['RESET']}"
             return super().format(colored_record)
 
-    def __init__(self):
+    def __init__(self, app: SUPPORTED_APPS = None, filename = None):  # pylint: disable=unused-argument
         """
         Initializes the PromptPostProcessor class.
 
         This method sets up the logger for the PromptPostProcessor class and configures its log level and handlers.
 
         Args:
-            None
+            filename (str, optional): The name of the file to log to. Defaults to None.
+            app (SUPPORTED_APPS): The application for which the logger is being created.
 
         Returns:
             None
@@ -68,8 +70,12 @@ class PromptPostProcessorLogFactory:  # pylint: disable=too-few-public-methods
         ppplog.propagate = False
         if not ppplog.handlers:
             handler = logging.StreamHandler(sys.stdout)
-            handler.setFormatter(self.ColoredFormatter("%(asctime)s %(levelname)s %(message)s")) # Used in A1111 / Forge / reForge / ComfyUI, but not in SD.Next
+            handler.setFormatter(self.ColoredFormatter("%(asctime)s %(levelname)s %(message)s"))
             ppplog.addHandler(handler)
+            if filename is not None:
+                file_handler = logging.FileHandler(filename, encoding="utf-8")
+                file_handler.setFormatter(logging.Formatter("%(asctime)s %(levelname)s %(message)s"))
+                ppplog.addHandler(file_handler)
         ppplog.setLevel(logging.DEBUG)
         self.log = PromptPostProcessorLogCustomAdapter(ppplog)
 

ppp_utils.py

@@ -0,0 +1,17 @@
+def deep_freeze(obj):
+    """
+    Deep freeze an object.
+
+    Args:
+        obj (object): The object to freeze.
+
+    Returns:
+        object: The frozen object.
+    """
+    if isinstance(obj, dict):
+        return tuple((k, deep_freeze(v)) for k, v in sorted(obj.items()))
+    if isinstance(obj, list):
+        return tuple(deep_freeze(i) for i in obj)
+    if isinstance(obj, set):
+        return tuple(deep_freeze(i) for i in sorted(obj))
+    return obj

ppp_wildcards.py

@@ -5,25 +5,7 @@ import logging
 import yaml
 
 from ppp_logging import DEBUG_LEVEL  # pylint: disable=import-error
-
+from ppp_utils import deep_freeze  # pylint: disable=import-error
-
-def deep_freeze(obj):
-    """
-    Deep freeze an object.
-
-    Args:
-        obj (object): The object to freeze.
-
-    Returns:
-        object: The frozen object.
-    """
-    if isinstance(obj, dict):
-        return tuple((k, deep_freeze(v)) for k, v in sorted(obj.items()))
-    if isinstance(obj, list):
-        return tuple(deep_freeze(i) for i in obj)
-    if isinstance(obj, set):
-        return tuple(deep_freeze(i) for i in sorted(obj))
-    return obj
 
 
 class PPPWildcard:
@@ -84,23 +66,35 @@ class PPPWildcards:
         return self.wildcards.__sizeof__() + self.__wildcards_folders.__sizeof__() + self.__wildcard_files.__sizeof__()
 
     def refresh_wildcards(
-        self, debug_level: DEBUG_LEVEL, wildcards_folders: Optional[list[str]], wildcards_input: str = None
+        self,
+        debug_level: DEBUG_LEVEL,
+        wildcards_folders: Optional[list[str]],
+        wildcards_input: str = None,
     ):
         """
         Initialize the wildcards.
         """
         self.__debug_level = debug_level
         self.__wildcards_folders = wildcards_folders or []
-        # if self.debug_level != DEBUG_LEVEL.none:
+        # if self.__debug_level != DEBUG_LEVEL.none:
-        #     self.logger.info("Refreshing wildcards...")
+        #     self.__logger.info("Refreshing wildcards...")
-        # t1 = time.time()
+        # t1 = time.monotonic_ns()
         for fullpath in list(self.__wildcard_files.keys()):
             if fullpath != self.LOCALINPUT_FILENAME:
                 path = os.path.dirname(fullpath)
-                if not os.path.exists(fullpath) or not any(
+                if not os.path.exists(fullpath):
-                    os.path.commonpath([path, folder]) == folder for folder in self.__wildcards_folders
-                ):
                     self.__remove_wildcards_from_path(fullpath)
+                else:
+                    a = False
+                    for folder in self.__wildcards_folders:
+                        try:
+                            if os.path.commonpath([folder, path]) == folder:
+                                a = True
+                                break
+                        except ValueError:
+                            pass
+                    if not a:
+                        self.__remove_wildcards_from_path(fullpath)
             elif wildcards_input is None:
                 self.__remove_wildcards_from_path(fullpath)
         if wildcards_folders is not None or wildcards_input is not None:
@@ -112,9 +106,9 @@ class PPPWildcards:
         else:
             self.wildcards = {}
             self.__wildcard_files = {}
-        # t2 = time.time()
+        # t2 = time.monotonic_ns()
-        # if self.debug_level != DEBUG_LEVEL.none:
+        # if self.__debug_level != DEBUG_LEVEL.none:
-        #     self.logger.info(f"Wildcards refresh time: {t2 - t1:.3f} seconds")
+        #     self.__logger.info(f"Wildcards refresh time: {(t2 - t1) / 1_000_000_000:.3f} seconds")
 
     def get_wildcards(self, key: str) -> list[PPPWildcard]:
         """
@@ -178,9 +172,9 @@ class PPPWildcards:
         last_modified_cached = self.__wildcard_files.get(full_path, None)  # a time or a hash
         if debug and last_modified_cached is not None and self.__debug_level != DEBUG_LEVEL.none:
             if full_path == self.LOCALINPUT_FILENAME:
-                self.__logger.debug("Removing wildcards from input")
+                self.__logger.debug("Removing from memory wildcards from input")
             else:
-                self.__logger.debug(f"Removing wildcards from file: {full_path}")
+                self.__logger.debug(f"Removing from memory wildcards from file: {full_path}")
         if full_path in self.__wildcard_files.keys():
             del self.__wildcard_files[full_path]
         for key in list(self.wildcards.keys()):
@@ -195,22 +189,25 @@ class PPPWildcards:
             base (str): The base path for the wildcards.
             full_path (str): The path to the file.
         """
-        last_modified = os.path.getmtime(full_path)
+        try:
-        last_modified_cached = self.__wildcard_files.get(full_path, None)
+            last_modified = os.path.getmtime(full_path)
-        if last_modified_cached is not None and last_modified == self.__wildcard_files[full_path]:
+            last_modified_cached = self.__wildcard_files.get(full_path, None)
-            return
+            if last_modified_cached is not None and last_modified == self.__wildcard_files[full_path]:
-        filename = os.path.basename(full_path)
+                return
-        _, extension = os.path.splitext(filename)
+            filename = os.path.basename(full_path)
-        if extension not in (".txt", ".json", ".yaml", ".yml"):
+            _, extension = os.path.splitext(filename)
-            return
+            if extension not in (".txt", ".json", ".yaml", ".yml"):
-        self.__remove_wildcards_from_path(full_path, False)
+                return
-        if last_modified_cached is not None and self.__debug_level != DEBUG_LEVEL.none:
+            self.__remove_wildcards_from_path(full_path, False)
-            self.__logger.debug(f"Updating wildcards from file: {full_path}")
+            if last_modified_cached is not None and self.__debug_level != DEBUG_LEVEL.none:
-        if extension == ".txt":
+                self.__logger.debug(f"Updating wildcards from file: {full_path}")
-            self.__get_wildcards_in_text_file(full_path, base)
+            if extension == ".txt":
-        elif extension in (".json", ".yaml", ".yml"):
+                self.__get_wildcards_in_text_file(full_path, base)
-            self.__get_wildcards_in_structured_file(full_path, base)
+            elif extension in (".json", ".yaml", ".yml"):
-        self.__wildcard_files[full_path] = last_modified
+                self.__get_wildcards_in_structured_file(full_path, base)
+            self.__wildcard_files[full_path] = last_modified
+        except Exception as e:  # pylint: disable=broad-except
+            self.__logger.error(f"Error reading wildcard file '{full_path}': {e}")
 
     def __get_wildcards_in_input(self, wildcards_input: str):
         """
@@ -219,23 +216,26 @@ class PPPWildcards:
         Args:
             wildcards_input (str): The input string containing wildcards in json or yaml format.
         """
-        new_h = hash(wildcards_input)
+        try:
-        h = self.__wildcard_files.get(self.LOCALINPUT_FILENAME, None)
+            new_h = hash(wildcards_input)
-        if h == new_h:
+            h = self.__wildcard_files.get(self.LOCALINPUT_FILENAME, None)
-            return
+            if h == new_h:
-        self.__remove_wildcards_from_path(self.LOCALINPUT_FILENAME, False)
-        if h is not None and self.__debug_level != DEBUG_LEVEL.none:
-            self.__logger.debug("Updating wildcards from input")
-        wildcards_input = wildcards_input.strip()
-        if wildcards_input != "":
-            try:
-                content = yaml.safe_load(wildcards_input)
-            except yaml.YAMLError as e:
-                self.__logger.warning(f"Invalid format for input wildcards: {e}")
                 return
-            if content is not None:
+            self.__remove_wildcards_from_path(self.LOCALINPUT_FILENAME, False)
-                self.__add_wildcard(content, self.LOCALINPUT_FILENAME, [self.LOCALINPUT_FILENAME])
+            if h is not None and self.__debug_level != DEBUG_LEVEL.none:
-        self.__wildcard_files[self.LOCALINPUT_FILENAME] = new_h
+                self.__logger.debug("Updating wildcards from input")
+            wildcards_input = wildcards_input.strip()
+            if wildcards_input != "":
+                try:
+                    content = yaml.safe_load(wildcards_input)
+                except yaml.YAMLError as e:
+                    self.__logger.warning(f"Invalid format for input wildcards: {e}")
+                    return
+                if content is not None:
+                    self.__add_wildcard(content, self.LOCALINPUT_FILENAME, [self.LOCALINPUT_FILENAME])
+            self.__wildcard_files[self.LOCALINPUT_FILENAME] = new_h
+        except Exception as e:  # pylint: disable=broad-except
+            self.__logger.error(f"Error reading wildcards input: {e}")
 
     def is_dict_choices_options(self, d: dict) -> bool:
         """
@@ -248,7 +248,8 @@ class PPPWildcards:
             bool: Whether the dictionary is a valid choices options dictionary or not.
         """
         return all(
-            k in ["sampler", "repeating", "count", "from", "to", "prefix", "suffix", "separator"] for k in d.keys()
+            k in ["sampler", "repeating", "optional", "count", "from", "to", "prefix", "suffix", "separator"]
+            for k in d.keys()
         )
 
     def is_dict_choice_options(self, d: dict) -> bool:
@@ -261,7 +262,7 @@ class PPPWildcards:
         Returns:
             bool: Whether the dictionary is a valid choice options dictionary or not.
         """
-        return all(k in ["labels", "weight", "if", "content", "text"] for k in d.keys())
+        return all(k in ["command", "labels", "weight", "if", "content", "text"] for k in d.keys())
 
     def __get_choices(self, obj: object, full_path: str, key_parts: list[str]) -> list:
         """
@@ -376,6 +377,8 @@ class PPPWildcards:
                     choices = self.__get_choices(obj, full_path, tmp_key_parts)
                     if choices is None:
                         self.__logger.warning(f"Invalid wildcard '{fullkey}' in file '{full_path}'!")
+                    elif fullkey.startswith("_"):
+                        self.__logger.warning(f"Invalid wildcard name '{fullkey}' in file '{full_path}'! (cannot start with underscore)")
                     else:
                         self.wildcards[fullkey] = PPPWildcard(full_path, fullkey, choices)
             return
@@ -395,6 +398,8 @@ class PPPWildcards:
             choices = self.__get_choices(content, full_path, key_parts)
             if choices is None:
                 self.__logger.warning(f"Invalid wildcard '{fullkey}' in file '{full_path}'!")
+            elif fullkey.startswith("_"):
+                self.__logger.warning(f"Invalid wildcard name '{fullkey}' in file '{full_path}'! (cannot start with underscore)")
             else:
                 self.wildcards[fullkey] = PPPWildcard(full_path, fullkey, choices)
 
@@ -408,8 +413,13 @@ class PPPWildcards:
         """
         external_key: str = os.path.relpath(os.path.splitext(full_path)[0], base)
         external_key_parts = external_key.split(os.sep)
-        with open(full_path, "r", encoding="utf-8") as file:
+        try:
-            content = yaml.safe_load(file)
+            with open(full_path, "r", encoding="utf-8") as file:
+                content = yaml.safe_load(file)
+        except:  # pylint: disable=bare-except
+            self.__logger.warning(f"Could not read file '{full_path}' with utf-8 encoding, trying windows-1252...")
+            with open(full_path, "r", encoding="windows-1252") as file:
+                content = yaml.safe_load(file)
         self.__add_wildcard(content, full_path, external_key_parts)
 
     def __get_wildcards_in_text_file(self, full_path, base):
@@ -422,8 +432,13 @@ class PPPWildcards:
         """
         external_key: str = os.path.relpath(os.path.splitext(full_path)[0], base)
         external_key_parts = external_key.split(os.sep)
-        with open(full_path, "r", encoding="utf-8") as file:
+        try:
-            text_content = map(lambda x: x.strip("\n\r"), file.readlines())
+            with open(full_path, "r", encoding="utf-8") as file:
+                text_content = map(lambda x: x.strip("\n\r"), file.readlines())
+        except:  # pylint: disable=bare-except
+            self.__logger.warning(f"Could not read file '{full_path}' with utf-8 encoding, trying windows-1252...")
+            with open(full_path, "r", encoding="windows-1252") as file:
+                text_content = map(lambda x: x.strip("\n\r"), file.readlines())
         text_content = list(filter(lambda x: x.strip() != "" and not x.strip().startswith("#"), text_content))
         text_content = [x.split("#")[0].rstrip() if len(x.split("#")) > 1 else x for x in text_content]
         self.__add_wildcard(text_content, full_path, external_key_parts)

pyproject.toml

@@ -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.13.2"
 license = { file = "LICENSE.txt" }
 dependencies = ["lark", "numpy", "pyyaml"]
 

scripts/ppp_script.py

@@ -4,9 +4,10 @@ if __name__ == "__main__":
 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
@@ -14,9 +15,11 @@ from modules.shared import opts  # pylint: disable=import-error
 from modules.paths import models_path  # pylint: disable=import-error
 import gradio as gr  # pylint: disable=import-error
 from ppp import PromptPostProcessor  # pylint: disable=import-error
+from ppp_hosts import SUPPORTED_APPS, SUPPORTED_APPS_NAMES  # pylint: disable=import-error
 from ppp_logging import DEBUG_LEVEL, PromptPostProcessorLogFactory  # pylint: disable=import-error
 from ppp_cache import PPPLRUCache  # pylint: disable=import-error
 from ppp_wildcards import PPPWildcards  # pylint: disable=import-error
+from ppp_enmappings import PPPExtraNetworkMappings  # pylint: disable=import-error
 
 
 class PromptPostProcessorA1111Script(scripts.Script):
@@ -41,6 +44,7 @@ class PromptPostProcessorA1111Script(scripts.Script):
     @classmethod
     def increment_instance_count(cls):
         cls.instance_count += 1
+        return cls.instance_count
 
     @classmethod
     def get_instance_count(cls):
@@ -50,27 +54,22 @@ class PromptPostProcessorA1111Script(scripts.Script):
         """
         Initializes the PromptPostProcessor object.
 
-        This method adds callbacks for UI settings and initializes the logger.
-
         Parameters:
             None
 
         Returns:
             None
         """
-        self.increment_instance_count()
+        self.instance_index = self.increment_instance_count()
-        lf = PromptPostProcessorLogFactory()
         self.name = PromptPostProcessor.NAME
-        self.ppp_logger = lf.log
-        self.ppp_debug_level = DEBUG_LEVEL(getattr(opts, "ppp_gen_debug_level", DEBUG_LEVEL.none.value))
-        self.lru_cache = PPPLRUCache(1000, logger=self.ppp_logger, debug_level=self.ppp_debug_level)
         grammar_filename = os.path.join(os.path.dirname(os.path.realpath(__file__)), "../grammar.lark")
         with open(grammar_filename, "r", encoding="utf-8") as file:
             self.grammar_content = file.read()
-        self.wildcards_obj = PPPWildcards(lf.log)
+        self.ppp_logger = None
-        i = self.get_instance_count()
+        self.ppp_debug_level = DEBUG_LEVEL.none.value
-        if i == 1:  # some UIs create multiple instances
+        self.lru_cache = None
-            self.ppp_logger.info(f"{PromptPostProcessor.NAME} {PromptPostProcessor.VERSION} initialized")
+        self.wildcards_obj = None
+        self.extranetwork_mappings_obj = None
 
     def title(self):
         """
@@ -163,7 +162,30 @@ class PromptPostProcessorA1111Script(scripts.Script):
         Returns:
             None
         """
-        t1 = time.time()
+        app = (
+            SUPPORTED_APPS.forge
+            if hasattr(p.sd_model, "model_config")
+            else (
+                SUPPORTED_APPS.reforge
+                if hasattr(p.sd_model, "forge_objects")
+                else (
+                    SUPPORTED_APPS.sdnext
+                    if hasattr(p.sd_model, "is_sdxl") and not hasattr(p.sd_model, "is_ssd")
+                    else SUPPORTED_APPS.a1111
+                )
+            )
+        )
+        if self.ppp_logger is None:
+            lf = PromptPostProcessorLogFactory(app)
+            self.ppp_logger = lf.log
+            self.ppp_debug_level = DEBUG_LEVEL(getattr(opts, "ppp_gen_debug_level", DEBUG_LEVEL.none.value))
+            self.lru_cache = PPPLRUCache(1000, logger=self.ppp_logger, debug_level=self.ppp_debug_level)
+            self.wildcards_obj = PPPWildcards(self.ppp_logger)
+            self.extranetwork_mappings_obj = PPPExtraNetworkMappings(self.ppp_logger)
+            self.ppp_logger.info(
+                f"{PromptPostProcessor.NAME} {PromptPostProcessor.VERSION} initialized, running on {SUPPORTED_APPS_NAMES[app]}"
+            )
+        t1 = time.monotonic_ns()
         if getattr(opts, "prompt_attention", "") == "Compel parser":
             self.ppp_logger.warning("Compel parser is not supported!")
         init_images = getattr(p, "init_images", [None]) or [None]
@@ -185,37 +207,22 @@ class PromptPostProcessorA1111Script(scripts.Script):
             }
         )
 
-        app_names = {
-            "sdnext": "SD.Next",
-            "forge": "Forge",
-            "reforge": "reForge",
-            "a1111": "A1111 (or compatible)",
-        }
-        app = (
-            "forge"
-            if hasattr(p.sd_model, "model_config")
-            else (
-                "reforge"
-                if hasattr(p.sd_model, "forge_objects")
-                else ("sdnext" if hasattr(p.sd_model, "is_sdxl") and not hasattr(p.sd_model, "is_ssd") else "a1111")
-            )
-        )
         if self.ppp_debug_level != DEBUG_LEVEL.none:
-            self.ppp_logger.info(f"Post-processing prompts ({'i2i' if is_i2i else 't2i'}) running on {app_names[app]}")
+            self.ppp_logger.info(f"Post-processing prompts ({'i2i' if is_i2i else 't2i'})")
         models_supported = {x: True for x in PromptPostProcessor.SUPPORTED_MODELS}
-        if app == "sdnext":
+        if app == SUPPORTED_APPS.sdnext:
             models_supported["ssd"] = False
-        elif app == "forge":
+        elif app == SUPPORTED_APPS.forge:
             models_supported["ssd"] = False
             models_supported["auraflow"] = False
-        elif app == "reforge":
+        elif app == SUPPORTED_APPS.reforge:
             models_supported["flux"] = False
             models_supported["auraflow"] = False
         else:  # assume A1111 compatible
             models_supported["flux"] = False
             models_supported["auraflow"] = False
         env_info = {
-            "app": app,
+            "app": app.value,
             "models_path": models_path,
             "model_filename": getattr(p.sd_model.sd_checkpoint_info, "filename", ""),
             "model_class": "",
@@ -237,7 +244,7 @@ class PromptPostProcessorA1111Script(scripts.Script):
             "is_wanvideo": False,  # WanVideo
             "is_hidream": False,  # HiDream
         }
-        if app == "sdnext":
+        if app == SUPPORTED_APPS.sdnext:
             # cannot differentiate SD1 and SD2, we set True to both
             # LatentDiffusion is for the original backend, StableDiffusionPipeline is for the diffusers backend
             env_info["model_class"] = p.sd_model.__class__.__name__
@@ -249,7 +256,7 @@ class PromptPostProcessorA1111Script(scripts.Script):
             env_info["is_flux"] = p.sd_model.__class__.__name__ == "FluxPipeline"
             env_info["is_auraflow"] = p.sd_model.__class__.__name__ == "AuraFlowPipeline"
             # also supports 'Latent Consistency Model': LatentConsistencyModelPipeline', 'PixArt-Alpha': 'PixArtAlphaPipeline', 'UniDiffuser': 'UniDiffuserPipeline', 'Wuerstchen': 'WuerstchenCombinedPipeline', 'Kandinsky 2.1': 'KandinskyPipeline', 'Kandinsky 2.2': 'KandinskyV22Pipeline', 'Kandinsky 3': 'Kandinsky3Pipeline', 'DeepFloyd IF': 'IFPipeline', 'Custom Diffusers Pipeline': 'DiffusionPipeline', 'InstaFlow': 'StableDiffusionPipeline', 'SegMoE': 'StableDiffusionPipeline', 'Kolors': 'KolorsPipeline', 'AuraFlow': 'AuraFlowPipeline', 'CogView': 'CogView3PlusPipeline'
-        elif app == "forge":
+        elif app == SUPPORTED_APPS.forge:
             # from repositories\huggingface_guess\huggingface_guess\model_list.py
             env_info["model_class"] = p.sd_model.model_config.__class__.__name__
             env_info["is_sd1"] = getattr(p.sd_model, "is_sd1", False)
@@ -261,7 +268,7 @@ class PromptPostProcessorA1111Script(scripts.Script):
             )  # p.sd_model.model_config.__class__.__name__ == "SD3" # not actually supported?
             env_info["is_flux"] = p.sd_model.model_config.__class__.__name__ in ("Flux", "FluxSchnell")
             env_info["is_auraflow"] = False  # p.sd_model.model_config.__class__.__name__ == "AuraFlow" # not supported
-        elif app == "reforge":
+        elif app == SUPPORTED_APPS.reforge:
             env_info["model_class"] = p.sd_model.__class__.__name__
             env_info["is_sd1"] = getattr(p.sd_model, "is_sd1", False)
             env_info["is_sd2"] = getattr(p.sd_model, "is_sd2", False)
@@ -279,6 +286,7 @@ class PromptPostProcessorA1111Script(scripts.Script):
             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)
@@ -287,8 +295,20 @@ class PromptPostProcessorA1111Script(scripts.Script):
             for f in wc_wildcards_folders.split(",")
             if f.strip() != ""
         ]
+        en_mappings_folders = getattr(opts, "ppp_en_mappingsfolders", "")
+        if en_mappings_folders == "":
+            en_mappings_folders = os.getenv(
+                "EXTRANETWORKMAPPINGS_DIR",
+                PPPExtraNetworkMappings.DEFAULT_ENMAPPINGS_FOLDER,
+            )
+        enmappings_folders = [
+            (f if os.path.isabs(f) else os.path.abspath(os.path.join(models_path, f)))
+            for f in en_mappings_folders.split(",")
+            if f.strip() != ""
+        ]
         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 +322,7 @@ class PromptPostProcessorA1111Script(scripts.Script):
             "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,11 +331,19 @@ class PromptPostProcessorA1111Script(scripts.Script):
             "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
         )
+        self.extranetwork_mappings_obj.refresh_extranetwork_mappings(self.ppp_debug_level, enmappings_folders)
         ppp = PromptPostProcessor(
-            self.ppp_logger, self.ppp_interrupt, env_info, options, self.grammar_content, self.wildcards_obj
+            self.ppp_logger,
+            self.ppp_interrupt,
+            env_info,
+            options,
+            self.grammar_content,
+            self.wildcards_obj,
+            self.extranetwork_mappings_obj,
         )
         prompts_list = []
 
@@ -367,7 +396,7 @@ class PromptPostProcessorA1111Script(scripts.Script):
         # 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 +407,35 @@ class PromptPostProcessorA1111Script(scripts.Script):
         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 +454,13 @@ class PromptPostProcessorA1111Script(scripts.Script):
             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]
@@ -431,9 +475,9 @@ class PromptPostProcessorA1111Script(scripts.Script):
             if p.extra_generation_params.get(k) is None:
                 p.extra_generation_params[k] = v
 
-        t2 = time.time()
+        t2 = time.monotonic_ns()
         if self.ppp_debug_level != DEBUG_LEVEL.none:
-            self.ppp_logger.info(f"process time: {t2 - t1:.3f} seconds")
+            self.ppp_logger.info(f"process time: {(t2 - t1) / 1_000_000_000:.3f} seconds")
 
     def ppp_interrupt(self):
         """
@@ -502,6 +546,21 @@ def on_ui_settings():
             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(
@@ -533,6 +592,16 @@ def on_ui_settings():
         ),
     )
 
+    shared.opts.add_option(
+        key="ppp_en_mappingsfolders",
+        info=shared.OptionInfo(
+            PPPExtraNetworkMappings.DEFAULT_ENMAPPINGS_FOLDER,
+            label="Extranetwork Mappings folders",
+            comment_after='<span class="info">(absolute or relative to the models folder)</span>',
+            section=section,
+        ),
+    )
+
     # wildcard settings
     shared.opts.add_option(
         key="ppp_wil_sep",
@@ -656,6 +725,14 @@ def on_ui_settings():
             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(

tests/enmappings/mappings.yaml

@@ -0,0 +1,11 @@
+lora:
+  lora1:
+    - condition: _is_pony
+      name: lorapony
+      parameters: 0.8
+      triggers: ["triggerpony1", "triggerpony2"]
+    - condition: _is_illustrious
+      name: loraillustrious
+      parameters: "0.9:0.8"
+      triggers: ["triggerillustrious1", "triggerillustrious2"]
+    - triggers: ["triggergeneric1", "triggergeneric2", "{one|two}"]

tests/wildcards/_invalid.txt

@@ -0,0 +1,3 @@
+# invalid wildcard name
+choice1
+choice2

tests/wildcards/test.json

@@ -6,7 +6,7 @@
       "choice3"
     ],
     "wildcard2": [
-      "r2-3$$-",
+      "r2-3$$-$$",
       "4::choice1",
       "3:: choice2 ",
       "2::choice3",

tests/wildcards/test.yaml

@@ -5,7 +5,7 @@ yaml:
     - choice3
 
   wildcard2:
-    - ~r2-3$$-
+    - ~r2-3$$-$$
     - "'label1,label2'4::choice1"
     - "3:: choice2 "
     - { labels: ["label1", "label3"], weight: 2, content: choice3 }
@@ -39,6 +39,7 @@ yaml:
     - {
         sampler: "~",
         repeating: false,
+        optional: false,
         count: 2,
         prefix: "prefix-",
         suffix: "-suffix",
@@ -67,3 +68,37 @@ yaml:
       - { count: 2, prefix: "#" }
       - nine
       - ten
+
+  empty_wildcard:
+    - o$$ # parameters: optional
+    - if false::1
+    - if false::2
+    - if false::3
+    - if _sd in ("test1", "test2")::4
+    - if (false or false)::5
+
+  circular1:
+    - 5::__yaml/circular2__
+    - choice1
+    - choice2
+
+  circular2:
+    - choice3
+    - choice4
+    - 5::__yaml/circular1__
+
+  including:
+    - "%0.5::include yaml/wildcard1"
+    - choice4
+    - choice5
+    - "%0.2::include yaml/wildcard7"
+
+  including1:
+    - choice1
+    - choice2
+    - "%5::include yaml/including2"
+
+  including2:
+    - choice3
+    - choice4
+    - "%5::include yaml/including1"

tests/wildcards2/text/wildcard2.txt

@@ -1,5 +1,5 @@
 # wildcard2
-r2-3$$-
+r2-3$$-$$
 4::choice1
 3:: choice2 
 2::choice3

tests/wildcards2/text/wildcard3.txt

@@ -1,2 +1,3 @@
-# wildcard3
+# wildcard3 (with windows-1252 encoding)
-__2$$,$$text/wildcard2__
+__2$$,$$text/wildcard2__
+0::áüç