clear-skies 1.21.1__py3-none-any.whl → 1.21.3__py3-none-any.whl

{clear_skies-1.21.1.dist-info → clear_skies-1.21.3.dist-info}/METADATA

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

{clear_skies-1.21.1.dist-info → clear_skies-1.21.3.dist-info}/RECORD

@@ -59,7 +59,7 @@ clearskies/column_types/__init__.py,sha256=wofhLfyW00I6tb6o9DMsMx7j9hlbbqefhDzWf
 clearskies/column_types/audit.py,sha256=2YcrZVVElpOUdmxYTQ_6CshL1HVou6fz65dOOs_b8Gw,9659
 clearskies/column_types/belongs_to.py,sha256=tH1tbTOfjifSNuVjO-KbMF7GiUIoLfcDItrrS3TGGM8,11044
 clearskies/column_types/boolean.py,sha256=1yyM1CUfgD84pPE65c1OP1Qjf_J0Z45hjPrDR51AUkQ,1878
-clearskies/column_types/category_tree.py,sha256=PgNmzZPyqYS5NADH_QTCxLvDXZFxzv5ESKTkvPrrLXo,9140
+clearskies/column_types/category_tree.py,sha256=kPx0fNTJxHaaEI_-0JxQ7NBcV2bYgUDGmtf1wmTqoEg,13172
 clearskies/column_types/column.py,sha256=ftuDFswjk-KE9Frxo1rhgkjr4sjSjnUc5ZtfNrnGLIc,15530
 clearskies/column_types/created.py,sha256=LIWSzPJ9rbHuk1u53pNvKtVCOG9y9XCn-mEEsSi97Zc,649
 clearskies/column_types/created_by_authorization_data.py,sha256=--1w1TOSo2CMwrpn6Y_iorl2RTqLgG8MbR8k27qreew,1108
@@ -68,7 +68,7 @@ clearskies/column_types/created_by_ip.py,sha256=wwCUoEwHEVGN89x4xP7NJ6QR85Aum6v3
 clearskies/column_types/created_by_routing_data.py,sha256=EhVorRaGV2OhEb0YSPwPmrsK2NQycYgGEd4ab8-qI2I,569
 clearskies/column_types/created_by_user_agent.py,sha256=sSYDRrqSjsCwcYlhF_s9NO-iDww3PaH6aO2ATp_SKGQ,419
 clearskies/column_types/created_micro.py,sha256=Y_YADPg-TYPfWCFuGbs1b7NeM1Ixi_oBP8OQfJgTI7s,670
-clearskies/column_types/datetime.py,sha256=VCVLDTxEN1yQ0h-BprejKWCYSOneQkvm7EeKy3c_T-Q,4339
+clearskies/column_types/datetime.py,sha256=xtuZpUC9fA16i1oO80kPIx--8RDPuei9RdsDDqensbw,4340
 clearskies/column_types/datetime_micro.py,sha256=ewQSniCc2MmNIyX2XNuNcCIwh5Fpf1HcvpLfzB8lz8g,382
 clearskies/column_types/email.py,sha256=qq0Yo_C3KxUqT68q2HWXocBBR4xwMqjxcIdgZRv218U,584
 clearskies/column_types/float.py,sha256=j8jJeBueSOusPtAFCWgLHYBncfLnqT1U7bh1zcAkYiA,1332
@@ -120,7 +120,7 @@ clearskies/di/__init__.py,sha256=T7SgQNny2XAZQPeFkdmp1XxxmEVxtnpcRiGK8YflkwU,304
 clearskies/di/additional_config.py,sha256=jdoS_HWC0MAabori3WwLRAG1i5YKZmQfQ1o0hCoxsPs,526
 clearskies/di/additional_config_auto_import.py,sha256=m57IODPbnCAus9iDu3mDp42u4H87oPZvjAlBGoS8uRQ,111
 clearskies/di/di.py,sha256=g0U0PI73eNp0mkGH3KUN1fmqNic5eEUK-_IB8hQh-Kg,15511
-clearskies/di/standard_dependencies.py,sha256=fgD4GT4Z0bcGPBaPDrzCqCtblD0UP572XD5d0O_DJxE,4523
+clearskies/di/standard_dependencies.py,sha256=NW8tNZ2Punwq70XaH_e9IhmQ7ggsFFvum8ymwinoD7U,4522
 clearskies/di/test_module/__init__.py,sha256=7YHQF7JHP0FdI7GdEGANSZ_t1EISQYhUNm1wqOg0NKw,88
 clearskies/di/test_module/another_module/__init__.py,sha256=8SRmHPDepLKGWTUSc1ucDF6U8mJPsNDsBDmBQCpzPWo,35
 clearskies/di/test_module/module_class.py,sha256=I_-wnMuHfbsvti-7d2Z4bXnr6deo__uvww9nds9qrlE,46
@@ -181,7 +181,7 @@ clearskies/input_requirements/unique.py,sha256=gpbm9uoXcy8WCHsuWqAotwockbjDfJOWi
 clearskies/mocks/__init__.py,sha256=T68OUB9gGCX0WoisGzsY3Bt2cCFX7ILHKPqi6XKTJM0,113
 clearskies/mocks/input_output.py,sha256=2wD5GbUyVSkXcBg1GTZ-Oz9VzcYxNHfTlmZAODW-7CI,3898
 clearskies/mocks/models.py,sha256=DCzsnMddBvPoBA8JwwbSOhzY7enQWrosgeYD4gx2deI,5124
-clearskies/model.py,sha256=ZI75_1KP4J-PID2Aw9l_mNHCeY-HOZH887QKdxRoTdg,13511
+clearskies/model.py,sha256=N5el03awXEfTBfhqjS3Yuc6ozMjATs7cMLs_IoZNuaE,13511
 clearskies/models.py,sha256=1H5Vohv1U4avN5_YHqULzc7ynZDRytmZ56x775xWTIo,13038
 clearskies/secrets/__init__.py,sha256=ctTmA_etV9G_5U21APWENI1HvThrBS4DidGWRtEDHQs,1053
 clearskies/secrets/additional_configs/__init__.py,sha256=cFCrbtKF5nuR061S2y1iKZp349x-y8Srdwe3VZbfSFU,1119
@@ -205,7 +205,7 @@ clearskies/tests/simple_api/models/__init__.py,sha256=nUA0W6fgXw_Bxa9CudkaDkC80t
 clearskies/tests/simple_api/models/status.py,sha256=PEhPbaQh5qdUNHp8O0gz91LOLENAEBtqSaHxUPXchaM,699
 clearskies/tests/simple_api/models/user.py,sha256=5_P4Tp1tTdX7PkMJ__epPM5MA7JAeVYGas69vcWloLc,819
 clearskies/tests/simple_api/users_api.py,sha256=KYXCgEofDxHeRdQK67txN5oYUPvxxmB8JTku7L-apk4,2344
-clear_skies-1.21.1.dist-info/LICENSE,sha256=3Ehd0g3YOpCj8sqj0Xjq5qbOtjjgk9qzhhD9YjRQgOA,1053
-clear_skies-1.21.1.dist-info/METADATA,sha256=gUmBHTE31EscgWpY1XRDst7EdoQlbySciQkEvh_fdoA,1817
-clear_skies-1.21.1.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-clear_skies-1.21.1.dist-info/RECORD,,
+clear_skies-1.21.3.dist-info/LICENSE,sha256=3Ehd0g3YOpCj8sqj0Xjq5qbOtjjgk9qzhhD9YjRQgOA,1053
+clear_skies-1.21.3.dist-info/METADATA,sha256=tV9vLb2zbcNwdE9QlBah3O39Kec5D4im3eO4dowTkTI,1817
+clear_skies-1.21.3.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+clear_skies-1.21.3.dist-info/RECORD,,

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, include_all=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("tree_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"{is_parent_column_name}=1")
+        if find_parents:
+            branches = branches.sort_by(level_column_name, "asc")
+        ids = [str(branch.get(join_on)) 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]

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"

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

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")