Initial commit

Author: Adrian Dankiv

.gitignore

@@ -0,0 +1,2 @@
+# Project exclude paths
+/.venv/

example1_simple.py

@@ -0,0 +1,32 @@
+from dataclasses import dataclass, field
+from enum import Enum
+
+from marshmallow_dataclass import class_schema
+
+
+class Command(Enum):
+    CREATE = 'create'
+    DELETE = 'delete'
+
+
+@dataclass
+class Config:
+    file_path: str
+    command: Command = field(metadata=dict(by_value=True))
+    bulk_size: int = 20
+
+
+Config.Schema = class_schema(Config)
+
+json_data = {
+    'file_path': '/validators-example/file',
+    'command': 'create',
+}
+
+config = Config.Schema().load(json_data)
+print(config)
+print(Config.Schema().dump(config))
+
+assert config.file_path == '/validators-example/file'
+assert config.command is Command.CREATE
+assert config.bulk_size == 20

example1_simple_many.py

@@ -0,0 +1,38 @@
+from dataclasses import dataclass, field
+from enum import Enum
+
+from marshmallow_dataclass import class_schema
+
+
+class Command(Enum):
+    CREATE = 'create'
+    DELETE = 'delete'
+
+
+@dataclass
+class Config:
+    file_path: str
+    command: Command = field(metadata=dict(by_value=True))
+    bulk_size: int = 20
+
+
+Config.Schema = class_schema(Config)
+
+json_data = [
+    {
+        'file_path': '/validators-example/file1',
+        'command': 'create',
+    },
+    {
+        'file_path': '/validators-example/file2',
+        'command': 'delete',
+    },
+]
+
+configs = Config.Schema().load(json_data, many=True)
+print(configs)
+
+assert len(configs) == 2
+assert configs[0].file_path == '/validators-example/file1'
+assert configs[0].command is Command.CREATE
+assert configs[0].bulk_size == 20

example2_nested.py

@@ -0,0 +1,51 @@
+from dataclasses import dataclass, field
+from enum import Enum
+
+from marshmallow_dataclass import class_schema
+
+
+class Command(Enum):
+    CREATE = 'create'
+    DELETE = 'delete'
+
+
+@dataclass
+class DatabaseConfig:
+    host: str
+    port: int
+    username: str
+    password: str
+
+
+@dataclass
+class Config:
+    file_path: str
+    command: Command = field(metadata=dict(by_value=True))
+    database_config: DatabaseConfig
+    bulk_size: int = 20
+
+
+DatabaseConfig.Schema = class_schema(DatabaseConfig)
+Config.Schema = class_schema(Config)
+
+json_data = {
+    'file_path': '/validators-example/file',
+    'command': 'create',
+    'database_config': {
+        'host': 'localhost',
+        'port': 5432,
+        'username': 'root',
+        'password': 'qwerty'
+    }
+}
+
+config = Config.Schema().load(json_data)
+print(config)
+
+assert config.file_path == '/validators-example/file'
+assert config.command is Command.CREATE
+assert config.bulk_size == 20
+assert config.database_config.host == 'localhost'
+assert config.database_config.port == 5432
+assert config.database_config.username == 'root'
+assert config.database_config.password == 'qwerty'

example3_validation.py

@@ -0,0 +1,32 @@
+from dataclasses import dataclass
+from typing import Any, Dict
+
+from marshmallow import ValidationError, validates_schema, validates
+from marshmallow_dataclass import class_schema
+
+
+@dataclass
+class Config:
+    min_value: int
+    max_value: int
+
+    @validates("min_value")
+    def validate_min(self, value):
+        if value < 0:
+            raise ValidationError("Min value must be greater than 0.")
+
+    @validates_schema
+    def validate_min_max(self, data: Dict[str, Any], partial: bool, many: bool) -> None:
+        if data['min_value'] > data['max_value']:
+            raise ValidationError('min_value should be less then max_value')
+
+
+Config.Schema = class_schema(Config)
+
+json_data = {
+    'min_value': -20,
+    'max_value': 15,
+}
+
+config = Config.Schema().load(json_data)
+print(config)

example4_alias.py

@@ -0,0 +1,26 @@
+from dataclasses import dataclass, field
+from enum import Enum
+
+from marshmallow_dataclass import class_schema
+
+
+class Command(Enum):
+    CREATE = 'create'
+    DELETE = 'delete'
+
+
+@dataclass
+class Config:
+    bulk_size: int = field(metadata=dict(data_key='main_bulk_size'))
+
+
+Config.Schema = class_schema(Config)
+
+json_data = {
+    'main_bulk_size': 20
+}
+
+config = Config.Schema().load(json_data)
+print(config)
+
+assert config.bulk_size == 20

example5_custom_fields.py

@@ -0,0 +1,53 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from pathlib import Path
+from typing import Optional
+
+from marshmallow import Schema, fields
+from marshmallow_dataclass import class_schema
+
+
+class Command(Enum):
+    CREATE = 'create'
+    DELETE = 'delete'
+
+
+class PathField(fields.String):
+    def _serialize(self, value, attr, obj, **kwargs) -> Optional[str]:
+        if isinstance(value, Path):
+            value = str(value)
+
+        return super()._serialize(value, attr, obj, **kwargs)
+
+    def _deserialize(self, value, attr, data, **kwargs) -> Optional[Path]:
+        result = super()._deserialize(value, attr, data, **kwargs)
+
+        if result is None:
+            return None
+
+        return Path(result)
+
+
+Schema.TYPE_MAPPING[Path] = PathField
+
+
+@dataclass
+class Config:
+    file_path: Path
+    command: Command = field(metadata=dict(by_value=True))
+    bulk_size: int = 20
+
+
+Config.Schema = class_schema(Config)
+
+json_data = {
+    'file_path': '/validators-example/file',
+    'command': 'create',
+}
+
+config = Config.Schema().load(json_data)
+print(config)
+
+assert config.file_path == Path('/validators-example/file')
+assert config.command is Command.CREATE
+assert config.bulk_size == 20

requirements.txt

@@ -0,0 +1 @@
+marshmallow-dataclass[enum,union]==8.2.0