django-query-capture
Overview
Django Query Capture can check the query situation at a glance, notice slow queries, and notice where N+1 occurs.
Some reasons you might want to use django-query-capture:
- It can be used to simply check queries in a specific block.
- It supports Django Middleware, Context Manager, and Decorator.
- When you use Context Manager, you can get real-time query data.
- You can see where the query occurs.
- Inefficient queries can be found in the test code.
- It is easy to customize by simply changing the table shape, changing the color, and selecting and setting the desired output.
- It supports customization that allows you to decorate the output freely from the beginning.
- Fully Documented
- It supports Type hint everywhere.
Simple Usage
- Just add it to Middleware without any other settings, and it will be output whenever a query occurs.
MIDDLEWARE = [
...,
"django_query_capture.middleware.QueryCaptureMiddleware",
]
- Use in function-based views. or just function
from django_query_capture import query_capture
@query_capture()
def my_view(request):
pass
- Use in class-based views.
from django.utils.decorators import method_decorator
from django.views.generic import TemplateView
from django_query_capture import query_capture
@method_decorator(query_capture, name='dispatch')
class AboutView(TemplateView):
pass
- Use it as a context.
When used as Context, you can check the query in real time.
from django_query_capture import query_capture
from tests.news.models import Reporter
@query_capture()
def run_something():
with query_capture() as capture:
Reporter.objects.create(full_name=f"target-1")
print(len(capture.captured_queries)) # console: 1
Reporter.objects.create(full_name=f"target-2")
print(len(capture.captured_queries)) # console: 2
- Use in test
Test code can capture inefficient queries through the AssertInefficientQuery Util.
from django.test import TestCase
from django_query_capture.test_utils import AssertInefficientQuery
class AssertInefficientQueryTests(TestCase):
def test_assert_inefficient_query(self):
with AssertInefficientQuery(num=19):
self.client.get('/api/reporter') # desire threshold count 19 but, /api/reporter duplicate query: 20, so raise error
Installation
pip install -U django-query-capture
or install with Poetry
poetry add django-query-capture
Full Documentation
Extension documentation is found here: https://ashekr.github.io/django-query-capture/.
🛡
License
This project is licensed under the terms of the MIT license. See LICENSE for more details.
Credits 
This project was generated with python-package-template
20 Aug 30, 2022
4 Nov 18, 2021
2.1k Dec 30, 2022
837 Dec 29, 2022
68 Oct 19, 2022
8 Oct 28, 2022
2 Sep 21, 2022
1.2k Jan 5, 2023
31 Aug 9, 2022
139 Dec 5, 2022
3 Aug 8, 2021
8 Jun 27, 2022
18 Sep 9, 2022
504 Jan 4, 2023
167 Nov 10, 2022
1.6k Jan 6, 2023
5 Nov 24, 2022
6 Aug 2, 2022
11 Dec 6, 2022