معرفی شرکت ها
django-dump-die-0.1.5
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
A Django app to add Laravel/Symfony-like dump and die functionality.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | django-dump-die-0.1.5 |
| نام | django-dump-die |
| نسخه کتابخانه | 0.1.5 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | David Barnes, Brandon Rodriguez |
| ایمیل نویسنده | David Barnes <barnesdavidj@gmail.com>, Brandon Rodriguez <brodriguez8774@gmail.com> |
| آدرس صفحه اصلی | https://github.com/DJBarnes/django-dump-die |
| آدرس اینترنتی | https://pypi.org/project/django-dump-die/ |
| مجوز | MIT License Copyright (c) 2021 David Barnes 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. |
Django Dump & Die
============================
[](https://django-dump-die.readthedocs.io/en/latest/?badge=latest)
[](https://img.shields.io/pypi/v/django-dump-die?color=blue)
[](https://img.shields.io/badge/python-%3E%3D3.7-brightgreen)
[](https://img.shields.io/badge/django-%3E%3D3-brightgreen)
[](https://img.shields.io/github/license/DJBarnes/django-dump-die)
Django-Dump-Die is a [Django](https://www.djangoproject.com/) app that
provides a couple of debug tools, in the form of built-in methods
`dump` and `dd`. These allow sending details about a variable to the
browser for inspection.
Dumped variables are presented in an easy to read and
fully expandable / collapsible tree. You can easily understand complex objects
and the results of django queries with a simple call to either method.
When `dump` and/or `dd` are called, dump die will intercept the page
response and replace the contents of the response with detailed information
about the corresponding variables passed for inspection.
The entire concept is heavily based on the dump die functionality that comes
with Php's [Laravel](https://laravel.com/)
and [Symfony](https://symfony.com/) frameworks.
Full documentation on [ReadTheDocs](https://django-dump-die.readthedocs.io/en/latest/).
## Quickstart
1. Install the Django App via Pypi.
```shell
python -m pip install django-dump-die
```
<br>
2. Add the corresponding app to your Django ``settings.py`` file:
```python
INSTALLED_APPS = [
'django_dump_die',
...
]
```
<br>
3. Add the corresponding middleware to your Django ``settings.py`` file:
```python
MIDDLEWARE = [
'django_dump_die.middleware.DumpAndDieMiddleware',
...
]
```
4. Ensure that you have **DEBUG** set to ``True`` in your Django ``settings.py`` file:
```python
DEBUG = True
```
---
:information_source: **NOTE**
Neither the `dump` command nor the `dd` command will do anything if **DEBUG** is not set to `True`.
With that said, this is a tool for debugging. You should not include this package
in production nor should you ever have **DEBUG** set to `True` in production.
---
5. From a file that is part of the request / response cycle such as a Django
View in `views.py`, make a call to dd sending it the contents of a variable
to inspect.
**views.py**
```python
def my_awesome_view(request):
dd(request)
```
## Usage
The middleware is where most of this package's heavy lifting happens.
By having the middleware installed, you can run ``dump(<variable>)`` and/or
``dd(<variable>)`` in any file that is part of the request response cycle,
and it will run the dump logic. No importing or extra logic is required.
Each ``dump(<variable>)`` command will add the passed object to an internal
list that will be dumped either when a ``dd(<variable>)`` is used, or if the
entirety of the request finishes. You can have as many ``dump(<variable>)``
statements as you want leading up to an optional ``dd(<variable>)``.
If you make a call to ``dd(<variable>)``, execution will immediately stop
and all dumped objects (including the the one sent to dd) will be output.
If you do not make a call to ``dd(<variable>)`` and only use
``dump(<variable>)`` statements, the request will continue processing until
it is time to return the response. At this point, Django-Dump-Die will
intercept and replace the response with the data that has been dumped thus
far.
---
:information_source: **NOTE**
Because dump die uses middleware to internally handle keeping track of
what to dump and then actually dumping the data to the browser, any
call to ``dump`` or ``dd`` must be done in a file that will be processed
during the request response cycle. Most commonly this will be a
``views.py`` file, but could also be utils called from a view.
Attempting to ``dump`` or ``dd`` from a console command will not work.
---
<br>
Example:
```python
# Sample classes for output.
class EmptyClass:
"""Empty Class."""
pass
class SomeClass:
"""Some Class."""
SAMPLE_CONST = 41
def __init__(self, *args, **kwargs):
self.my_number = 32
self.my_string = 'A super cool string'
self.works = True
self.nothing = None
self.bytes = bytes('My Bytes', 'utf-8')
self.list_o_stuff = ['A', 'B', 'C']
self.sample_set = {'A', 'B', 'C'}
self.sample_tuple = ('A', 12, True)
self.empty_class = EmptyClass()
self.empty_class_dup = self.empty_class
def do_work(self):
"""Do some work"""
return True
# Example Usage
empty_class = EmptyClass()
some_class = SomeClass()
dump('Simple String')
dump(empty_class)
dd(some_class)
```
<br>
---
:information_source: **NOTE**
Most editors will give a red error squiggle for the dd command.
This is intentional, and the command will still run. This is because this
command is meant to be used for debugging, and is not meant to stay
long-term. The red squiggle helps identify it as something that should be
removed before any actual commits.
---
### Usage & Parameters
For further documentation on usage and parameters, see
[ReadTheDocs/Usage](https://django-dump-die.readthedocs.io/en/latest/usage.html)
## Configuration
The package has a few available configuration options and settings, which are
documented at
[ReadTheDocs/Configuration](https://django-dump-die.readthedocs.io/en/latest/configuration.html)
نیازمندی
| مقدار | نام |
|---|---|
| >=3.0.0 | django |
| - | black |
| - | coverage |
| - | pylint |
| - | pylint-django |
| - | doc8 |
| - | esbonio |
| - | pip-tools |
| - | rstcheck |
| - | sphinx |
| - | sphinx-autobuild |
| - | sphinx-rtd-theme |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7 | Python |
نحوه نصب
نصب پکیج whl django-dump-die-0.1.5:
pip install django-dump-die-0.1.5.whl
نصب پکیج tar.gz django-dump-die-0.1.5:
pip install django-dump-die-0.1.5.tar.gz