| Name | drf-flex-query JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | https://github.com/Oper18/drf-flex-query |
| Summary | Flexible related objects quering for Django REST Framework. |
| upload_time | 2024-02-14 20:23:59 |
| maintainer | |
| docs_url | None |
| author | Grigorii Novikov |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 Oper18 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
django
rest
api
query
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
DRF Flex Query
######
DRF Flex Query is an extension for [Django REST Framework](https://django-rest-framework.org/) which helps to speed up retrieving related objects of main query.
Using separate related objects query and python dicts instead of left joins in SQL and quering every related object using this package could speed up request with multiple related objects in several times.
Installation
============
You can install DRF Flex Query by:
.. code-block:: bash
pip install drf-flex-query
Basic Usage
===========
Extend basic model
-------------
First of all you need to implement custom database manager by inherit from drf-flex-query manager:
.. code-block:: python
from flex_query.models import Model
class MyModel(Model):
pass
class MyQueringModel(Model):
main_model = models.ForeignKey(MyModel, null=True)
class MyRelatedModel(Model):
main_model = models.ForeignKey(MyModel, null=True)
or you could add additional manager without changing relationship:
.. code-block:: python
from django.db.models import Model
from flex_query.manager import FlexQueryDBManager
class MyModel(Model):
flex_query_objects = FlexQueryDBManager()
Create serializer
=================
Define serializers for object and all relations:
.. code-block:: python
from rest_framework.serializers import ModelSerializer
from flex_query.serializers import FlexQueryBaseModelSerializer, RelatedAttrSerializerInfo
class MainModelSerializer(ModelSerializer):
class Meta:
model = MyModel
fields = "__all__"
class MyRelatedModelSerializer(ModelSerializer):
class Meta:
model = MyRelatedModel
fields = "__all__"
class MySerializer(FlexQueryBaseModelSerializer):
main_model = serializers.SerializerMethodField("get_main_model")
related_models = serializers.SerializerMethodField("get_related_models")
class Meta:
model = MyQueringModel
fields = ("id", "main_model", "related_models")
custom_attrs = ("main_models", "related_models")
related_attrs_mapping = {
"get_main_model": RelatedAttrSerializerInfo(
dependency_name="main_models",
dep_field_map_name="main_model_id",
serializer_class=MainModelSerializer,
many=False,
forward_kwargs=(),
),
"get_related_models": RelatedAttrSerializerInfo(
dependency_name="related_models",
dep_field_map_name="main_model_id",
serializer_class=MyRelatedModelSerializer,
many=True,
forward_kwargs=(),
),
}
Define API View
===============
For setup APIView configuration you need to define list of related queries and rules for its quering
.. code-block:: python
from flex_query.generics import FlexQueryRelationsGenericAPIView
class MyAPIView(FlexQueryRelationsGenericAPIView):
queryset = MyQueringModel.objects.all()
serializer_class = MySerializer
related_queries_data = [
QueryFilterInfo(
query_arg_name="main_models",
attribute="main_model_id",
query_model=MyModel,
filter_field="pk",
mapping_rules={1: KeyMapping(name="id", obj_type="object")},
),
QueryFilterInfo(
query_arg_name="related_models",
attribute="id",
query_model=MyRelatedModel,
filter_field="pk",
mapping_rules={1: KeyMapping(name="main_model_id", obj_type="list")},
source_query="main_models",
),
]
Raw data
{
"_id": null,
"home_page": "https://github.com/Oper18/drf-flex-query",
"name": "drf-flex-query",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "django,rest,api,query",
"author": "Grigorii Novikov",
"author_email": "Grigorii Novikov <genovikov93@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0b/35/76b3b4b216294ddb13767934553eee07e4c3c7e2da086fe1fd0fd28e6e55/drf-flex-query-1.0.0.tar.gz",
"platform": null,
"description": "DRF Flex Query\n######\n\nDRF Flex Query is an extension for [Django REST Framework](https://django-rest-framework.org/) which helps to speed up retrieving related objects of main query.\n\nUsing separate related objects query and python dicts instead of left joins in SQL and quering every related object using this package could speed up request with multiple related objects in several times.\n\nInstallation\n============\n\nYou can install DRF Flex Query by:\n\n.. code-block:: bash\n\n pip install drf-flex-query\n\n\nBasic Usage\n===========\n\nExtend basic model\n-------------\n\nFirst of all you need to implement custom database manager by inherit from drf-flex-query manager:\n\n.. code-block:: python\n\n from flex_query.models import Model\n\n class MyModel(Model):\n pass\n\n class MyQueringModel(Model):\n main_model = models.ForeignKey(MyModel, null=True)\n\n class MyRelatedModel(Model):\n main_model = models.ForeignKey(MyModel, null=True)\n\n\nor you could add additional manager without changing relationship:\n\n.. code-block:: python\n\n from django.db.models import Model\n\n from flex_query.manager import FlexQueryDBManager\n\n class MyModel(Model):\n flex_query_objects = FlexQueryDBManager()\n\n\nCreate serializer\n=================\n\nDefine serializers for object and all relations:\n\n.. code-block:: python\n\n from rest_framework.serializers import ModelSerializer\n\n from flex_query.serializers import FlexQueryBaseModelSerializer, RelatedAttrSerializerInfo\n\n class MainModelSerializer(ModelSerializer):\n\n class Meta:\n model = MyModel\n fields = \"__all__\"\n \n class MyRelatedModelSerializer(ModelSerializer):\n\n class Meta:\n model = MyRelatedModel\n fields = \"__all__\"\n\n class MySerializer(FlexQueryBaseModelSerializer):\n main_model = serializers.SerializerMethodField(\"get_main_model\")\n related_models = serializers.SerializerMethodField(\"get_related_models\")\n \n class Meta:\n model = MyQueringModel\n fields = (\"id\", \"main_model\", \"related_models\")\n custom_attrs = (\"main_models\", \"related_models\")\n related_attrs_mapping = {\n \"get_main_model\": RelatedAttrSerializerInfo(\n dependency_name=\"main_models\",\n dep_field_map_name=\"main_model_id\",\n serializer_class=MainModelSerializer,\n many=False,\n forward_kwargs=(),\n ),\n \"get_related_models\": RelatedAttrSerializerInfo(\n dependency_name=\"related_models\",\n dep_field_map_name=\"main_model_id\",\n serializer_class=MyRelatedModelSerializer,\n many=True,\n forward_kwargs=(),\n ),\n }\n\n\nDefine API View\n===============\n\nFor setup APIView configuration you need to define list of related queries and rules for its quering\n\n.. code-block:: python\n\n from flex_query.generics import FlexQueryRelationsGenericAPIView\n\n\n class MyAPIView(FlexQueryRelationsGenericAPIView):\n queryset = MyQueringModel.objects.all()\n serializer_class = MySerializer\n related_queries_data = [\n QueryFilterInfo(\n query_arg_name=\"main_models\",\n attribute=\"main_model_id\",\n query_model=MyModel,\n filter_field=\"pk\",\n mapping_rules={1: KeyMapping(name=\"id\", obj_type=\"object\")},\n ),\n QueryFilterInfo(\n query_arg_name=\"related_models\",\n attribute=\"id\",\n query_model=MyRelatedModel,\n filter_field=\"pk\",\n mapping_rules={1: KeyMapping(name=\"main_model_id\", obj_type=\"list\")},\n source_query=\"main_models\",\n ),\n ]\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Oper18 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Flexible related objects quering for Django REST Framework.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Oper18/drf-flex-query",
"Issues": "https://github.com/Oper18/drf-flex-query/issues"
},
"split_keywords": [
"django",
"rest",
"api",
"query"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e422f13a0ac2e751081967345697380b04f5dd9ec50628ce15c4b461a2121e37",
"md5": "8ae1b953cd265a526967bbb6280225f5",
"sha256": "1cb03be06390e253083e5ff7a77401cf1b4f42341ba996297e3d87f8ae452594"
},
"downloads": -1,
"filename": "drf_flex_query-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ae1b953cd265a526967bbb6280225f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8417,
"upload_time": "2024-02-14T20:23:57",
"upload_time_iso_8601": "2024-02-14T20:23:57.543530Z",
"url": "https://files.pythonhosted.org/packages/e4/22/f13a0ac2e751081967345697380b04f5dd9ec50628ce15c4b461a2121e37/drf_flex_query-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b3576b3b4b216294ddb13767934553eee07e4c3c7e2da086fe1fd0fd28e6e55",
"md5": "03437d5b624fabad21e31e735c7d3a4a",
"sha256": "ebc833872e198d9005f2635d02a6e05f9eab50f877163ab9a130ee9deda2e9ea"
},
"downloads": -1,
"filename": "drf-flex-query-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "03437d5b624fabad21e31e735c7d3a4a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7024,
"upload_time": "2024-02-14T20:23:59",
"upload_time_iso_8601": "2024-02-14T20:23:59.320706Z",
"url": "https://files.pythonhosted.org/packages/0b/35/76b3b4b216294ddb13767934553eee07e4c3c7e2da086fe1fd0fd28e6e55/drf-flex-query-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 20:23:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Oper18",
"github_project": "drf-flex-query",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "drf-flex-query"
}
