天天看點

python urllib2詳解及執行個體

urllib2是Python的一個擷取URLs(Uniform Resource Locators)的元件。他以urlopen函數的形式提供了一個非常簡單的接口,

這是具有利用不同協定擷取URLs的能力,他同樣提供了一個比較複雜的接口來處理一般情況,例如:基礎驗證,cookies,代理和其他。

它們通過handlers和openers的對象提供。

urllib2支援擷取不同格式的URLs(在URL的":"前定義的字串,例如:"ftp"是"ftp:python.ort/"的字首),它們利用它們相關網絡協定(例如FTP,HTTP)

進行擷取。這篇教程關注最廣泛的應用--HTTP。

對于簡單的應用,urlopen是非常容易使用的。但當你在打開HTTP的URLs時遇到錯誤或異常,你将需要一些超文本傳輸協定(HTTP)的了解。

最權威的HTTP文檔當然是RFC 2616(http://rfc.net/rfc2616.html)。這是一個技術文檔,是以并不易于閱讀。這篇HOWTO教程的目的是展現如何使用urllib2,

并提供足夠的HTTP細節來幫助你了解。他并不是urllib2的文檔說明,而是起一個輔助作用。

擷取 URLs

最簡單的使用urllib2将如下所示

1

2

3

import

urllib2 

response 

=

urllib2.urlopen(

'http://python.org/'

html 

=

response.read()

urllib2的很多應用就是那麼簡單(記住,除了"http:",URL同樣可以使用"ftp:","file:"等等來替代)。但這篇文章是教授HTTP的更複雜的應用。

HTTP是基于請求和應答機制的--用戶端提出請求,服務端提供應答。urllib2用一個Request對象來映射你提出的HTTP請求,在它最簡單的使用形式中你将用你要請求的

位址建立一個Request對象,通過調用urlopen并傳入Request對象,将傳回一個相關請求response對象,這個應答對象如同一個檔案對象,是以你可以在Response中調用.read()。

4

import

urllib2 

req 

=

urllib2.Request(

'http://www.xxxx.com'

response 

=

urllib2.urlopen(req) 

the_page 

=

response.read()

記得urllib2使用相同的接口處理所有的URL頭。例如你可以像下面那樣建立一個ftp請求。

req = urllib2.Request('ftp://example.com/')

在HTTP請求時,允許你做額外的兩件事。首先是你能夠發送data表單資料,其次你能夠傳送額外的關于資料或發送本身的資訊("metadata")到伺服器,此資料作為HTTP的"headers"來發送。

接下來讓我們看看這些如何發送的吧。

Data資料

有時候你希望發送一些資料到URL(通常URL與CGI[通用網關接口]腳本,或其他WEB應用程式挂接)。在HTTP中,這個經常使用熟知的POST請求發送。這個通常在你送出一個HTML表單時由你的浏覽器來做。

并不是所有的POSTs都來源于表單,你能夠使用POST送出任意的資料到你自己的程式。一般的HTML表單,data需要編碼成标準形式。然後做為data參數傳到Request對象。編碼工作使用urllib的函數而非urllib2。

5

6

7

8

9

10

import

urllib 

import

urllib2 

url 

=

'http://www.xxxx.com'

values 

=

{

'name'

'Michael Foord'

'location'

'pythontab'

'language'

'Python'

data 

=

urllib.urlencode(values) 

req 

=

urllib2.Request(url, data) 

response 

=

urllib2.urlopen(req) 

the_page 

=

response.read()

記住有時需要别的編碼(例如從HTML上傳檔案--看http://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13 HTML Specification, Form Submission的詳細說明)。

如ugoni沒有傳送data參數,urllib2使用GET方式的請求。GET和POST請求的不同之處是POST請求通常有"副作用",它們會由于某種途徑改變系統狀态(例如送出成堆垃圾到你的門口)。

盡管HTTP标準說的很清楚POSTs通常會産生副作用,GET請求不會産生副作用,但沒有什麼可以阻止GET請求産生副作用,同樣POST請求也可能不産生副作用。Data同樣可以通過在Get請求

的URL本身上面編碼來傳送。

可看如下例子

11

12

>>> 

import

urllib2 

>>> 

import

urllib 

>>> data 

=

{} 

>>> data[

'name'

=

'Somebody Here'

>>> data[

'location'

=

'pythontab'

>>> data[

'language'

=

'Python'

>>> url_values 

=

urllib.urlencode(data) 

>>> 

print

url_values 

name

=

blueelwang

+

Here&language

=

Python&location

=

pythontab 

>>> url 

=

'http://www.xxx.com'

>>> full_url 

=

url 

+

'?'

+

url_values 

>>> data 

=

urllib2.

open

(full_url)

Headers

我們将在這裡讨論特定的HTTP頭,來說明怎樣添加headers到你的HTTP請求。

有一些站點不喜歡被程式(非人為通路)通路,或者發送不同版本的内容到不同的浏覽器。預設的urllib2把自己作為“Python-urllib/x.y”(x和y是Python主版本和次版本号,例如Python-urllib/2.5),

這個身份可能會讓站點迷惑,或者幹脆不工作。浏覽器确認自己身份是通過User-Agent頭,當你建立了一個請求對象,你可以給他一個包含頭資料的字典。下面的例子發送跟上面一樣的内容,但把自身

模拟成Internet Explorer。

13

import

urllib 

import

urllib2 

url 

=

'http://www.xxx.com'

user_agent 

=

'Mozilla/4.0 (compatible; MSIE 5.5; Windows NT)'

values 

=

{

'name'

'Michael Foord'

'location'

'pythontab'

'language'

'Python'

headers 

=

'User-Agent'

: user_agent } 

data 

=

urllib.urlencode(values) 

req 

=

urllib2.Request(url, data, headers) 

response 

=

urllib2.urlopen(req) 

the_page 

=

response.read()

response應答對象同樣有兩個很有用的方法。看下面的節info and geturl,我們将看到當發生錯誤時會發生什麼。

Handle Exceptions處理異常

當urlopen不能夠處理一個response時,産生urlError(不過通常的Python APIs異常如ValueError,TypeError等也會同時産生)。

HTTPError是urlError的子類,通常在特定HTTP URLs中産生。

URLError

通常,URLError在沒有網絡連接配接(沒有路由到特定伺服器),或者伺服器不存在的情況下産生。這種情況下,異常同樣會帶有"reason"屬性,它是一個tuple,包含了一個錯誤号和一個錯誤資訊。

例如

>>> req 

=

urllib2.Request(

'http://www.xxx.com'

>>> 

try

: urllib2.urlopen(req) 

>>> 

except

URLError, e: 

>>>    

print

e.reason 

>>>

(4, 'getaddrinfo failed') 

HTTPError

伺服器上每一個HTTP 應答對象response包含一個數字"狀态碼"。有時狀态碼指出伺服器無法完成請求。預設的處理器會為你處理一部分這種應答(例如:假如response是一個"重定向",需要用戶端從别的位址擷取文檔

,urllib2将為你處理)。其他不能處理的,urlopen會産生一個HTTPError。典型的錯誤包含"404"(頁面無法找到),"403"(請求禁止),和"401"(帶驗證請求)。

請看RFC 2616 第十節有所有的HTTP錯誤碼

HTTPError執行個體産生後會有一個整型'code'屬性,是伺服器發送的相關錯誤号。

Error Codes錯誤碼

因為預設的處理器處理了重定向(300以外号碼),并且100-299範圍的号碼訓示成功,是以你隻能看到400-599的錯誤号碼。

BaseHTTPServer.BaseHTTPRequestHandler.response是一個很有用的應答号碼字典,顯示了RFC 2616使用的所有的應答号。這裡為了友善重新展示該字典。(譯者略)

當一個錯誤号産生後,伺服器傳回一個HTTP錯誤号,和一個錯誤頁面。你可以使用HTTPError執行個體作為頁面傳回的應答對象response。這表示和錯誤屬性一樣,它同樣包含了read,geturl,和info方法。

>>> req 

=

urllib2.Request(

'http://www.xxx.org/fish.html'

>>> 

try

>>>     urllib2.urlopen(req) 

>>> 

except

URLError, e: 

>>>     

print

e.code 

>>>     

print

e.read() 

>>>

404 

<!DOCTYPE html PUBLIC 

"-//W3C//DTD HTML 4.01 Transitional//EN"

"http://www.w3.org/TR/html4/loose.dtd"

<?xml-stylesheet href=

"./css/ht2html.css"

type

=

"text/css"

?> 

<html><

head

><title>Error 404: File Not Found<

/title

...... etc...

Wrapping it Up包裝

是以如果你想為HTTPError或URLError做準備,将有兩個基本的辦法。我則比較喜歡第二種。

第一個:

from

urllib2 

import

Request, urlopen, URLError, HTTPError 

req 

=

Request(someurl) 

try

response 

=

urlopen(req) 

except

HTTPError, e: 

print

'The server couldn/'

t fulfill the request.' 

print

'Error code: '

, e.code 

except

URLError, e: 

print

'We failed to reach a server.'

print

'Reason: '

, e.reason 

else

# everything is fine

注意:except HTTPError 必須在第一個,否則except URLError将同樣接受到HTTPError。 

第二個:

from

urllib2 

import

Request, urlopen, URLError 

req 

=

Request(someurl) 

try

response 

=

urlopen(req) 

except

URLError, e: 

if

hasattr

(e, 

'reason'

): 

print

'We failed to reach a server.'

print

'Reason: '

, e.reason 

elif

hasattr

(e, 

'code'

): 

print

'The server couldn/'

t fulfill the request.' 

print

'Error code: '

, e.code 

else

# everything is fine

info and geturl

urlopen傳回的應答對象response(或者HTTPError執行個體)有兩個很有用的方法info()和geturl()

geturl -- 這個傳回擷取的真實的URL,這個很有用,因為urlopen(或者opener對象使用的)或許

會有重定向。擷取的URL或許跟請求URL不同。

info -- 這個傳回對象的字典對象,該字典描述了擷取的頁面情況。通常是伺服器發送的特定頭headers。目前是httplib.HTTPMessage 執行個體。

經典的headers包含"Content-length","Content-type",和其他。檢視Quick Reference to HTTP Headers(http://www.cs.tut.fi/~jkorpela/http.html)

擷取有用的HTTP頭清單,以及它們的解釋意義。

Openers和Handlers

當你擷取一個URL你使用一個opener(一個urllib2.OpenerDirector的執行個體,urllib2.OpenerDirector可能名字可能有點讓人混淆。)正常情況下,我們

使用預設opener -- 通過urlopen,但你能夠建立個性的openers,Openers使用處理器handlers,所有的“繁重”工作由handlers處理。每個handlers知道

如何通過特定協定打開URLs,或者如何處理URL打開時的各個方面,例如HTTP重定向或者HTTP cookies。

如果你希望用特定處理器擷取URLs你會想建立一個openers,例如擷取一個能處理cookie的opener,或者擷取一個不重定向的opener。

要建立一個 opener,執行個體化一個OpenerDirector,然後調用不斷調用.add_handler(some_handler_instance).

同樣,可以使用build_opener,這是一個更加友善的函數,用來建立opener對象,他隻需要一次函數調用。

build_opener預設添加幾個處理器,但提供快捷的方法來添加或更新預設處理器。

其他的處理器handlers你或許會希望處理代理,驗證,和其他常用但有點特殊的情況。

install_opener 用來建立(全局)預設opener。這個表示調用urlopen将使用你安裝的opener。

Opener對象有一個open方法,該方法可以像urlopen函數那樣直接用來擷取urls:通常不必調用install_opener,除了為了友善。

Basic Authentication 基本驗證

為了展示建立和安裝一個handler,我們将使用HTTPBasicAuthHandler,為了更加細節的描述本主題--包含一個基礎驗證的工作原理。

請看Basic Authentication Tutorial(http://www.voidspace.org.uk/python/articles/authentication.shtml)

當需要基礎驗證時,伺服器發送一個header(401錯誤碼) 請求驗證。這個指定了scheme 和一個‘realm’,看起來像這樣:Www-authenticate: SCHEME realm="REALM".

Www-authenticate: Basic realm="cPanel Users"

用戶端必須使用新的請求,并在請求頭裡包含正确的姓名和密碼。這是“基礎驗證”,為了簡化這個過程,我們可以建立一個HTTPBasicAuthHandler的執行個體,并讓opener使用這個

handler。

HTTPBasicAuthHandler使用一個密碼管理的對象來處理URLs和realms來映射使用者名和密碼。如果你知道realm(從伺服器發送來的頭裡)是什麼,你就能使用HTTPPasswordMgr。

通常人們不關心realm是什麼。那樣的話,就能用友善的HTTPPasswordMgrWithDefaultRealm。這個将在你為URL指定一個預設的使用者名和密碼。這将在你為特定realm提供一個其他組合時

得到提供。我們通過給realm參數指定None提供給add_password來訓示這種情況。

最高層次的URL是第一個要求驗證的URL。你傳給.add_password()更深層次的URLs将同樣合适。

14

# 建立一個密碼管理者 

password_mgr 

=

urllib2.HTTPPasswordMgrWithDefaultRealm() 

# 添加使用者名和密碼 

# 如果知道 realm, 我們可以使用他代替 ``None``. 

top_level_url 

=

"http://example.com/foo/"

password_mgr.add_password(

None

, top_level_url, username, password) 

handler 

=

urllib2.HTTPBasicAuthHandler(password_mgr) 

# 建立 "opener" (OpenerDirector 執行個體) 

opener 

=

urllib2.build_opener(handler) 

# 使用 opener 擷取一個URL 

opener.

open

(a_url) 

# 安裝 opener. 

# 現在所有調用 urllib2.urlopen 将用我們的 opener. 

urllib2.install_opener(opener)

注意:以上的例子我們僅僅提供我們的HHTPBasicAuthHandler給build_opener。預設的openers有正常狀況的handlers--ProxyHandler,UnknownHandler,HTTPHandler,HTTPDefaultErrorHandler, HTTPRedirectHandler, FTPHandler, FileHandler, HTTPErrorProcessor。

top_level_url 實際上可以是完整URL(包含"http:",以及主機名及可選的端口号)例如:http://example.com/,也可以是一個“authority”(即主機名和可選的

包含端口号)例如:“example.com” or “example.com:8080”(後者包含了端口号)。權限驗證,如果遞交的話不能包含"使用者資訊"部分,例如:

“joe@password:example.com”是錯誤的。

Proxies代理urllib 将自動監測你的代理設定并使用他們。這個通過ProxyHandler這個在正常處理器鍊中的對象來處理。通常,那工作的很好。但有時不起作用

。其中一個方法便是安裝我們自己的代理處理器ProxyHandler,并不定義代理。這個跟使用Basic Authentication 處理器很相似。

>>> proxy_support 

=

urllib.request.ProxyHandler({}) 

>>> opener 

=

urllib.request.build_opener(proxy_support) 

>>> urllib.request.install_opener(opener)

注意:

此時urllib.request不支援通過代理擷取https位址。但,這個可以通過擴充urllib.request達到目的。

Sockets and Layers

Python支援擷取網絡資源是分層結構。urllib 使用http.client庫,再調用socket庫實作。

在Python2.3你可以指定socket的等待回應逾時時間。這個在需要擷取網頁的應用程式裡很有用。預設的socket模型沒有逾時和挂起。現在,socket逾時沒有暴露

給http.client或者urllib.request層。但你可以給所有的sockets設定全局的逾時。

不努力,誰會可憐你?