bump: version 0.0.0 → 0.1.0a0

CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.1.0a0 (2025-11-06)
+
+### Feat
+
+- update for last rougail version
+- support of password type

locale/fr/LC_MESSAGES/rougail_user_data_questionary.po

@@ -0,0 +1,29 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR ORGANIZATION
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"POT-Creation-Date: 2025-11-06 06:11+0100\n"
+"PO-Revision-Date: 2025-11-06 06:11+0100\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_questionary/config.py:31
+msgid "Define values interactivly"
+msgstr "Définir des valeurs interactivement"
+
+#: src/rougail/user_data_questionary/config.py:39
+msgid "Ask values only for mandatories variables without any value"
+msgstr "Demander des valeurs uniquement pour des variables obligatoires sans valeur"
+
+#: src/rougail/user_data_questionary/config.py:44
+msgid "Show secrets instead of obscuring them"
+msgstr "Afficher les secrets plutôt que des obscurcir."

locale/rougail_user_data_questionary.pot

@@ -0,0 +1,29 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR ORGANIZATION
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2025-11-06 06:11+0100\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_questionary/config.py:31
+msgid "Define values interactivly"
+msgstr ""
+
+#: src/rougail/user_data_questionary/config.py:39
+msgid "Ask values only for mandatories variables without any value"
+msgstr ""
+
+#: src/rougail/user_data_questionary/config.py:44
+msgid "Show secrets instead of obscuring them"
+msgstr ""
+

pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+build-backend = "flit_core.buildapi"
+requires = ["flit_core >=3.8.0,<4"]
+
+[project]
+name = "rougail.user_data_questionary"
+version = "0.1.0a0"
+authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
+readme = "README.md"
+description = "Rougail user_data questionary"
+requires-python = ">=3.11"
+license = {file = "LICENSE"}
+classifiers = [
+    "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Natural Language :: English",
+    "Natural Language :: French",
+
+]
+dependencies = [
+    "rougail-base >= 1.1,<2",
+    "questionary ~= 2.1.0",
+]
+
+[project.urls]
+Home = "https://forge.cloud.silique.fr/stove/rougail-user-data-questionary"
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "$version"
+version_scheme = "pep440"
+version_provider = "pep621"
+version_files = [
+    "src/rougail/user_data_questionary/__version__.py",
+    "pyproject.toml:version"
+]
+update_changelog_on_bump = true
+changelog_merge_prerelease = true

src/rougail/user_data_questionary/__init__.py

@@ -0,0 +1,5 @@
+from .data import RougailUserDataQuestionary
+from .__version__ import __version__
+
+RougailUserData = RougailUserDataQuestionary
+__all__ = ('RougailUserDataQuestionary',)

src/rougail/user_data_questionary/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0a0"

src/rougail/user_data_questionary/config.py

@@ -0,0 +1,56 @@
+"""
+Silique (https://www.silique.fr)
+Copyright (C) 2024-2025
+
+distribued with GPL-2 or later license
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+
+from .i18n import _
+
+
+def get_rougail_config(
+    *,
+    backward_compatibility=True,
+) -> dict:
+    options = f"""
+questionary:
+  description: {_("Define values interactivly")}
+  disabled:
+    jinja: |
+      {{% if step.user_data is not propertyerror and 'questionary' not in step.user_data %}}
+      disabled
+      {{% endif %}}
+
+  mandatory:
+    description: {_("Ask values only for mandatories variables without any value")}
+    alternative_name: qm
+    default: false
+
+  show_secrets:
+    description: {_("Show secrets instead of obscuring them")}
+    alternative_name: qs
+    type: boolean
+    default: false
+"""
+    return {'name': 'questionary',
+            'process': 'user data',
+            'options': options,
+            'level': 60,
+            }
+
+
+__all__ = ('get_rougail_config',)

src/rougail/user_data_questionary/data.py

@@ -0,0 +1,193 @@
+"""
+Silique (https://www.silique.fr)
+Copyright (C) 2024-2025
+
+distribued with GPL-2 or later license
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+from questionary import text, select, confirm, password, Validator, ValidationError, print as qprint
+
+from rougail.tiramisu import CONVERT_OPTION
+from rougail.config import RougailConfig
+from rougail.error import ExtentionError
+from tiramisu.error import ValueOptionError
+
+
+class RougailUserDataQuestionary:
+    interactive_user_datas = True
+
+    def __init__(
+        self,
+        config: "Config",
+        *,
+        rougailconfig: "RougailConfig" = None,
+    ):
+        # this is the tiramisu config object
+        self.config = config
+        if rougailconfig is None:
+            rougailconfig = RougailConfig
+            user_data = rougailconfig['step.user_data']
+            if 'questionary' not in user_data:
+                user_data.append('questionary')
+                rougailconfig['step.user_data'] = user_data
+        user_data = rougailconfig['step.user_data']
+        if 'questionary' not in user_data:
+            raise ExtentionError('questionary is not set in step.user_data')
+        self.rougailconfig = rougailconfig
+        self.errors = []
+        self.warnings = []
+
+    def run(
+        self,
+    ) -> None:
+        self.config.property.read_write()
+        if self.rougailconfig['questionary.mandatory']:
+            current_titles = []
+            while True:
+                mandatories = self.config.value.mandatory()
+                if not mandatories:
+                    break
+                mandatory = mandatories[0]
+                path = mandatory.path()
+                if '.' in path:
+                    current_config = self.config
+                    for idx, p in enumerate(path.split('.')[0:-1]):
+                        current_config = current_config.option(p)
+                        if idx < len(current_titles):
+                            if current_titles[idx] == p:
+                                continue
+                            current_titles = current_titles[0:idx]
+                        current_titles.append(p)
+                        self.print(current_config.description(), idx)
+                self.display_questionary(mandatory)
+        else:
+            self.parse(self.config)
+        self.config.property.read_only()
+        return {'errors': [],
+                'warnings': [],
+                }
+        return [
+            {
+                "source": 'Questionary',
+                "errors": self.errors,
+                "warnings": self.warnings,
+                "values": values,
+            }
+        ]
+
+    def parse(self, config, title_level=0):
+        for option in config:
+            if option.isoptiondescription():
+                self.print(option.description(), title_level)
+                self.parse(option, title_level + 1)
+            else:
+                self.display_questionary(option)
+
+    def print(self, title, title_level):
+        qprint(' ' * title_level + '📂 ' + title, 'bold')
+
+    def display_questionary(self, option):
+        kwargs = {}
+        option_type = option.information.get('type')
+        isdefault = option.owner.isdefault()
+        default = option.value.get()
+        ismulti = option.ismulti()
+        type_obj = None
+        type_obj = CONVERT_OPTION.get(option_type, {}).get("func")
+        RougailValidator.option = option
+        RougailValidator.option_type = {'type': option_type,
+                                        'func': type_obj,
+                                        }
+        RougailValidator.ismulti = ismulti
+        ori_default = default
+        if option_type == 'choice':
+            question_funtion = select
+            RougailValidator.default = default
+            kwargs['choices'] = option.value.list()
+        elif option_type == 'boolean':
+            question_funtion = confirm
+        elif option_type == 'secret' and not self.rougailconfig['questionary.show_secrets']:
+            question_funtion = password
+        else:
+            question_funtion = text
+            kwargs['validate'] = RougailValidator
+        args = ['📓 ' + option.description()]
+        if ismulti:
+            kwargs['multiline'] = True
+            if default:
+                kwargs['default'] = "\n".join([str(d) for d in default])
+        elif default is not None:
+            if isinstance(default, (int, float)):
+                default = str(default)
+            kwargs['default'] = default
+        value = RougailValidator().convert_value(question_funtion(*args, **kwargs).ask(), False)
+        if isdefault and value == ori_default:
+            option.value.reset()
+        else:
+            option.value.set(value)
+
+
+class RougailValidator(Validator):
+    def validate(self, document):
+        return self.convert_value(document.text)
+
+    def convert_value(self,
+                      document,
+                      validate=True,
+                      ):
+        if not self.ismulti:
+            value = self._convert_a_value(document, document, validate)
+        else:
+            value = []
+            if document is not None:
+                for val in document.strip().split('\n'): 
+                    val = self._convert_a_value(val, document, validate)
+                    if val is not None:
+                        value.append(val)
+        if validate:
+            try:
+                self.option.value.set(value)
+            except ValueOptionError as err:
+                err.prefix = ''
+                raise ValidationError(
+                    message=str(err),
+                    cursor_position=len(document),
+                )
+        return value
+
+    def _convert_a_value(self, value, document, validate):
+        if value is None:
+            if self.option_type['type'] == 'choice':
+                return self.default
+            return
+        if isinstance(value, str):
+            value = value.strip()
+        if value == '':
+            if validate and "mandatory" in self.option.property.get():
+                raise ValidationError(
+                    message=f"Value must not be empty",
+                    cursor_position=len(document),
+                )
+            return
+        if self.option_type['func']:
+            try:
+                return self.option_type['func'](value)
+            except:
+                raise ValidationError(
+                    message=f"Not a valid {self.option_type['type']}",
+                    cursor_position=len(document),
+                )
+        return value

src/rougail/user_data_questionary/i18n.py

@@ -0,0 +1,26 @@
+"""
+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_questionary", str(Path(__file__).parent / "locale"), fallback=True
+)
+
+_ = t.gettext