clear-skies 1.19.31__tar.gz → 1.20.1__tar.gz

{clear_skies-1.19.31 → clear_skies-1.20.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clear-skies
-Version: 1.19.31
+Version: 1.20.1
 Summary: A framework for building backends in the cloud
 Home-page: https://github.com/cmancone/clearskies
 License: MIT
@@ -18,7 +18,7 @@ Provides-Extra: jose
 Provides-Extra: jwcrypto
 Provides-Extra: mysql
 Provides-Extra: secrets
-Requires-Dist: akeyless (>=3.6.2,<4.0.0) ; extra == "secrets"
+Requires-Dist: akeyless (>=4.0.0,<5.0.0) ; extra == "secrets"
 Requires-Dist: akeyless-cloud-id (>=0.2.3,<0.3.0) ; extra == "secrets"
 Requires-Dist: dateparser (>=1.1.8,<2.0.0)
 Requires-Dist: jose (>=1.0.0,<2.0.0) ; extra == "jose"

{clear_skies-1.19.31 → clear_skies-1.20.1}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [tool.poetry]
 name = "clear-skies"
-version = "1.19.31"
+version = "1.20.1"
 description = "A framework for building backends in the cloud"
 authors = [
     "Conor Mancone <cmancone@gmail.com>",
@@ -29,7 +29,7 @@ classifiers = [
 python = "^3.10"
 dateparser = "^1.1.8"
 requests = "^2.31.0"
-akeyless = {version = "^3.6.2", optional = true}
+akeyless = {version = "^4.0.0", optional = true}
 akeyless-cloud-id = {version = "^0.2.3", optional = true}
 pymysql = {version = "^1.1.0", optional = true}
 jose = {version = "^1.0.0", optional = true}

{clear_skies-1.19.31 → clear_skies-1.20.1}/src/clearskies/column_types/__init__.py

@@ -15,6 +15,7 @@ from .datetime_micro import DateTimeMicro
 from .email import Email
 from .float import Float
 from .has_many import HasMany
+from .has_one import HasOne
 from .integer import Integer
 from .json import JSON
 from .many_to_many import ManyToMany
@@ -96,6 +97,10 @@ def has_many(name, **kwargs):
     return build_column_config(name, HasMany, **kwargs)
 
 
+def has_one(name, **kwargs):
+    return build_column_config(name, HasOne, **kwargs)
+
+
 def integer(name, **kwargs):
     return build_column_config(name, Integer, **kwargs)
 
@@ -173,6 +178,8 @@ __all__ = [
     "Float",
     "has_many",
     "HasMany",
+    "has_one",
+    "HasOne",
     "integer",
     "Integer",
     "json",

clear_skies-1.20.1/src/clearskies/column_types/has_one.py

@@ -0,0 +1,58 @@
+from .has_many import HasMany
+import re
+from collections import OrderedDict
+from ..autodoc.schema import Array as AutoDocArray
+from ..autodoc.schema import Object as AutoDocObject
+from ..autodoc.schema import String as AutoDocString
+
+
+class HasOne(HasMany):
+    """
+    Controls a has-one relationship.
+
+    This is a readonly column.  When used in a model context it will return the related record.
+    When used in an API context, it will convert the child record into an object.
+
+    It assumes that the foreign id in the child table is `[parent_model_class_name]_id` in all lower case.
+    e.g., if the parent model class is named Status, then it assumes an id in the child class called `status_id`.
+    """
+
+    def can_provide(self, column_name):
+        return column_name == self.name
+
+    def provide(self, data, column_name):
+        foreign_column_name = self.config("foreign_column_name")
+        id_column_name = self.config("parent_id_column_name")
+        return self.child_models.find(f"{foreign_column_name}={data[id_column_name]}")
+
+    def to_json(self, model):
+        json = OrderedDict()
+        columns = self.get_child_columns()
+        child = model.__getattr__(self.name)
+        child_id_column_name = child.id_column_name
+        json = {
+            **json,
+            **columns[child_id_column_name].to_json(child),
+        }
+        for column_name in self.config("readable_child_columns"):
+            json = {
+                **json,
+                **columns[column_name].to_json(child),
+            }
+        return {self.name: json}
+
+    def documentation(self, name=None, example=None, value=None):
+        columns = self.get_child_columns()
+        child_id_column_name = self.child_models.get_id_column_name()
+        child_properties = [columns[child_id_column_name].documentation()]
+
+        for column_name in self.config("readable_child_columns"):
+            child_docs = columns[column_name].documentation()
+            if type(child_docs) != list:
+                child_docs = [child_docs]
+            child_properties.extend(child_docs)
+
+        return AutoDocObject(
+            self.camel_to_nice(self.child_models.model_class().__name__),
+            child_properties,
+        )