nuql 0.0.1__py3-none-any.whl

nuql/resources/utils/validators.py

@@ -0,0 +1,165 @@
+__all__ = ['validate_condition_dict', 'validate_schema']
+
+import inspect
+from typing import Dict, Any, List, Type
+
+import nuql
+from nuql import types, resources
+
+
+def validate_condition_dict(condition: Dict[str, Any] | None, required: bool = False) -> None:
+    """
+    Validates a condition dict when provided.
+
+    :arg condition: Dict or None.
+    :param required: If condition is required.
+    """
+    # Validate empty condition
+    if condition is None and not required:
+        return None
+    elif condition is None and required:
+        raise nuql.ValidationError([{'name': 'condition', 'message': 'Condition is required.'}])
+
+    # Type check
+    if not isinstance(condition, dict):
+        raise nuql.ValidationError([{'name': 'condition', 'message': 'Condition must be a dict.'}])
+
+    # Check where key is present
+    if 'where' not in condition or not isinstance(condition['where'], str):
+        raise nuql.ValidationError([{
+            'name': 'condition.where',
+            'message': 'Condition must contain a \'where\' key and must be a string.'
+        }])
+
+    # Type check variables
+    if 'variables' in condition and not isinstance(condition['variables'], dict):
+        raise nuql.ValidationError([{
+            'name': 'condition.variables',
+            'message': 'Condition variables must be a dict if defined.'
+        }])
+
+    # Validate no extra keys were passed
+    extra_keys = set(condition.keys()) - {'where', 'variables'}
+    if extra_keys:
+        raise nuql.ValidationError([{
+            'name': 'condition',
+            'message': f'Condition contains unexpected keys: {", ".join(extra_keys)}'
+        }])
+
+
+def validate_table(name: str, config: Dict[str, Any], fields: Dict[str, Type['types.FieldType']]) -> None:
+    """
+    Validate a table.
+
+    :arg name: Table name.
+    :arg config: Table config.
+    :arg fields: Field map.
+    """
+    if not isinstance(config, dict):
+        raise nuql.ValidationError([{
+            'name': f'schema.tables.{name}',
+            'message': 'Table config must be a dict.'
+        }])
+
+    for field_name, field_config in config.items():
+        if not isinstance(field_name, str):
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields',
+                'message': 'All field names in table config must be a string.'
+            }])
+
+        if not isinstance(field_config, dict):
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}',
+                'message': 'Field config must be a dict.'
+            }])
+
+        field_type = field_config.get('type')
+
+        if not field_type:
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}.type',
+                'message': 'Field type is required.'
+            }])
+
+        if field_type not in fields:
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}.type',
+                'message': f'Field type \'{field_type}\' is not defined.'
+            }])
+
+        if 'required' in field_config and not isinstance(field_config['required'], bool):
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}.required',
+                'message': 'Field key \'required\' must be a boolean value if provided.'
+            }])
+
+        if 'on_create' in field_config and not inspect.isfunction(field_config['on_create']):
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}.on_create',
+                'message': 'Field key \'on_create\' must be a function if provided.'
+            }])
+
+        if 'on_update' in field_config and not inspect.isfunction(field_config['on_update']):
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}.on_update',
+                'message': 'Field key \'on_update\' must be a function if provided.'
+            }])
+
+        if 'on_write' in field_config and not inspect.isfunction(field_config['on_write']):
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}.on_write',
+                'message': 'Field key \'on_write\' must be a function if provided.'
+            }])
+
+        if 'validator' in field_config and not inspect.isfunction(field_config['validator']):
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}.validator',
+                'message': 'Field key \'validator\' must be a function if provided.'
+            }])
+
+        if 'enum' in field_config and not isinstance(field_config['enum'], list):
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}.enum',
+                'message': 'Field key \'enum\' must be a list if provided.'
+            }])
+
+        accepted_keys = [
+            'type', 'required', 'default', 'value', 'on_create', 'on_update', 'on_write', 'validator', 'enum',
+            'of', 'fields',
+        ]
+        invalid_field_config_keys = [x for x in field_config.keys() if x not in accepted_keys]
+        if invalid_field_config_keys:
+            raise nuql.ValidationError([{
+                'name': f'schema.tables.{name}.fields.{field_name}',
+                'message': f'Field config contains unexpected keys: {", ".join(invalid_field_config_keys)}. '
+                           f'Accepted keys are: {", ".join(accepted_keys)}'
+            }])
+
+
+def validate_schema(schema: Dict[str, Any], fields: List[Type['types.FieldType']]) -> None:
+    """
+    Validate a schema.
+
+    :arg schema: Schema dict.
+    :arg fields: List of fields passed from client.
+    """
+    fields = resources.get_field_types(fields)
+
+    # Type check schema
+    if not isinstance(schema, dict):
+        raise nuql.ValidationError([{
+            'name': 'schema',
+            'message': 'Schema must be a dict.'
+        }])
+
+    for table_name, config in schema.items():
+        # Type check table name
+        if not isinstance(table_name, str):
+            raise nuql.ValidationError([{
+                'name': 'schema.table_name',
+                'message': 'Table name in schema must be a string.',
+            }])
+
+        # Validate table schema
+        validate_table(table_name, config, fields)

nuql/types/__init__.py

@@ -0,0 +1,3 @@
+from .fields import *
+from .serialisation import *
+from .config import *

nuql/types/config.py

@@ -0,0 +1,27 @@
+__all__ = ['TableConfig', 'SchemaConfig', 'DBIndexType', 'IndexesType', 'PrimaryIndex', 'SecondaryIndex']
+
+from typing import Dict, TypedDict, NotRequired, Literal, List
+
+from nuql import types
+
+
+TableConfig = Dict[str, types.FieldConfig]
+SchemaConfig = Dict[str, TableConfig]
+DBIndexType = Literal['local', 'global']
+
+
+class PrimaryIndex(TypedDict):
+    hash: str
+    sort: NotRequired[str | None]
+
+
+class SecondaryIndex(TypedDict):
+    hash: str
+    sort: str
+    type: DBIndexType
+    name: str
+    follow: NotRequired[bool]
+    projection: NotRequired[Literal['keys', 'all']]
+
+
+IndexesType = List[PrimaryIndex | SecondaryIndex]

nuql/types/fields.py

@@ -0,0 +1,27 @@
+__all__ = ['FieldConfig', 'IndexType', 'GeneratorCallback', 'ValidatorCallback', 'FieldType']
+
+from typing import TypedDict, NotRequired, Any, Literal, Callable, List, TypeVar, TYPE_CHECKING, Dict
+
+from nuql import resources
+
+
+IndexType = Literal['local', 'global']
+
+GeneratorCallback = Callable[[], Any]
+ValidatorCallback = Callable[[Any, resources.Validator], None]
+
+FieldType = TypeVar('FieldType', bound=resources.FieldBase)
+
+
+class FieldConfig(TypedDict):
+    type: str
+    required: NotRequired[bool]
+    default: NotRequired[Any]
+    value: NotRequired[Any]
+    on_create: NotRequired[GeneratorCallback]
+    on_update: NotRequired[GeneratorCallback]
+    on_write: NotRequired[GeneratorCallback]
+    validator: NotRequired[ValidatorCallback]
+    enum: NotRequired[List[Any]]
+    of: NotRequired['FieldConfig']
+    fields: NotRequired[Dict[str, Any]]

nuql/types/serialisation.py

@@ -0,0 +1,10 @@
+__all__ = ['SerialisationType', 'ValidationErrorItem']
+
+from typing import Literal, TypedDict
+
+SerialisationType = Literal['create', 'update', 'write', 'query']
+
+
+class ValidationErrorItem(TypedDict):
+    name: str
+    message: str

nuql-0.0.1.dist-info/METADATA

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: nuql
+Version: 0.0.1
+Summary: Nuql (pronounced 'nuckle') is a lightweight DynamoDB library for implementing the single table model pattern.
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.13
+Requires-Dist: boto3>=1.40.0
+Requires-Dist: pyparsing>=3.2.3
+Requires-Dist: python-ulid>=3.0.0
+Requires-Dist: uuid-utils>=0.11.0

nuql-0.0.1.dist-info/RECORD

@@ -0,0 +1,65 @@
+nuql/__init__.py,sha256=IjH6hvOvMlqYwZUk7n2x0wy0XWUtZo0cwADTlv9VW-A,77
+nuql/client.py,sha256=aT4TKJ-Rnixo67h3jhmsunqH7oJS_-joHJvPTwJTDZI,2846
+nuql/connection.py,sha256=6PusMgUwPoOT8X0CqWLKdgsdvdAEwmb_dfelz0WpJE8,1471
+nuql/exceptions.py,sha256=1dhtHoLJZyP-njCPC2hNTK48tSllbGV7amlwq3tJQps,2044
+nuql/api/__init__.py,sha256=DKxuIAjckS1vjMIPykbI3h81HszlBB9LdwQuFf53-wo,324
+nuql/api/adapter.py,sha256=VIrItHyAW87xGgjavXRiN2-99shRjDn0kik_iLHeEl0,1355
+nuql/api/batch_write.py,sha256=IZi349BdEiahmWqtQlch4lN6yXNi921czxNTBQIzbzY,2998
+nuql/api/condition_check.py,sha256=uSB01Gp3ZwSWPFLJk6pZDv8zXF_QCZFLVu9yDNq2Vcs,1588
+nuql/api/create.py,sha256=SUfsZtRrp1WWILsdwvSGXKdSGIiiRFsKlttX8uS8AMw,793
+nuql/api/delete.py,sha256=8d7LP2SLje9YHNXrCQNbt3IS67xGMtPLY5ZOx7NtJrg,3038
+nuql/api/get.py,sha256=8K29b-wRW4szYInPvdgyTe7lq3SsvQf1VaiABxsaw_0,934
+nuql/api/put_item.py,sha256=5dWZsYSYpIerVoRkZYDC3l6vw4ctGFua-wAXD3HY4cU,4109
+nuql/api/put_update.py,sha256=ZkNUjX3GkBrymVenoI4RHmjn5Xzh4u1YcRxTte9X22Q,795
+nuql/api/transaction.py,sha256=tL7S_AvKXpcH0OwYh3Fn8N_TWDsGy3mihyjyM6gT5bg,4687
+nuql/api/upsert.py,sha256=X7Qwg_1x8-RUUlQZUq6qLKzlzapOLyKMlFBiDMN8QOg,1133
+nuql/api/batch_get/__init__.py,sha256=N1NQ_WFov4bANyCdS1HBPaPYnlDhZ4QEJSMiEN0sL0k,48
+nuql/api/batch_get/batch_get.py,sha256=DgGCYLQqiCUzwZdrf1XyWHEecY4nzQ-mweWhLPe68RQ,1069
+nuql/api/batch_get/queue.py,sha256=6S70p0i4xXlh8pU8X0-F8-U8P3uzoxJDzbUNaMEhrzU,4032
+nuql/api/query/__init__.py,sha256=_YhXEUvd82bBhOlkBHtPYC8a8VgCHskeg4l95X8w2O0,112
+nuql/api/query/condition.py,sha256=SNCEJZah7v2ioSfxHUmco73HzuKCKVvrzDx6kSLMBQY,5965
+nuql/api/query/condition_builder.py,sha256=kHlpSYcrEX-vQvkqjOG6GVC2_a63zJSjJgIs2_zhGIo,6201
+nuql/api/query/key_condition.py,sha256=B7POd7R4dLV-o629J7rEtvkm9kyqRQAqpAs_Pofun1U,7145
+nuql/api/query/query.py,sha256=Wb3TPmzUdnN96KV_kyXzrVmOsqrVbxFUv3sE48AZxuk,6365
+nuql/api/update/__init__.py,sha256=15mjrAPhrOM74c3Q6NQXTGVjFFgwPCiTAlBLHIDmPQ8,85
+nuql/api/update/expression_builder.py,sha256=jFkp0EASDx7uK2b0TanRALGusXqtXwvOVy02WW2OfGM,1147
+nuql/api/update/update_item.py,sha256=KCfrAZiDPmQc0k20UAA9H3dw_8WFYJ8fDOqHb_xSYNo,5295
+nuql/api/update/utils.py,sha256=ZT2EuSSvoD6-C3Gpybn68N9MohVYDGa6DdpSDIGh-GA,3728
+nuql/fields/__init__.py,sha256=Ldf91fDoiNRkseWo3NksQlOxJTEI-EdS6i1OPjzE_9Y,256
+nuql/fields/boolean.py,sha256=OnmxZyaFH2up1dHDc5p9iHi8fvYZQV1TPI-LMwSb0NA,712
+nuql/fields/datetime.py,sha256=4K28yydnzUc1HsMH-lgSSNOx2NbEL4qXC3kTpuRBVis,1386
+nuql/fields/datetime_timestamp.py,sha256=drJLpmGhL8ANrfGsArKeVLb4v7maiignhzC4qpQzMHY,1275
+nuql/fields/float.py,sha256=x48Spo_GNku0djO0Ogs8usZTfwOY-27Mh5OPOQBO3OY,1316
+nuql/fields/integer.py,sha256=pHs3CJM4xKN60IYg5aTe4QjSQQBR4jp08HyANtidHgs,1312
+nuql/fields/key.py,sha256=v8lsEW7K0HFGvguCq5PeiMmJaK-ygqrkKnrkm67_fbI,7338
+nuql/fields/list.py,sha256=EJI4wlqg8H2FsaB0jAhjnESAeHxX-dt9a-jb3ezFWEM,3067
+nuql/fields/map.py,sha256=dlKA2c9wLupr2soIig5-TYHfNkm05VF2svCfkRv2G1w,2340
+nuql/fields/string.py,sha256=UrG6JpMFpfCSdgSnw_U4e75rWQpxNScSW-7MlWRDVng,6264
+nuql/fields/ulid.py,sha256=mcwTztzIqE_3q1cRa2pf6pN8s0322NQlfQcky9xAWkI,971
+nuql/fields/uuid.py,sha256=fhwAcMUHuih2NgPh7QOs4hcCwrl8Cu2CqSpvLMBAV-c,1041
+nuql/generators/__init__.py,sha256=YgTwNlvZYM4EYo2u3gSN4bIuXz7f8SQF7Y7jnpXN_Ls,67
+nuql/generators/datetime.py,sha256=eX10E9mbCaFVJb3xsVaNxTCpBpl1lsd6HTGYS6hsqNs,981
+nuql/generators/ulid.py,sha256=MuxmKQBPEBSqhlD4NPCnUrDgwgn82a0sTQISQ0iIYmM,194
+nuql/generators/uuid.py,sha256=MoEQVxgEsqGlhpf4W-OuRiLKqNwRtE2NtS3eFTOc5lo,394
+nuql/resources/__init__.py,sha256=8HRJ_H5yTdQtfeVZ29ikdbLQSPKiZRyNkoocQd5QtZ8,92
+nuql/resources/fields/__init__.py,sha256=bajUBAvrK8kIMyb2vD_0NCwibRHOLo4Yoq1sac0Dobc,70
+nuql/resources/fields/field.py,sha256=zDufEscRJr-vfSlbfdk9lBxoQffW_Qr2m_Es0plBGhg,4889
+nuql/resources/fields/field_map.py,sha256=tDDoXdyXnxRJWJ9Il7-uu81R_zSOUXiwrY5mllS3jYU,2517
+nuql/resources/fields/value.py,sha256=CG3PnGeSMHDQciIMR6jkMhogCJZhpEfipLdyk9gnjJw,59
+nuql/resources/records/__init__.py,sha256=gD8-xt4uIOpx_ZTnw1QTzOiwUpjKhR3nhkZw4AmEvaI,81
+nuql/resources/records/projections.py,sha256=PTwoc8-XXieXsYw0H-3Fv7G8SzSN__j35QsqempXBj8,1618
+nuql/resources/records/serialiser.py,sha256=yhMUZ-E0NMMxDszOSfl9ZWNdc2mSJDZfSIjUxAGKnLM,5039
+nuql/resources/records/validator.py,sha256=tuEkNEbZApV-3v2YkTkXemFfRBJyt03IZDtsl7Lmitw,1526
+nuql/resources/tables/__init__.py,sha256=Bk8ewpPb_myliQPmyIarzma_Vezd4XR-Z1lABsTUMPQ,46
+nuql/resources/tables/indexes.py,sha256=5e5bQ_yRgyLmnoXuKAqEw0mJJhY_NE4Sk0vavvMG2m4,5076
+nuql/resources/tables/table.py,sha256=2UjpxhW_0C2nXQr6gMf2k8JLRYA6M1vf5QaGXMDRZw4,5513
+nuql/resources/utils/__init__.py,sha256=vRZp-isHvATfzDlIPLOSu8x6sj3GprPQViL2l6p4OQk,48
+nuql/resources/utils/dict.py,sha256=K-BWbeaXEIDwSRLUXI8BIKr9UluOE0dhd378733j6ug,553
+nuql/resources/utils/validators.py,sha256=tUv6-u29KMpazdvM8vKHEUtyaMUkE61KCdJCEG8LhZk,6583
+nuql/types/__init__.py,sha256=Ea4KR4mUs1RNUEskKF9sXfGpoQw2V9cnIYeE20wkChs,76
+nuql/types/config.py,sha256=lFfPPe62l4DkfLXR8ecw5AiSRAFzsTYy_3a0d_1M7hY,659
+nuql/types/fields.py,sha256=LjGgXM84WO54gRDkgvnwF3pjFvFxErdGYOvs0BskF_o,883
+nuql/types/serialisation.py,sha256=XAy_gARcwYmfEuxWAJox2ClWK9ow0F5WXKVbMUVBq9w,242
+nuql-0.0.1.dist-info/METADATA,sha256=an5t_-VKW6mYk3UM01vGq1R-PCAOjqqWnWYjy4z_Dsc,466
+nuql-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nuql-0.0.1.dist-info/RECORD,,

nuql-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any