rougail-base 1.2.0__py3-none-any.whl

rougail/__init__.py

@@ -0,0 +1,36 @@
+"""Rougail method
+
+Created by:
+EOLE (http://eole.orion.education.fr)
+Copyright (C) 2005-2018
+
+Forked by:
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2019-2021
+
+Silique (https://www.silique.fr)
+Copyright (C) 2022-2026
+
+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 .__version__ import __version__
+
+try:
+    from .convert import Rougail, SUPPORTED_VERSION
+    from .config import RougailConfig
+
+    __all__ = ("Rougail", "RougailConfig", "__version__")
+except ModuleNotFoundError as err:
+    __all__ = ("__version__",)

rougail/__version__.py

@@ -0,0 +1 @@
+__version__ = "1.2.0"

rougail/error.py

@@ -0,0 +1,87 @@
+"""Standard error classes
+
+Created by:
+EOLE (http://eole.orion.education.fr)
+Copyright (C) 2005-2018
+
+Forked by:
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2019-2021
+
+Silique (https://www.silique.fr)
+Copyright (C) 2022-2026
+
+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 .i18n import _
+from .tiramisu import display_xmlfiles
+
+
+class ConfigError(Exception):
+    """Standard error for templating"""
+
+
+class FileNotFound(ConfigError):
+    """Template file is not found"""
+
+
+class TemplateError(ConfigError):
+    """Templating generate an error"""
+
+
+class TemplateDisabled(TemplateError):
+    """Template is disabled."""
+
+
+class SpaceObjShallNotBeUpdated(Exception):
+    """Specific behavior in case of the presence or not
+    of an object in the space object
+    """
+
+
+class DictConsistencyError(Exception):
+    """It's not only that the Creole XML is valid against the Creole DTD
+    it's that it is not consistent.
+    """
+
+    def __init__(self, msg, errno, xmlfiles):
+        if xmlfiles:
+            msg = _("{0} in {1}").format(msg, display_xmlfiles(xmlfiles))
+        super().__init__(msg)
+        self.errno = errno
+
+
+## ---- generic exceptions ----
+
+
+class NotFoundError(Exception):
+    "not found error"
+
+    pass
+
+
+class ExtensionError(Exception):
+    pass
+
+
+class RougailWarning(UserWarning):
+    pass
+
+
+## ---- specific exceptions ----
+
+
+class VariableCalculationDependencyError(Exception):
+    pass

rougail/i18n.py

@@ -0,0 +1,32 @@
+"""Internationalisation utilities
+Created by:
+EOLE (http://eole.orion.education.fr)
+Copyright (C) 2005-2018
+
+Forked by:
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2019-2021
+
+Silique (https://www.silique.fr)
+Copyright (C) 2022-2026
+
+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", str(Path(__file__).parent / "locale"), fallback=True)
+
+_ = t.gettext

rougail/structural_string/__init__.py

@@ -0,0 +1,103 @@
+"""
+Silique (https://www.silique.fr)
+Copyright (C) 2025-2026
+
+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 typing import List, Optional
+from itertools import chain
+from ruamel.yaml import YAML
+
+from ..tiramisu import normalize_family
+from ..convert.path import Paths
+
+# from ..error import DictConsistencyError
+# from ..i18n import _
+
+
+class Walker:
+    def __init__(
+        self,
+        convert,
+    ) -> None:
+        """Parse directories content"""
+        self.convert = convert
+        self.yaml = YAML()
+        rougailconfig = self.convert.rougailconfig
+        if rougailconfig["main_namespace"]:
+            self.load_with_extra(
+                rougailconfig["extra_namespaces"],
+                rougailconfig["main_namespace"],
+                rougailconfig["main_structural_strings"],
+                rougailconfig["isolated_namespace"],
+            )
+        else:
+            self.convert.namespace = None
+            for string in rougailconfig["main_structural_strings"]:
+                self.parse_variable(
+                    string,
+                )
+
+    def load_with_extra(
+        self,
+        extra_structures: dict,
+        main_namespace: str,
+        main_strings: Optional[List[str]] = None,
+        isolated_namespace: bool = True,
+    ) -> None:
+        directory_dict = chain(
+            (
+                (
+                    main_namespace,
+                    main_strings,
+                ),
+            ),
+            extra_structures.items(),
+        )
+        for namespace, extra_objects in directory_dict:
+            namespace_path = normalize_family(namespace)
+            for idx, string in enumerate(extra_objects):
+                if not idx:
+                    # create only for the first file
+                    self.convert.create_namespace(namespace, isolated_namespace)
+                self.parse_variable(
+                    string,
+                )
+
+    def parse_variable(
+        self,
+        string: str,
+    ) -> None:
+        objects = self.yaml.load(string)
+        if objects is None:
+            return
+        path = self.convert.namespace
+        if path:
+            name = f"yaml file for {path}"
+        else:
+            name = "yaml file"
+        version = self.convert.validate_file_version(
+            objects,
+            name,
+        )
+        self.convert.parse_root_file(
+            [name],
+            path,
+            version,
+            objects,
+        )
+
+
+__all__ = ("Walker",)

rougail/structural_string/config.py

@@ -0,0 +1,68 @@
+"""
+Silique (https://www.silique.fr)
+Copyright (C) 2025-2026
+
+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 ..utils import _
+
+
+def get_rougail_config(
+    *,
+    backward_compatibility=True,
+) -> dict:
+    if backward_compatibility:
+        main_namespace_default = "rougail"
+    else:
+        main_namespace_default = "null"
+    options = f"""
+main_structural_strings:
+  description: {_("Structural files contents")}
+  help: {_("This variable is a list of string with YAML file format")}
+  multi: true
+  disabled:
+    jinja: >-
+      {{% if 'string' not in _.step.structural %}}
+        true
+      {{% elif cli is defined and cli.versions is defined and cli.versions %}}
+        true
+      {{% else %}}
+        false
+      {{% endif %}}
+    return_type: boolean
+    description: {_('string is not in "_.step.structural"')}
+
+extra_namespaces:
+
+  strings:
+    description: {_("Extra structural contents")}
+    help: {_("This variable is a list of string with YAML file format")}
+    alternative_name: xc
+    multi: true
+    disabled:
+      jinja: >-
+        {{{{ 'string' not in __.step.structural }}}}
+      return_type: boolean
+      description: {_('string is not in "__.step.structural"')}
+"""
+    return {
+        "name": "string",
+        "process": "structural",
+        "options": options,
+        "level": 15,
+    }
+
+
+__all__ = "get_rougail_config"