backo 0.3.7__tar.gz → 0.3.8__tar.gz

{backo-0.3.7 → backo-0.3.8}/CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.3.8] 2026-09-29
+  
+    * Internal :
+      * BREAKING CHANGE : use stricto 0.3.0
+        * function signature of transform=, contraint=, contraints= has change to (object, value, old_value)
+        * required= field must be with a default=
+    * Fix
+      * fix issue #32 (load and check value)
+      * fix issue #31 (StandardMetaDataHandler do set_value() rather than set())
+      * fix issue #29
+      * fix issue require= during init_script
+      * fix issue need mongo for init_script (now with DBYmlDirConnector)
+    * Feature
+      * BREAKING CHANGE : add feature by default fields with set= are not saved into the DB. Must
+    add view= [ "save" ] to save it.
+
 ## [0.3.7] 2026-09-23
   
     * Internal :

{backo-0.3.7 → backo-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: backo
-Version: 0.3.7
+Version: 0.3.8
 Summary: Back office low code
 Project-URL: GitHub, https://github.com/backo-stricto/backo
 Project-URL: Homepage, https://github.com/backo-stricto/backo
@@ -41,7 +41,7 @@ Requires-Dist: pyyaml
 Requires-Dist: questionary
 Requires-Dist: redis>=8.1.0
 Requires-Dist: requests
-Requires-Dist: stricto>=0.2.11
+Requires-Dist: stricto>=0.3.0
 Provides-Extra: mongo
 Requires-Dist: pymongo>=4.17.0; extra == 'mongo'
 Description-Content-Type: text/markdown

{backo-0.3.7 → backo-0.3.8}/backo/db/mongo.py

@@ -214,6 +214,22 @@ class IdTransformer(Transformer):
         """
         _loaded_object["_id"] = str(_loaded_object["_id"])
 
+    def transform_value_to_db(self, v: Any) -> Any:
+        """
+        Transform its value on save, create, filter
+
+        """
+        if isinstance(v, str):
+            return ObjectId(v)
+        return v
+
+    def transform_value_from_db(self, v: Any) -> Any:
+        """
+        Transform its value on load
+
+        """
+        return str(v)
+
     def on_create(self, obj: dict, _key_path: list[str]):
         """
         Delete the _id field if exists
@@ -399,12 +415,12 @@ class DBMongoConnector(DBHandler):
                 'Mongo connection error while "{0}.drop()"', self._collection_name
             ) from e
 
-    def generate_id(self, o: dict) -> str:  # pylint: disable=unused-argument
+    def generate_id(self, _o: dict) -> str:
         """
         Not used in Mongo
         (the _id is generated by the DB itself)
         """
-        return "666"
+        raise DBError("generate_id() not implemented in DBMongoConnector")
 
     def get_by_id(self, _id: str) -> dict:
         """get"""

{backo-0.3.7 → backo-0.3.8}/backo/file/file.py

@@ -35,7 +35,7 @@ FILE_MODEL = {
 
 
 def transform_to_filestorage(  # pylint: disable=unused-argument
-    v: Any, o: Any
+    _o: Any, v: Any, _old_value: Any
 ) -> FileStorage | None:
     """Transform any kind of object into a FileStorage
 
@@ -267,7 +267,7 @@ class File(Dict):
         Set the file content
         """
         return self._set_content_from_filestorage(
-            transform_to_filestorage(content, None)
+            transform_to_filestorage(None, content, None)
         )
 
     def set_value(self, value: Any) -> bool:

{backo-0.3.7 → backo-0.3.8}/backo/initialisation/init_script.py

@@ -157,6 +157,7 @@ class Init:
 
         if exists == False:
             return
+
         if can_read == False:
             return
 
@@ -254,7 +255,10 @@ and if it is required.",
                 views=["!conf"],
             ),
             "name": String(
-                require=True, description="Name of the field", regexp=r"[A-z_-]+"
+                require=True,
+                description="Name of the field",
+                regexp=r"[A-z_-]+",
+                default="",
             ),
             "type": String(
                 require=True,
@@ -262,8 +266,13 @@ and if it is required.",
                 default="String",
                 description="type of the field",
             ),
-            "required": Bool(default=False, description="is the field required"),
-            "default": String(description="a default value", can_read=args.expert),
+            "required": Bool(
+                default=False, description="is the field required", can_read=args.expert
+            ),
+            "default": String(
+                description="a default value (mandatory if the field is required)",
+                can_read=args.expert,
+            ),
         },
         description="field",
     )
@@ -271,10 +280,15 @@ and if it is required.",
     selection_model = Dict(
         {
             "name": String(
-                require=True, description="Name of the selection", regexp=r"[A-z_-]+"
+                require=True,
+                description="Name of the selection",
+                regexp=r"[A-z_-]+",
+                default="",
             ),
             "paths": List(
-                String(required=True, description="path", regexp=r"^\$\..+"),
+                String(
+                    required=True, description="path", regexp=r"^\$\..+", default=""
+                ),
                 description="paths list",
             ),
         },
@@ -284,11 +298,17 @@ and if it is required.",
     action_model = Dict(
         {
             "name": String(
-                require=True, description="Name of the action", regexp=r"[A-z_-]+"
+                require=True,
+                description="Name of the action",
+                regexp=r"[A-z_-]+",
+                default="",
             ),
             "fields": List(field_model, default=[], description="action fields list"),
             "function_name": String(
-                required=True, description="name of the function", regexp=r"[A-z_-]+"
+                required=True,
+                description="name of the function",
+                regexp=r"[A-z_-]+",
+                default="",
             ),
         },
         description="selection",
@@ -297,7 +317,10 @@ and if it is required.",
     collection_model = Dict(
         {
             "name": String(
-                require=True, description="Name of the collection", regexp=r"[A-z_-]+"
+                require=True,
+                description="Name of the collection",
+                regexp=r"[A-z_-]+",
+                default="",
             ),
             "welcome1": Message(
                 default='\
@@ -358,7 +381,10 @@ Lets go.",
                 views=["!conf"],
             ),
             "name": String(
-                require=True, description="Name of the application", regexp=r"[A-z_-]+"
+                require=True,
+                description="Name of the application",
+                regexp=r"[A-z_-]+",
+                default="",
             ),
             "welcome2": Message(
                 default='\
@@ -469,21 +495,26 @@ It is better to have at least one collection :).',
 
     template = env.get_template("__init__.pytemplate")
     rendered = template.render(db_json_struct)
-    filename = os.path.join(destination_collection_directory, "__init__.py")
-    with open(filename, mode="w", encoding="utf-8") as outfile:
-        questionary.print(f"> creating file {filename}", style="italic fg:yellow")
-        outfile.write(rendered)
-
-    template = env.get_template("backoffice.pytemplate")
-    rendered = template.render(db_json_struct)
-    backo_filename = os.path.join(repo_dir, "backoffice.py")
+    backo_filename = os.path.join(destination_collection_directory, "__init__.py")
     with open(backo_filename, mode="w", encoding="utf-8") as outfile:
         questionary.print(f"> creating file {backo_filename}", style="italic fg:yellow")
         outfile.write(rendered)
 
+    for fname in ["backoffice", "main", "migrate"]:
+        template = env.get_template(f"{fname}.pytemplate")
+        rendered = template.render(db_json_struct)
+        backo_filename = os.path.join(repo_dir, f"{fname}.py")
+        with open(backo_filename, mode="w", encoding="utf-8") as outfile:
+            questionary.print(
+                f"> creating file {backo_filename}", style="italic fg:yellow"
+            )
+            outfile.write(rendered)
+
     questionary.print(f'{"\u2500"*40}', style="bold fg:yellow")
-    questionary.print("Now you can start the backoffice :", style="fg:darkred")
-    questionary.print(f"python {backo_filename}")
+    questionary.print(
+        f"Now you can start the backoffice (in {repo_dir}) :", style="fg:darkred"
+    )
+    questionary.print("[uv run] python main.py")
 
 
 if __name__ == "__main__":

backo-0.3.8/backo/initialisation/templates/backoffice.pytemplate

@@ -0,0 +1,29 @@
+"""
+backoffice : The main application
+"""
+
+# linter is lost with different modules with the same name
+# pylint: disable=no-name-in-module
+
+
+from backo import Backoffice, log_system, LogLevel
+
+# Import all collections
+{% for collection in collections %}from collections_set import {{ collection.name }}
+{% endfor %}
+
+
+# Set log system (for debug)
+log_system.add_handler(log_system.set_streamhandler()) # output to stderr
+log = log_system.get_or_create_logger("{{ name }}", LogLevel.INFO)
+
+# -----------------------------------------
+# Backoffice creation
+# -----------------------------------------
+my_backoffice = Backoffice("{{ name }}")
+{% for collection in collections %}my_backoffice.register_collection({{ collection.name }})
+{% endfor %}
+
+
+# To check if you have some syntax issue
+my_backoffice.check_syntax()

{backo-0.3.7 → backo-0.3.8}/backo/initialisation/templates/collection.pytemplate

@@ -18,7 +18,8 @@ from backo import (
     Action,
     Selection,
 )
-from backo.db import DBMongoConnector
+# from backo.db import DBMongoConnector
+from backo.db import DBYmlDirConnector
 
 log = log_system.get_or_create_logger("{{ name }}", LogLevel.INFO)
 
@@ -39,9 +40,11 @@ log = log_system.get_or_create_logger("{{ name }}", LogLevel.INFO)
 # ------------------------------------------------
 # COLLECTION
 # ------------------------------------------------
-connector = DBMongoConnector(
-    mongodb://localhost:27017/{{ app_name }}", "{{ name }}"
-)
+# If you want mongo...
+# connector = DBMongoConnector(
+#     mongodb://localhost:27017/{{ app_name }}", "{{ name }}"
+# )
+connector = DBYmlDirConnector( "/tmp/{{ app_name }}/{{ name }}" )
 
 
 def can_create(right_name: str, {{ name }}: Item) -> bool:

backo-0.3.7/backo/initialisation/templates/backoffice.pytemplate → backo-0.3.8/backo/initialisation/templates/main.pytemplate

@@ -6,27 +6,21 @@ backoffice : The main application
 # pylint: disable=no-name-in-module
 
 import json
-import sys
 from functools import wraps
 from datetime import datetime, timezone, timedelta
 import jwt
 from flask import Flask, request, jsonify, make_response, Response
+from backo import current_user, log_system
+from backoffice import my_backoffice
+
+# Add log output to stderr
+log_system.add_handler(log_system.set_streamhandler())
+
 
 # Avoid CORS issues 
 # --------------------------
 # from flask_cors import CORS
 
-from backo import Backoffice, current_user, log_system, LogLevel
-
-# Import all collections
-{% for collection in collections %}from collections_set import {{ collection.name }}
-{% endfor %}
-
-
-# Set log system (for debug)
-log_system.add_handler(log_system.set_streamhandler()) # output to stderr
-log = log_system.get_or_create_logger("{{ name }}", LogLevel.INFO)
-
 
 # set the flask application route
 flask = Flask("{{ name }}")
@@ -119,24 +113,10 @@ def logout():
 
 
 # -----------------------------------------
-# Backoffice creation
+# Adding routes
 # -----------------------------------------
-my_backoffice = Backoffice("{{ name }}")
-{% for collection in collections %}my_backoffice.register_collection({{ collection.name }})
-{% endfor %}
-
-
-# To check if you have some syntax issue
-my_backoffice.check_syntax()
 my_backoffice.build_routes(flask, "", check_user_token)
 
 
-# ------------------------------------
-# Clean the database
-# ------------------------------------
-# {% for collection in collections %}{{ collection.name }}.drop()
-# {% endfor %}
-
-
 if __name__ == "__main__":
     flask.run(host="0.0.0.0", port=5000)

backo-0.3.8/backo/initialisation/templates/migrate.pytemplate

@@ -0,0 +1,58 @@
+"""
+backoffice : The migration
+"""
+
+# linter is lost with different modules with the same name
+# pylint: disable=no-name-in-module
+import argparse
+from backo import log_system, LogLevel, MigrationStrategy
+from backoffice import my_backoffice
+
+log = log_system.get_or_create_logger("migration")
+log.addHandler( log_system.set_streamhandler() )
+log.setLevel( LogLevel.INFO )
+
+# Setup argument parser
+parser = argparse.ArgumentParser(description="Backo: initialisation tool.")
+parser.add_argument(
+    "--id", "--ids",
+    nargs="*",
+    type=str,
+    default=[],
+    dest="_ids",
+    help="id or ids to check for migration",
+) 
+parser.add_argument(
+    "--mode",
+    type=str,
+    choices=["dry_run", "execute", "force"],
+    default="dry_run",
+    dest="mode",
+    help="execution mode (by default dry_run)"
+)
+parser.add_argument(
+    "-coll", "--collection",
+    type=str,
+    required=True,
+    dest="collection",
+    help="the collection name"
+)
+
+# Parse command line arguments
+args = parser.parse_args()
+s = MigrationStrategy[args.mode.upper()]
+_ids = args._ids if args._ids else None
+# ------------------------------------------------------
+# Change Here the migration function
+# ------------------------------------------------------
+def migrate(o: dict) -> dict:
+    """fake migration"""
+    return o
+
+
+log.info(f'Start migration for collection="{args.collection}", _ids={_ids}, strategy={s}')
+# To check compatibility
+my_backoffice.migrate( args.collection, _ids=_ids, strategy=s)
+
+# To do or check migration (the migration function must be filled)
+# my_backoffice.migrate( args.collection, migrate, _ids=_ids, strategy=s)

{backo-0.3.7 → backo-0.3.8}/backo/item.py

@@ -179,6 +179,7 @@ class Item(Dict):  # pylint: disable=too-many-instance-attributes
         self.set_value(obj)
         self.set_status_saved()
         self.__dict__["_loaded_object"] = copy.copy(self)
+        self.enable_permissions()
         self.trigg("loaded", **kwargs)
 
     def load(self, _id: str, **kwargs) -> None:
@@ -385,20 +386,6 @@ class Item(Dict):  # pylint: disable=too-many-instance-attributes
             self.get_value(),
         )
 
-    def create_uniq_id(self) -> str:
-        """
-        Create an _id before creation.
-        Depends on the db_connector used. some of them needs _ids
-
-        is probably overwritten
-
-
-        :meta private:
-
-
-        """
-        return self.db_handler.generate_id(self)
-
     def create(self, obj: dict, **kwargs):
         """
         Create and save an object into the DB
@@ -433,9 +420,6 @@ class Item(Dict):  # pylint: disable=too-many-instance-attributes
 
         self.set(obj)
 
-        # Set the _id
-        self._id = self.create_uniq_id()
-
         # Set _meta
         if self.meta_data_handler:
             self.meta_data_handler.update(self)
@@ -447,9 +431,7 @@ class Item(Dict):  # pylint: disable=too-many-instance-attributes
         # dict_to_save = self.get_value()
         dict_to_save = self.get_view("save").get_encoded()
 
-        self.disable_permissions()
-        self._id = self.db_handler.create(dict_to_save)
-        self.enable_permissions()
+        self._id.set_value(self.db_handler.create(dict_to_save))
 
         self.set_status_saved()
 

{backo-0.3.7 → backo-0.3.8}/backo/meta_data_handler.py

@@ -62,17 +62,17 @@ class StandardMetaDataHandler(
 
         # Set creation ctime and owner
         if o._meta.ctime == None:  # pylint: disable=singleton-comparison
-            o._meta.ctime = now
+            o._meta.ctime.set_value(now)
 
         login = current_user.login.copy()
         user_id = current_user._id.copy()
 
         if o._meta.created_by._id == None:  # pylint: disable=singleton-comparison
-            o._meta.created_by.set({"_id": user_id, "login": login})
+            o._meta.created_by.set_value({"_id": user_id, "login": login})
 
         # Set modificattion time and last updater
-        o._meta.modified_by.set({"_id": user_id, "login": login})
-        o._meta.mtime.set(now)
+        o._meta.modified_by.set_value({"_id": user_id, "login": login})
+        o._meta.mtime.set_value(now)
 
         # Put permission back
         if permission_enabled is True:
@@ -95,7 +95,7 @@ class StandardMetaDataHandler(
                     ),
                     "modified_by": Dict(
                         {"_id": String(), "login": String(default="ANONYMOUS")},
-                        description="Modifyied by",
+                        description="Modified by",
                     ),
                 },
                 can_modify=False,

{backo-0.3.7 → backo-0.3.8}/backo/patch.py

@@ -13,7 +13,7 @@ sys.path.insert(1, "../../stricto")
 from stricto import Dict, String, GenericType
 
 
-def must(value, o) -> bool:  # pylint: disable=unused-argument
+def must(_o, value, _old_value) -> bool:
     """check if start with a $.
 
     :param value: _description_

{backo-0.3.7 → backo-0.3.8}/backo/selection.py

@@ -105,6 +105,7 @@ class Selection(CollectionAddon):
         CollectionAddon.__init__(self)
         self._permissions = Permissions(**kwargs)
         self._permissions.add_or_modify_permission("read", options.get("can_read"))
+        self._permissions.enable()
 
     def get_schema(self) -> dict:
         """

{backo-0.3.7 → backo-0.3.8}/examples/nationality/collections_set/people.py

@@ -28,8 +28,8 @@ log = log_system.get_or_create_logger("user")
 # ------------------------------------
 item = Item(
     {
-        "name": String(require=True),
-        "surname": String(require=True),
+        "name": String(require=True, default=""),
+        "surname": String(require=True, default=""),
         "first_nationality": Ref(coll="countries"),
         "other_nationalities": RefsList(coll="countries"),
     },

{backo-0.3.7 → backo-0.3.8}/examples/rest_api_connector/collections_set/users.py

@@ -28,9 +28,9 @@ log = log_system.get_or_create_logger("users")
 # ------------------------------------
 item = Item(
     {
-        "name": String(require=True),
-        "surname": String(require=True),
-        "login": String(require=True),
+        "name": String(require=True, default=""),
+        "surname": String(require=True, default=""),
+        "login": String(require=True, default=""),
         "vms": RefsList(coll="vms"),
     },
     meta_data_handler=GenericMetaDataHandler(),

{backo-0.3.7 → backo-0.3.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "backo"
-version = "0.3.7"
+version = "0.3.8"
 authors = [
   { name="Bertrand Wallrich", email="Bertrand.Wallrich@inria.fr" },
 ]
@@ -23,7 +23,7 @@ dependencies = [
   "python-magic",
   "redis>=8.1.0",
   "python-jsonpath",
-  "stricto>=0.2.11"
+  "stricto>=0.3.0"
 ]
 
 [project.optional-dependencies]

{backo-0.3.7 → backo-0.3.8}/tests/test_file.py

@@ -218,7 +218,7 @@ class TestFile(unittest.TestCase):
     def test_file_constraints(self):
         """Test constraints on a file"""
 
-        def only_text(f: FileStorage | None, o) -> bool:
+        def only_text(_o, f: FileStorage | None, _old_f) -> bool:
             """check manualy if the mime type is text/plain"""
 
             if f is None:

{backo-0.3.7 → backo-0.3.8}/tests/test_selections.py

@@ -9,7 +9,7 @@ from backo import Item, Collection
 from backo.db import DBYmlDirConnector
 from backo import Backoffice
 from backo import current_user, Selection
-from backo import String, Bool, SFilter, Operator, Sort, SortItem
+from backo import String, Bool, SFilter, Operator, Sort, SortItem, SRightError
 
 ### --- For development ---
 # import logging
@@ -33,6 +33,8 @@ class TestSelections(unittest.TestCase):
         """
         super().__init__(*args, **kwargs)
 
+        self.read = True
+
         # --- DB for user
         self.yml_users = DBYmlDirConnector(YML_DIR)
         self.yml_users.generate_id = lambda o: f"User_{o["name"]}_{o["surname"]}"
@@ -48,6 +50,8 @@ class TestSelections(unittest.TestCase):
                 }
             ),
             self.yml_users,
+            can_read=self.can_read,
+            can_modify=True,
         )
 
         self.backo.register_collection(self.users)
@@ -59,6 +63,12 @@ class TestSelections(unittest.TestCase):
         current_user.reinit()
         return super().tearDown()
 
+    def can_read(self, _right_name, _obj):
+        """
+        function for can_read method used in test
+        """
+        return self.read
+
     def test_all_selection(self):
         """
         creating an backoffice with ref one to many
@@ -96,6 +106,22 @@ class TestSelections(unittest.TestCase):
         )
         self.assertEqual(rep["total"], 2)
 
+    def test_selection_cant_read_collection(self):
+        """
+        test cannot read the selection
+        """
+
+        self.yml_users.drop()
+
+        self.read = False
+        with self.assertRaises(SRightError) as e:
+            self.users._selections["_all"].select()
+        self.assertEqual(
+            e.exception.to_string(),
+            "Execute _all selection is forbidden",
+        )
+        self.read = True
+
     def test_multi_selection(self):
         """
         test selection with multi projections

{backo-0.3.7 → backo-0.3.8}/uv.lock

@@ -31,7 +31,7 @@ wheels = [
 
 [[package]]
 name = "backo"
-version = "0.3.7"
+version = "0.3.8"
 source = { editable = "." }
 dependencies = [
     { name = "deepdiff" },
@@ -77,7 +77,7 @@ requires-dist = [
     { name = "questionary" },
     { name = "redis", specifier = ">=8.1.0" },
     { name = "requests" },
-    { name = "stricto", specifier = ">=0.2.11" },
+    { name = "stricto", specifier = ">=0.3.0" },
 ]
 provides-extras = ["mongo"]
 
@@ -1057,11 +1057,11 @@ wheels = [
 
 [[package]]
 name = "stricto"
-version = "0.2.11"
+version = "0.3.0"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/bd/42/a498ba8dece692bd81532e92ceed91b24effbc12d9e5cf02daad69f1ea78/stricto-0.2.11.tar.gz", hash = "sha256:c085063a3e31aa29d12ab32002f0eb2666eaf3382da94fe2a4978d324e954c77", size = 63504, upload-time = "2026-09-23T09:04:27.021Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/67/4e/66a23d47a8def2c264395253a775a0c284cb6b8bfd680238986ba54352fe/stricto-0.3.0.tar.gz", hash = "sha256:b393b6f5d9543e7ed3c7110d2f23d769591805c7790397cb7711df92e1cc36b6", size = 63704, upload-time = "2026-09-25T09:12:58.34Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/6c/10/95456e60f411a19b734ed8013d4d5acdeb9e093403ee3a794db4b898dc88/stricto-0.2.11-py3-none-any.whl", hash = "sha256:71ccd471368e54c32b411f2693f8c7ee468abc4561e37c7da80ba60582b11f2d", size = 52220, upload-time = "2026-09-23T09:04:25.774Z" },
+    { url = "https://files.pythonhosted.org/packages/25/f5/e36b5fdcbfb309a233d72ed8b10a4ba93a8249638e68710e345daf8aad21/stricto-0.3.0-py3-none-any.whl", hash = "sha256:269417730a166081680cbd420a31eecf46d700c326f0ad164b0bff726c0d0c12", size = 52313, upload-time = "2026-09-25T09:12:57.343Z" },
 ]
 
 [[package]]