amsdal 0.4.11__cp312-cp312-macosx_10_13_universal2.whl → 0.5.0__cp312-cp312-macosx_10_13_universal2.whl

amsdal/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2023-present
 #
 # SPDX-License-Identifier: AMSDAL End User License Agreement
-__version__ = '0.4.11'
+__version__ = '0.5.0'

amsdal/__migrations__/0000_initial.py

@@ -6,212 +6,31 @@ class Migration(migrations.Migration):
     operations: list[migrations.Operation] = [
         migrations.CreateClass(
             module_type=ModuleType.TYPE,
-            class_name='Object',
-            new_schema={
-                'title': 'Object',
-                'properties': {
-                    'title': {'type': 'string', 'title': 'Title'},
-                    'type': {'type': 'string', 'title': 'Type'},
-                    'default': {'type': 'anything', 'title': 'Default'},
-                    'properties': {
-                        'type': 'dictionary',
-                        'items': {'key': {'type': 'string'}, 'value': {'type': 'anything'}},
-                        'title': 'Properties',
-                    },
-                    'required': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Required'},
-                    'unique': {
-                        'type': 'array',
-                        'items': {'type': 'array', 'items': {'type': 'string'}},
-                        'title': 'Unique Fields',
-                    },
-                    'custom_code': {'type': 'string', 'title': 'Custom Code'},
-                    'meta_class': {'type': 'string', 'title': 'Meta Class'},
-                },
-            },
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.TYPE,
-            class_name='Binary',
-            new_schema={'title': 'Binary', 'properties': {}, 'meta_class': 'TypeMeta'},
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.TYPE,
-            class_name='Dictionary',
-            new_schema={'title': 'Dictionary', 'properties': {}, 'meta_class': 'TypeMeta'},
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.TYPE,
-            class_name='Anything',
-            new_schema={'title': 'Anything', 'properties': {}, 'meta_class': 'TypeMeta'},
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.TYPE,
-            class_name='String',
-            new_schema={'title': 'String', 'default': '', 'properties': {}, 'meta_class': 'TypeMeta'},
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.TYPE,
-            class_name='Array',
-            new_schema={'title': 'Array', 'properties': {}, 'meta_class': 'TypeMeta'},
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.TYPE,
-            class_name='Number',
-            new_schema={'title': 'Number', 'properties': {}, 'meta_class': 'TypeMeta'},
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.TYPE,
-            class_name='Boolean',
-            new_schema={
-                'title': 'Boolean',
-                'properties': {},
-                'options': [{'key': 'true', 'value': True}, {'key': 'false', 'value': False}],
-                'meta_class': 'TypeMeta',
-            },
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.CORE,
-            class_name='Option',
-            new_schema={
-                'title': 'Option',
-                'required': ['key', 'value'],
-                'properties': {
-                    'key': {'type': 'string', 'title': 'Key'},
-                    'value': {'type': 'string', 'title': 'Value Type'},
-                },
-                'meta_class': 'TypeMeta',
-            },
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.CORE,
-            class_name='Validator',
-            new_schema={
-                'title': 'Validator',
-                'required': ['name', 'data'],
-                'properties': {
-                    'name': {'type': 'string', 'title': 'Validator Name'},
-                    'data': {'type': 'anything', 'title': 'Validator Data'},
-                },
-                'meta_class': 'TypeMeta',
-            },
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.CORE,
-            class_name='ClassPropertyMeta',
-            new_schema={
-                'title': 'ClassPropertyMeta',
-                'properties': {
-                    'title': {'type': 'string', 'title': 'Title'},
-                    'default': {'type': 'anything', 'title': 'Default'},
-                    'options': {'type': 'array', 'items': {'type': 'Option'}, 'title': 'Options'},
-                },
-                'meta_class': 'TypeMeta',
-            },
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.CORE,
-            class_name='ClassProperty',
-            new_schema={
-                'title': 'ClassProperty',
-                'required': ['type'],
-                'properties': {
-                    'type': {'type': 'string', 'title': 'Type'},
-                    'items': {
-                        'type': 'dictionary',
-                        'items': {'key': {'type': 'string'}, 'value': {'type': 'anything'}},
-                        'title': 'Items',
-                    },
-                    'db_field': {
-                        'type': 'array',
-                        'items': {'type': 'string'},
-                        'title': 'DB Fields',
-                    },
-                },
-                'meta_class': 'TypeMeta',
-            },
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.CORE,
-            class_name='ClassObject',
-            new_schema={
-                'title': 'ClassObject',
-                'properties': {
-                    'table_name': {'type': 'string', 'title': 'Table Name'},
-                    'properties': {
-                        'type': 'dictionary',
-                        'items': {'key': {'type': 'string'}, 'value': {'type': 'ClassProperty'}},
-                        'title': 'Properties',
-                    },
-                    'primary_key': {
-                        'type': 'array',
-                        'items': {'type': 'string'},
-                        'title': 'Primary key fields',
-                    },
-                    'indexed': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Indexed'},
-                    'unique': {
-                        'type': 'array',
-                        'items': {'type': 'array', 'items': {'type': 'string'}},
-                        'title': 'Unique Fields',
-                    },
-                    'required': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Required'},
-                    'meta_class': {'type': 'string', 'default': 'ClassObject', 'title': 'Meta Class'},
-                },
-                'custom_code': '@property  # type: ignore[misc]\ndef display_name(self) -> str:  # type: ignore[no-untyped-def]\n    return self.title',
-            },
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.CORE,
-            class_name='ClassObjectMeta',
-            new_schema={
-                'title': 'ClassObjectMeta',
-                'required': ['title', 'type'],
-                'properties': {
-                    'title': {'type': 'string', 'title': 'Title'},
-                    'type': {'type': 'string', 'title': 'Type'},
-                    'default': {'type': 'anything', 'title': 'Default'},
-                    'properties': {
-                        'type': 'dictionary',
-                        'items': {'key': {'type': 'string'}, 'value': {'type': 'ClassPropertyMeta'}},
-                        'title': 'Properties',
-                    },
-                    'custom_code': {'type': 'string', 'title': 'Custom Code'},
-                },
-            },
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.CORE,
-            class_name='Fixture',
-            new_schema={
-                'title': 'Fixture',
-                'required': ['data', 'external_id'],
-                'properties': {
-                    'class_name': {'type': 'string', 'title': 'Class Name'},
-                    'external_id': {'type': 'string', 'title': 'External ID'},
-                    'data': {
-                        'type': 'dictionary',
-                        'items': {'key': {'type': 'string'}, 'value': {'type': 'anything'}},
-                        'title': 'Data',
-                    },
-                },
-                "primary_key": ["partition_key"],
-                "table_name": "Fixture",
-                'unique': [['external_id']],
-            },
-        ),
-        migrations.CreateClass(
-            module_type=ModuleType.CORE,
-            class_name='File',
-            new_schema={
-                'title': 'File',
-                'required': ['filename', 'data'],
-                'properties': {
-                    'filename': {'type': 'string', 'title': 'Filename'},
-                    'data': {'type': 'binary', 'title': 'Data'},
-                    'size': {'type': 'number', 'title': 'Size'},
+            class_name="Object",
+            new_schema={
+                "title": "Object",
+                "required": ["title", "type", "module_type"],
+                "properties": {
+                    "title": {"type": "string", "title": "Title"},
+                    "type": {"type": "string", "title": "Type"},
+                    "module_type": {"type": "string", "title": "Module Type"},
+                    "default": {"type": "anything", "title": "Default"},
+                    "properties": {
+                        "type": "dictionary",
+                        "items": {"key": {"type": "string"}, "value": {"type": "anything"}},
+                        "title": "Properties",
+                    },
+                    "required": {"type": "array", "items": {"type": "string"}, "title": "Required"},
+                    "custom_code": {"type": "string", "title": "Custom Code"},
+                    "meta_class": {"type": "string", "title": "Meta Class"},
+                },
+                "custom_code": "from typing import Any\n\nfrom amsdal_models.builder.validators.dict_validators import validate_non_empty_keys\nfrom pydantic.functional_validators import field_validator\n\n\n@field_validator('properties')\n@classmethod\ndef _non_empty_keys_properties(cls: type, value: Any) -> Any:\n    return validate_non_empty_keys(value)",
+                "storage_metadata": {
+                    "table_name": "Object",
+                    "db_fields": {},
+                    "primary_key": ["partition_key"],
+                    "foreign_keys": {},
                 },
-                "primary_key": ["partition_key"],
-                "table_name": "File",
-                'custom_code': "def pre_update(self):  # type: ignore[no-untyped-def]\n    self.size = len(self.data or b'')\n\ndef pre_create(self) -> None:  # type: ignore[no-untyped-def]\n    self.size = len(self.data or b'')\n\nfrom pathlib import Path\nfrom typing import BinaryIO\n\n\ndef to_file(self, file_or_path: Path | BinaryIO) -> None:  # type: ignore[no-untyped-def]\n    if isinstance(file_or_path, Path):\n        if file_or_path.is_dir():\n            file_or_path = file_or_path / self.name\n        file_or_path.write_bytes(self.data)  # type: ignore[union-attr]\n    else:\n        file_or_path.write(self.data)\n        file_or_path.seek(0)\n\nfrom pathlib import Path\nfrom typing import BinaryIO\n\n\n@classmethod  # type: ignore[misc, no-untyped-def]\ndef from_file(\n    cls,\n    file_or_path: Path | BinaryIO,\n) -> 'File':  # type: ignore[name-defined]  # noqa: F821\n    if isinstance(file_or_path, Path):\n        if file_or_path.is_dir():\n            msg = f'{file_or_path} is a directory'\n            raise ValueError(msg)\n\n        data = file_or_path.read_bytes()\n        filename = file_or_path.name\n    else:\n        file_or_path.seek(0)\n        data = file_or_path.read()\n        filename = Path(file_or_path.name).name\n\n    return cls(data=data, filename=filename)\n\nimport base64\n\nfrom pydantic import field_validator\n\n\n@field_validator('data')  # type: ignore[misc]\n@classmethod\ndef data_base64_decode(cls, v: bytes) -> bytes:  # type: ignore[no-untyped-def]  # noqa: ARG001\n    is_base64: bool = False\n\n    try:\n        is_base64 = base64.b64encode(base64.b64decode(v)) == v\n    except Exception:\n        ...\n\n    if is_base64:\n        return base64.b64decode(v)\n\n    return v\n\n@property  # type: ignore[misc]\ndef mimetype(self) -> str | None:  # type: ignore[no-untyped-def]\n    import mimetypes\n\n    return mimetypes.guess_type(self.filename)[0]",
             },
         ),
     ]

amsdal/__migrations__/0001_create_class_file.py

@@ -0,0 +1,160 @@
+from amsdal_models.migration import migrations
+from amsdal_utils.models.enums import ModuleType
+
+
+class Migration(migrations.Migration):
+    operations: list[migrations.Operation] = [
+        migrations.CreateClass(
+            module_type=ModuleType.CORE,
+            class_name="ClassProperty",
+            new_schema={
+                "title": "ClassProperty",
+                "required": ["type"],
+                "properties": {
+                    "title": {"type": "string", "title": "Title"},
+                    "type": {"type": "string", "title": "Type"},
+                    "default": {"type": "anything", "title": "Default"},
+                    "options": {"type": "array", "items": {"type": "Option", "title": "Option"}, "title": "Options"},
+                    "items": {
+                        "type": "dictionary",
+                        "items": {"key": {"type": "string"}, "value": {"type": "anything"}},
+                        "title": "Items",
+                    },
+                    "discriminator": {"type": "string", "title": "Discriminator"},
+                },
+                "meta_class": "TypeMeta",
+                "custom_code": "from typing import Any\n\nfrom amsdal_models.builder.validators.dict_validators import validate_non_empty_keys\nfrom pydantic.functional_validators import field_validator\n\nfrom amsdal.models.core.option import *\n\n\n@field_validator('items')\n@classmethod\ndef _non_empty_keys_items(cls: type, value: Any) -> Any:\n    return validate_non_empty_keys(value)",
+                "storage_metadata": {"table_name": "ClassProperty", "db_fields": {}, "foreign_keys": {}},
+            },
+        ),
+        migrations.CreateClass(
+            module_type=ModuleType.CORE,
+            class_name="ClassObject",
+            new_schema={
+                "title": "ClassObject",
+                "required": ["title", "type", "module_type"],
+                "properties": {
+                    "title": {"type": "string", "title": "Title"},
+                    "type": {"type": "string", "title": "Type"},
+                    "module_type": {"type": "string", "title": "Module Type"},
+                    "properties": {
+                        "type": "dictionary",
+                        "items": {"key": {"type": "string"}, "value": {"type": "ClassProperty"}},
+                        "title": "Properties",
+                    },
+                    "required": {"type": "array", "items": {"type": "string"}, "title": "Required"},
+                    "custom_code": {"type": "string", "title": "Custom Code"},
+                    "storage_metadata": {"type": "StorageMetadata", "title": "Storage metadata"},
+                },
+                "custom_code": 'from typing import Any\n\nfrom amsdal_models.builder.validators.dict_validators import validate_non_empty_keys\nfrom pydantic.functional_validators import field_validator\n\nfrom amsdal.models.core.class_property import *\nfrom amsdal.models.core.storage_metadata import *\n\n\n@field_validator(\'properties\')\n@classmethod\ndef _non_empty_keys_properties(cls: type, value: Any) -> Any:\n    return validate_non_empty_keys(value)\n\n@property\ndef display_name(self) -> str:\n    """\n        Returns the display name of the object.\n\n        Returns:\n            str: The display name, which is the title of the object.\n        """\n    return self.title',
+                "storage_metadata": {
+                    "table_name": "ClassObject",
+                    "db_fields": {},
+                    "primary_key": ["partition_key"],
+                    "foreign_keys": {},
+                },
+            },
+        ),
+        migrations.CreateClass(
+            module_type=ModuleType.CORE,
+            class_name="File",
+            new_schema={
+                "title": "File",
+                "required": ["filename", "data"],
+                "properties": {
+                    "filename": {"type": "string", "title": "Filename"},
+                    "data": {"type": "binary", "title": "Data"},
+                    "size": {"type": "number", "title": "Size"},
+                },
+                "custom_code": 'import base64\nfrom pathlib import Path\nfrom typing import BinaryIO\n\nfrom pydantic import field_validator\n\n\n@classmethod\ndef from_file(cls, file_or_path: Path | BinaryIO) -> \'File\':\n    """\n        Creates a `File` object from a file path or a binary file object.\n\n        Args:\n            file_or_path (Path | BinaryIO): The file path or binary file object.\n\n        Returns:\n            File: The created `File` object.\n\n        Raises:\n            ValueError: If the provided path is a directory.\n        """\n    if isinstance(file_or_path, Path):\n        if file_or_path.is_dir():\n            msg = f\'{file_or_path} is a directory\'\n            raise ValueError(msg)\n        data = file_or_path.read_bytes()\n        filename = file_or_path.name\n    else:\n        file_or_path.seek(0)\n        data = file_or_path.read()\n        filename = Path(file_or_path.name).name\n    return cls(data=data, filename=filename)\n\n@field_validator(\'data\')\n@classmethod\ndef data_base64_decode(cls, v: bytes) -> bytes:\n    """\n        Decodes a base64-encoded byte string if it is base64-encoded.\n\n        This method checks if the provided byte string is base64-encoded and decodes it if true.\n        If the byte string is not base64-encoded, it returns the original byte string.\n\n        Args:\n            cls: The class this method belongs to.\n            v (bytes): The byte string to be checked and potentially decoded.\n\n        Returns:\n            bytes: The decoded byte string if it was base64-encoded, otherwise the original byte string.\n        """\n    is_base64: bool = False\n    try:\n        is_base64 = base64.b64encode(base64.b64decode(v)) == v\n    except Exception:\n        ...\n    if is_base64:\n        return base64.b64decode(v)\n    return v\n\n@property\ndef mimetype(self) -> str | None:\n    """\n        Returns the MIME type of the file based on its filename.\n\n        This method uses the `mimetypes` module to guess the MIME type of the file.\n\n        Returns:\n            str | None: The guessed MIME type of the file, or None if it cannot be determined.\n        """\n    import mimetypes\n    return mimetypes.guess_type(self.filename)[0]\n\nasync def apre_create(self) -> None:\n    """\n        Prepares the object for creation by setting its size attribute.\n\n        This method calculates the size of the object\'s data and assigns it to the size attribute.\n        If the data is None, it defaults to an empty byte string.\n\n        Args:\n            None\n        """\n    self.size = len(self.data or b\'\')\n\nasync def apre_update(self) -> None:\n    """\n        Prepares the object for update by setting its size attribute.\n\n        This method calculates the size of the object\'s data and assigns it to the size attribute.\n        If the data is None, it defaults to an empty byte string.\n\n        Args:\n            None\n        """\n    self.size = len(self.data or b\'\')\n\ndef __repr__(self) -> str:\n    return f\'File<{self.filename}>({self.size or len(self.data) or 0} bytes)\'\n\ndef __str__(self) -> str:\n    return repr(self)\n\ndef pre_create(self) -> None:\n    """\n        Prepares the object for creation by setting its size attribute.\n\n        This method calculates the size of the object\'s data and assigns it to the size attribute.\n        If the data is None, it defaults to an empty byte string.\n\n        Args:\n            None\n        """\n    self.size = len(self.data or b\'\')\n\ndef pre_update(self) -> None:\n    """\n        Prepares the object for update by setting its size attribute.\n\n        This method calculates the size of the object\'s data and assigns it to the size attribute.\n        If the data is None, it defaults to an empty byte string.\n\n        Args:\n            None\n        """\n    self.size = len(self.data or b\'\')\n\ndef to_file(self, file_or_path: Path | BinaryIO) -> None:\n    """\n        Writes the object\'s data to a file path or a binary file object.\n\n        Args:\n            file_or_path (Path | BinaryIO): The file path or binary file object where the data will be written.\n\n        Returns:\n            None\n\n        Raises:\n            ValueError: If the provided path is a directory.\n        """\n    if isinstance(file_or_path, Path):\n        if file_or_path.is_dir():\n            file_or_path = file_or_path / self.name\n        file_or_path.write_bytes(self.data)\n    else:\n        file_or_path.write(self.data)\n        file_or_path.seek(0)',
+                "storage_metadata": {
+                    "table_name": "File",
+                    "db_fields": {},
+                    "primary_key": ["partition_key"],
+                    "foreign_keys": {},
+                },
+            },
+        ),
+        migrations.CreateClass(
+            module_type=ModuleType.CORE,
+            class_name="Fixture",
+            new_schema={
+                "title": "Fixture",
+                "required": ["external_id", "data"],
+                "properties": {
+                    "class_name": {"type": "string", "title": "Class Name"},
+                    "order": {"type": "number", "title": "Order"},
+                    "external_id": {"type": "string", "title": "External ID"},
+                    "data": {
+                        "type": "dictionary",
+                        "items": {"key": {"type": "string"}, "value": {"type": "anything"}},
+                        "title": "Data",
+                    },
+                },
+                "custom_code": "from typing import Any\n\nfrom amsdal_models.builder.validators.dict_validators import validate_non_empty_keys\nfrom pydantic.functional_validators import field_validator\n\n\n@field_validator('data')\n@classmethod\ndef _non_empty_keys_data(cls: type, value: Any) -> Any:\n    return validate_non_empty_keys(value)",
+                "storage_metadata": {
+                    "table_name": "Fixture",
+                    "db_fields": {},
+                    "primary_key": ["partition_key"],
+                    "unique": [["external_id"]],
+                    "foreign_keys": {},
+                },
+            },
+        ),
+        migrations.CreateClass(
+            module_type=ModuleType.CORE,
+            class_name="Option",
+            new_schema={
+                "title": "Option",
+                "required": ["key", "value"],
+                "properties": {
+                    "key": {"type": "string", "title": "Key"},
+                    "value": {"type": "string", "title": "Value Type"},
+                },
+                "meta_class": "TypeMeta",
+                "storage_metadata": {"table_name": "Option", "db_fields": {}, "foreign_keys": {}},
+            },
+        ),
+        migrations.CreateClass(
+            module_type=ModuleType.CORE,
+            class_name="StorageMetadata",
+            new_schema={
+                "title": "StorageMetadata",
+                "properties": {
+                    "table_name": {"type": "string", "title": "Table name"},
+                    "db_fields": {
+                        "type": "dictionary",
+                        "items": {"key": {"type": "string"}, "value": {"type": "array"}},
+                        "title": "Database fields",
+                    },
+                    "primary_key": {"type": "array", "items": {"type": "string"}, "title": "Primary key fields"},
+                    "indexed": {
+                        "type": "array",
+                        "items": {"type": "array", "items": {"type": "string"}},
+                        "title": "Indexed",
+                    },
+                    "unique": {
+                        "type": "array",
+                        "items": {"type": "array", "items": {"type": "string"}},
+                        "title": "Unique Fields",
+                    },
+                },
+                "meta_class": "TypeMeta",
+                "storage_metadata": {"table_name": "StorageMetadata", "db_fields": {}, "foreign_keys": {}},
+            },
+        ),
+        migrations.CreateClass(
+            module_type=ModuleType.CORE,
+            class_name="Validator",
+            new_schema={
+                "title": "Validator",
+                "required": ["name", "data"],
+                "properties": {
+                    "name": {"type": "string", "title": "Validator Name"},
+                    "data": {"type": "anything", "title": "Validator Data"},
+                },
+                "meta_class": "TypeMeta",
+                "storage_metadata": {"table_name": "Validator", "db_fields": {}, "foreign_keys": {}},
+            },
+        ),
+    ]