feat: document unix file name parameters

locale/fr/LC_MESSAGES/rougail_output_doc.po

@@ -5,8 +5,8 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: \n"
-"POT-Creation-Date: 2025-03-29 15:07+0100\n"
-"PO-Revision-Date: 2025-03-29 15:08+0100\n"
+"POT-Creation-Date: 2025-03-30 19:45+0200\n"
+"PO-Revision-Date: 2025-03-30 19:46+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
 "Language: fr\n"
@@ -120,39 +120,39 @@ msgstr "multiple"
 msgid "No attribute \"description\" for \"{0}\" in {1}"
 msgstr "Aucun attribut \"description\" pour \"{0}\" dans {1}"
 
-#: src/rougail/output_doc/doc.py:464
+#: src/rougail/output_doc/doc.py:463
 msgid "(default)"
 msgstr "(défaut)"
 
-#: src/rougail/output_doc/doc.py:471
+#: src/rougail/output_doc/doc.py:470
 msgid "text based with regular expressions \"{0}\""
 msgstr "texte avec expression rationnelle \"{0}\""
 
-#: src/rougail/output_doc/doc.py:559
+#: src/rougail/output_doc/doc.py:558
 msgid "depends on a calculation"
 msgstr "dépend d'un calcul"
 
-#: src/rougail/output_doc/doc.py:560
+#: src/rougail/output_doc/doc.py:559
 msgid "\"{0}\" is a calculation for {1} but has no description in {2}"
 msgstr "\"{0}\" est un calcul pour {1} mais n'a pas de description dans {2}"
 
-#: src/rougail/output_doc/doc.py:582
+#: src/rougail/output_doc/doc.py:581
 msgid "the value of the variable \"{0}\""
 msgstr "la valeur de la variable \"{0}\""
 
-#: src/rougail/output_doc/doc.py:583
+#: src/rougail/output_doc/doc.py:582
 msgid "the value of an undocumented variable"
 msgstr "la valeur d'une variable non documentée"
 
-#: src/rougail/output_doc/doc.py:598
+#: src/rougail/output_doc/doc.py:597
 msgid "the values of undocumented variables"
 msgstr "les valeurs de variables non documentées"
 
-#: src/rougail/output_doc/doc.py:605
+#: src/rougail/output_doc/doc.py:604
 msgid "the value of the identifier"
 msgstr "la valeur de l'identifiant"
 
-#: src/rougail/output_doc/doc.py:609
+#: src/rougail/output_doc/doc.py:608
 msgid "the value of the {0}"
 msgstr "la valeur de l'{0}"
 
@@ -165,12 +165,12 @@ msgid "Example with all variables modifiable"
 msgstr "Exemple avec toutes les variables modifiable"
 
 #: src/rougail/output_doc/output/console.py:142
-#: src/rougail/output_doc/utils.py:366
+#: src/rougail/output_doc/utils.py:373
 msgid "Variable"
 msgstr "Variable"
 
 #: src/rougail/output_doc/output/console.py:143
-#: src/rougail/output_doc/utils.py:366
+#: src/rougail/output_doc/utils.py:373
 msgid "Description"
 msgstr "Description"
 
@@ -258,39 +258,51 @@ msgstr "longueur maximal pour le secret est de {0} caractères"
 msgid "forbidden characters are {0}"
 msgstr "caractères interdits sont {0}"
 
-#: src/rougail/output_doc/utils.py:233
+#: src/rougail/output_doc/utils.py:93
+msgid "this filename could be a relative path"
+msgstr "ce nom de fichier peut être un chemin relative"
+
+#: src/rougail/output_doc/utils.py:94
+msgid "this file must exists"
+msgstr "ce fichier doit exister"
+
+#: src/rougail/output_doc/utils.py:95
+msgid "file type allowed: {0}"
+msgstr "type de fichier autorisé : {0}"
+
+#: src/rougail/output_doc/utils.py:240
 msgid "Variables for \"{0}\""
 msgstr "Variables pour \"{0}\""
 
-#: src/rougail/output_doc/utils.py:249
+#: src/rougail/output_doc/utils.py:256
 msgid "Identifiers"
 msgstr "Identifiants"
 
-#: src/rougail/output_doc/utils.py:314
+#: src/rougail/output_doc/utils.py:321
 msgid "Validator"
 msgstr "Validateur"
 
-#: src/rougail/output_doc/utils.py:316
+#: src/rougail/output_doc/utils.py:323
 msgid "Validators"
 msgstr "Validateurs"
 
-#: src/rougail/output_doc/utils.py:318
+#: src/rougail/output_doc/utils.py:325
 msgid "Choices"
 msgstr "Choix"
 
-#: src/rougail/output_doc/utils.py:320
+#: src/rougail/output_doc/utils.py:327
 msgid "Default"
 msgstr "Défaut"
 
-#: src/rougail/output_doc/utils.py:324
+#: src/rougail/output_doc/utils.py:331
 msgid "Example"
 msgstr "Exemple"
 
-#: src/rougail/output_doc/utils.py:326
+#: src/rougail/output_doc/utils.py:333
 msgid "Examples"
 msgstr "Exemples"
 
-#: src/rougail/output_doc/utils.py:387
+#: src/rougail/output_doc/utils.py:394
 msgid "{0}: {1}"
 msgstr "{0} : {1}"
 

locale/rougail_output_doc.pot

@@ -5,7 +5,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2025-03-29 15:07+0100\n"
+"POT-Creation-Date: 2025-03-30 19:46+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -119,39 +119,39 @@ msgstr ""
 msgid "No attribute \"description\" for \"{0}\" in {1}"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:464
+#: src/rougail/output_doc/doc.py:463
 msgid "(default)"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:471
+#: src/rougail/output_doc/doc.py:470
 msgid "text based with regular expressions \"{0}\""
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:559
+#: src/rougail/output_doc/doc.py:558
 msgid "depends on a calculation"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:560
+#: src/rougail/output_doc/doc.py:559
 msgid "\"{0}\" is a calculation for {1} but has no description in {2}"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:582
+#: src/rougail/output_doc/doc.py:581
 msgid "the value of the variable \"{0}\""
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:583
+#: src/rougail/output_doc/doc.py:582
 msgid "the value of an undocumented variable"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:598
+#: src/rougail/output_doc/doc.py:597
 msgid "the values of undocumented variables"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:605
+#: src/rougail/output_doc/doc.py:604
 msgid "the value of the identifier"
 msgstr ""
 
-#: src/rougail/output_doc/doc.py:609
+#: src/rougail/output_doc/doc.py:608
 msgid "the value of the {0}"
 msgstr ""
 
@@ -164,12 +164,12 @@ msgid "Example with all variables modifiable"
 msgstr ""
 
 #: src/rougail/output_doc/output/console.py:142
-#: src/rougail/output_doc/utils.py:366
+#: src/rougail/output_doc/utils.py:373
 msgid "Variable"
 msgstr ""
 
 #: src/rougail/output_doc/output/console.py:143
-#: src/rougail/output_doc/utils.py:366
+#: src/rougail/output_doc/utils.py:373
 msgid "Description"
 msgstr ""
 
@@ -257,39 +257,51 @@ msgstr ""
 msgid "forbidden characters are {0}"
 msgstr ""
 
-#: src/rougail/output_doc/utils.py:233
+#: src/rougail/output_doc/utils.py:93
+msgid "this filename could be a relative path"
+msgstr ""
+
+#: src/rougail/output_doc/utils.py:94
+msgid "this file must exists"
+msgstr ""
+
+#: src/rougail/output_doc/utils.py:95
+msgid "file type allowed: {0}"
+msgstr ""
+
+#: src/rougail/output_doc/utils.py:240
 msgid "Variables for \"{0}\""
 msgstr ""
 
-#: src/rougail/output_doc/utils.py:249
+#: src/rougail/output_doc/utils.py:256
 msgid "Identifiers"
 msgstr ""
 
-#: src/rougail/output_doc/utils.py:314
+#: src/rougail/output_doc/utils.py:321
 msgid "Validator"
 msgstr ""
 
-#: src/rougail/output_doc/utils.py:316
+#: src/rougail/output_doc/utils.py:323
 msgid "Validators"
 msgstr ""
 
-#: src/rougail/output_doc/utils.py:318
+#: src/rougail/output_doc/utils.py:325
 msgid "Choices"
 msgstr ""
 
-#: src/rougail/output_doc/utils.py:320
+#: src/rougail/output_doc/utils.py:327
 msgid "Default"
 msgstr ""
 
-#: src/rougail/output_doc/utils.py:324
+#: src/rougail/output_doc/utils.py:331
 msgid "Example"
 msgstr ""
 
-#: src/rougail/output_doc/utils.py:326
+#: src/rougail/output_doc/utils.py:333
 msgid "Examples"
 msgstr ""
 
-#: src/rougail/output_doc/utils.py:387
+#: src/rougail/output_doc/utils.py:394
 msgid "{0}: {1}"
 msgstr ""
 

src/rougail/output_doc/utils.py

@@ -88,6 +88,13 @@ DocTypes = {
             "forbidden_char": _("forbidden characters are {0}"),
         },
     },
+    "unix_filename": {
+        "params": {
+            "allow_relative": _("this filename could be a relative path"),
+            "test_existence": _("this file must exists"),
+            "types": _("file type allowed: {0}"),
+        },
+    },
 }