clear-skies 2.0.15__py3-none-any.whl → 2.0.16__py3-none-any.whl

{clear_skies-2.0.15.dist-info → clear_skies-2.0.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies
-Version: 2.0.15
+Version: 2.0.16
 Summary: A framework for building backends in the cloud
 Project-URL: Documentation, https://clearskies.io/
 Project-URL: Repository, https://github.com/clearskies-py/clearskies

{clear_skies-2.0.15.dist-info → clear_skies-2.0.16.dist-info}/RECORD

@@ -62,7 +62,7 @@ clearskies/autodoc/schema/password.py,sha256=hSXPvHoXEbG-KHQFxXubEarxSMg9Cki_n8t
 clearskies/autodoc/schema/schema.py,sha256=zsJFtEyUCGGokYsnpcIfRVbeEwVTOWqE6VjTYyv8JZM,242
 clearskies/autodoc/schema/string.py,sha256=GXRI-aU8PYmjfnhmfaOe4vq7JASb-aB4SiFeG-EmJY0,60
 clearskies/backends/__init__.py,sha256=krBB3gHLP-lVYkm5ksdK7teEtouAHhL3EC__WGVnF4A,3157
-clearskies/backends/api_backend.py,sha256=4xcAymjkAgIA_9H68owe2Y9D4omxRnq6tnp_0RTIEhc,54133
+clearskies/backends/api_backend.py,sha256=yOiPgLV4M4zuAYK3IikZlaCmJb0wUlzjwdo1zTQ24I4,54665
 clearskies/backends/backend.py,sha256=XzFBsUP4lwX2c2_zeK4Hch1MlT3YJS1ffxolUHoJXqA,5797
 clearskies/backends/cursor_backend.py,sha256=5YBO0EwxU_1YKIL3_fIbA93sh7NG4Qg8jpAMoIA5qiU,14139
 clearskies/backends/memory_backend.py,sha256=H_2fib9EFdXsg3ZMMpC20DMHnrnYDbPgZnmiarbOhiM,33963
@@ -70,7 +70,7 @@ clearskies/backends/secrets_backend.py,sha256=f_C5oAAr3tgM4UqioYPWcASPe9DhySC_uL
 clearskies/columns/__init__.py,sha256=a__-1hv-aMV3RU0Sd-BEkfItSJaG51EF2VeRQoTdka8,1990
 clearskies/columns/audit.py,sha256=KABjKk3YdV6G_43OdkhFA_iGkmjP9Sb-m0Beh2_aXU4,7624
 clearskies/columns/belongs_to_id.py,sha256=Ga3IpWlMy2_m8e5OK_iortNjHdMbF1RQF2tglWAzBVc,17575
-clearskies/columns/belongs_to_model.py,sha256=nZ-yOs5CJx_WoMQ2wLLQfwSTfuF5vantEL0DFUgwC4Q,5714
+clearskies/columns/belongs_to_model.py,sha256=6DonRb1JSAlCjHnaSnZ92K9r0WrNNWhUIH_mN1tcRCE,5708
 clearskies/columns/belongs_to_self.py,sha256=cmgjxq4SmokGO2UbE0VlcFRXack9KjPLzyE9L3fNang,3725
 clearskies/columns/boolean.py,sha256=pdkO7dxqIYCHX95C_yGo5vyvH_D0fO8zs0XgRN50zMQ,3713
 clearskies/columns/category_tree.py,sha256=hqMlYQjVRlsU0PsC_M3_WWKkkzqw8wM5Xo-D4Mp9tIc,10967
@@ -203,6 +203,7 @@ clearskies/exceptions/moved_permanently.py,sha256=fcgU_VBtAe8ZnbyNoNpXDcTQ8Utsjd
 clearskies/exceptions/moved_temporarily.py,sha256=Pt3muYHASvgOC50wPmoul9hUfy3Ud_NPSGFxshNWbIk,110
 clearskies/exceptions/not_found.py,sha256=_lZwovDrd18dUHDop5pF4mhexBPNr126xF2gOLA2-EA,36
 clearskies/functional/__init__.py,sha256=yXnbX-pjW6MOaBTjIzogvSJZ6O9dbUAWOalhu0WSDiQ,106
+clearskies/functional/json.py,sha256=gKyLl_DNfSv1XddTQH6HtdOjqrhUXaRs_uImTh0Lei0,1594
 clearskies/functional/routing.py,sha256=tfIvP_Y29GTGr91_1ec3LSQFoTRwpkqU4BYHXPnBaXA,3685
 clearskies/functional/string.py,sha256=ZnkOjx8nxqZq2TV0CIb-Kz4onGoyekTX_WkLJM6XTmM,3311
 clearskies/functional/validations.py,sha256=cPYOTwWomlQrPvqPP_Jdlds7zZ5H9GABCP5pnGzC9T4,2821
@@ -222,7 +223,7 @@ clearskies/query/join.py,sha256=4lrDUQzck7klKY_VYkc4SVK95SVwyy3SVTvasnsAEyc,4713
 clearskies/query/query.py,sha256=0XR3fNhOpDNJY0US2oseAS3p3Y0jxxVs86P6vWEvUcA,6063
 clearskies/query/sort.py,sha256=c-EtIkjg3kLjwSTdXD7sfyx-mNUhAepUV-2izprh3iY,754
 clearskies/secrets/__init__.py,sha256=G-A8YhCMlS_OdboSeKzCZp6iwfqwU4BPEnB5HvD88wY,142
-clearskies/secrets/akeyless.py,sha256=k9j-GbAGo67J4cH6VQDVYLZJodRcJfNmwLRaBOE2vgg,20335
+clearskies/secrets/akeyless.py,sha256=KFvehjTiWtl7YhOE3a99__F38N9IUQURNi-bkY7l8ZI,19348
 clearskies/secrets/secrets.py,sha256=z9ouvwTwdyyOFmaCCWMRR6T9capRWFHswz563OA-JzE,1566
 clearskies/secrets/additional_configs/__init__.py,sha256=cFCrbtKF5nuR061S2y1iKZp349x-y8Srdwe3VZbfSFU,1119
 clearskies/secrets/additional_configs/mysql_connection_dynamic_producer.py,sha256=CnIiXLVQdUnUey3dbCTXuNNP7Mmw1gjjNjZiBtfgGto,2757
@@ -253,7 +254,7 @@ clearskies/validators/minimum_value.py,sha256=ZyG2S_-4lbbMbf7PUemEyAT-r4-gjJMUdE
 clearskies/validators/required.py,sha256=GWxyexwj-K6DunZWNEnZxW6tQGAFd4oOCvQrW1s1K9k,1308
 clearskies/validators/timedelta.py,sha256=DJ0pTm-SSUtjZ7phGoD6vjb086vXPzvLLijkU-jQlOs,1892
 clearskies/validators/unique.py,sha256=X7qGv_BfskNJWnYCt6vDHbvpBiHym58yLjXk5ZnhAlg,975
-clear_skies-2.0.15.dist-info/METADATA,sha256=iKhiL7xgkQDyCY83fzUEE9iUSOBIRLCH83nPoKUHOgo,2114
-clear_skies-2.0.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-clear_skies-2.0.15.dist-info/licenses/LICENSE,sha256=3Ehd0g3YOpCj8sqj0Xjq5qbOtjjgk9qzhhD9YjRQgOA,1053
-clear_skies-2.0.15.dist-info/RECORD,,
+clear_skies-2.0.16.dist-info/METADATA,sha256=DWJ3EZbyG0Ny3gKospCLkq5xOx2znEJK-HDk4EUsLDM,2114
+clear_skies-2.0.16.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+clear_skies-2.0.16.dist-info/licenses/LICENSE,sha256=3Ehd0g3YOpCj8sqj0Xjq5qbOtjjgk9qzhhD9YjRQgOA,1053
+clear_skies-2.0.16.dist-info/RECORD,,

clearskies/backends/api_backend.py

@@ -11,6 +11,7 @@ from clearskies.autodoc.schema import Schema as AutoDocSchema
 from clearskies.autodoc.schema import String as AutoDocString
 from clearskies.backends.backend import Backend
 from clearskies.di import InjectableProperties, inject
+from clearskies.functional import json as json_functional
 from clearskies.functional import routing, string
 
 if TYPE_CHECKING:
@@ -550,7 +551,7 @@ class ApiBackend(configurable.Configurable, Backend, InjectableProperties):
     }
     ```
     """
-    api_to_model_map = configs.StringDict(default={})
+    api_to_model_map = configs.AnyDict(default={})
 
     """
     The name of the pagination parameter
@@ -589,7 +590,7 @@ class ApiBackend(configurable.Configurable, Backend, InjectableProperties):
         authentication: Authentication | None = None,
         model_casing: str = "snake_case",
         api_casing: str = "snake_case",
-        api_to_model_map: dict[str, str] = {},
+        api_to_model_map: dict[str, str | list[str]] = {},
         pagination_parameter_name: str = "start",
         pagination_parameter_type: str = "str",
         limit_parameter_name: str = "limit",
@@ -897,16 +898,16 @@ class ApiBackend(configurable.Configurable, Backend, InjectableProperties):
                 f"The response from a records request returned a variable of type {response_data.__class__.__name__}, which is just confusing.  To do automatic introspection, I need a list or a dictionary.  I'm afraid you'll have to extend the API backend and override the map_record_response method to deal with this."
             )
 
-        for key, value in response_data.items():
-            if not isinstance(value, list):
-                continue
-            return self.map_records_response(value, query, query_data)
-
         # a records request may only return a single record, so before we fail, let's check for that
         record = self.check_dict_and_map_to_model(response_data, columns, query_data)
         if record is not None:
             return [record]
 
+        for key, value in response_data.items():
+            if not isinstance(value, list):
+                continue
+            return self.map_records_response(value, query, query_data)
+
         raise ValueError(
             "The response from a records request returned a dictionary, but none of the items in the dictionary was a list, so I don't know where to find the records.  I only ever check one level deep in dictionaries.  I'm afraid you'll have to extend the API backend and override the map_records_response method to deal with this."
         )
@@ -958,27 +959,38 @@ class ApiBackend(configurable.Configurable, Backend, InjectableProperties):
         map_keys = set(response_to_model_map.keys())
         matching = response_keys.intersection(map_keys)
 
-        # if nothing matches then clearly this isn't what we're looking for: repeat on all the children
-        if not matching:
-            for key, value in response_data.items():
-                if not isinstance(value, dict):
-                    continue
-                mapped = self.check_dict_and_map_to_model(value, columns)
-                if mapped:
-                    return {**query_data, **mapped}
-
-            # no match anywhere :(
-            return None
-
         # we may need to be smarter about whether or not we think we found a match, but for now let's
         # ignore that possibility.  If any columns match between the keys in our response dictionary and
         # the keys that we are expecting to find data in, then just assume that we have found a record.
         mapped = {response_to_model_map[key]: response_data[key] for key in matching}
 
+        for api_key, column_name in self.api_to_model_map.items():
+            if not "." in api_key:
+                continue
+            value = json_functional.get_nested_attribute(response_data, api_key)
+            if value is None:
+                continue
+            if isinstance(column_name, list):
+                for column in column_name:
+                    mapped[column] = value
+            else:
+                mapped[column_name] = value
         # finally, move over anything not mentioned in the map
         for key in response_keys.difference(map_keys):
             mapped[string.swap_casing(key, self.api_casing, self.model_casing)] = response_data[key]
 
+            # if nothing matches then clearly this isn't what we're looking for: repeat on all the children
+        if not mapped:
+            for key, value in response_data.items():
+                if not isinstance(value, dict):
+                    continue
+                remapped = self.check_dict_and_map_to_model(value, columns)
+                if remapped:
+                    return {**query_data, **remapped}
+
+            # no match anywhere :(
+            return None
+
         return {**query_data, **mapped}
 
     def build_response_to_model_map(self, columns: dict[str, Column]) -> dict[str, str]:

clearskies/columns/belongs_to_model.py

@@ -65,7 +65,7 @@ class BelongsToModel(Column):
         parent_class = belongs_to_column.parent_model_class
         parent_model = self.di.build(parent_class, cache=False)
         if not parent_id:
-            return parent_model.empty_model()
+            return parent_model.empty()
 
         parent_id_column_name = parent_model.id_column_name
         join_alias = belongs_to_column.join_table_alias()

clearskies/functional/json.py

@@ -0,0 +1,47 @@
+from typing import Any, cast
+
+
+def get_nested_attribute(data: dict[str, Any] | str, attr_path: str) -> Any:
+    """
+    Extract a nested attribute from JSON data using dot notation.
+
+    This function navigates through a nested JSON structure using a dot-separated path
+    to retrieve a specific attribute. If the input is a string, it will attempt to parse
+    it as JSON first.
+
+    Example:
+    ```
+    data = {"database": {"credentials": {"username": "admin", "password": "secret"}}}
+    username = get_nested_attribute(data, "database.credentials.username")
+    # Returns "admin"
+    ```
+
+    Args:
+        data: The JSON data as a dictionary or a JSON string
+        attr_path: The path to the attribute using dot notation (e.g., "database.username")
+
+    Returns:
+        The value at the specified path
+
+    Raises:
+        ValueError: If the data cannot be parsed as JSON
+        KeyError: If the attribute path doesn't exist in the data
+    """
+    keys = attr_path.split(".", 1)
+    if not isinstance(data, dict):
+        try:
+            import json
+
+            data = json.loads(data)
+        except Exception:
+            raise ValueError(f"Could not parse data as JSON to get attribute '{attr_path}'")
+
+    # At this point, we know data is a dictionary
+    data_dict = cast(dict[str, Any], data)  # Help type checker understand data is a dict
+
+    if len(keys) == 1:
+        if keys[0] not in data_dict:
+            raise KeyError(f"Data does not contain attribute '{attr_path}'")
+        return data_dict[keys[0]]
+
+    return get_nested_attribute(data_dict[keys[0]], keys[1])

clearskies/secrets/akeyless.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import datetime
-import json
 import logging
 from types import ModuleType
 from typing import TYPE_CHECKING, Any
@@ -9,6 +8,7 @@ from typing import TYPE_CHECKING, Any
 from clearskies import configs, secrets
 from clearskies.decorators import parameters_to_properties
 from clearskies.di import inject
+from clearskies.functional.json import get_nested_attribute
 from clearskies.secrets.exceptions import PermissionsError
 
 if TYPE_CHECKING:
@@ -224,7 +224,7 @@ class Akeyless(secrets.Secrets):
                 raise KeyError(f"Secret '{path}' not found")
             raise e
         if json_attribute:
-            return self._get_nested_attribute(res[path], json_attribute)  # type: ignore
+            return get_nested_attribute(res[path], json_attribute)  # type: ignore
         return str(res[path])
 
     def get_dynamic_secret(
@@ -249,7 +249,7 @@ class Akeyless(secrets.Secrets):
             kwargs["args"] = args  # type: ignore
         res: dict[str, Any] = self.api.get_dynamic_secret_value(self.akeyless.GetDynamicSecretValue(**kwargs))  # type: ignore
         if json_attribute:
-            return self._get_nested_attribute(res, json_attribute)
+            return get_nested_attribute(res, json_attribute)
         return res
 
     def get_rotated_secret(
@@ -276,7 +276,7 @@ class Akeyless(secrets.Secrets):
 
         res: dict[str, str] = self._api.get_rotated_secret_value(self.akeyless.GetRotatedSecretValue(**kwargs))["value"]  # type: ignore
         if json_attribute:
-            return self._get_nested_attribute(res, json_attribute)
+            return get_nested_attribute(res, json_attribute)
         return res
 
     def describe_secret(self, path: str) -> Any:
@@ -470,26 +470,6 @@ class Akeyless(secrets.Secrets):
             self.akeyless.DescribePermissions(token=self._get_token(), path=path, type=type)
         ).client_permissions  # type: ignore
 
-    def _get_nested_attribute(self, data: dict[str, Any] | str, attr_path: str) -> Any:
-        """
-        Extract a nested attribute from JSON data.
-
-        Parses the provided data as JSON if it's a string. Traverses the nested structure using
-        the dot-separated path (e.g., "database.username"). Raises ValueError if the data cannot
-        be parsed as JSON, or KeyError if the attribute path doesn't exist in the data.
-        """
-        keys = attr_path.split(".", 1)
-        if not isinstance(data, dict):
-            try:
-                data = json.loads(data)
-            except Exception:
-                raise ValueError(f"Could not parse secret as JSON to get attribute '{attr_path}'")
-        if len(keys) == 1:
-            if not isinstance(data, dict) or keys[0] not in data:
-                raise KeyError(f"Secret does not contain attribute '{attr_path}'")
-            return data[keys[0]]  # type: ignore
-        return self._get_nested_attribute(data[keys[0]], keys[1])  # type: ignore
-
 
 class AkeylessSaml(Akeyless):
     """Convenience class for SAML authentication with Akeyless."""