rougail/doc/param/simple.md

91 lines
1.3 KiB
Markdown
Raw Normal View History

2021-02-10 08:19:33 +01:00
# Paramètre de type "texte"
2021-02-15 15:17:23 +01:00
Déclarons un paramètre avec une string :
2021-02-10 08:19:33 +01:00
2022-11-03 22:17:43 +01:00
```xml
2021-02-10 08:19:33 +01:00
<param type="string">no</param>
```
2022-11-02 22:52:50 +01:00
En YAML :
2022-11-03 22:17:43 +01:00
```yml
2022-11-02 22:52:50 +01:00
param:
- type: string
text: no
```
2021-02-10 08:19:33 +01:00
C'est le type par défaut pour un paramètre.
# Paramètre de type "nombre"
Déclarons un paramètre avec un nombre :
2022-11-03 22:17:43 +01:00
```xml
2021-02-10 08:19:33 +01:00
<param type="number">1</param>
```
2022-11-02 22:52:50 +01:00
En YAML :
2022-11-03 22:17:43 +01:00
```yml
2022-11-02 22:52:50 +01:00
param:
- type: number
2022-11-04 19:42:16 +01:00
text: 1
2022-11-02 22:52:50 +01:00
```
2021-02-10 08:19:33 +01:00
Créons la fonction correspondante :
2022-11-03 22:17:43 +01:00
```python
2021-02-10 08:19:33 +01:00
def return_value_with_number(value):
if value == 1:
return 'no'
return 'yes'
```
La variable aura donc "no" comme valeur puisque le paramètre aura la valeur fixe "1".
2021-02-15 15:17:23 +01:00
# Paramètre de type "booléen"
Déclarons un paramètre avec un booléen :
2022-11-03 22:17:43 +01:00
```xml
2021-02-15 15:17:23 +01:00
<param type="boolean">True</param>
```
2022-11-02 22:52:50 +01:00
En YAML :
2022-11-03 22:17:43 +01:00
```yml
2022-11-02 22:52:50 +01:00
param:
- type: boolean
2022-11-03 22:16:52 +01:00
text: true
2022-11-02 22:52:50 +01:00
```
2021-02-10 08:19:33 +01:00
# Paramètre de type "nil"
Le paramètre peut être une valeur null (None en python) :
2022-11-03 22:17:43 +01:00
```xml
2021-02-10 08:19:33 +01:00
<param type="nil"/>
```
2022-03-05 11:13:05 +01:00
2022-11-02 22:52:50 +01:00
En YAML :
2022-11-03 22:17:43 +01:00
```yml
2022-11-02 22:52:50 +01:00
param:
- type: nil
```
2022-03-05 11:13:05 +01:00
# Paramètre de type "space"
Les paramètres sont chargés en supprimer les espaces en début ou fin de chaîne. Ce qui rend impossible d'avoir un paramètre " ". Avec le type "space", le paramètre sera donc un simple espace :
2022-11-03 22:17:43 +01:00
```xml
2022-03-05 11:13:05 +01:00
<param type="space"/>
```
2022-11-02 22:52:50 +01:00
En YAML :
2022-11-03 22:17:43 +01:00
```yml
2022-11-02 22:52:50 +01:00
param:
- type: space
```