From ec6928be3430e5113a888da43a9b386f85add40b Mon Sep 17 00:00:00 2001 From: mark hellewell Date: Thu, 25 Jul 2013 22:48:22 +1000 Subject: [PATCH] [1.6.x] Fixed #18315 -- Documented QueryDict.popitem and QueryDict.pop Thanks gcbirzan for the report. Backport of 8c9240222f from master --- docs/ref/request-response.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt index 7ca46dfe790..ebe4119b352 100644 --- a/docs/ref/request-response.txt +++ b/docs/ref/request-response.txt @@ -495,6 +495,26 @@ In addition, ``QueryDict`` has the following methods: >>> q.lists() [(u'a', [u'1', u'2', u'3'])] +.. method:: QueryDict.pop(key) + + Returns a list of values for the given key and removes them from the + dictionary. Raises ``KeyError`` if the key does not exist. For example:: + + >>> q = QueryDict('a=1&a=2&a=3', mutable=True) + >>> q.pop('a') + [u'1', u'2', u'3'] + +.. method:: QueryDict.popitem() + + Removes an arbitrary member of the dictionary (since there's no concept + of ordering), and returns a two value tuple containing the key and a list + of all values for the key. Raises ``KeyError`` when called on an empty + dictionary. For example:: + + >>> q = QueryDict('a=1&a=2&a=3', mutable=True) + >>> q.popitem() + (u'a', [u'1', u'2', u'3']) + .. method:: QueryDict.dict() Returns ``dict`` representation of ``QueryDict``. For every (key, list)