Shows queries, detects N+1 in Django, Simple to use, Can Customize Console Result
Project description
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(self, 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-query-capture-0.2.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd0b29cee441bfff619d3ce9aa938eb3286ec9866aa61a3402275402002ec12e |
|
MD5 | c5a3b90cb7485984fad810e57031fc6c |
|
BLAKE2b-256 | 298a2c54960ba23a41b7f40aaa508b3f7f6974c748a45cdde57a095b4d6dfb72 |
Hashes for django_query_capture-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf7c2fa7e0172e79bc1752290c25d117538e07cee99754c78c09bfe20db68b3c |
|
MD5 | a55efe772ea6e29e53a15161a7f440c4 |
|
BLAKE2b-256 | 9e50a057f4cd7e890fc2ddcb06710dde811906c0c11becc6154c47b7ba9f1de7 |