clear-skies 1.19.31__py3-none-any.whl → 1.20.0__py3-none-any.whl

{clear_skies-1.19.31.dist-info → clear_skies-1.20.0.dist-info}/METADATA

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

{clear_skies-1.19.31.dist-info → clear_skies-1.20.0.dist-info}/RECORD

@@ -55,7 +55,7 @@ clearskies/backends/memory_backend.py,sha256=6Ts_NtP9S_QisvpNcQKO0CUqhCRAuL3d5LZ
 clearskies/backends/restful_api_advanced_search_backend.py,sha256=uiR4SEKhLNmczYJEAkVMIdPWxQc4YWSp-_WzcSL7DEo,5480
 clearskies/backends/secrets_backend.py,sha256=4lzrgdL_O_pgCT5HknV2gotFgp9GzjQ5_2n0-4H4kvs,2204
 clearskies/binding_config.py,sha256=bF8LBNEgJacwKCqToAtDqN9hv5omzU7zt_4qB9KPtE0,457
-clearskies/column_types/__init__.py,sha256=Z3HVDZeleZJQNnIrhQbvhzI09-v2ADNw0PQFYkoUwvE,4588
+clearskies/column_types/__init__.py,sha256=wofhLfyW00I6tb6o9DMsMx7j9hlbbqefhDzWfw0Row0,4731
 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
@@ -73,6 +73,7 @@ clearskies/column_types/datetime_micro.py,sha256=3DxtkeJZhWigdni7QEJFV3BJuCmXJMy
 clearskies/column_types/email.py,sha256=qq0Yo_C3KxUqT68q2HWXocBBR4xwMqjxcIdgZRv218U,584
 clearskies/column_types/float.py,sha256=j8jJeBueSOusPtAFCWgLHYBncfLnqT1U7bh1zcAkYiA,1332
 clearskies/column_types/has_many.py,sha256=Z4oM1g2dQx6H9171c52FLC41nLryCOKmh51I75mYmmY,5895
+clearskies/column_types/has_one.py,sha256=uphIPUuHLwwmhljLMaKKPujR6TYTT7onn-hHUF6S_IY,2230
 clearskies/column_types/integer.py,sha256=dGIluusPmhLRNg7PplOJLbQI2AXojqRBUHt8ekYWNVI,1386
 clearskies/column_types/json.py,sha256=TbZkdwCoZYhbALUxof2jENGfaq2i5TlcyBcmo7XzDGQ,652
 clearskies/column_types/many_to_many.py,sha256=Yu5wmMkVqRteMrH_8uSZK-bM_IrfDyv6AFb92iJ1FZs,11984
@@ -204,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.19.31.dist-info/LICENSE,sha256=3Ehd0g3YOpCj8sqj0Xjq5qbOtjjgk9qzhhD9YjRQgOA,1053
-clear_skies-1.19.31.dist-info/METADATA,sha256=J3n3vqiDQIaaf0i6Q5pTTsumlb_1D0_iR0ai2iHDzwU,1712
-clear_skies-1.19.31.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-clear_skies-1.19.31.dist-info/RECORD,,
+clear_skies-1.20.0.dist-info/LICENSE,sha256=3Ehd0g3YOpCj8sqj0Xjq5qbOtjjgk9qzhhD9YjRQgOA,1053
+clear_skies-1.20.0.dist-info/METADATA,sha256=s3CfL8eRPixLfFoHgKH3lq4AL0T3rYcwPhO48EKp0Do,1711
+clear_skies-1.20.0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+clear_skies-1.20.0.dist-info/RECORD,,

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

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,
+        )