From 500b182d1780f9c435f4320035cad5681164d969 Mon Sep 17 00:00:00 2001 From: Stefan Wojcik Date: Sat, 10 Dec 2016 20:09:19 -0500 Subject: [PATCH] deprecate explain's format param --- mongoengine/queryset/base.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/mongoengine/queryset/base.py b/mongoengine/queryset/base.py index 1a575327..3ee978b8 100644 --- a/mongoengine/queryset/base.py +++ b/mongoengine/queryset/base.py @@ -977,8 +977,15 @@ class BaseQuerySet(object): :param format: format the plan before returning it """ plan = self._cursor.explain() + + # TODO remove this option completely - it's useless. If somebody + # wants to pretty-print the output, they easily can. if format: + msg = ('"format" param of BaseQuerySet.explain has been ' + 'deprecated and will be removed in future versions.') + warnings.warn(msg, DeprecationWarning) plan = pprint.pformat(plan) + return plan # DEPRECATED. Has no more impact on PyMongo 3+