Document QueryDict.pop & popitem

[gcbirzan]

All the 'regular' operations on QueryDict return a single value, with a 'list' variant for returning a list of items. pop() pops a list, popitem() for just one item. This is not only inconsistent, but also not documented.

I'd prefer a solution that makes pop return a single item, vs mentioning it in the docs, but that breaks backwards compatibility.

[Aymeric Augustin]

I'm not convinced this is a sufficient reason to break backwards compatibility.

[anonymous]

This confused me to no end before I found out that doing QueryDictkey would not return the same value as QueryDict.pop('key'). This hardly seems like it conform with other uses of pop.

[_ado]

Given a QueryDict d={'k':['a', 'b'], 'v':['1', '2']} then d.get('k')='a', but d.pop('k')=['a', 'b']
I've been using pop() to get me the list of values. Changing the functionality would be a backwards compatibility problem, indeed. I recommend to update the documentation instead.

[Aymeric Augustin]

OK, let's fix this.

[Tim Graham <timograham@…>]

In fdef471912022dd5d65946fa6f86adbc3c60f630:

[1.5.x] Fixed #18315 -- Documented QueryDict.popitem and QueryDict.pop

Thanks gcbirzan for the report.

Backport of 8c9240222f from master

[Tim Graham <timograham@…>]

In f3a961f009afe4f1be4a5bb6d5c37c98c30fed41:

[1.4.x] Fixed #18315 -- Documented QueryDict.popitem and QueryDict.pop

Thanks gcbirzan for the report.

Backport of 8c9240222f from master

[Tim Graham <timograham@…>]

In ec6928be3430e5113a888da43a9b386f85add40b:

[1.6.x] Fixed #18315 -- Documented QueryDict.popitem and QueryDict.pop

Thanks gcbirzan for the report.

Backport of 8c9240222f from master

[Tim Graham <timograham@…>]

In 8c9240222fd882d9ae3819ff289989df1bcd05d7:

Fixed #18315 -- Documented QueryDict.popitem and QueryDict.pop

Thanks gcbirzan for the report.