python-requests: order get parameters

Question

I am implementing a client library for a private HTTP-API using python requests. The API(which I don't control) expects the parameters to be in a certain order, but python-requests doesn't honor a sorted dict as parameter.

This is what i tried:

import requests from django.utils.datastructures import SortedDict  params = SortedDict() params['s'] = 'value1' params['f'] = 'value2'  requests.get('https://example.org/private_api', params=params) #performs request as https://example.org/private_api?f=value1&s=value2  

This is what I am trying to avoid:

requests.get('https://example.org?{0}'.format(urlencode(params))) 

Answer 1

The requests lib now supports this out-of-the-box: To get ordered parameters you use a sequence of two-valued tuples instead. This eliminates the additional requirement of OrderedDict.

payload = (('key1', 'value1'), ('key2', 'value2')) r = requests.get("http://httpbin.org/get", params=payload) 

Demo:

>>> import requests >>> requests.__version__ 1.2.3 >>> payload = (('key1', 'value1'), ('key2', 'value2'), ('key3', 'value3')) >>> r = requests.get("http://httpbin.org/get", params=payload) >>> print r.json()['url'] http://httpbin.org/get?key1=value1&key2=value2&key3=value3 

Answer 2

Currently requests doesn't allow to do this as you wish. This is of course shortcoming that will be fixed. However as params parameter can take not only dictionary but bytes as well you should be able to do something in between:

from collections import OrderedDict from urllib import urlencode import requests  params = OrderedDict([('first', 1), ('second', 2), ('third', 3)]) requests.get('https://example.org/private_api', params=urlencode(params)) 

This doesn't work as I see due to bug in line 85 of models.py: self.params = dict(params or []. I raised this problem in issue Wrong handling of params given as bytes object