clear-skies 1.21.1__tar.gz → 1.21.2__tar.gz

{clear_skies-1.21.1 → clear_skies-1.21.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clear-skies
-Version: 1.21.1
+Version: 1.21.2
 Summary: A framework for building backends in the cloud
 Home-page: https://github.com/cmancone/clearskies
 License: MIT

{clear_skies-1.21.1 → clear_skies-1.21.2}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [tool.poetry]
 name = "clear-skies"
-version = "1.21.1"
+version = "1.21.2"
 description = "A framework for building backends in the cloud"
 authors = [
     "Conor Mancone <cmancone@gmail.com>",

{clear_skies-1.21.1 → clear_skies-1.21.2}/src/clearskies/column_types/category_tree.py

@@ -119,6 +119,10 @@ class CategoryTree(BelongsTo):
         "tree_level_column_name",
         "max_iterations",
         "parent_models_class",
+        "children_column_name",
+        "descendents_column_name",
+        "ancestors_column_name",
+        "load_relatives_strategy",
     ]
 
     def __init__(self, di):
@@ -137,6 +141,11 @@ class CategoryTree(BelongsTo):
             configuration["tree_models_class"],
             config_name="tree_models_class",
         )
+        load_relatives_strategy = configuration.get("load_relatives_strategy", None)
+        if load_relatives_strategy and load_relatives_strategy not in ["join", "where_in", "individual"]:
+            raise ValueError(
+                f"Configuration error for category_tree column '{self.name} in model class '{self.model_class.__name__}': load_relatives_strategy must be one of ['join', 'where_in', or 'individual']"
+            )
 
     def _finalize_configuration(self, configuration):
         return {
@@ -152,6 +161,10 @@ class CategoryTree(BelongsTo):
                 "tree_is_parent_column_name": configuration.get("tree_is_parent_column_name", "is_parent"),
                 "tree_level_column_name": configuration.get("tree_level_column_name", "level"),
                 "max_iterations": configuration.get("max_iterations", 100),
+                "children_column_name": configuration.get("children_column_name", "children"),
+                "descendents_column_name": configuration.get("descendents_column_name", "descendents"),
+                "ancestors_column_name": configuration.get("ancestors_column_name", "ancestors"),
+                "load_relatives_strategy": configuration.get("load_relatives_strategy", "join"),
             },
         }
 
@@ -167,7 +180,7 @@ class CategoryTree(BelongsTo):
         return data
 
     def force_tree_update(self, model):
-        self.update_tree_table(model, model.id, model.__getattr__(self.name))
+        self.update_tree_table(model, model.get(self.id_column_name), model.__getattr__(self.name))
 
     def update_tree_table(self, model, child_id, direct_parent_id):
         tree_models = self.tree_models
@@ -224,3 +237,68 @@ class CategoryTree(BelongsTo):
             + "You may have accidentally created a circular cateogry tree.  If not, and your category tree "
             + "really _is_ that deep, then adjust the 'max_iterations' configuration for this column accordingly. "
         )
+
+    def can_provide(self, column_name):
+        return column_name in [
+            self.config("model_column_name"),
+            self.config("children_column_name"),
+            self.config("descendents_column_name"),
+            self.config("ancestors_column_name"),
+        ]
+
+    def provide(self, data, column_name):
+        if column_name == self.config("model_column_name"):
+            return super().provide(data, column_name)
+
+        if column_name == self.config("children_column_name"):
+            return self.relatives(data)
+
+        if column_name == self.config("descendents_column_name"):
+            return self.relatives(data, include_all=True)
+
+        if column_name == self.config("ancestors_column_name"):
+            return self.relatives(data, find_parents=True)
+
+    def relatives(self, data, include_all=False, find_parents=False):
+        id_column_name = self.model_class.id_column_name
+        model_id = data[self.model_class.id_column_name]
+        model_table_name = self.model_class.table_name()
+        tree_table_name = self.config("tree_models_class").table_name()
+        parent_id_column_name = self.config("tree_parent_id_column_name")
+        child_id_column_name = self.config("tree_child_id_column_name")
+        is_parent_column_name = self.config("is_parent_column_name")
+        level_column_name = self.config("tree_level_column_name")
+
+        if find_parents:
+            join_on = parent_id_column_name
+            search_on = child_id_column_name
+        else:
+            join_on = child_id_column_name
+            search_on = parent_id_column_name
+
+        # if we can join then use a join.
+        if self.config("load_relatives_strategy") == "join":
+            relatives = self.parent_models.join(
+                f"{tree_table_name} as tree on tree.{join_on}={model_table_name}.{id_column_name}"
+            )
+            relatives = relatives.where(f"tree.{search_on}={model_id}")
+            if not include_all:
+                relatives = relatives.where(f"tree.{is_parent_column_name}=1")
+            if find_parents:
+                relatives = relatives.sort_by(level_column_name, "asc")
+            return relatives
+
+        # joins only work for SQL-like backends.  Otherwise, we have to pull out our list of ids
+        branches = self.tree_models.where(f"{search_on}={model_id}")
+        if not include_all:
+            branches = branches.where(f"tree.{is_parent_column_name}=1")
+        if find_parents:
+            branches = branches.sort_by(level_column_name, "asc")
+        ids = [str(branch.get(child_id_column_name)) for branch in branches]
+
+        # Can we search with a WHERE IN() clause?  If the backend supports it, it is probably faster
+        if self.config("load_relatives_strategy") == "where_in":
+            return self.parent_models.where(f"{id_column_name} IN ('" + "','".join(ids) + "')")
+
+        # otherwise we have to load each model individually which is SLOW....
+        return [self.parent_models.find(f"{id_column_name}={id}") for id in ids]

{clear_skies-1.21.1 → clear_skies-1.21.2}/src/clearskies/column_types/datetime.py

@@ -3,6 +3,7 @@ from datetime import datetime, timezone
 import dateparser
 from ..autodoc.schema import DateTime as AutoDocDateTime
 
+
 class DateTime(Column):
     _auto_doc_class = AutoDocDateTime
     _date_format = "%Y-%m-%d %H:%M:%S"

{clear_skies-1.21.1 → clear_skies-1.21.2}/src/clearskies/di/standard_dependencies.py

@@ -138,8 +138,9 @@ class StandardDependencies(DI):
 
     def provide_uuid(self):
         return uuid
-  
+
     def provide_timezone(self):
         """Set the default timezone."""
         import datetime
+
         return datetime.UTC

{clear_skies-1.21.1 → clear_skies-1.21.2}/src/clearskies/model.py

@@ -10,6 +10,7 @@ try:
 except ModuleNotFoundError:
     from typing import Self
 
+
 class Model(Models):
     _configured_columns = None
     _data = None
@@ -202,7 +203,7 @@ class Model(Models):
             return data[key]
         return self.__getattr__(key)
 
-    def was_changed(self: Self, key) -> bool: 
+    def was_changed(self: Self, key) -> bool:
         """Returns True/False to denote if a column was changed in the last save"""
         if self._previous_data is None:
             raise ValueError("was_changed was called before a save was finished - you must save something first")