-
• {% trans "Hide" %} »
+
• {% trans "Hide" %} »
{% for panel in toolbar.panels %} {% include "debug_toolbar/includes/panel_button.html" %} {% endfor %}

- diff --git a/debug_toolbar/utils.py b/debug_toolbar/utils.py index 30344dd03..cc5d74477 100644 --- a/debug_toolbar/utils.py +++ b/debug_toolbar/utils.py @@ -210,6 +210,16 @@ def getframeinfo(frame, context=1): return (filename, lineno, frame.f_code.co_name, lines, index) +def get_sorted_request_variable(variable): + """ + Get a sorted list of variables from the request data. + """ + if isinstance(variable, dict): + return [(k, variable.get(k)) for k in sorted(variable)] + else: + return [(k, variable.getlist(k)) for k in sorted(variable)] + + def get_stack(context=1): """ Get a list of records for a frame and all higher (calling) frames. diff --git a/docs/changes.rst b/docs/changes.rst index 76a4fe1b4..b2c8a3709 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -1,6 +1,23 @@ Change log ========== +3.2 (2020-12-03) +---------------- + +* Moved CI to GitHub Actions: https://github.com/jazzband/django-debug-toolbar/actions +* Stopped crashing when ``request.GET`` and ``request.POST`` are + dictionaries instead of ``QueryDict`` instances. This isn't a valid + use of Django but django-debug-toolbar shouldn't crash anyway. +* Fixed a crash in the history panel when sending a JSON POST request + with invalid JSON. +* Added missing signals to the signals panel by default. +* Documented how to avoid CORS errors now that we're using JavaScript + modules. +* Verified support for Python 3.9. +* Added a ``css`` and a ``js`` template block to + ``debug_toolbar/base.html`` to allow overriding CSS and JS. + + 3.2a1 (2020-10-19) ------------------ @@ -10,8 +27,7 @@ Change log * Continued refactoring the HTML and CSS code for simplicity, continued improving the use of semantic HTML. * Stopped caring about prehistoric browsers for good. Started splitting - up the JavaScript code to take advantage of - JavaScript modules. + up the JavaScript code to take advantage of JavaScript modules. * Continued removing unused CSS. * Started running Selenium tests on Travis CI. * Added a system check which prevents using django-debug-toolbar without @@ -29,6 +45,7 @@ Change log * Started spellchecking the documentation. * Removed calls to the deprecated ``request.is_ajax()`` method. These calls were unnecessary now that most endpoints return JSON anyway. +* Removed support for Python 3.5. 3.1 (2020-09-21) diff --git a/docs/conf.py b/docs/conf.py index 59d886ada..e29866a82 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,7 @@ copyright = copyright.format(datetime.date.today().year) # The full version, including alpha/beta/rc tags -release = "3.2a1" +release = "3.2" # -- General configuration --------------------------------------------------- diff --git a/docs/configuration.rst b/docs/configuration.rst index a1618b44f..39b648183 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -221,6 +221,40 @@ Panel options The SQL panel highlights queries that took more that this amount of time, in milliseconds, to execute. +* ``ENABLE_SQL_TOKEN_GROUPING`` + + Default: ``True`` + + Panel: SQL + + Controls SQL token grouping. + + Token grouping allows pretty print of similar tokens, + like aligned indentation for every selected field. + + When set to ``True``, it might cause render slowdowns + when a view make long SQL textual queries. + + **Without grouping**:: + + SELECT "auth_user"."id", "auth_user"."password", "auth_user"."last_login", "auth_user"."is_superuser", "auth_user"."username", "auth_user"."first_name", "auth_user"."last_name" + FROM "auth_user" + WHERE "auth_user"."username" = '''test_username''' + LIMIT 21 + + **With grouping**:: + + SELECT "auth_user"."id", + "auth_user"."password", + "auth_user"."last_login", + "auth_user"."is_superuser", + "auth_user"."username", + "auth_user"."first_name", + "auth_user"."last_name", + FROM "auth_user" + WHERE "auth_user"."username" = '''test_username''' + LIMIT 21 + Here's what a slightly customized toolbar configuration might look like:: # This example is unlikely to be appropriate for your project. diff --git a/example/README.rst b/example/README.rst index 2b9f41fc2..94c09f8e5 100644 --- a/example/README.rst +++ b/example/README.rst @@ -41,8 +41,8 @@ Run the Django development server:: $ python example/manage.py runserver -You can change the database used by specifying the ``DJANGO_DATABASE_ENGINE`` +You can change the database used by specifying the ``DB_BACKEND`` environment variable:: - $ DJANGO_DATABASE_ENGINE=postgresql python example/manage.py migrate - $ DJANGO_DATABASE_ENGINE=postgresql python example/manage.py runserver + $ DB_BACKEND=postgresql python example/manage.py migrate + $ DB_BACKEND=postgresql python example/manage.py runserver diff --git a/example/settings.py b/example/settings.py index b04d283c8..dae1b591e 100644 --- a/example/settings.py +++ b/example/settings.py @@ -71,8 +71,8 @@ } } -# To use another database, set the DJANGO_DATABASE_ENGINE environment variable. -if os.environ.get("DJANGO_DATABASE_ENGINE", "").lower() == "postgresql": +# To use another database, set the DB_BACKEND environment variable. +if os.environ.get("DB_BACKEND", "").lower() == "postgresql": # % su postgres # % createuser debug_toolbar # % createdb debug_toolbar -O debug_toolbar @@ -83,7 +83,7 @@ "USER": "debug_toolbar", } } -if os.environ.get("DJANGO_DATABASE_ENGINE", "").lower() == "mysql": +if os.environ.get("DB_BACKEND", "").lower() == "mysql": # % mysql # mysql> CREATE DATABASE debug_toolbar; # mysql> CREATE USER 'debug_toolbar'@'localhost'; diff --git a/setup.cfg b/setup.cfg index 0f95e92dc..93a297b31 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = django-debug-toolbar -version = 3.2a1 +version = 3.2 description = A configurable set of panels that display various debug information about the current request/response. long_description = file: README.rst author = Rob Hudson @@ -22,14 +22,14 @@ classifiers = Programming Language :: Python Programming Language :: Python :: 3 Programming Language :: Python :: 3 :: Only - Programming Language :: Python :: 3.5 Programming Language :: Python :: 3.6 Programming Language :: Python :: 3.7 Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 Topic :: Software Development :: Libraries :: Python Modules [options] -python_requires = >=3.5 +python_requires = >=3.6 install_requires = Django >= 2.2 sqlparse >= 0.2.0 diff --git a/tests/panels/test_history.py b/tests/panels/test_history.py index 6d65b6e9d..6d592bccf 100644 --- a/tests/panels/test_history.py +++ b/tests/panels/test_history.py @@ -30,7 +30,8 @@ def test_post(self): def test_post_json(self): for data, expected_stats_data in ( ({"foo": "bar"}, {"foo": "bar"}), - ("", {}), + ("", {}), # Empty JSON + ("'", {}), # Invalid JSON ): with self.subTest(data=data): self.request = rf.post( diff --git a/tests/panels/test_request.py b/tests/panels/test_request.py index 9e7f487fb..54410b81d 100644 --- a/tests/panels/test_request.py +++ b/tests/panels/test_request.py @@ -1,3 +1,5 @@ +from django.http import QueryDict + from ..base import BaseTestCase @@ -30,3 +32,55 @@ def test_insert_content(self): content = self.panel.content self.assertIn("nôt åscíì", content) self.assertValidHTML(content) + + def test_query_dict_for_request_in_method_get(self): + """ + Test verifies the correctness of the statistics generation method + in the case when the GET request is class QueryDict + """ + self.request.GET = QueryDict("foo=bar") + response = self.panel.process_request(self.request) + self.panel.generate_stats(self.request, response) + # ensure the panel GET request data is processed correctly. + content = self.panel.content + self.assertIn("foo", content) + self.assertIn("bar", content) + + def test_dict_for_request_in_method_get(self): + """ + Test verifies the correctness of the statistics generation method + in the case when the GET request is class Dict + """ + self.request.GET = {"foo": "bar"} + response = self.panel.process_request(self.request) + self.panel.generate_stats(self.request, response) + # ensure the panel GET request data is processed correctly. + content = self.panel.content + self.assertIn("foo", content) + self.assertIn("bar", content) + + def test_query_dict_for_request_in_method_post(self): + """ + Test verifies the correctness of the statistics generation method + in the case when the POST request is class QueryDict + """ + self.request.POST = QueryDict("foo=bar") + response = self.panel.process_request(self.request) + self.panel.generate_stats(self.request, response) + # ensure the panel POST request data is processed correctly. + content = self.panel.content + self.assertIn("foo", content) + self.assertIn("bar", content) + + def test_dict_for_request_in_method_post(self): + """ + Test verifies the correctness of the statistics generation method + in the case when the POST request is class Dict + """ + self.request.POST = {"foo": "bar"} + response = self.panel.process_request(self.request) + self.panel.generate_stats(self.request, response) + # ensure the panel POST request data is processed correctly. + content = self.panel.content + self.assertIn("foo", content) + self.assertIn("bar", content) diff --git a/tests/settings.py b/tests/settings.py index dbbbb79b2..0808c2e8c 100644 --- a/tests/settings.py +++ b/tests/settings.py @@ -79,17 +79,19 @@ "second": {"BACKEND": "django.core.cache.backends.locmem.LocMemCache"}, } -if os.environ.get("DJANGO_DATABASE_ENGINE") == "postgresql": - DATABASES = { - "default": {"ENGINE": "django.db.backends.postgresql", "NAME": "debug-toolbar"} - } -elif os.environ.get("DJANGO_DATABASE_ENGINE") == "mysql": - DATABASES = { - "default": {"ENGINE": "django.db.backends.mysql", "NAME": "debug_toolbar"} - } -else: - DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3"}} - +DATABASES = { + "default": { + "ENGINE": "django.db.backends.%s" % os.getenv("DB_BACKEND"), + "NAME": os.getenv("DB_NAME"), + "USER": os.getenv("DB_USER"), + "PASSWORD": os.getenv("DB_PASSWORD"), + "HOST": os.getenv("DB_HOST", ""), + "PORT": os.getenv("DB_PORT", ""), + "TEST": { + "USER": "default_test", + }, + }, +} # Debug Toolbar configuration diff --git a/tests/test_integration.py b/tests/test_integration.py index 1ab053ab9..8c28f6c6e 100644 --- a/tests/test_integration.py +++ b/tests/test_integration.py @@ -350,7 +350,7 @@ class DebugToolbarLiveTestCase(StaticLiveServerTestCase): def setUpClass(cls): super().setUpClass() options = Options() - options.headless = bool(os.environ.get("TRAVIS")) + options.headless = bool(os.environ.get("CI")) cls.selenium = webdriver.Firefox(options=options) @classmethod diff --git a/tox.ini b/tox.ini index b8b930b1c..1b0e2842f 100644 --- a/tox.ini +++ b/tox.ini @@ -3,10 +3,10 @@ envlist = docs style readme - py{35,36,37,38}-dj22-sqlite - py{36,37,38}-dj{30,31}-sqlite - py{36,37,38}-djmaster-sqlite - py{37,38}-dj{22,30,31}-{postgresql,mariadb} + py{36,37,38,39}-dj22-sqlite + py{36,37,38,39}-dj{30,31}-sqlite + py{36,37,38,39}-djmaster-sqlite + py{37,38,39}-dj{22,30,31}-{postgresql,mysql} [testenv] deps = @@ -15,7 +15,7 @@ deps = dj31: Django==3.1.* sqlite: mock postgresql: psycopg2-binary - mariadb: mysqlclient + mysql: mysqlclient djmaster: https://github.com/django/django/archive/master.tar.gz coverage Jinja2 @@ -23,13 +23,18 @@ deps = selenium sqlparse passenv= - TRAVIS - DJANGO_SELENIUM_TESTS + CI + DB_BACKEND + DB_NAME + DB_USER + DB_PASSWORD + DB_HOST + DB_PORT + GITHUB_* setenv = PYTHONPATH = {toxinidir} PYTHONWARNINGS = d - postgresql: DJANGO_DATABASE_ENGINE = postgresql - mariadb: DJANGO_DATABASE_ENGINE = mysql + py38-dj31-postgresql: DJANGO_SELENIUM_TESTS = true whitelist_externals = make pip_pre = True commands = make coverage TEST_ARGS='{posargs:tests}' @@ -41,7 +46,6 @@ deps = sphinxcontrib-spelling [testenv:style] -basepython = python3 commands = make style_check deps = black>=19.10b0 @@ -50,7 +54,19 @@ deps = skip_install = true [testenv:readme] -basepython = python3 commands = python setup.py check -r -s deps = readme_renderer skip_install = true + +[gh-actions] +python = + 3.6: py36 + 3.7: py37 + 3.8: py38 + 3.9: py39 + +[gh-actions:env] +DB_BACKEND = + mysql: mysql + postgresql: postgresql + sqlite3: sqlite