urllib - QLGQ/learning-python GitHub Wiki

Introdution

首先来一个最简单的使用方法

import urllib
print urllib.urlopen('http://www.google.com').read()

urllib.urlopen(url[, data[, proxies]])：
创建一个表示远程url的类文件对象，然后像本地文件一样操作这个类文件对象来获取远程数据。参数url表示远程数据的路径，一般是网址；参数data表示以post方式提交到url的数据（玩过web的人应该知道提交数据的两种方式：post与get。如果你不清楚，也不必太在意，一般情况下很少用到这个参数）；参数proxies用于设置代理。urlopen返回一个类文件对象，它提供了如下方法：

read()，readline()，readlines()，fileno()，close()：这些方法的使用方式与文件对象完全一样；
info()：返回一个httplib.HTTPMessage对象，表示远程服务器返回的头信息；
getcode()：返回Http状态码，如果是http请求，200表示请求成功，404表示网址未找到；
geturl()：返回请求的url。

下面来扩充一下上面的例子，加深对urllib的印象：

google = urllib.urlopen('http://www.google.com')
print 'http header:/n', google.info()
print 'http status:', google.getcode()
print 'url:', google.geturl()
for line in google:    # 就像在操作本地文件
    print line,
google.close()

urllib.urlretrieve(url[, filename[, reporthook[, data]]])：
urlretrieve方法直接将远程数据下载到本地。参数filename指定了保存到本地的路径（如果未指定该参数，urllib会生成一个临时文件来保存数据）；参数reporthook是一个回调函数，当连接上服务器、以及相应的数据块传输完毕的时候会触发该回调。我们可以利用这个回调函数来显示当前的下载进度，下面的例子会展示。参数data指post到服务器的数据。该方法返回一个包含两个元素的元组（filename, headers），filename表示保存到本地的路径，header表示服务器的响应头。下面通过例子来演示一下这个方法的使用，这个例子将新浪首页的html抓取到本地，保存在D:/sina.html文件中，同时显示下载的进度。

def cbk(a, b, c):
    """回调函数
    @a:已经下载的模块
    @b:数据块的大小
    @c:远程文件的大小
    """
    per = 100.0 * a * b / c
    if per > 100:
        per = 100
    print '%.2f%%' % per

url = 'http://www.sina.com.cn'
local = 'd://sina.html'
urllib.urlretrieve(url, local, cbk)

上面介绍的两个方法是urllib中最常用的方法，这些方法在获取远程数据的时候，内部会使用URLopener或者FancyURLOpener类。作为urllib的使用者，我们很少会用到这两个类。

urllib中还提供了一些辅助方法，用于对url进行编码、解码。url中是不能出现一些特殊的符号的，有些符号有特殊的用途。我们知道以get方式提交数据的时候，会在url中添加key=value这样的字符串，所以在value中是不允许有'='，因此要对其进行编码；与此同时服务器接收到这些参数的时候，要进行解码，还原成原始的数据。这个时候，这些辅助方法会很有用：

urllib.quote(string[, safe])：对字符串进行编码。参数safe指定了不需要编码的字符;
urllib.unquote(string) ：对字符串进行解码；
urllib.quote_plus(string[,safe]) ：与urllib.quote类似，但这个方法用'+'来替换' '，而quote用'%20'来代替' '
urllib.unquote_plus(string) ：对字符串进行解码；
urllib.urlencode(query[, doseq])：将dict或者包含两个元素的元组列表转换成url参数。例如字典{'name': 'dark-bull', 'age': 200}将被转换为"name=dark-bull&age=200"
urllib.pathname2url(path)：将本地路径转换成url路径；
urllib.url2pathname(path)：将url路径转换成本地路径；

用一个例子来体验下这些方法：

data = 'name = ~a+3'    
    
data1 = urllib.quote(data)    
print data1 # result: name%20%3D%20%7Ea%2B3    
print urllib.unquote(data1) # result: name = ~a+3    
    
data2 = urllib.quote_plus(data)    
print data2 # result: name+%3D+%7Ea%2B3    
print urllib.unquote_plus(data2)    # result: name = ~a+3    
    
data3 = urllib.urlencode({ 'name': 'dark-bull', 'age': 200 })    
print data3 # result: age=200&name=dark-bull    
    
data4 = urllib.pathname2url(r'd:/a/b/c/23.php')    
print data4 # result: ///D|/a/b/c/23.php    
print urllib.url2pathname(data4)    # result: D:/a/b/c/23.php

# splittype('type:opaquestring') --> 'type', 'opaquestring'

# splithost('//host[:port]/path') --> 'host[:port]', '/path'

# splituser('user[:passwd]@host[:port]') --> 'user[:passwd]', 'host[:port]'
# splitpasswd('user:passwd') -> 'user', 'passwd'
# splitport('host:port') --> 'host', 'port'
# splitquery('/path?query') --> '/path', 'query'
# splittag('/path#tag') --> '/path', 'tag'
# splitattr('/path;attr1=value1;attr2=value2;...') ->
#   '/path', ['attr1=value1', 'attr2=value2', ...]
# splitvalue('attr=value') --> 'attr', 'value'

Reference

python模块学习——urllib