From c88de367e584b1eb471ad1b17a0f97d749280a4a Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Thu, 12 Mar 2026 08:11:17 +0100 Subject: [PATCH] [tutorial v1.1_200] Variable calculation with propertyerror (config and doc) --- README.md | 157 ++++++++++++++++++++++++++------------- config/02/config.yml | 2 + config/02/output_ro.html | 7 +- config/03/config.yml | 12 ++- config/03/output_ro.html | 51 ++++++------- tree.html | 30 ++++---- 6 files changed, 155 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index 406eb443..f9712539 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 @@ -269,6 +329,8 @@ foxyproxy: - title: My company type: HTTP color: '#66cc66' + address: proxy.company.net + port: 8080 ``` *** @@ -296,6 +358,8 @@ Variables: - :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" + - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/02/config.yml" + - :notebook: port (Port): 8080 ← loaded from the YAML file "config/02/config.yml" *** ### Example 3 @@ -310,17 +374,15 @@ firefox: manual: http_proxy: address: http.proxy.net + port: 3128 + use_for_https: false + https_proxy: + address: https.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 + color: '#66cc66' ``` *** @@ -333,7 +395,6 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox > > **Caption:** > - Variable -> - Unmodifiable variable > - Default value > - Modified value > - (:hourglass_flowing_sand: Original default value) @@ -344,14 +405,14 @@ Variables: - :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 + - :notebook: port (Proxy port): 3128 ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: 8080) + - :notebook: use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: true) + - :open_file_folder: https_proxy (HTTPS Proxy) + - :notebook: address (Proxy address): https.proxy.net ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: http.proxy.net) + - :notebook: port (Proxy port): 3128 - :open_file_folder: socks_proxy (SOCKS Proxy) - :notebook: address (Proxy address): http.proxy.net - - :notebook: port (Proxy port): 8080 + - :notebook: port (Proxy port): 3128 - :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 @@ -364,16 +425,10 @@ Variables: - :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" + - :notebook: address (IP address, DNS name, server name): http.proxy.net + - :notebook: port (Port): 3128 *** -- [[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..94667928 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -4,3 +4,5 @@ foxyproxy: - title: My company type: HTTP color: '#66cc66' + address: proxy.company.net + port: 8080 diff --git a/config/02/output_ro.html b/config/02/output_ro.html index db9388b0..383e5e65 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -15,6 +15,11 @@ Variables: ┃ 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 + ┣━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file + ┃ "config/02/config.yml" + ┣━━ 📓 address (IP address, DNS name, server name): + ┃ proxy.company.net ◀ loaded from the YAML file + ┃ "config/02/config.yml" + ┗━━ 📓 port (Port): 8080 ◀ loaded from the YAML file "config/02/config.yml" diff --git a/config/03/config.yml b/config/03/config.yml index 68cc8676..c2a8f35f 100644 --- a/config/03/config.yml +++ b/config/03/config.yml @@ -4,14 +4,12 @@ firefox: manual: http_proxy: address: http.proxy.net + port: 3128 + use_for_https: false + https_proxy: + address: https.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 + color: '#66cc66' diff --git a/config/03/output_ro.html b/config/03/output_ro.html index 348b6b44..091dfcfb 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,8 +1,8 @@ -
╭───────────────────── Caption ─────────────────────╮
-│ Variable              Default value               │
-│ Unmodifiable variable Modified value              │
-│                       (⏳ Original default value) │
-╰───────────────────────────────────────────────────╯
+
╭────────────── Caption ───────────────╮
+│ Variable Default value               │
+│          Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
 Variables:
 ┣━━ 📂 firefox (Firefox)
 ┃   ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
@@ -12,14 +12,17 @@ Variables:
 ┃   ┃   ┣━━ 📂 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
+┃   ┃   ┃   ┗━━ 📓 port (Proxy port): 3128 ◀ loaded from the YAML file 
+┃   ┃   ┃       "config/03/config.yml" (⏳ 8080)
+┃   ┃   ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): false ◀ loaded 
+┃   ┃   ┃   from the YAML file "config/03/config.yml" (⏳ true)
+┃   ┃   ┣━━ 📂 https_proxy (HTTPS Proxy)
+┃   ┃   ┃   ┣━━ 📓 address (Proxy address): https.proxy.net ◀ loaded from the 
+┃   ┃   ┃   ┃   YAML file "config/03/config.yml" (⏳ http.proxy.net)
+┃   ┃   ┃   ┗━━ 📓 port (Proxy port): 3128
 ┃   ┃   ┗━━ 📂 socks_proxy (SOCKS Proxy)
 ┃   ┃       ┣━━ 📓 address (Proxy address): http.proxy.net
-┃   ┃       ┣━━ 📓 port (Proxy port): 8080
+┃   ┃       ┣━━ 📓 port (Proxy port): 3128
 ┃   ┃       ┗━━ 📓 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 
@@ -29,25 +32,13 @@ Variables:
 ┃       ┗━━ 📓 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 
+            ┣━━ 📓 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): #1166cc ◀ loaded from the YAML file 
-                "config/03/config.yml"
+            ┣━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file 
+            ┃   "config/03/config.yml"
+            ┣━━ 📓 address (IP address, DNS name, server name): http.proxy.net
+            ┗━━ 📓 port (Port): 3128
 

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