How to retrieve GET vars in python bottle app

Question

I'm trying to make a simple REST api using the Python bottle app. I'm facing a problem in retrieving the GET variables from the request global object. Any suggestions how to retrieve this from the GET request?

score 31 · Answer 1 · edited Apr 07 '20 at 19:15

31

They are stored in the request.query object.

http://bottlepy.org/docs/dev/tutorial.html#query-variables

It looks like you can also access them by treating the request.query attribute like a dictionary:

request.query['city']

So dict(request.query) would create a dictionary of all the query parameters.

As @mklauber notes, this will not work for multi-byte characters. It looks like the best method is:

my_dict = request.query.decode()

or:

dict(request.query.decode())

to have a dict instead of a <bottle.FormsDict object at 0x000000000391B...> object.

edited Apr 07 '20 at 19:15

Basj

29,668
65
241
451

answered Oct 23 '12 at 21:21

Nathan Villaescusa

15,601
2
49
54

3

Note, based on the docs, dict based access does not properly decode and renecode multi-byte characters. – mklauber Oct 23 '12 at 21:30
Ah, yeah it seems like `my_dict = request.query.decode()` is correct way. – Nathan Villaescusa Oct 23 '12 at 21:33

score 6 · Answer 2 · edited Apr 07 '20 at 19:16

6

If you want them all:

from urllib.parse import parse_qs

dict = parse_qs(request.query_string)

If you want one:

one = request.GET.get('one', '').strip()

edited Apr 07 '20 at 19:16

Basj

29,668
65
241
451

answered Oct 23 '12 at 21:26

f p

2,937
1
24
33

or you could just use `request.query.one` – jfs Oct 23 '12 at 21:31
1

@f p: it returns an empty string as well as your code. The only difference is that request.query.one is always a Unicode string. – jfs Oct 24 '12 at 11:36

score 3 · Answer 3 · answered Sep 02 '16 at 10:52

3

Can you try this please:

For this example : http://localhost:8080/command?param_name=param_value

In your code:

param_value = request.query.param_name

answered Sep 02 '16 at 10:52

madkabx

31
2

score 0 · Answer 4 · answered Jan 25 '19 at 16:45

from the docs

name = request.cookies.name
# is a shortcut for:
name = request.cookies.getunicode('name') # encoding='utf-8' (default)
# which basically does this:
try:
    name = request.cookies.get('name', '').decode('utf-8')
except UnicodeError:
    name = u''

So you might prefer using attribute accessor (request.query.variable_name) than request.query.get('variable_name')

Another point is you can use request.params.variable_name which works both for GET and POST methods, than having to swich request.query.variable_name or request.forms.variable_name depending GET/POST.

How to retrieve GET vars in python bottle app

4 Answers4