summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authormark hellewell <mark.hellewell@icloud.com>2013-07-25 22:48:22 +1000
committerTim Graham <timograham@gmail.com>2013-07-25 11:08:47 -0400
commitec6928be3430e5113a888da43a9b386f85add40b (patch)
treef2e5d9fbf6429fc1af0120c1b1f3fdfd98a73320 /docs/ref
parentd439f85bbfd9f86dd91e70498ba536394690d1ab (diff)
downloaddjango-ec6928be3430e5113a888da43a9b386f85add40b.tar.gz
[1.6.x] Fixed #18315 -- Documented QueryDict.popitem and QueryDict.pop
Thanks gcbirzan for the report. Backport of 8c9240222f from master
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/request-response.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt
index 7ca46dfe79..ebe4119b35 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)