nuql 0.0.2__tar.gz → 0.0.4__tar.gz

{nuql-0.0.2 → nuql-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nuql
-Version: 0.0.2
+Version: 0.0.4
 Summary: Nuql (pronounced 'nuckle') is a lightweight DynamoDB library for implementing the single table model pattern.
 License: MIT License
         

nuql-0.0.4/nuql/fields/list.py

@@ -0,0 +1,52 @@
+__all__ = ['List']
+
+from typing import List as _List, Any
+
+import nuql
+from nuql import resources, types
+from nuql.resources import FieldBase
+
+
+class List(FieldBase):
+    type = 'list'
+    of: FieldBase
+
+    def on_init(self) -> None:
+        """Defines the contents of the list."""
+        if 'of' not in self.config:
+            raise nuql.NuqlError(
+                code='SchemaError',
+                message='Config key \'of\' must be defined for the list field type'
+            )
+
+        # Initialise the configured 'of' field type
+        field_map = resources.create_field_map(
+            fields={'of': self.config['of']},
+            parent=self.parent,
+            field_types=self.parent.provider.fields
+        )
+        self.of = field_map['of']
+
+    def serialise_internal(
+            self,
+            value: Any,
+            action: 'types.SerialisationType',
+            validator: 'resources.Validator'
+    ) -> Any:
+        """Internal serialisation"""
+        if not isinstance(value, list):
+            return None
+        else:
+            return [self.of(item, action, validator) for item in value]
+
+    def deserialise(self, value: _List[Any] | None) -> _List[Any] | None:
+        """
+        Deserialises a list of values.
+
+        :arg value: List or None.
+        :return: List or None.
+        """
+        if not isinstance(value, list):
+            return None
+
+        return [self.of.deserialise(item) for item in value]

nuql-0.0.4/nuql/fields/map.py

@@ -0,0 +1,37 @@
+__all__ = ['Map']
+
+from typing import Dict as _Dict, Any
+
+import nuql
+from nuql import resources, types
+
+
+class Map(resources.FieldBase):
+    type = 'map'
+    fields: _Dict[str, Any] = {}
+    serialiser: 'resources.Serialiser' = None
+
+    def on_init(self) -> None:
+        """Initialises the dict schema."""
+        if 'fields' not in self.config:
+            raise nuql.NuqlError(
+                code='SchemaError',
+                message='Config key \'fields\' must be defined for the dict field type'
+            )
+
+        self.fields = resources.create_field_map(self.config['fields'], self.parent, self.parent.provider.fields)
+        self.serialiser = resources.Serialiser(self)
+
+    def serialise_internal(
+            self,
+            value: Any,
+            action: 'types.SerialisationType',
+            validator: 'resources.Validator'
+    ) -> Any:
+        """Serialises the Map value"""
+        if value:
+            return self.serialiser.serialise(action, value, validator)
+
+    def deserialise(self, value: Any) -> Any:
+        """Deserialises the Map value"""
+        return self.serialiser.deserialise(value)

{nuql-0.0.2 → nuql-0.0.4}/nuql/resources/fields/field.py

@@ -96,7 +96,10 @@ class FieldBase:
             value = self.default
 
         # Serialise the value
-        value = self.serialise_internal(value, action, validator)
+        if not isinstance(value, (None, resources.EmptyValue)):
+            value = self.serialise_internal(value, action, validator)
+        else:
+            value = None
 
         # Validate required field
         if self.required and action == 'create' and value is None:

{nuql-0.0.2 → nuql-0.0.4}/nuql/resources/fields/field_map.py

@@ -62,10 +62,10 @@ def get_field_types(field_types: List[Type['types.FieldType']] | None = None) ->
 
     def is_valid(_obj: Any) -> bool:
         """Check the provided object is a valid field type."""
-        if not inspect.isclass(obj):
+        if not inspect.isclass(_obj):
             return False
 
-        if not issubclass(obj, resources.FieldBase):
+        if not issubclass(_obj, resources.FieldBase):
             return False
 
         return True

{nuql-0.0.2 → nuql-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nuql"
-version = "0.0.2"
+version = "0.0.4"
 description = "Nuql (pronounced 'nuckle') is a lightweight DynamoDB library for implementing the single table model pattern."
 requires-python = ">=3.13"
 dependencies = [

nuql-0.0.2/nuql/fields/list.py

@@ -1,90 +0,0 @@
-__all__ = ['List']
-
-from typing import List as _List, Any
-
-import nuql
-from nuql import resources, types
-from nuql.resources import FieldBase
-
-
-class List(FieldBase):
-    type = 'list'
-    of: FieldBase
-
-    def on_init(self) -> None:
-        """Defines the contents of the list."""
-        if 'of' not in self.config:
-            raise nuql.NuqlError(
-                code='SchemaError',
-                message='Config key \'of\' must be defined for the list field type'
-            )
-
-        # Initialise the configured 'of' field type
-        field_map = resources.create_field_map(
-            fields={'of': self.config['of']},
-            parent=self.parent,
-            field_types=self.parent.provider.fields
-        )
-        self.of = field_map['of']
-
-    def __call__(self, value: Any, action: 'types.SerialisationType', validator: 'resources.Validator') -> Any:
-        """
-        Encapsulates the internal serialisation logic to prepare for
-        sending the record to DynamoDB.
-
-        :arg value: Deserialised value.
-        :arg action: SerialisationType (`create`, `update`, `write` or `query`).
-        :arg validator: Validator instance.
-        :return: Serialised value.
-        """
-        has_value = not isinstance(value, resources.EmptyValue)
-
-        # Apply generators if applicable to the field to overwrite the value
-        if action in ['create', 'update', 'write']:
-            if action == 'create' and self.on_create:
-                value = self.on_create()
-
-            if action == 'update' and self.on_update:
-                value = self.on_update()
-
-            if self.on_write:
-                value = self.on_write()
-
-        # Set default value if applicable
-        if not has_value and not value:
-            value = self.default
-
-        # Serialise the value
-        if not isinstance(value, list):
-            value = None
-        else:
-            value = [self.of(item, action, validator) for item in value]
-
-        # Validate required field
-        if self.required and action == 'create' and value is None:
-            validator.add(name=self.name, message='Field is required')
-
-        # Validate against enum
-        if self.enum and has_value and action in ['create', 'update', 'write'] and value not in self.enum:
-            validator.add(name=self.name, message=f'Value must be one of: {", ".join(self.enum)}')
-
-        # Run internal validation
-        self.internal_validation(value, action, validator)
-
-        # Run custom validation logic
-        if self.validator and action in ['create', 'update', 'write']:
-            self.validator(value, validator)
-
-        return value
-
-    def deserialise(self, value: _List[Any] | None) -> _List[Any] | None:
-        """
-        Deserialises a list of values.
-
-        :arg value: List or None.
-        :return: List or None.
-        """
-        if not isinstance(value, list):
-            return None
-
-        return [self.of.deserialise(item) for item in value]

nuql-0.0.2/nuql/fields/map.py

@@ -1,67 +0,0 @@
-__all__ = ['Map']
-
-from typing import Dict as _Dict, Any
-
-import nuql
-from nuql import resources, types
-
-
-class Map(resources.FieldBase):
-    type = 'map'
-    fields: _Dict[str, Any] = {}
-    serialiser: 'resources.Serialiser' = None
-
-    def on_init(self) -> None:
-        """Initialises the dict schema."""
-        if 'fields' not in self.config:
-            raise nuql.NuqlError(
-                code='SchemaError',
-                message='Config key \'fields\' must be defined for the dict field type'
-            )
-
-        self.fields = resources.create_field_map(self.config['fields'], self.parent, self.parent.provider.fields)
-        self.serialiser = resources.Serialiser(self)
-
-    def __call__(self, value: Any, action: 'types.SerialisationType', validator: 'resources.Validator') -> Any:
-        """
-        Encapsulates the internal serialisation logic to prepare for
-        sending the record to DynamoDB.
-
-        :arg value: Deserialised value.
-        :arg action: SerialisationType (`create`, `update`, `write` or `query`).
-        :arg validator: Validator instance.
-        :return: Serialised value.
-        """
-        has_value = not isinstance(value, resources.EmptyValue)
-
-        # Apply generators if applicable to the field to overwrite the value
-        if action in ['create', 'update', 'write']:
-            if action == 'create' and self.on_create:
-                value = self.on_create()
-
-            if action == 'update' and self.on_update:
-                value = self.on_update()
-
-            if self.on_write:
-                value = self.on_write()
-
-        # Set default value if applicable
-        if not has_value and not value:
-            value = self.default
-
-        # Serialise the value
-        if value:
-            value = self.serialiser.serialise(action, value, validator)
-
-        # Validate required field
-        if self.required and action == 'create' and value is None:
-            validator.add(name=self.name, message='Field is required')
-
-        # Run internal validation
-        self.internal_validation(value, action, validator)
-
-        # Run custom validation logic
-        if self.validator and action in ['create', 'update', 'write']:
-            self.validator(value, validator)
-
-        return value