From 23e0ee5cf0af4464aaccabd08b63eaf121feb25d Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Wed, 11 Mar 2026 09:01:35 +0100 Subject: [PATCH] [tutorial v1.1_200] Variable calculation with propertyerror (config and doc) --- README.md | 221 +++++++++++++++++---------------------- config/02/config.yml | 3 +- config/02/output_ro.html | 23 +--- config/03/cmd_ro.txt | 1 - config/03/config.yml | 17 --- config/03/output_ro.html | 53 ---------- tree.html | 30 +++--- 7 files changed, 117 insertions(+), 231 deletions(-) delete mode 100644 config/03/cmd_ro.txt delete mode 100644 config/03/config.yml delete mode 100644 config/03/output_ro.html diff --git a/README.md b/README.md index d6ae7c11..9c550a73 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_182] Auto save value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_182/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_190~1..v1.1_190)) +- [[tutorial v1.1_190] A variable name that conflict with a known the variable's attribute "type"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_200~1..v1.1_200)) -# [tutorial v1.1_190] A variable name that conflict with a known the variable's attribute "type" +# [tutorial v1.1_200] Variable calculation with propertyerror -[Read the tutorial "A variable name that conflict with a known the variable's attribute "type"" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-variable-name-that-conflict-with-a-known-the-variable's-attribute-type) +[Read the tutorial "Variable calculation with propertyerror" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#variable-calculation-with-propertyerror) ## Screenshot @@ -29,7 +29,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_190 +git switch --detach v1.1_200 ``` ## Structure @@ -37,21 +37,21 @@ git switch --detach v1.1_190

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   ├── 50-prompt_authentication.yml
- │   ├── 55-proxy_dns_socks5.yml
- │   └── 60-dns_over_https.yml
- ├── foxyproxy
- │   └── 00-foxyproxy.yml
- └── types
-     └── proxy
-         └── 00_type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   ├── 40-no_proxy.yml
+ │   ├── 50-prompt_authentication.yml
+ │   ├── 55-proxy_dns_socks5.yml
+ │   └── 60-dns_over_https.yml
+ ├── foxyproxy
+ │   └── 00-foxyproxy.yml
+ └── types
+     └── proxy
+         └── 00_type.yml


Contents of the foxyproxy/00-foxyproxy.yml file @@ -90,6 +90,61 @@ proxies: #{%- for i in range(6) -%}{{- '0123456789abcdef' | random -}}{%- endfor -%} description: random color value auto_save: true + + address: + description: IP address, DNS name, server name + type: domainname + params: + allow_ip: true + allow_without_dot: true + default: + description: copy HTTP address if proxy is not "Manual" + variable: firefox.manual.http_proxy.address + propertyerror: false + disabled: + jinja: |- + {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} + return_type: boolean + description: |- + if type not in: + - HTTP + - HTTPS/SSL + - SOCKS4 + - SOCKS5 + + port: + description: Port + type: port + default: + description: copy HTTP port if proxy is not "Manual" + variable: firefox.manual.http_proxy.port + propertyerror: false + disabled: + jinja: |- + {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} + return_type: boolean + description: |- + if type not in: + - HTTP + - HTTPS/SSL + - SOCKS4 + - SOCKS5 + + url: + description: URL + type: web_address + default: + description: copy HTTP address if proxy is "Auto" + variable: firefox.auto + propertyerror: false + disabled: + jinja: |- + {{ _.type not in ['PAC URL', 'WPAD'] }} + return_type: boolean + description: |- + if type is not in: + - PAC URL + - WPAD ... ``` @@ -198,11 +253,14 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox > **Path**: foxyproxy.proxies\ > `basic` -| Variable | Description | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. | -| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** | -| **foxyproxy.proxies.color**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value | +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. | +| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** | +| **foxyproxy.proxies.color**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value | +| **foxyproxy.proxies.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.
**Validators**:
• type domainname
• the domain name can be a hostname
• the domain name can be an IP
**Default**: copy HTTP address if proxy is not "Manual"
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | +| **foxyproxy.proxies.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: copy HTTP port if proxy is not "Manual"
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | +| **foxyproxy.proxies.url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Default**: copy HTTP address if proxy is "Auto"
**Disabled**: if type is not in:
- PAC URL
- WPAD | *** @@ -211,11 +269,13 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox ```shell rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml ``` -#### New variable +#### New variables -| Variable | Description | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** | +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **foxyproxy.proxies.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.
**Validators**:
• type domainname
• the domain name can be a hostname
• the domain name can be an IP
**Default**: copy HTTP address if proxy is not "Manual"
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | +| **foxyproxy.proxies.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: copy HTTP port if proxy is not "Manual"
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 | +| **foxyproxy.proxies.url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Default**: copy HTTP address if proxy is "Auto"
**Disabled**: if type is not in:
- PAC URL
- WPAD | #### Modified variable @@ -267,8 +327,9 @@ Variables: foxyproxy: proxies: - title: My company - type: HTTP color: '#66cc66' + type: HTTP + address: proxy.company.net ``` *** @@ -277,103 +338,13 @@ foxyproxy: ```shell rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/02/config.yml ``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :open_file_folder: firefox (Firefox) - - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy - - :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false -- :open_file_folder: foxyproxy (FoxyProxy) - - :open_file_folder: proxies (Proxy configuration) - - :open_file_folder: title (Title or Description) - - :notebook: title (Title or Description): My company ← loaded from the YAML file "config/02/config.yml" - - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/02/config.yml" - -*** -### Example 3 - -#### config/03/config.yml - - -```yml ---- -firefox: - proxy_mode: Manual proxy configuration - manual: - http_proxy: - address: http.proxy.net -foxyproxy: - proxies: - - title: My company - color: '#66cc66' - type: HTTP - - title: An other company - color: '#cc66cc' - type: SOCKS5 - - title: WPAD - color: '#1166cc' - type: WPAD -``` - -*** -#### Output - -```shell -rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/03/config.yml -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Unmodifiable variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :open_file_folder: firefox (Firefox) - - :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: No proxy) - - :open_file_folder: manual (Manual proxy configuration) - - :open_file_folder: http_proxy (HTTP Proxy) - - :notebook: address (Proxy address): http.proxy.net ← loaded from the YAML file "config/03/config.yml" - - :notebook: port (Proxy port): 8080 - - :notebook: use_for_https (Also use this proxy for HTTPS): true - - :open_file_folder: https_proxy (HTTPS Proxy) - - :notebook: address (Proxy address): http.proxy.net - - :notebook: port (Proxy port): 8080 - - :open_file_folder: socks_proxy (SOCKS Proxy) - - :notebook: address (Proxy address): null - - :notebook: port (Proxy port): 8080 - - :notebook: version (SOCKS host version used by proxy): v5 - - :notebook: no_proxy (Address for which proxy will be desactivated): [] - - :notebook: prompt_authentication (Prompt for authentication if password is saved): true - - :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false - - :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false -- :open_file_folder: foxyproxy (FoxyProxy) - - :open_file_folder: proxies (Proxy configuration) - - :open_file_folder: title (Title or Description) - - :notebook: title (Title or Description): My company ← loaded from the YAML file "config/03/config.yml" - - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/03/config.yml" - - :open_file_folder: title (Title or Description) - - :notebook: title (Title or Description): An other company ← loaded from the YAML file "config/03/config.yml" - - :notebook: type (Proxy Type): SOCKS5 ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #cc66cc ← loaded from the YAML file "config/03/config.yml" - - :open_file_folder: title (Title or Description) - - :notebook: title (Title or Description): WPAD ← loaded from the YAML file "config/03/config.yml" - - :notebook: type (Proxy Type): WPAD ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #1166cc ← loaded from the YAML file "config/03/config.yml" +> [!CAUTION] +> +> - foxyproxy (FoxyProxy) +> - proxies (Proxy configuration) +> - port (Port): :stop_sign: mandatory variable but has no value *** -- [[tutorial v1.1_200] Variable calculation with propertyerror](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_200~1..v1.1_200)) +- [[tutorial v1.1_210] Username is mandatory if a password is set](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_210/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_210~1..v1.1_210)) diff --git a/config/02/config.yml b/config/02/config.yml index 0780700f..ffa7a240 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -2,5 +2,6 @@ foxyproxy: proxies: - title: My company - type: HTTP color: '#66cc66' + type: HTTP + address: proxy.company.net diff --git a/config/02/output_ro.html b/config/02/output_ro.html index db9388b0..c196610e 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,20 +1,5 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📂 firefox (Firefox)
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-┗━━ 📂 dns_over_https (DNS over HTTPS)
-    ┗━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): false
-┗━━ 📂 foxyproxy (FoxyProxy)
-    ┗━━ 📂 proxies (Proxy configuration)
-        ┗━━ 📂 title (Title or Description)
-            ┣━━ 📓 title (Title or Description): My company ◀ loaded from the 
-            YAML file "config/02/config.yml"
-            ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file 
-            "config/02/config.yml" (⏳ Direct (no proxy))
-            ┗━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file 
-                "config/02/config.yml"
+
🛑 Caution
+┗━━ foxyproxy (FoxyProxy)
+    ┗━━ proxies (Proxy configuration)
+        ┗━━ port (Port): 🛑 mandatory variable but has no value
 
diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt deleted file mode 100644 index 70205a54..00000000 --- a/config/03/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/03/config.yml \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml deleted file mode 100644 index 68cc8676..00000000 --- a/config/03/config.yml +++ /dev/null @@ -1,17 +0,0 @@ ---- -firefox: - proxy_mode: Manual proxy configuration - manual: - http_proxy: - address: http.proxy.net -foxyproxy: - proxies: - - title: My company - color: '#66cc66' - type: HTTP - - title: An other company - color: '#cc66cc' - type: SOCKS5 - - title: WPAD - color: '#1166cc' - type: WPAD diff --git a/config/03/output_ro.html b/config/03/output_ro.html deleted file mode 100644 index 40bad8a0..00000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,53 +0,0 @@ -
╭───────────────────── Caption ─────────────────────╮
-│ Variable              Default value               │
-│ Unmodifiable variable Modified value              │
-│                       (⏳ Original default value) │
-╰───────────────────────────────────────────────────╯
-Variables:
-┣━━ 📂 firefox (Firefox)
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
-configuration ◀ loaded from the YAML file "config/03/config.yml" (⏳ No 
-proxy)
-┣━━ 📂 manual (Manual proxy configuration)
-┣━━ 📂 http_proxy (HTTP Proxy)
-┣━━ 📓 address (Proxy address): http.proxy.net ◀ loaded from the 
-YAML file "config/03/config.yml"
-┗━━ 📓 port (Proxy port): 8080
-┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true
-┣━━ 📂 https_proxy (HTTPS Proxy)
-┣━━ 📓 address (Proxy address): http.proxy.net
-┗━━ 📓 port (Proxy port): 8080
-┗━━ 📂 socks_proxy (SOCKS Proxy)
-    ┣━━ 📓 address (Proxy address): null
-    ┣━━ 📓 port (Proxy port): 8080
-    ┗━━ 📓 version (SOCKS host version used by proxy): v5
-┣━━ 📓 no_proxy (Address for which proxy will be desactivated): []
-┣━━ 📓 prompt_authentication (Prompt for authentication if password is 
-saved): true
-┣━━ 📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false
-┗━━ 📂 dns_over_https (DNS over HTTPS)
-    ┗━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): false
-┗━━ 📂 foxyproxy (FoxyProxy)
-    ┗━━ 📂 proxies (Proxy configuration)
-        ┣━━ 📂 title (Title or Description)
-        ┣━━ 📓 title (Title or Description): My company ◀ loaded from the 
-        YAML file "config/03/config.yml"
-        ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file 
-        "config/03/config.yml" (⏳ Direct (no proxy))
-        ┗━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file 
-            "config/03/config.yml"
-        ┣━━ 📂 title (Title or Description)
-        ┣━━ 📓 title (Title or Description): An other company ◀ loaded from 
-        the YAML file "config/03/config.yml"
-        ┣━━ 📓 type (Proxy Type): SOCKS5 ◀ loaded from the YAML file 
-        "config/03/config.yml" (⏳ Direct (no proxy))
-        ┗━━ 📓 color (Color): #cc66cc ◀ loaded from the YAML file 
-            "config/03/config.yml"
-        ┗━━ 📂 title (Title or Description)
-            ┣━━ 📓 title (Title or Description): WPAD ◀ loaded from the YAML 
-            file "config/03/config.yml"
-            ┣━━ 📓 type (Proxy Type): WPAD ◀ loaded from the YAML file 
-            "config/03/config.yml" (⏳ Direct (no proxy))
-            ┗━━ 📓 color (Color): #1166cc ◀ loaded from the YAML file 
-                "config/03/config.yml"
-
diff --git a/tree.html b/tree.html index 7d525d59..c230fbfe 100644 --- a/tree.html +++ b/tree.html @@ -1,17 +1,17 @@

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   ├── 50-prompt_authentication.yml
- │   ├── 55-proxy_dns_socks5.yml
- │   └── 60-dns_over_https.yml
- ├── foxyproxy
- │   └── 00-foxyproxy.yml
- └── types
-     └── proxy
-         └── 00_type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   ├── 40-no_proxy.yml
+ │   ├── 50-prompt_authentication.yml
+ │   ├── 55-proxy_dns_socks5.yml
+ │   └── 60-dns_over_https.yml
+ ├── foxyproxy
+ │   └── 00-foxyproxy.yml
+ └── types
+     └── proxy
+         └── 00_type.yml


\ No newline at end of file