diff options
| author | mark hellewell <mark.hellewell@icloud.com> | 2013-07-25 22:48:22 +1000 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-07-25 11:09:25 -0400 |
| commit | f3a961f009afe4f1be4a5bb6d5c37c98c30fed41 (patch) | |
| tree | 62b3c6b4d3d6f17d43a1c1e89548a68b69c9fd10 | |
| parent | eda39fe704b1b76a94f44b49949660bef2827ed2 (diff) | |
[1.4.x] Fixed #18315 -- Documented QueryDict.popitem and QueryDict.pop
Thanks gcbirzan for the report.
Backport of 8c9240222f from master
| -rw-r--r-- | docs/ref/request-response.txt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt index d435822a8d..e3cc4de62b 100644 --- a/docs/ref/request-response.txt +++ b/docs/ref/request-response.txt @@ -492,6 +492,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() .. versionadded:: 1.4 |
