clear-skies 2.0.15__tar.gz → 2.0.16__tar.gz

{clear_skies-2.0.15 → clear_skies-2.0.16}/CHANGELOG.md

@@ -5,8 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.16] - 2025-10-16
+
+### Added
+- Add json attribute to api backend by @cmancone in [#30](https://github.com/clearskies-py/clearskies/pull/30)
+- Add json attribute to api backend
+
+### Fixed
+- Reorder map_records_response
+- Reorder mapping steps
+- Use empty instead of empty_model
+
 ## [2.0.15] - 2025-10-16
 
+### Changed
+- Bump version to v2.0.15 by @github-actions[bot]
+
 ### Removed
 - Remove unused imports by @tnijboer in [#29](https://github.com/clearskies-py/clearskies/pull/29)
 
@@ -838,6 +852,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * @ made their first contribution
 * @tnijboer made their first contribution
 * @conormancone-cimpress made their first contribution
+[2.0.16]: https://github.com/clearskies-py/clearskies/compare/v2.0.15..v2.0.16
 [2.0.15]: https://github.com/clearskies-py/clearskies/compare/v2.0.14..v2.0.15
 [2.0.14]: https://github.com/clearskies-py/clearskies/compare/v2.0.13..v2.0.14
 [2.0.13]: https://github.com/clearskies-py/clearskies/compare/v2.0.12..v2.0.13

clear_skies-2.0.16/LATEST_CHANGELOG.md

@@ -0,0 +1,11 @@
+## [2.0.16] - 2025-10-16
+
+### Added
+- Add json attribute to api backend by @cmancone in [#30](https://github.com/clearskies-py/clearskies/pull/30)
+- Add json attribute to api backend
+
+### Fixed
+- Reorder map_records_response
+- Reorder mapping steps
+- Use empty instead of empty_model
+

{clear_skies-2.0.15 → clear_skies-2.0.16}/PKG-INFO

@@ -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 → clear_skies-2.0.16}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "clear-skies"
 description = "A framework for building backends in the cloud"
-version = "2.0.15"
+version = "2.0.16"
 license = "MIT"
 readme = "./README.md"
 authors = [{name = "Conor Mancone", email = "cmancone@gmail.com"}]

{clear_skies-2.0.15 → clear_skies-2.0.16}/src/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]:

{clear_skies-2.0.15 → clear_skies-2.0.16}/src/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()

clear_skies-2.0.16/src/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])

{clear_skies-2.0.15 → clear_skies-2.0.16}/src/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."""

{clear_skies-2.0.15 → clear_skies-2.0.16}/uv.lock

@@ -202,7 +202,7 @@ wheels = [
 
 [[package]]
 name = "clear-skies"
-version = "2.0.15"
+version = "2.0.16"
 source = { editable = "." }
 dependencies = [
     { name = "dateparser" },

clear_skies-2.0.15/LATEST_CHANGELOG.md

@@ -1,5 +0,0 @@
-## [2.0.15] - 2025-10-16
-
-### Removed
-- Remove unused imports by @tnijboer in [#29](https://github.com/clearskies-py/clearskies/pull/29)
-