summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWu Haotian <whtsky@gmail.com>2021-06-30 18:45:10 +0800
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2021-07-05 09:08:39 +0200
commitaba9c2de669dcc0278c7ffde7981be91801be00b (patch)
treed0bad959ff2d904f2f5da16c155daf48ee7bc8cf
parentb3b04ad2111f1e3eb0640cd5d51d4391655317ce (diff)
Fixed #32226 -- Fixed JSON format of QuerySet.explain() on PostgreSQL.
-rw-r--r--AUTHORS1
-rw-r--r--django/db/models/sql/compiler.py4
-rw-r--r--tests/queries/test_explain.py8
3 files changed, 12 insertions, 1 deletions
diff --git a/AUTHORS b/AUTHORS
index 6a2224110f..4e4dbc00fd 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -974,6 +974,7 @@ answer newbie questions, and generally made Django that much better:
Wilson Miner <wminer@gmail.com>
Wim Glenn <hey@wimglenn.com>
wojtek
+ Wu Haotian <whtsky@gmail.com>
Xavier Francisco <xavier.n.francisco@gmail.com>
Xia Kai <https://blog.xiaket.org/>
Yann Fouillat <gagaro42@gmail.com>
diff --git a/django/db/models/sql/compiler.py b/django/db/models/sql/compiler.py
index 136732bd0b..eda7fc3b5e 100644
--- a/django/db/models/sql/compiler.py
+++ b/django/db/models/sql/compiler.py
@@ -1,4 +1,5 @@
import collections
+import json
import re
from functools import partial
from itertools import chain
@@ -1250,9 +1251,10 @@ class SQLCompiler:
result = list(self.execute_sql())
# Some backends return 1 item tuples with strings, and others return
# tuples with integers and strings. Flatten them out into strings.
+ output_formatter = json.dumps if self.query.explain_format == 'json' else str
for row in result[0]:
if not isinstance(row, str):
- yield ' '.join(str(c) for c in row)
+ yield ' '.join(output_formatter(c) for c in row)
else:
yield row
diff --git a/tests/queries/test_explain.py b/tests/queries/test_explain.py
index 9bf7de687a..f1108c062f 100644
--- a/tests/queries/test_explain.py
+++ b/tests/queries/test_explain.py
@@ -1,3 +1,4 @@
+import json
import unittest
import xml.etree.ElementTree
@@ -39,6 +40,13 @@ class ExplainTests(TestCase):
self.fail(
f'QuerySet.explain() result is not valid XML: {e}'
)
+ elif format == 'json':
+ try:
+ json.loads(result)
+ except json.JSONDecodeError as e:
+ self.fail(
+ f'QuerySet.explain() result is not valid JSON: {e}'
+ )
@skipUnlessDBFeature('validates_explain_options')
def test_unknown_options(self):