利用 Python urllib 模組在 URL 附加網址參數

Python 內建 urllib.parse 模組可以幫助解析 URL 中的參數(或稱 query) ，如果要對 URL 中的參數進行新增或刪除，可以善用 urllib.parse 省去自己寫的麻煩。

p.s. python 2 中是 urllib.urlparse

首先看看 urllib.parse 如何運作，以下用 urllib.parse 中的 urlparse 解析 Google 搜尋網址：

>>> from urllib.parse import urlparse
>>> r = urlparse('https://www.google.com.tw/search?q=International%20Women%27s%20Day')
>>> r
ParseResult(scheme='https', netloc='www.google.com.tw', path='/search', params='', query='q=International%20Women%27s%20Day', fragment='')

可以看到 urlparse 解析網址後回傳一個 ParseResult ，其中 query 就是我們感興趣的部分。

接下來可以用 dir() 細看 ParseResult 有沒有什麼參數可以使用：

>>> dir(r)
['__add__', '__class__', '__contains__', '__delattr__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__getnewargs__', '__gt__', '__hash__', '__init__', '__iter__', '__le__', '__len__', '__lt__', '__module__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__rmul__', '__setattr__', '__sizeof__', '__slots__', '__str__', '__subclasshook__', '_asdict', '_encoded_counterpart', '_fields', '_hostinfo', '_make', '_replace', '_source', '_userinfo', 'count', 'encode', 'fragment', 'geturl', 'hostname', 'index', 'netloc', 'params', 'password', 'path', 'port', 'query', 'scheme', 'username']

發現有 query 屬性在 ParseResult 中，所以我們可以 r.query 取得 query 的值。

接著，把 query 轉成 dictionary 方便我們添加網址中的參數，可以使用 urllib.parse 中的 parse_qs 幫助我們達到目的：

>>> from urllib.parse import parse_qs
>>> d = parse_qs(r.query)
>>> d
{'q': ["International Women's Day"]}

parse_qs 成功解析出參數 q ，還順便貼心的進行解碼，把 query 中的 %20 換回空白以及 %27 換回單引號。

開始為網址添加參數吧，以下添加 2 個 GA 參數作為範例！

>>> d['utm_source'] = 'myapollo'
>>> d['utm_media'] = 'blog'

添加好之後，接著是把上述的 d 組合回新的 query 字串，可以使用 urlencode 把 dictionary 組合回 query 字串。

>>> from urllib.parse import urlencode
>>> new_query = urlencode(d)
>>> new_query
'utm_media=blog&q=%5B%22International+Women%27s+Day%22%5D&utm_source=myapollo'

最後使用 urllib.parse 中的 urlunparse 把 new_query 組合網址中，但是 urlunparse 只能接受 ParseResult 或者任何長度 6 的 iterable (tuple, list) 。其中 ParseResult 屬於 tuple ，所以無法更改任何資料，因此須將它轉為 list 後將 new_query 放回去，最後再用 urlunparse 組合起來。

>>> parts = list(r)
>>> parts[4] = new_query # query 在第 5 個
>>> urlunparse(parts)
'https://www.google.com.tw/search?utm_media=blog&q=%5B%22International+Women%27s+Day%22%5D&utm_source=myapollo&utm_media=blog'

See, 完成了！

透過 1 個簡單的需求，也同時學會 urlparse , urlunparse , parse_qs , urlencode 等方便的函數。

Reference #

https://docs.python.org/3/library/urllib.parse.html

python urllib