Compare commits

...

11 commits

849 changed files with 1885 additions and 926 deletions

View file

@ -1,3 +1,30 @@
## 0.1.0a15 (2025-11-21)
### Fix
- ExtentionError => ExtensionError
## 0.1.0a14 (2025-11-06)
### Fix
- add translation
- update tests
## 0.1.0a13 (2025-10-29)
### Feat
- can define a new separator
## 0.1.0a12 (2025-10-10)
### Fix
- update test
- translation + tests
- tests for formatter
## 0.1.0a11 (2025-09-29) ## 0.1.0a11 (2025-09-29)
### Feat ### Feat

View file

@ -0,0 +1,48 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR ORGANIZATION
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: \n"
"POT-Creation-Date: 2025-10-04 17:04+0200\n"
"PO-Revision-Date: 2025-10-04 17:04+0200\n"
"Last-Translator: \n"
"Language-Team: \n"
"Language: fr\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: pygettext.py 1.5\n"
"X-Generator: Poedit 3.7\n"
#: src/rougail/user_data_environment/annotator.py:46
msgid ""
"family name must be a lowercase name when we want to use user data "
"\"environment\", so \"{0}\" is invalid"
msgstr ""
"le nom d'une famille doit être un nom en minuscule lorsque vous voulez "
"utiliser de données utilisateur \"environment\", donc \"{0}\" est invalide"
#: src/rougail/user_data_environment/annotator.py:56
msgid ""
"variable name must be a lowercase name when we want to use user data "
"\"environment\", so \"{0}\" is invalid"
msgstr ""
"le nom d'une variable doit être un nom en minuscule lorsque vous voulez "
"utiliser de données utilisateur \"environment\", donc \"{0}\" est invalide"
#: src/rougail/user_data_environment/config.py:34
msgid "Configuration loading environment variables"
msgstr "Configuration le chargement des variables d'environnements"
#: src/rougail/user_data_environment/config.py:42
msgid "Name of the default environment prefix"
msgstr "Nom du préfix d'environnement par défaut"
#: src/rougail/user_data_environment/config.py:49
msgid "Environnement variables may contain secrets"
msgstr "Les variables d'environnement peuvent contenir des secrets"
#~ msgid "Define values from the environment"
#~ msgstr "Défini les valeurs pour l'environnemnt"

View file

@ -0,0 +1,37 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR ORGANIZATION
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2025-10-04 17:05+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"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: pygettext.py 1.5\n"
#: src/rougail/user_data_environment/annotator.py:46
msgid "family name must be a lowercase name when we want to use user data \"environment\", so \"{0}\" is invalid"
msgstr ""
#: src/rougail/user_data_environment/annotator.py:56
msgid "variable name must be a lowercase name when we want to use user data \"environment\", so \"{0}\" is invalid"
msgstr ""
#: src/rougail/user_data_environment/config.py:34
msgid "Configuration loading environment variables"
msgstr ""
#: src/rougail/user_data_environment/config.py:42
msgid "Name of the default environment prefix"
msgstr ""
#: src/rougail/user_data_environment/config.py:49
msgid "Environnement variables may contain secrets"
msgstr ""

View file

@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"]
[project] [project]
name = "rougail.user_data_environment" name = "rougail.user_data_environment"
version = "0.1.0a11" version = "0.1.0a15"
authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}] authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
readme = "README.md" readme = "README.md"
description = "Rougail user_data environment" description = "Rougail user_data environment"
@ -13,9 +13,6 @@ license = {file = "LICENSE"}
classifiers = [ classifiers = [
"License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)", "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
"Programming Language :: Python", "Programming Language :: Python",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13", "Programming Language :: Python :: 3.13",

View file

@ -1 +1 @@
__version__ = "0.1.0a11" __version__ = "0.1.0a15"

View file

@ -22,24 +22,42 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
""" """
from .i18n import _
def get_rougail_config( def get_rougail_config(
*, *,
backward_compatibility=True, backward_compatibility=True,
) -> dict: ) -> dict:
options = """ options = f"""
environment: environment:
description: Define values from the environment description: {_("Configuration loading environment variables")}
disabled: disabled:
jinja: | jinja: |
{% if step.user_data is propertyerror or 'environment' not in step.user_data %} {{% if _.step.user_data is propertyerror or 'environment' not in _.step.user_data %}}
disabled disabled
{% endif %} {{% endif %}}
default_environment_name: default_environment_name:
description: Name of the default environment prefix description: {_("Name of the default environment prefix")}
default: rougail default: ROUGAIL
validators:
- jinja: |-
{{% if _.default_environment_name | upper != _.default_environment_name %}}
{_("should only user uppercase character")}
{{% endif %}}
disabled: disabled:
variable: main_namespace variable: __.main_namespace
when_not: null when_not: null
custom_separator:
description: {_('Replace the separator character "." in path by an other')}
help: {_('The "." character could be not allowed in path name')}
mandatory: false
with_secrets:
description: {_("Environnement variables may contain secrets")}
default: true
""" """
return { return {
"name": "environment", "name": "environment",

View file

@ -22,7 +22,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import os import os
from rougail.tiramisu import CONVERT_OPTION from rougail.tiramisu import CONVERT_OPTION
from rougail.config import RougailConfig from rougail.config import RougailConfig
from rougail.error import ExtentionError from rougail.error import ExtensionError
from tiramisu.error import ValueOptionError from tiramisu.error import ValueOptionError
@ -42,9 +42,15 @@ class RougailUserDataEnvironment:
user_data.append("environment") user_data.append("environment")
rougailconfig["step.user_data"] = user_data rougailconfig["step.user_data"] = user_data
user_data = rougailconfig["step.user_data"] user_data = rougailconfig["step.user_data"]
self.rougailconfig = rougailconfig
if "environment" not in user_data: if "environment" not in user_data:
raise ExtentionError("environment is not set in step.user_data") raise ExtensionError("environment is not set in step.user_data")
if "environment.with_secrets" in rougailconfig:
self.with_secrets = rougailconfig["environment.with_secrets"]
else:
self.with_secrets = True
self.custom_separator = rougailconfig["environment.custom_separator"]
if not rougailconfig["main_namespace"]:
self.default_environment_name = rougailconfig["environment.default_environment_name"]
self.errors = [] self.errors = []
self.warnings = [] self.warnings = []
@ -59,39 +65,43 @@ class RougailUserDataEnvironment:
"options": { "options": {
"multi_separator": ",", "multi_separator": ",",
"needs_convert": True, "needs_convert": True,
"allow_secrets_variables": self.with_secrets,
}, },
} }
] ]
def parse(self): def parse(self):
variables = {} variables = {}
self.prefixes = []
for option in self.config: for option in self.config:
if not option.isoptiondescription() or option.group_type() != "namespace": if not option.isoptiondescription() or option.group_type() != "namespace":
break break
variables.update(get_rougail_environment(option.name())) self.prefixes.append(option.name().upper() + ".")
else: else:
return variables return self.get_rougail_environment(0)
return get_rougail_environment( # no namespace then we filter the ROUGAIL_ environment variables
None, self.rougailconfig["environment.default_environment_name"] self.prefixes = [self.default_environment_name + "_"]
) return self.get_rougail_environment(len(self.prefixes[0]))
def get_rougail_environment(self, len_env):
"""gets all the rougail environment variables and their values
def get_rougail_environment(namespace, environment_name=None): :sample: {'VARINT': '5', 'VARNAME34': '58, 22', 'VARNAME2': 'tata',
"""gets all the rougail environment variables and their values 'VARNAME1': 'titi', 'MYFAMILY.VARNAME3': 'spam'}
:returns: rougail environment variables as a key/value dict
"""
return {
envvar[len_env:].lower(): envval
for envvar, envval in self.get_correct_envs()
}
:sample: {'VARINT': '5', 'VARNAME34': '58, 22', 'VARNAME2': 'tata', def get_correct_envs(self):
'VARNAME1': 'titi', 'MYFAMILY.VARNAME3': 'spam'} for envvar, envval in os.environ.items():
:returns: rougail environment variables as a key/value dict if self.custom_separator:
""" envvar = envvar.replace(self.custom_separator, '.')
# then we filter the ROUGAIL_ environment variables for prefix in self.prefixes:
if namespace is None: if envvar.startswith(prefix):
rougail_environment_var = environment_name.upper() + "_" yield envvar, envval
len_env = len(rougail_environment_var) for prefix in self.prefixes:
else: if envvar.startswith(prefix):
rougail_environment_var = namespace.upper() + "." yield envvar, envval
len_env = 0
return {
envvar[len_env:].lower(): envval
for envvar, envval in os.environ.items()
if envvar.startswith(rougail_environment_var)
}

View file

@ -0,0 +1,27 @@
"""Internationalisation utilities
Silique (https://www.silique.fr)
Copyright (C) 2025
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
from gettext import translation
from pathlib import Path
t = translation(
"rougail_user_data_environment", str(Path(__file__).parent / "locale"), fallback=True
)
_ = t.gettext

View file

@ -1,6 +1,6 @@
{ {
"errors": [], "errors": [],
"warnings": [ "warnings": [
"the value \"test\" is invalid for \"variable_int\", which is not an integer, it will be ignored when loading from environment variable" "the value \"test\" is an invalid integer for \"variable_int\", which is not an integer, it will be ignored when loading from environment variable"
] ]
} }

View file

@ -1,6 +1,6 @@
{ {
"errors": [], "errors": [],
"warnings": [ "warnings": [
"the value \"**********\" is invalid for \"secret\", at least 10 characters are required, it will be ignored when loading from environment variable" "the value \"**********\" is an invalid password for \"secret\", at least 10 characters are required, it will be ignored when loading from environment variable"
] ]
} }

View file

@ -1,3 +1,3 @@
ROUGAIL_LEADERSHIP.VAR1="string1,string2,string3" ROUGAIL_LEADERSHIP.VAR1="string1,string2,string3"
ROUGAIL_LEADERSHIP.VAR2="string1,," ROUGAIL_LEADERSHIPoVAR2="string1,,"
ROUGAIL_VAR2="string1" ROUGAIL_VAR2="string1"

View file

@ -1,3 +1,3 @@
ROUGAIL_LEADERSHIP.VAR1="string1,string2,string3" ROUGAIL_LEADERSHIP.VAR1="string1,string2,string3"
ROUGAIL_LEADERSHIP.VAR2="string1,," ROUGAIL_LEADERSHIPoVAR2="string1,,"
ROUGAIL_VAR2="string1" ROUGAIL_VAR2="string1"

View file

@ -4,3 +4,5 @@ ROUGAIL_VAR3="string1"
ROUGAIL_VAR4="string1" ROUGAIL_VAR4="string1"
ROUGAIL_VAR5="string1" ROUGAIL_VAR5="string1"
ROUGAIL_VAR6="string1" ROUGAIL_VAR6="string1"
ROUGAIL_VAR7="string1"
ROUGAIL_VAR8="string1"

View file

@ -4,3 +4,5 @@ ROUGAIL_VAR3="string1"
ROUGAIL_VAR4="string1" ROUGAIL_VAR4="string1"
ROUGAIL_VAR5="string1" ROUGAIL_VAR5="string1"
ROUGAIL_VAR6="string1" ROUGAIL_VAR6="string1"
ROUGAIL_VAR7="string1"
ROUGAIL_VAR8="string1"

View file

@ -4,5 +4,7 @@
"var3": "string1", "var3": "string1",
"var4": "string1", "var4": "string1",
"var5": "string1", "var5": "string1",
"var6": "string1" "var6": "string1",
"var7": "string1",
"var8": "string1"
} }

View file

@ -4,5 +4,7 @@
"var3": "string1", "var3": "string1",
"var4": "value", "var4": "value",
"var5": "value", "var5": "value",
"var6": "value" "var6": "value",
"var7": "8080",
"var8": "true"
} }

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1 @@
ROUGAIL_VAR="1,2,3"

View file

@ -0,0 +1 @@
ROUGAIL_VAR="1,2,3"

View file

@ -0,0 +1 @@
ROUGAIL_VAR="1,2,3"

View file

@ -0,0 +1,7 @@
{
"var": [
1,
2,
3
]
}

View file

@ -0,0 +1,7 @@
{
"var": [
1,
2,
3
]
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,2 @@
ROUGAIL_VAR1="string1"
ROUGAIL_VAR2="string1"

View file

@ -0,0 +1,2 @@
ROUGAIL_VAR1="string1"
ROUGAIL_VAR2="string1"

View file

@ -0,0 +1,2 @@
ROUGAIL_VAR1="string1"
ROUGAIL_VAR2="string1"

View file

@ -0,0 +1,4 @@
{
"var1": "string1",
"var2": "string1"
}

View file

@ -0,0 +1,4 @@
{
"var1": "string1",
"var2": "string1"
}

View file

@ -0,0 +1,6 @@
{
"errors": [],
"warnings": [
"variable \"variable2\" (a seconde variable) is disabled, it will be ignored when loading from environment variable"
]
}

View file

@ -0,0 +1,6 @@
{
"errors": [],
"warnings": [
"variable \"variable2\" (a seconde variable) is disabled, it will be ignored when loading from environment variable"
]
}

View file

@ -0,0 +1,3 @@
ROUGAIL_CONDITION="string1"
ROUGAIL_VARIABLE1="string1"
ROUGAIL_VARIABLE2="string1"

View file

@ -0,0 +1,3 @@
ROUGAIL_CONDITION="string1"
ROUGAIL_VARIABLE1="string1"
ROUGAIL_VARIABLE2="string1"

View file

@ -0,0 +1,2 @@
ROUGAIL_VARIABLE1="string1"
ROUGAIL_VARIABLE2="string1"

View file

@ -0,0 +1,4 @@
{
"condition": "string1",
"variable1": "string1"
}

View file

@ -0,0 +1,4 @@
{
"condition": "no",
"variable1": "string1"
}

View file

@ -1,8 +1,8 @@
{ {
"errors": [], "errors": [],
"warnings": [ "warnings": [
"variable \"var1\" (a first variable) is hidden, it will be ignored when loading from environment variable",
"variable \"var2\" (a first variable) is hidden, it will be ignored when loading from environment variable", "variable \"var2\" (a first variable) is hidden, it will be ignored when loading from environment variable",
"variable \"var3\" (a second variable) is hidden, it will be ignored when loading from environment variable" "variable \"var3\" (a second variable) is hidden, it will be ignored when loading from environment variable",
"variable \"var4\" (a forth variable) is hidden, it will be ignored when loading from environment variable"
] ]
} }

View file

@ -2,3 +2,4 @@ ROUGAIL_CONDITION="True"
ROUGAIL_VAR1="string1" ROUGAIL_VAR1="string1"
ROUGAIL_VAR2="string1" ROUGAIL_VAR2="string1"
ROUGAIL_VAR3="string1" ROUGAIL_VAR3="string1"
ROUGAIL_VAR4="string1"

View file

@ -2,3 +2,4 @@ ROUGAIL_CONDITION="True"
ROUGAIL_VAR1="string1" ROUGAIL_VAR1="string1"
ROUGAIL_VAR2="string1" ROUGAIL_VAR2="string1"
ROUGAIL_VAR3="string1" ROUGAIL_VAR3="string1"
ROUGAIL_VAR4="string1"

View file

@ -1,6 +1,6 @@
{ {
"condition": true, "condition": true,
"var1": null, "var1": "string1",
"var2": null, "var2": null,
"var3": null, "var3": null,
"var4": null "var4": null

View file

@ -0,0 +1,6 @@
{
"errors": [],
"warnings": [
"variable \"variable\" (a variable) is disabled, it will be ignored when loading from environment variable"
]
}

View file

@ -0,0 +1,6 @@
{
"errors": [],
"warnings": [
"variable \"variable\" (a variable) is disabled, it will be ignored when loading from environment variable"
]
}

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1 @@
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,3 @@
{
"condition": true
}

View file

@ -0,0 +1,3 @@
{
"condition": true
}

View file

@ -0,0 +1,6 @@
{
"errors": [],
"warnings": [
"variable \"condition\" (a condition) is hidden, it will be ignored when loading from environment variable"
]
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1 @@
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,4 @@
{
"condition": false,
"variable": "string1"
}

View file

@ -0,0 +1,4 @@
{
"condition": false,
"variable": "string1"
}

View file

@ -0,0 +1,6 @@
{
"errors": [],
"warnings": [
"variable \"condition\" (a condition) is disabled, it will be ignored when loading from environment variable"
]
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1 @@
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,3 @@
{
"variable": "string1"
}

View file

@ -0,0 +1,3 @@
{
"variable": "string1"
}

View file

@ -0,0 +1,6 @@
{
"errors": [],
"warnings": [
"variable \"variable\" (a variable) is disabled, it will be ignored when loading from environment variable"
]
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1 @@
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,3 @@
{
"condition": true
}

View file

@ -0,0 +1,4 @@
{
"condition": false,
"variable": "string1"
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1 @@
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,3 @@
{
"condition": true
}

View file

@ -0,0 +1,3 @@
{
"condition": true
}

View file

@ -0,0 +1,6 @@
{
"errors": [],
"warnings": [
"variable \"condition\" (a condition) is disabled, it will be ignored when loading from environment variable"
]
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,2 @@
ROUGAIL_CONDITION="True"
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1 @@
ROUGAIL_VARIABLE="string1"

View file

@ -0,0 +1,3 @@
{
"variable": "string1"
}

View file

@ -0,0 +1,3 @@
{
"variable": "string1"
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1 @@
ROUGAIL_INT="1"

View file

@ -0,0 +1 @@
ROUGAIL_INT="1"

View file

@ -0,0 +1,3 @@
{
"int": 1
}

View file

@ -0,0 +1,3 @@
{
"int": 1000
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1,4 @@
{
"errors": [],
"warnings": []
}

View file

@ -0,0 +1 @@
ROUGAIL_INT="1"

View file

@ -0,0 +1 @@
ROUGAIL_INT="1"

View file

@ -0,0 +1,3 @@
{
"int": 1
}

View file

@ -0,0 +1,3 @@
{
"int": 1000
}

View file

@ -1,2 +1,2 @@
ROUGAIL_FAMILY1.VARIABLE1="string1" ROUGAIL_FAMILY1.VARIABLE1="string1"
ROUGAIL_FAMILY2.VARIABLE2="string1" ROUGAIL_FAMILY2oVARIABLE2="string1"

View file

@ -1,2 +1,2 @@
ROUGAIL_FAMILY1.VARIABLE1="string1" ROUGAIL_FAMILY1.VARIABLE1="string1"
ROUGAIL_FAMILY2.VARIABLE2="string1" ROUGAIL_FAMILY2oVARIABLE2="string1"

Some files were not shown because too many files have changed in this diff Show more