How to add custom parameters to an URL query string with Python?

Question

I need to add custom parameters to an URL query string using Python

Example: This is the URL that the browser is fetching (GET):

/scr.cgi?q=1&ln=0

then some python commands are executed, and as a result I need to set following URL in the browser:

/scr.cgi?q=1&ln=0&SOMESTRING=1

Is there some standard approach?

I believe this is a duplicate of stackoverflow.com/q/2506379/2252728 — butla
– butla, Commented Sep 17, 2018 at 16:24

mattbasta · Accepted Answer · 2013-08-06 17:36:19Z

72

You can use urlsplit() and urlunsplit() to break apart and rebuild a URL, then use urlencode() on the parsed query string:

from urllib import urlencode
from urlparse import parse_qs, urlsplit, urlunsplit

def set_query_parameter(url, param_name, param_value):
    """Given a URL, set or replace a query parameter and return the
    modified URL.

    >>> set_query_parameter('http://example.com?foo=bar&biz=baz', 'foo', 'stuff')
    'http://example.com?foo=stuff&biz=baz'

    """
    scheme, netloc, path, query_string, fragment = urlsplit(url)
    query_params = parse_qs(query_string)

    query_params[param_name] = [param_value]
    new_query_string = urlencode(query_params, doseq=True)

    return urlunsplit((scheme, netloc, path, new_query_string, fragment))

Use it as follows:

>>> set_query_parameter("/scr.cgi?q=1&ln=0", "SOMESTRING", 1)
'/scr.cgi?q=1&ln=0&SOMESTRING=1'

edited Aug 6, 2013 at 17:36

mattbasta

13.8k10 gold badges51 silver badges70 bronze badges

answered Oct 15, 2012 at 14:05

Wilfred Hughes

31.4k15 gold badges149 silver badges202 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

mhouglum Over a year ago

Although this is several years old, I still feel the need to point this out since this question shows up on the front page of Google searches: If you care about order of parameters (which I assume you do, because of the doseq=True part), you should be using parse_qsl(), rather than parse_qs() -- the former returns a list of tuples, whereas the latter returns a dict, which is not guaranteed to preserve order when iterated over. Then, adding a param can be done via query_params.append((param_name, param_value)).

Ignacio Vazquez-Abrams · Accepted Answer · 2010-11-27 19:36:03Z

9

Use urlsplit() to extract the query string, parse_qsl() to parse it (or parse_qs() if you don't care about argument order), add the new argument, urlencode() to turn it back into a query string, urlunsplit() to fuse it back into a single URL, then redirect the client.

answered Nov 27, 2010 at 19:36

Ignacio Vazquez-Abrams

804k160 gold badges1.4k silver badges1.4k bronze badges

Comments

Mayank Jaiswal · Accepted Answer · 2016-12-02 08:58:44Z

2

You can use python's url manipulation library furl.

import furl
f =  furl.furl("/scr.cgi?q=1&ln=0")  
f.args['SOMESTRING'] = 1
print(f.url)

answered Dec 2, 2016 at 8:58

Mayank Jaiswal

13.2k7 gold badges42 silver badges41 bronze badges

1 Comment

commadelimited Over a year ago

It doesn't appear that furl is a built in module, so it would need to be installed first.

khachik · Accepted Answer · 2010-11-27 19:35:41Z

0

import urllib
url = "/scr.cgi?q=1&ln=0"
param = urllib.urlencode({'SOME&STRING':1})
url = url.endswith('&') and (url + param) or (url + '&' + param)

the docs

answered Nov 27, 2010 at 19:35

khachik

28.8k10 gold badges63 silver badges98 bronze badges

Collectives™ on Stack Overflow

How to add custom parameters to an URL query string with Python?

4 Answers 4

1 Comment

Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related