Adicionar parâmetros ao URL fornecido em Python

Suponha que recebi um URL.
Ele já pode ter parâmetros GET (por exemplo http://example.com/search?q=question) ou pode não ter (por exemplo http://example.com/).

E agora eu preciso adicionar alguns parâmetros a ele, como {'lang':'en','tag':'python'}. No primeiro caso eu vou ter http://example.com/search?q=question&lang=en&tag=pythone no segundo - http://example.com/search?lang=en&tag=python.

Existe alguma maneira padrão de fazer isso?

Existem algumas peculiaridades nos módulos urllibe urlparse. Aqui está um exemplo de trabalho:

try:
    import urlparse
    from urllib import urlencode
except: # For Python 3
    import urllib.parse as urlparse
    from urllib.parse import urlencode

url = "http://stackoverflow.com/search?q=question"
params = {'lang':'en','tag':'python'}

url_parts = list(urlparse.urlparse(url))
query = dict(urlparse.parse_qsl(url_parts[4]))
query.update(params)

url_parts[4] = urlencode(query)

print(urlparse.urlunparse(url_parts))

ParseResult, O resultado de urlparse(), é somente leitura e precisamos convertê-lo para um listantes que possamos tentar modificar seus dados.

Por quê

Não fiquei satisfeito com todas as soluções desta página ( vamos lá, onde está a nossa coisa favorita de copiar e colar? ), Então escrevi as minhas com base nas respostas aqui. Ele tenta ser completo e mais pitônico. Eu adicionei um manipulador para valores dict e bool nos argumentos para ser mais amigável ao consumidor ( JS ), mas eles ainda são opcionais, você pode descartá-los.

Como funciona

Teste 1: Adicionando novos argumentos, manipulando matrizes e valores Bool:

url = 'http://stackoverflow.com/test'
new_params = {'answers': False, 'data': ['some','values']}

add_url_params(url, new_params) == \
    'http://stackoverflow.com/test?data=some&data=values&answers=false'

Teste 2: Reescrevendo argumentos existentes, manipulando valores DICT:

url = 'http://stackoverflow.com/test/?question=false'
new_params = {'question': {'__X__':'__Y__'}}

add_url_params(url, new_params) == \
    'http://stackoverflow.com/test/?question=%7B%22__X__%22%3A+%22__Y__%22%7D'

Falar é fácil. Mostre-me o código.

Código em si. Eu tentei descrevê-lo em detalhes:

from json import dumps

try:
    from urllib import urlencode, unquote
    from urlparse import urlparse, parse_qsl, ParseResult
except ImportError:
    # Python 3 fallback
    from urllib.parse import (
        urlencode, unquote, urlparse, parse_qsl, ParseResult
    )


def add_url_params(url, params):
    """ Add GET params to provided URL being aware of existing.

    :param url: string of target URL
    :param params: dict containing requested params to be added
    :return: string with updated URL

    >> url = 'http://stackoverflow.com/test?answers=true'
    >> new_params = {'answers': False, 'data': ['some','values']}
    >> add_url_params(url, new_params)
    'http://stackoverflow.com/test?data=some&data=values&answers=false'
    """
    # Unquoting URL first so we don't loose existing args
    url = unquote(url)
    # Extracting url info
    parsed_url = urlparse(url)
    # Extracting URL arguments from parsed URL
    get_args = parsed_url.query
    # Converting URL arguments to dict
    parsed_get_args = dict(parse_qsl(get_args))
    # Merging URL arguments dict with new params
    parsed_get_args.update(params)

    # Bool and Dict values should be converted to json-friendly values
    # you may throw this part away if you don't like it :)
    parsed_get_args.update(
        {k: dumps(v) for k, v in parsed_get_args.items()
         if isinstance(v, (bool, dict))}
    )

    # Converting URL argument to proper query string
    encoded_get_args = urlencode(parsed_get_args, doseq=True)
    # Creating new parsed result object based on provided with new
    # URL arguments. Same thing happens inside of urlparse.
    new_url = ParseResult(
        parsed_url.scheme, parsed_url.netloc, parsed_url.path,
        parsed_url.params, encoded_get_args, parsed_url.fragment
    ).geturl()

    return new_url

Esteja ciente de que pode haver alguns problemas. Se você encontrar um, entre em contato e faremos com que isso melhore.

Você deseja usar a codificação de URL se as seqüências de caracteres puderem ter dados arbitrários (por exemplo, caracteres como e comercial, barras, etc. precisarão ser codificados).

Confira urllib.urlencode:

>>> import urllib
>>> urllib.urlencode({'lang':'en','tag':'python'})
'lang=en&tag=python'

Em python3:

from urllib import parse
parse.urlencode({'lang':'en','tag':'python'})

Você também pode usar o módulo furl https://github.com/gruns/furl

>>> from furl import furl
>>> print furl('http://example.com/search?q=question').add({'lang':'en','tag':'python'}).url
http://example.com/search?q=question&lang=en&tag=python

Terceirize-o para a biblioteca de solicitações testadas em batalha .

É assim que eu vou fazer:

from requests.models import PreparedRequest
url = 'http://example.com/search?q=question'
params = {'lang':'en','tag':'python'}
req = PreparedRequest()
req.prepare_url(url, params)
print(req.url)

Se você estiver usando os pedidos lib :

import requests
...
params = {'tag': 'python'}
requests.get(url, params=params)

Sim: use urllib .

Dos exemplos na documentação:

>>> import urllib
>>> params = urllib.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0})
>>> f = urllib.urlopen("http://www.musi-cal.com/cgi-bin/query?%s" % params)
>>> print f.geturl() # Prints the final URL with parameters.
>>> print f.read() # Prints the contents

Com base nesta resposta, uma linha para casos simples (código Python 3):

from urllib.parse import urlparse, urlencode


url = "https://stackoverflow.com/search?q=question"
params = {'lang':'en','tag':'python'}

url += ('&' if urlparse(url).query else '?') + urlencode(params)

ou:

url += ('&', '?')[urlparse(url).query == ''] + urlencode(params)

Acho isso mais elegante do que as duas principais respostas:

from urllib.parse import urlencode, urlparse, parse_qs

def merge_url_query_params(url: str, additional_params: dict) -> str:
    url_components = urlparse(url)
    original_params = parse_qs(url_components.query)
    # Before Python 3.5 you could update original_params with 
    # additional_params, but here all the variables are immutable.
    merged_params = {**original_params, **additional_params}
    updated_query = urlencode(merged_params, doseq=True)
    # _replace() is how you can create a new NamedTuple with a changed field
    return url_components._replace(query=updated_query).geturl()

assert merge_url_query_params(
    'http://example.com/search?q=question',
    {'lang':'en','tag':'python'},
) == 'http://example.com/search?q=question&lang=en&tag=python'

As coisas mais importantes que não gosto nas respostas principais (elas são boas):

• Łukasz: ter que lembrar o índice no qual queryestá o componente da URL
• Sapphire64: a maneira muito detalhada de criar as atualizações ParseResult

O que é ruim na minha resposta é a dictmesclagem de aparência mágica usando a descompactação, mas eu prefiro isso a atualizar um dicionário já existente por causa do meu preconceito contra a mutabilidade.

Eu gostei da versão Łukasz, mas como as funções urllib e urllparse são um pouco difíceis de usar nesse caso, acho mais simples fazer algo assim:

params = urllib.urlencode(params)

if urlparse.urlparse(url)[4]:
    print url + '&' + params
else:
    print url + '?' + params

Use as várias urlparsefunções para separar o URL existente, urllib.urlencode()no dicionário combinado, e urlparse.urlunparse()reuni-lo novamente.

Ou apenas pegue o resultado urllib.urlencode()e concatene-o no URL de forma apropriada.

Ainda outra resposta:

def addGetParameters(url, newParams):
    (scheme, netloc, path, params, query, fragment) = urlparse.urlparse(url)
    queryList = urlparse.parse_qsl(query, keep_blank_values=True)
    for key in newParams:
        queryList.append((key, newParams[key]))
    return urlparse.urlunparse((scheme, netloc, path, params, urllib.urlencode(queryList), fragment))

Aqui está como eu o implementei.

import urllib

params = urllib.urlencode({'lang':'en','tag':'python'})
url = ''
if request.GET:
   url = request.url + '&' + params
else:
   url = request.url + '?' + params    

Funcionou como um encanto. No entanto, eu gostaria de ter uma maneira mais limpa de implementar isso.

Outra maneira de implementar o acima é colocá-lo em um método.

import urllib

def add_url_param(request, **params):
   new_url = ''
   _params = dict(**params)
   _params = urllib.urlencode(_params)

   if _params:
      if request.GET:
         new_url = request.url + '&' + _params
      else:
         new_url = request.url + '?' + _params
   else:
      new_url = request.url

   return new_ur

No python 2.5

import cgi
import urllib
import urlparse

def add_url_param(url, **params):
    n=3
    parts = list(urlparse.urlsplit(url))
    d = dict(cgi.parse_qsl(parts[n])) # use cgi.parse_qs for list values
    d.update(params)
    parts[n]=urllib.urlencode(d)
    return urlparse.urlunsplit(parts)

url = "http://stackoverflow.com/search?q=question"
add_url_param(url, lang='en') == "http://stackoverflow.com/search?q=question&lang=en"