pass view_kwargs as dict to update it, enhance logical abstraction management, fix wrong attribute spelling and enhance relationships management

Author: akira-dev

flask_rest_jsonapi/data_layers/alchemy.py

@@ -25,18 +25,20 @@ class BaseDataLayer(object):
                           'before_delete_relationship',
                           'after_delete_relationship')
 
-    def __init__(self, **kwargs):
+    def __init__(self, kwargs):
         """Intialize an data layer instance with kwargs
 
         :param dict kwargs: information about data layer instance
         """
+        kwargs.pop('class', None)
+
         for key, value in kwargs.items():
             setattr(self, key, value)
 
         if kwargs.get('methods') is not None:
             self.bound_additional_methods()
 
-    def create_object(self, data, **view_kwargs):
+    def create_object(self, data, view_kwargs):
         """Create an object
 
         :param dict data: the data validated by marshmallow
@@ -45,15 +47,15 @@ def create_object(self, data, **view_kwargs):
         """
         raise NotImplementedError
 
-    def get_object(self, **view_kwargs):
+    def get_object(self, view_kwargs):
         """Retrieve an object
 
         :params dict view_kwargs: kwargs from the resource view
         :return DeclarativeMeta: an object
         """
         raise NotImplementedError
 
-    def get_collection(self, qs, **view_kwargs):
+    def get_collection(self, qs, view_kwargs):
         """Retrieve a collection of objects
 
         :param QueryStringManager qs: a querystring manager to retrieve information from url
@@ -62,7 +64,7 @@ def get_collection(self, qs, **view_kwargs):
         """
         raise NotImplementedError
 
-    def update_object(self, obj, data, **view_kwargs):
+    def update_object(self, obj, data, view_kwargs):
         """Update an object
 
         :param DeclarativeMeta obj: an object
@@ -72,73 +74,73 @@ def update_object(self, obj, data, **view_kwargs):
         """
         raise NotImplementedError
 
-    def delete_object(self, obj, **view_kwargs):
+    def delete_object(self, obj, view_kwargs):
         """Delete an item through the data layer
 
         :param DeclarativeMeta obj: an object
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def create_relationship(self, json_data, relationship_field, related_id_field, **view_kwargs):
+    def create_relationship(self, json_data, relationship_field, related_id_field, view_kwargs):
         """Create a relationship
 
         :param dict json_data: the request params
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         :return boolean: True if relationship have changed else False
         """
         raise NotImplementedError
 
-    def get_relationship(self, relationship_field, related_type_, related_id_field, **view_kwargs):
+    def get_relationship(self, relationship_field, related_type_, related_id_field, view_kwargs):
         """Get information about a relationship
 
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_type_: the related resource type
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         :return tuple: the object and related object(s)
         """
         raise NotImplementedError
 
-    def update_relationship(self, json_data, relationship_field, related_id_field, **view_kwargs):
+    def update_relationship(self, json_data, relationship_field, related_id_field, view_kwargs):
         """Update a relationship
 
         :param dict json_data: the request params
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         :return boolean: True if relationship have changed else False
         """
         raise NotImplementedError
 
-    def delete_relationship(self, json_data, relationship_field, related_id_field, **view_kwargs):
+    def delete_relationship(self, json_data, relationship_field, related_id_field, view_kwargs):
         """Delete a relationship
 
         :param dict json_data: the request params
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def query(self, **view_kwargs):
+    def query(self, view_kwargs):
         """Construct the base query to retrieve wanted data
 
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def before_create_object(self, data, **view_kwargs):
+    def before_create_object(self, data, view_kwargs):
         """Provide additional data before object creation
 
         :param dict data: the data validated by marshmallow
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def after_create_object(self, obj, data, **view_kwargs):
+    def after_create_object(self, obj, data, view_kwargs):
         """Provide additional data after object creation
 
         :param obj: an object from data layer
@@ -147,30 +149,30 @@ def after_create_object(self, obj, data, **view_kwargs):
         """
         raise NotImplementedError
 
-    def before_get_object(self, **view_kwargs):
+    def before_get_object(self, view_kwargs):
         """Make work before to retrieve an object
 
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def after_get_object(self, obj, **view_kwargs):
+    def after_get_object(self, obj, view_kwargs):
         """Make work after to retrieve an object
 
         :param obj: an object from data layer
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def before_get_collection(self, qs, **view_kwargs):
+    def before_get_collection(self, qs, view_kwargs):
         """Make work before to retrieve a collection of objects
 
         :param QueryStringManager qs: a querystring manager to retrieve information from url
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def after_get_collection(self, collection, qs, **view_kwargs):
+    def after_get_collection(self, collection, qs, view_kwargs):
         """Make work after to retrieve a collection of objects
 
         :param iterable collection: the collection of objects
@@ -179,7 +181,7 @@ def after_get_collection(self, collection, qs, **view_kwargs):
         """
         raise NotImplementedError
 
-    def before_update_object(self, obj, data, **view_kwargs):
+    def before_update_object(self, obj, data, view_kwargs):
         """Make checks or provide additional data before update object
 
         :param obj: an object from data layer
@@ -188,7 +190,7 @@ def before_update_object(self, obj, data, **view_kwargs):
         """
         raise NotImplementedError
 
-    def after_update_object(self, obj, data, **view_kwargs):
+    def after_update_object(self, obj, data, view_kwargs):
         """Make work after update object
 
         :param obj: an object from data layer
@@ -197,50 +199,50 @@ def after_update_object(self, obj, data, **view_kwargs):
         """
         raise NotImplementedError
 
-    def before_delete_object(self, obj, **view_kwargs):
+    def before_delete_object(self, obj, view_kwargs):
         """Make checks before delete object
 
         :param obj: an object from data layer
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def after_delete_object(self, obj, **view_kwargs):
+    def after_delete_object(self, obj, view_kwargs):
         """Make work after delete object
 
         :param obj: an object from data layer
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def before_create_relationship(self, json_data, relationship_field, related_id_field, **view_kwargs):
+    def before_create_relationship(self, json_data, relationship_field, related_id_field, view_kwargs):
         """Make work before to create a relationship
 
         :param dict json_data: the request params
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         :return boolean: True if relationship have changed else False
         """
         raise NotImplementedError
 
-    def after_create_relationship(self, obj, updated, json_data, relationship_field, related_id_field, **view_kwargs):
+    def after_create_relationship(self, obj, updated, json_data, relationship_field, related_id_field, view_kwargs):
         """Make work after to create a relationship
 
         :param obj: an object from data layer
         :param bool updated: True if object was updated else False
         :param dict json_data: the request params
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         :return boolean: True if relationship have changed else False
         """
         raise NotImplementedError
 
-    def before_get_relationship(self, relationship_field, related_type_, related_id_field, **view_kwargs):
+    def before_get_relationship(self, relationship_field, related_type_, related_id_field, view_kwargs):
         """Make work before to get information about a relationship
 
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_type_: the related resource type
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
@@ -249,60 +251,60 @@ def before_get_relationship(self, relationship_field, related_type_, related_id_
         raise NotImplementedError
 
     def after_get_relationship(self, obj, related_objects, relationship_field, related_type_, related_id_field,
-                               **view_kwargs):
+                               view_kwargs):
         """Make work after to get information about a relationship
 
         :param obj: an object from data layer
         :param iterable related_objects: related objects of the object
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_type_: the related resource type
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         :return tuple: the object and related object(s)
         """
         raise NotImplementedError
 
-    def before_update_relationship(self, json_data, relationship_field, related_id_field, **view_kwargs):
+    def before_update_relationship(self, json_data, relationship_field, related_id_field, view_kwargs):
         """Make work before to update a relationship
 
         :param dict json_data: the request params
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         :return boolean: True if relationship have changed else False
         """
         raise NotImplementedError
 
-    def after_update_relationship(self, obj, updated, json_data, relationship_field, related_id_field, **view_kwargs):
+    def after_update_relationship(self, obj, updated, json_data, relationship_field, related_id_field, view_kwargs):
         """Make work after to update a relationship
 
         :param obj: an object from data layer
         :param bool updated: True if object was updated else False
         :param dict json_data: the request params
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         :return boolean: True if relationship have changed else False
         """
         raise NotImplementedError
 
-    def before_delete_relationship(self, json_data, relationship_field, related_id_field, **view_kwargs):
+    def before_delete_relationship(self, json_data, relationship_field, related_id_field, view_kwargs):
         """Make work before to delete a relationship
 
         :param dict json_data: the request params
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         """
         raise NotImplementedError
 
-    def after_delete_relationship(self, obj, updated, json_data, relationship_field, related_id_field, **view_kwargs):
+    def after_delete_relationship(self, obj, updated, json_data, relationship_field, related_id_field, view_kwargs):
         """Make work after to delete a relationship
 
         :param obj: an object from data layer
         :param bool updated: True if object was updated else False
         :param dict json_data: the request params
-        :param str relationship_field: the model attribut used for relationship
+        :param str relationship_field: the model attribute used for relationship
         :param str related_id_field: the identifier field of the related model
         :param dict view_kwargs: kwargs from the resource view
         """

flask_rest_jsonapi/data_layers/base.py

@@ -3,7 +3,7 @@
 from sqlalchemy import and_, or_, not_
 
 from flask_rest_jsonapi.exceptions import InvalidFilters
-from flask_rest_jsonapi.schema import get_relationships
+from flask_rest_jsonapi.schema import get_relationships, get_model_field
 
 
 def create_filters(model, filter_info, resource):
@@ -68,7 +68,7 @@ def name(self):
             name = name.split('__')[0]
 
         if name not in self.schema._declared_fields:
-            raise InvalidFilters("{} has no attribut {}".format(self.schema.__name__, name))
+            raise InvalidFilters("{} has no attribute {}".format(self.schema.__name__, name))
 
         return name
 
@@ -109,13 +109,12 @@ def column(self):
         """
         field = self.name
 
-        if self.schema._declared_fields[field].attribute is not None:
-            field = self.schema._declared_fields[field].attribute
+        model_field = get_model_field(self.schema, field)
 
         try:
-            return getattr(self.model, field)
+            return getattr(self.model, model_field)
         except AttributeError:
-            raise InvalidFilters("{} has no attribute {} in a filter".format(self.model.__name__, field))
+            raise InvalidFilters("{} has no attribute {} in a filter".format(self.model.__name__, model_field))
 
     @property
     def operator(self):
@@ -153,14 +152,12 @@ def related_model(self):
         """
         relationship_field = self.name
 
-        if relationship_field not in get_relationships(self.schema):
-            raise InvalidFilters("{} has no relationship attribut {}".format(self.schema.__name__, relationship_field))
+        if relationship_field not in get_relationships(self.schema).values():
+            raise InvalidFilters("{} has no relationship attribute {}".format(self.schema.__name__, relationship_field))
 
-        if hasattr(self.resource, 'schema_to_model') and\
-                self.resource.schema_to_model.get(relationship_field) is not None:
-            relationship_field = self.resource.schema_to_model[relationship_field]
+        relationship_model_field = get_model_field(self.schema, relationship_field)
 
-        return getattr(self.model, relationship_field).property.mapper.class_
+        return getattr(self.model, relationship_model_field).property.mapper.class_
 
     @property
     def related_schema(self):
@@ -170,7 +167,7 @@ def related_schema(self):
         """
         relationship_field = self.name
 
-        if relationship_field not in get_relationships(self.schema):
-            raise InvalidFilters("{} has no relationship attribut {}".format(self.schema.__name__, relationship_field))
+        if relationship_field not in get_relationships(self.schema).values():
+            raise InvalidFilters("{} has no relationship attribute {}".format(self.schema.__name__, relationship_field))
 
         return self.schema._declared_fields[relationship_field].schema.__class__

flask_rest_jsonapi/data_layers/filtering/alchemy.py

@@ -32,10 +32,7 @@ def add_pagination_links(data, object_count, querystring, base_url):
         if last_page > 1:
             links['first'] = links['last'] = base_url
 
-            try:
-                del all_qs_args['page[number]']
-            except KeyError:
-                pass
+            all_qs_args.pop('page[number]', None)
 
             # compute first link
             if all_qs_args: