Merge pull request #2 from flask-pro/improve-crud-methods

improve CRUD-methods.

Author: flask-pro

CHANGES.md

@@ -1,3 +1,10 @@
+## Version 2.1.0
+
+* `PaginateMixin` removed, this functional moved to `ReadMixin`.
+* Add parameter `deserialize` to `CreateMixin`, `ReadMixin` and `UpdateMixine`.
+* Improved docstrings.
+
+
 ## Version 2.0.0
 
 * Refactoring of the module has been carried out. Improved class and method interfaces.

README.md

@@ -41,7 +41,6 @@ from db_first import BaseCRUD
 from db_first.base_model import ModelMixin
 from db_first.mixins import CreateMixin
 from db_first.mixins import DeleteMixin
-from db_first.mixins import PaginationMixin
 from db_first.mixins import ReadMixin
 from db_first.mixins import UpdateMixin
 from marshmallow import fields
@@ -73,17 +72,22 @@ class InputSchemaOfUpdate(InputSchemaOfCreate):
     id = fields.UUID()
 
 
+class InputSchemaOfRead(Schema):
+    id = fields.UUID()
+
+
 class OutputSchema(InputSchemaOfUpdate):
     created_at = fields.DateTime()
 
 
-class ItemController(CreateMixin, ReadMixin, UpdateMixin, DeleteMixin, PaginationMixin, BaseCRUD):
+class ItemController(CreateMixin, ReadMixin, UpdateMixin, DeleteMixin, BaseCRUD):
     class Meta:
         session = session
         model = Items
         input_schema_of_create = InputSchemaOfCreate
         input_schema_of_update = InputSchemaOfUpdate
         output_schema_of_create = OutputSchema
+        input_schema_of_read = InputSchemaOfRead
         output_schema_of_read = OutputSchema
         output_schema_of_update = OutputSchema
         schema_of_paginate = OutputSchema
@@ -93,14 +97,14 @@ class ItemController(CreateMixin, ReadMixin, UpdateMixin, DeleteMixin, Paginatio
 if __name__ == '__main__':
     item = ItemController()
 
-    first_new_item = item.create(data={'data': 'first'})
+    first_new_item = item.create(deserialize=True, data='first')
     print('Item as object:', first_new_item)
-    second_new_item = item.create(data={'data': 'second'}, serialize=True)
+    second_new_item = item.create(deserialize=True, data='second', serialize=True)
     print('Item as dict:', second_new_item)
 
-    first_item = item.read(first_new_item.id)
+    first_item = item.read(id=first_new_item.id)
     print('Item as object:', first_item)
-    first_item = item.read(first_new_item.id, serialize=True)
+    first_item = item.read(id=first_new_item.id)
     print('Item as dict:', first_item)
 
     updated_first_item = item.update(data={'id': first_new_item.id, 'data': 'updated_first'})
@@ -110,8 +114,9 @@ if __name__ == '__main__':
     )
     print('Item as dict:', updated_second_item)
 
-    items = item.paginate(sort_created_at='desc')
+    items = item.read(sort_created_at='desc')
     print('Items as objects:', items)
-    items = item.paginate(sort_created_at='desc', serialize=True)
+    items = item.read(sort_created_at='desc', serialize=True)
     print('Items as dicts:', items)
+
 ```

examples/full_example.py

@@ -4,7 +4,6 @@
 from db_first.base_model import ModelMixin
 from db_first.mixins import CreateMixin
 from db_first.mixins import DeleteMixin
-from db_first.mixins import PaginationMixin
 from db_first.mixins import ReadMixin
 from db_first.mixins import UpdateMixin
 from marshmallow import fields
@@ -36,17 +35,22 @@ class InputSchemaOfUpdate(InputSchemaOfCreate):
     id = fields.UUID()
 
 
+class InputSchemaOfRead(Schema):
+    id = fields.UUID()
+
+
 class OutputSchema(InputSchemaOfUpdate):
     created_at = fields.DateTime()
 
 
-class ItemController(CreateMixin, ReadMixin, UpdateMixin, DeleteMixin, PaginationMixin, BaseCRUD):
+class ItemController(CreateMixin, ReadMixin, UpdateMixin, DeleteMixin, BaseCRUD):
     class Meta:
         session = session
         model = Items
         input_schema_of_create = InputSchemaOfCreate
         input_schema_of_update = InputSchemaOfUpdate
         output_schema_of_create = OutputSchema
+        input_schema_of_read = InputSchemaOfRead
         output_schema_of_read = OutputSchema
         output_schema_of_update = OutputSchema
         schema_of_paginate = OutputSchema
@@ -56,14 +60,14 @@ class Meta:
 if __name__ == '__main__':
     item = ItemController()
 
-    first_new_item = item.create(data={'data': 'first'})
+    first_new_item = item.create(deserialize=True, data='first')
     print('Item as object:', first_new_item)
-    second_new_item = item.create(data={'data': 'second'}, serialize=True)
+    second_new_item = item.create(deserialize=True, data='second', serialize=True)
     print('Item as dict:', second_new_item)
 
-    first_item = item.read(first_new_item.id)
+    first_item = item.read(id=first_new_item.id)
     print('Item as object:', first_item)
-    first_item = item.read(first_new_item.id, serialize=True)
+    first_item = item.read(id=first_new_item.id)
     print('Item as dict:', first_item)
 
     updated_first_item = item.update(data={'id': first_new_item.id, 'data': 'updated_first'})
@@ -73,7 +77,7 @@ class Meta:
     )
     print('Item as dict:', updated_second_item)
 
-    items = item.paginate(sort_created_at='desc')
+    items = item.read(sort_created_at='desc')
     print('Items as objects:', items)
-    items = item.paginate(sort_created_at='desc', serialize=True)
+    items = item.read(sort_created_at='desc', serialize=True)
     print('Items as dicts:', items)

pyproject.toml

@@ -25,7 +25,7 @@ license = {file = "LICENSE"}
 name = "DB-First"
 readme = "README.md"
 requires-python = ">=3.9"
-version = "2.0.0"
+version = "2.1.0"
 
 [project.optional-dependencies]
 dev = [

src/db_first/__init__.py

@@ -1,5 +1,5 @@
 from .base import BaseCRUD
 from .base_model import ModelMixin
-from .query_maker import QueryMaker
+from .statement_maker import StatementMaker
 
-__all__ = ['QueryMaker', 'BaseCRUD', 'ModelMixin']
+__all__ = ['BaseCRUD', 'ModelMixin', 'StatementMaker']

src/db_first/base.py

@@ -1,4 +1,5 @@
 from typing import Any
+from typing import Optional
 
 from sqlalchemy.engine import Result
 
@@ -8,7 +9,7 @@
 
 class BaseCRUD:
     @classmethod
-    def _get_option_from_meta(cls, name: str) -> Any:
+    def _get_option_from_meta(cls, name: str, default: Optional[Any] = ...) -> Any:
         try:
             meta = cls.Meta
         except AttributeError:
@@ -17,7 +18,10 @@ def _get_option_from_meta(cls, name: str) -> Any:
         try:
             option = getattr(meta, name)
         except AttributeError:
-            raise OptionNotFound(f'Option <{name}> not set in Meta class.')
+            if default is Ellipsis:
+                raise OptionNotFound(f'Option <{name}> not set in Meta class.')
+            else:
+                option = default
 
         return option
 

src/db_first/mixins/__init__.py

@@ -2,6 +2,5 @@
 from .crud import DeleteMixin
 from .crud import ReadMixin
 from .crud import UpdateMixin
-from .pagination import PaginationMixin
 
-__all__ = ['CreateMixin', 'ReadMixin', 'UpdateMixin', 'DeleteMixin', 'PaginationMixin']
+__all__ = ['CreateMixin', 'ReadMixin', 'UpdateMixin', 'DeleteMixin']