Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
bdc5b608
Commit
bdc5b608
authored
Mar 02, 2001
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Lots of organizational changes for consistency with the rest of the
documentation. Fix a few small markup nits.
parent
422cfff0
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
289 additions
and
225 deletions
+289
-225
Doc/lib/liburllib2.tex
Doc/lib/liburllib2.tex
+289
-225
No files found.
Doc/lib/liburllib2.tex
View file @
bdc5b608
...
@@ -2,7 +2,6 @@
...
@@ -2,7 +2,6 @@
extensible library for opening URLs
}
extensible library for opening URLs
}
\declaremodule
{
standard
}{
urllib2
}
\declaremodule
{
standard
}{
urllib2
}
\moduleauthor
{
Jeremy Hylton
}{
jhylton@users.sourceforge.net
}
\moduleauthor
{
Jeremy Hylton
}{
jhylton@users.sourceforge.net
}
\sectionauthor
{
Moshe Zadka
}{
moshez@users.sourceforge.net
}
\sectionauthor
{
Moshe Zadka
}{
moshez@users.sourceforge.net
}
...
@@ -10,7 +9,7 @@
...
@@ -10,7 +9,7 @@
protocols
}
protocols
}
The
\module
{
urllib2
}
module defines functions and classes which help
The
\module
{
urllib2
}
module defines functions and classes which help
in opening URLs (mostly HTTP) in a complex world -- basic and digest
in opening URLs (mostly HTTP) in a complex world --
-
basic and digest
authentication, redirections and more.
authentication, redirections and more.
The
\module
{
urllib2
}
module defines the following functions:
The
\module
{
urllib2
}
module defines the following functions:
...
@@ -18,21 +17,20 @@ The \module{urllib2} module defines the following functions:
...
@@ -18,21 +17,20 @@ The \module{urllib2} module defines the following functions:
\begin{funcdesc}
{
urlopen
}{
url
\optional
{
, data
}}
\begin{funcdesc}
{
urlopen
}{
url
\optional
{
, data
}}
Open the url
\var
{
url
}
, which can either a string or a
\class
{
Request
}
Open the url
\var
{
url
}
, which can either a string or a
\class
{
Request
}
object (currently the code checks that it really is a
\class
{
Request
}
object (currently the code checks that it really is a
\class
{
Request
}
instance, or an instance of a subclass of
\class
{
Request
}
.
instance, or an instance of a subclass of
\class
{
Request
}
)
.
\var
{
data
}
should be a string, which specifies additional data to
\var
{
data
}
should be a string, which specifies additional data to
send to the server. In HTTP requests, which are the only ones that
send to the server. In HTTP requests, which are the only ones that
support
\var
{
data
}
, it should be a buffer in the format of
support
\var
{
data
}
, it should be a buffer in the format of
\
cod
e
{
application/x-www-form-urlencoded
}
, for example one returned
\
mimetyp
e
{
application/x-www-form-urlencoded
}
, for example one returned
from
\function
{
urllib.urlencode
}
.
from
\function
{
urllib.urlencode
()
}
.
This function returns a file-like object with two additional methods:
This function returns a file-like object with two additional methods:
\begin{itemize}
\begin{itemize}
\item
\method
{
geturl()
}
--- return the URL of the resource retrieved
\item
\code
{
geturl()
}
--- return the URL of the resource retrieved
\item
\method
{
info()
}
--- return the meta-information of the page, as
\item
\code
{
info()
}
--- return the meta-information of the page, as
a dictionary-like object
a dictionary-like object
\end{itemize}
\end{itemize}
Raises
\exception
{
URLError
}
on errors.
Raises
\exception
{
URLError
}
on errors.
...
@@ -44,8 +42,7 @@ The code does not check for a real \class{OpenerDirector}, and any
...
@@ -44,8 +42,7 @@ The code does not check for a real \class{OpenerDirector}, and any
class with the appropriate interface will work.
class with the appropriate interface will work.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
build
_
opener
}{
\optional
{
handler
\optional
{
,
\begin{funcdesc}
{
build
_
opener
}{
\optional
{
handler,
\moreargs
}}
handler
\optional
{
, ...
}}}}
Return an
\class
{
OpenerDirector
}
instance, which chains the
Return an
\class
{
OpenerDirector
}
instance, which chains the
handlers in the order given.
\var
{
handler
}
s can be either instances
handlers in the order given.
\var
{
handler
}
s can be either instances
of
\class
{
BaseHandler
}
, or subclasses of
\class
{
BaseHandler
}
(in
of
\class
{
BaseHandler
}
, or subclasses of
\class
{
BaseHandler
}
(in
...
@@ -57,20 +54,23 @@ them, instances of them or subclasses of them:
...
@@ -57,20 +54,23 @@ them, instances of them or subclasses of them:
\code
{
ProxyHandler, UnknownHandler, HTTPHandler, HTTPDefaultErrorHandler,
\code
{
ProxyHandler, UnknownHandler, HTTPHandler, HTTPDefaultErrorHandler,
HTTPRedirectHandler, FTPHandler, FileHandler
}
HTTPRedirectHandler, FTPHandler, FileHandler
}
If the Python installation has SSL support (
\
code
{
socket.ssl
}
exists),
If the Python installation has SSL support (
\
function
{
socket.ssl()
}
\class
{
HTTPSHandler
}
will also be added.
exists),
\class
{
HTTPSHandler
}
will also be added.
\end{funcdesc}
\end{funcdesc}
The following exceptions are raised as appropriate:
\begin{excdesc}
{
URLError
}
\begin{excdesc}
{
URLError
}
The error handlers raise when they run into a problem. It is a
subclass
The error handlers raise when they run into a problem. It is a
of
\exception
{
IOError
}
.
subclass
of
\exception
{
IOError
}
.
\end{excdesc}
\end{excdesc}
\begin{excdesc}
{
HTTPError
}
\begin{excdesc}
{
HTTPError
}
A subclass of
\exception
{
URLError
}
, it can also function as a
A subclass of
\exception
{
URLError
}
, it can also function as a
non-exceptional file-like return value (the same thing that
\function
{
urlopen
}
non-exceptional file-like return value (the same thing that
returns). This is useful when handling exotic HTTP errors, such as
\function
{
urlopen()
}
returns). This is useful when handling exotic
requests for authentications
.
HTTP errors, such as requests for authentication
.
\end{excdesc}
\end{excdesc}
\begin{excdesc}
{
GopherError
}
\begin{excdesc}
{
GopherError
}
...
@@ -78,22 +78,138 @@ A subclass of \exception{URLError}, this is the error raised by the
...
@@ -78,22 +78,138 @@ A subclass of \exception{URLError}, this is the error raised by the
Gopher handler.
Gopher handler.
\end{excdesc}
\end{excdesc}
\begin{classdesc}
{
Request
}{
url
\optional
{
data,
\optional
{
, headers
}}}
The following classes are provided:
\begin{classdesc}
{
Request
}{
url
\optional
{
, data
\optional
{
, headers
}}}
This class is an abstraction of a URL request.
This class is an abstraction of a URL request.
\var
{
url
}
should be a string which is a valid URL. For descrtion
\var
{
url
}
should be a string which is a valid URL. For descrtion
of
\var
{
data
}
see the
\method
{
add
_
data
}
description.
of
\var
{
data
}
see the
\method
{
add
_
data
()
}
description.
\var
{
headers
}
should be a dictionary, and will be treated as if
\var
{
headers
}
should be a dictionary, and will be treated as if
\method
{
add
_
header
}
was called with each key and value as arguments.
\method
{
add
_
header
()
}
was called with each key and value as arguments.
\end{classdesc}
\end{classdesc}
\begin{classdesc}
{
OpenerDirector
}{}
The
\class
{
OpenerDirector
}
class opens URLs via
\class
{
BaseHandler
}
s
chained together. It manages the chaining of handlers, and recovery
from errors.
\end{classdesc}
\begin{classdesc}
{
BaseHandler
}{}
This is the base class for all registered handlers --- and handles only
the simple mechanics of registration.
\end{classdesc}
\begin{classdesc}
{
HTTPDefaultErrorHandler
}{}
A class which defines a default handler for HTTP error responses; all
responses are turned into
\exception
{
HTTPError
}
exceptions.
\end{classdesc}
\begin{classdesc}
{
HTTPRedirectHandler
}{}
A class to handle redirections.
\end{classdesc}
\begin{classdesc}
{
ProxyHandler
}{
\optional
{
proxies
}}
Cause requests to go through a proxy.
If
\var
{
proxies
}
is given, it must be a dictionary mapping
protocol names to URLs of proxies.
The default is to read the list of proxies from the environment
variables
\envvar
{
\var
{
protocol
}_
proxy
}
.
\end{classdesc}
\begin{classdesc}
{
HTTPPasswordMgr
}{}
Keep a database of
\code
{
(
\var
{
realm
}
,
\var
{
uri
}
) -> (
\var
{
user
}
,
\var
{
password
}
)
}
mappings.
\end{classdesc}
\begin{classdesc}
{
HTTPPasswordMgrWithDefaultRealm
}{}
Keep a database of
\code
{
(
\var
{
realm
}
,
\var
{
uri
}
) -> (
\var
{
user
}
,
\var
{
password
}
)
}
mappings.
A realm of
\code
{
None
}
is considered a catch-all realm, which is searched
if no other realm fits.
\end{classdesc}
\begin{classdesc}
{
AbstractBasicAuthHandler
}{
\optional
{
password
_
mgr
}}
This is a mixin class that helps with HTTP authentication, both
to the remote host and to a proxy.
\var
{
password
_
mgr
}
should be something that is compatible with
\class
{
HTTPPasswordMgr
}
--- supplies the documented interface above.
\end{classdesc}
\begin{classdesc}
{
HTTPBasicAuthHandler
}{
\optional
{
password
_
mgr
}}
Handle authentication with the remote host.
Valid
\var
{
password
_
mgr
}
, if given, are the same as for
\class
{
AbstractBasicAuthHandler
}
.
\end{classdesc}
\begin{classdesc}
{
ProxyBasicAuthHandler
}{
\optional
{
password
_
mgr
}}
Handle authentication with the proxy.
Valid
\var
{
password
_
mgr
}
, if given, are the same as for
\class
{
AbstractBasicAuthHandler
}
.
\end{classdesc}
\begin{classdesc}
{
AbstractDigestAuthHandler
}{
\optional
{
password
_
mgr
}}
This is a mixin class, that helps with HTTP authentication, both
to the remote host and to a proxy.
\var
{
password
_
mgr
}
should be something that is compatible with
\class
{
HTTPPasswordMgr
}
--- supplies the documented interface above.
\end{classdesc}
\begin{classdesc}
{
HTTPDigestAuthHandler
}{
\optional
{
password
_
mgr
}}
Handle authentication with the remote host.
Valid
\var
{
password
_
mgr
}
, if given, are the same as for
\class
{
AbstractBasicAuthHandler
}
.
\end{classdesc}
\begin{classdesc}
{
ProxyDigestAuthHandler
}{
\optional
{
password
_
mgr
}}
Handle authentication with the proxy.
\var
{
password
_
mgr
}
, if given, shoudl be the same as for
the constructor of
\class
{
AbstractDigestAuthHandler
}
.
\end{classdesc}
\begin{classdesc}
{
HTTPHandler
}{}
A class to handle opening of HTTP URLs.
\end{classdesc}
\begin{classdesc}
{
HTTPSHandler
}{}
A class to handle opening of HTTPS URLs.
\end{classdesc}
\begin{classdesc}
{
FileHandler
}{}
Open local files.
\end{classdesc}
\begin{classdesc}
{
FTPHandler
}{}
Open FTP URLs.
\end{classdesc}
\begin{classdesc}
{
CacheFTPHandler
}{}
Open FTP URLs, keeping a cache of open FTP connections to minimize
delays.
\end{classdesc}
\begin{classdesc}
{
GopherHandler
}{}
Open gopher URLs.
\end{classdesc}
\begin{classdesc}
{
UnknownHandler
}{}
A catch-all class to handle unknown URLs.
\end{classdesc}
\subsection
{
Request Objects
\label
{
request-objects
}}
The following methods describe all of
\class
{
Request
}
's public interface,
The following methods describe all of
\class
{
Request
}
's public interface,
and so all must be overridden in subclasses.
and so all must be overridden in subclasses.
\begin{methoddesc}
[Request]
{
add
_
data
}{
data
}
\begin{methoddesc}
[Request]
{
add
_
data
}{
data
}
Set the
\class
{
Request
}
data to
\var
{
data
}
is ignored
Set the
\class
{
Request
}
data to
\var
{
data
}
is ignored
by all handlers except HTTP handlers --- and there it should be an
by all handlers except HTTP handlers --- and there it should be an
\
cod
e
{
application/x-www-form-encoded
}
buffer, and will change the
\
mimetyp
e
{
application/x-www-form-encoded
}
buffer, and will change the
request to be
\code
{
POST
}
rather then
\code
{
GET
}
.
request to be
\code
{
POST
}
rather then
\code
{
GET
}
.
\end{methoddesc}
\end{methoddesc}
...
@@ -106,12 +222,12 @@ Return the instance's data.
...
@@ -106,12 +222,12 @@ Return the instance's data.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[Request]
{
add
_
header
}{
key, val
}
\begin{methoddesc}
[Request]
{
add
_
header
}{
key, val
}
Add another header to the request.
Headers
Add another header to the request.
Headers are currently ignored by
a
re currently ignored by all handlers except HTTP handlers, where they
a
ll handlers except HTTP handlers, where they are added to the list
are added to the list of headers sent to the server. Note that there
of headers sent to the server. Note that there cannot be more then
cannot be more then one header with the same name, and later calls
one header with the same name, and later calls will overwrite
will overwrite previous calls in case the
\var
{
key
}
collides. Currently,
previous calls in case the
\var
{
key
}
collides. Currently, this is
this is
no loss of HTTP functionality, since all headers which have meaning
no loss of HTTP functionality, since all headers which have meaning
when used more then once have a (header-specific) way of gaining the
when used more then once have a (header-specific) way of gaining the
same functionality using only one header.
same functionality using only one header.
\end{methoddesc}
\end{methoddesc}
...
@@ -121,7 +237,7 @@ Return the URL given in the constructor.
...
@@ -121,7 +237,7 @@ Return the URL given in the constructor.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[Request]
{
get
_
type
}{}
\begin{methoddesc}
[Request]
{
get
_
type
}{}
Return the type of the URL --- also known as the schem
a
.
Return the type of the URL --- also known as the schem
e
.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[Request]
{
get
_
host
}{}
\begin{methoddesc}
[Request]
{
get
_
host
}{}
...
@@ -134,28 +250,27 @@ the server.
...
@@ -134,28 +250,27 @@ the server.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[Request]
{
set
_
proxy
}{
host, type
}
\begin{methoddesc}
[Request]
{
set
_
proxy
}{
host, type
}
Make the request by connecting to a proxy server. The
\var
{
host
}
and
\var
{
type
}
Make the request by connecting to a proxy server. The
\var
{
host
}
and
will replace those of the instance, and the instance's selector will be
\var
{
type
}
will replace those of the instance, and the instance's
the original URL given in the constructor.
selector will be
the original URL given in the constructor.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
OpenerDirector
}{}
The
\class
{
OpenerDirector
}
class opens URLs via
\class
{
BaseHandler
}
s chained
\subsection
{
OpenerDirector Objects
\label
{
opener-director-objects
}}
together. It manages the chaining of handlers, and recovery from errors.
\
end{classdesc}
\
class
{
OpenerDirector
}
instances have the following methods:
\begin{methoddesc}
[OpenerDirector]
{
add
_
handler
}{
handler
}
\begin{methoddesc}
[OpenerDirector]
{
add
_
handler
}{
handler
}
\var
{
handler
}
should be an instance of
\class
{
BaseHandler
}
.
The following
\var
{
handler
}
should be an instance of
\class
{
BaseHandler
}
.
The
methods are searched, and added to the possible chains.
following
methods are searched, and added to the possible chains.
\begin{itemize}
\begin{itemize}
\item
\code
{{
\em
protocol
}_
open
}
--- signal that the handler knows how
\item
\method
{
\var
{
protocol
}_
open()
}
---
to open
{
\em
protocol
}
URLs.
signal that the handler knows how to open
\var
{
protocol
}
URLs.
\item
\code
{{
\em
protocol
}_
error
_{
\em
type
}}
-- signal that the handler
\item
\method
{
\var
{
protocol
}_
error
_
\var
{
type
}
()
}
---
knows how to handle
{
\em
type
}
signal that the handler knows how to handle
\var
{
type
}
errors from
errors from
{
\em
protocol
}
.
\var
{
protocol
}
.
\end{itemize}
\end{itemize}
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[OpenerDirector]
{
close
}{}
\begin{methoddesc}
[OpenerDirector]
{
close
}{}
...
@@ -171,23 +286,26 @@ the cycles.
...
@@ -171,23 +286,26 @@ the cycles.
Open the given
\var
{
url
}
. (which can be a request object or a string),
Open the given
\var
{
url
}
. (which can be a request object or a string),
optionally passing the given
\var
{
data
}
.
optionally passing the given
\var
{
data
}
.
Arguments, return values and exceptions raised are the same as those
Arguments, return values and exceptions raised are the same as those
of
\function
{
urlopen
}
(which simply calls the
\method
{
open()
}
method
of
\function
{
urlopen
()
}
(which simply calls the
\method
{
open()
}
method
on the default installed
\class
{
OpenerDirector
}
.
on the default installed
\class
{
OpenerDirector
}
.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[OpenerDirector]
{
error
}{
proto
\optional
{
, arg
\optional
{
, ...
}}}
\begin{methoddesc}
[OpenerDirector]
{
error
}{
proto
\optional
{
,
arg
\optional
{
,
\moreargs
}}}
Handle an error in a given protocol. The HTTP protocol is special cased to
Handle an error in a given protocol. The HTTP protocol is special cased to
use the code as the error. This will call the registered error handlers
use the code as the error. This will call the registered error handlers
for the given protocol with the given arguments (which are protocol specific).
for the given protocol with the given arguments (which are protocol specific).
Return values and exceptions raised are the same as those
Return values and exceptions raised are the same as those
of
\function
{
urlopen
}
.
of
\function
{
urlopen
()
}
.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
BaseHandler
}{}
This is the base class for all registered handlers --- and handles only
\subsection
{
BaseHandler Objects
\label
{
base-handler-objects
}}
the simple mechanics of registration.
\end{classdesc}
\class
{
BaseHandler
}
objects provide a couple of methods that are
directly useful, and others that are meant to be used by derived
classes. These are intended for direct use:
\begin{methoddesc}
[BaseHandler]
{
add
_
parent
}{
director
}
\begin{methoddesc}
[BaseHandler]
{
add
_
parent
}{
director
}
Add a director as parent.
Add a director as parent.
...
@@ -197,168 +315,136 @@ Add a director as parent.
...
@@ -197,168 +315,136 @@ Add a director as parent.
Remove any parents.
Remove any parents.
\end{methoddesc}
\end{methoddesc}
The following members and methods should be used only be classes
derived
The following members and methods should be used only be classes
from
\class
{
BaseHandler
}
:
derived
from
\class
{
BaseHandler
}
:
\begin{memberdesc}
[BaseHandler]
{
parent
}
\begin{memberdesc}
[BaseHandler]
{
parent
}
A valid
\class
{
OpenerDirector
}
, which can be used to open using a
different
A valid
\class
{
OpenerDirector
}
, which can be used to open using a
protocol, or handle errors.
different
protocol, or handle errors.
\end{memberdesc}
\end{memberdesc}
\begin{methoddesc}
[BaseHandler]
{
default
_
open
}{
req
}
\begin{methoddesc}
[BaseHandler]
{
default
_
open
}{
req
}
This method is
{
\em
not
}
defined in
\class
{
BaseHandler
}
, but subclasses
This method is
\emph
{
not
}
defined in
\class
{
BaseHandler
}
, but
should define it if they want to catch all URLs.
s
ubclasses s
hould define it if they want to catch all URLs.
This method, if exists, will be called by the
\member
{
parent
}
This method, if exists, will be called by the
\member
{
parent
}
\class
{
OpenerDirector
}
. It should return a file-like object as described
\class
{
OpenerDirector
}
. It should return a file-like object as
in the return value of the
\method
{
open
}
of
\class
{
OpenerDirector
}
or
described in the return value of the
\method
{
open()
}
of
\code
{
None
}
. It should raise
\exception
{
URLError
}
, unless a truly exceptional
\class
{
OpenerDirector
}
or
\code
{
None
}
. It should raise
thing happens (for example,
\exception
{
MemoryError
}
should not be mapped
\exception
{
URLError
}
, unless a truly exceptional thing happens (for
to
\exception
{
URLError
}
.
example,
\exception
{
MemoryError
}
should not be mapped to
\exception
{
URLError
}
.
This method will be called before any protocol-specific open method.
This method will be called before any protocol-specific open method.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[BaseHandler]
{{
\em
protocol
}_
open
}{
req
}
\begin{methoddesc}
[BaseHandler]
{
\var
{
protocol
}_
open
}{
req
}
This method is
{
\em
not
}
defined in
\class
{
BaseHandler
}
, but subclasses
This method is
\emph
{
not
}
defined in
\class
{
BaseHandler
}
, but
should define it if they want to handle URLs with the given protocol.
subclasses should define it if they want to handle URLs with the given
protocol.
This method, if
exists
, will be called by the
\member
{
parent
}
This method, if
defined
, will be called by the
\member
{
parent
}
\class
{
OpenerDirector
}
. Return values should be the same as for
\class
{
OpenerDirector
}
.
Return values should be the same as for
\method
{
default
_
open
}
.
\method
{
default
_
open
()
}
.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[BaseHandler]
{
unknown
_
open
}{
req
}
\begin{methoddesc}
[BaseHandler]
{
unknown
_
open
}{
req
}
This method is
{
\em
not
}
defined in
\class
{
BaseHandler
}
, but subclasses
This method is
\var
{
not
}
defined in
\class
{
BaseHandler
}
, but
s
hould define it if they want to catch all URLs with no specific
s
ubclasses should define it if they want to catch all URLs with no
registerd handler to open it.
specific
registerd handler to open it.
This method, if exists, will be called by the
\member
{
parent
}
This method, if exists, will be called by the
\member
{
parent
}
\class
{
OpenerDirector
}
. Return values should be the same as for
\class
{
OpenerDirector
}
.
Return values should be the same as for
\method
{
default
_
open
}
.
\method
{
default
_
open
()
}
.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[BaseHandler]
{
http
_
error
_
default
}{
req, fp, code, msg, hdrs
}
\begin{methoddesc}
[BaseHandler]
{
http
_
error
_
default
}{
req, fp, code, msg, hdrs
}
This method is
{
\em
not
}
defined in
\class
{
BaseHandler
}
, but subclasses
This method is
\emph
{
not
}
defined in
\class
{
BaseHandler
}
, but
s
hould override it if they intend to provide a catch-all for otherwise
s
ubclasses should override it if they intend to provide a catch-all
unhandled HTTP errors. It will be called automatically by the
for otherwise unhandled HTTP errors. It will be called automatically
\class
{
OpenerDirector
}
getting the error, and should not normally be called
by the
\class
{
OpenerDirector
}
getting the error, and should not
in other circumstances.
normally be called
in other circumstances.
\var
{
req
}
will be a
\class
{
Request
}
object,
\var
{
fp
}
will be a
file-like
\var
{
req
}
will be a
\class
{
Request
}
object,
\var
{
fp
}
will be a
object with the HTTP error body,
\var
{
code
}
will be the three-digit cod
e
file-like object with the HTTP error body,
\var
{
code
}
will be th
e
of the error,
\var
{
msg
}
will be the user-visible explanation of th
e
three-digit code of the error,
\var
{
msg
}
will be the user-visibl
e
code and
\var
{
hdrs
}
will be a dictionary-like object with the headers of
explanation of the code and
\var
{
hdrs
}
will be a mapping object with
the error.
the
headers of the
error.
Return values and exceptions raised should be the same as those
Return values and exceptions raised should be the same as those
of
\function
{
urlopen
}
.
of
\function
{
urlopen
()
}
.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[BaseHandler]
{
http
_
error
_{
\em
nnn
}}{
req, fp, code, msg, hdrs
}
\begin{methoddesc}
[BaseHandler]
{
http
_
error
_
\var
{
nnn
}}{
req, fp, code, msg, hdrs
}
\code
{
nnn
}
should be a three-digit HTTP error code. This method is also
\var
{
nnn
}
should be a three-digit HTTP error code. This method is
not defined in
\class
{
BaseHandler
}
, but will be called, if it exists, on
also not defined in
\class
{
BaseHandler
}
, but will be called, if it
an instance of a subclass, when an HTTP error with code
\code
{
nnn
}
occurse.
exists, on an instance of a subclass, when an HTTP error with code
\var
{
nnn
}
occurs.
Subclasses should override this method to handle specific HTTP errors.
Subclasses should override this method to handle specific HTTP
errors.
Arguments, return values and exceptions raised shou
dl be the same as for
Arguments, return values and exceptions raised shou
ld be the same as
\method
{
http
_
error
_
default
}
for
\method
{
http
_
error
_
default()
}
.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
HTTPDefaultErrorHandler
}{}
\subsection
{
HTTPRedirectHandler Objects
\label
{
http-redirect-handler
}}
A class which catches all HTTP errors.
\end{classdesc}
\begin{methoddesc}
[HTTPDefaultErrorHandler]
{
http
_
error
_
default
}{
req, fp, code,
msg, hdrs
}
Raise an
\exception
{
HTTPError
}
\end{methoddesc}
\begin{classdesc}
{
HTTPRedirectHandler
}{}
\strong
{
Note:
}
303 redirection is not supported by this version of
A class to handle redirections.
\module
{
urllib2
}
.
\end{classdesc}
\begin{methoddesc}
[HTTPRedirectHandler]
{
http
_
error
_
301
}{
req,
fp, code,
\begin{methoddesc}
[HTTPRedirectHandler]
{
http
_
error
_
301
}{
req,
msg, hdrs
}
fp, code,
msg, hdrs
}
Redirect to the
\code
{
Location:
}
URL.
This method get
s called by
Redirect to the
\code
{
Location:
}
URL.
This method i
s called by
the parent
\class
{
OpenerDirector
}
when getting an HTTP
permanent-redirect
the parent
\class
{
OpenerDirector
}
when getting an HTTP
error
.
permanent-redirect response
.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[HTTPRedirectHandler]
{
http
_
error
_
302
}{
req, fp, code,
\begin{methoddesc}
[HTTPRedirectHandler]
{
http
_
error
_
302
}{
req,
msg, hdrs
}
fp, code, msg, hdrs
}
The same as
\method
{
http
_
error
_
301
}
.
The same as
\method
{
http
_
error
_
301()
}
, but called for the
temporary-redirect response.
\end{methoddesc}
\end{methoddesc}
\strong
{
Note:
}
303 redirection is not supported by this version of
\module
{
urllib2
}
.
\begin{classdesc}
{
ProxyHandler
}{
\optional
{
proxies
}}
\subsection
{
ProxyHandler Objects
\label
{
proxy-handler
}}
Cause requests to go through a proxy.
If
\var
{
proxies
}
is given, it must be a dictionary mapping
protocol names to URLs of proxies.
The default is to read the list of proxies from the environment
variables
\code
{{
\em
protocol
}_
proxy
}
.
\end{classdesc}
\begin{methoddesc}
[ProxyHandler]
{{
\em
protocol
}_
open
}{
request
}
\begin{methoddesc}
[ProxyHandler]
{
\var
{
protocol
}_
open
}{
request
}
The
\class
{
ProxyHandler
}
will have a method
\code
{{
\em
protocol
}_
open
}
for
The
\class
{
ProxyHandler
}
will have a method
every
{
\em
protocol
}
which has a proxy in the
\var
{
proxies
}
dictionary
\method
{
\var
{
protocol
}_
open()
}
for every
\var
{
protocol
}
which has a
given in the constructor. The method will modify requests to go
proxy in the
\var
{
proxies
}
dictionary given in the constructor. The
through the proxy, by calling
\code
{
request.set
_
proxy()
}
, and call the next
method will modify requests to go through the proxy, by calling
handler in the chain to actually execute the protocol.
\code
{
request.set
_
proxy()
}
, and call the next handler in the chain to
actually execute the protocol.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
HTTPPasswordMgr
}{}
Keep a database of
\code
{
(
\var
{
realm
}
,
\var
{
uri
}
) -> (
\var
{
user
}
,
\var
{
password
}
)
}
mapping.
\end{classdesc}
\begin{methoddesc}
[HTTPPasswordMgr]
{
add
_
password
}{
realm, uri, user, passwd
}
\var
{
uri
}
can be either a single URI, or a sequene of URIs.
\var
{
realm
}
,
\var
{
user
}
and
\var
{
passwd
}
must be strings. This causes
\code
{
(
\var
{
user
}
,
\var
{
passwd
}
)
}
to be used as authentication tokens
when authentication for
\var
{
realm
}
and a super-URI of any of the
given URIs is given.
\end{methoddesc}
\begin{methoddesc}
[HTTPPasswordMgr]
{
find
_
user
_
password
}{
realm, authuri
}
\subsection
{
HTTPPasswordMgr Objects
\label
{
http-password-mgr
}}
Get user/password for given realm and URI, if any. This method will
return
\code
{
(None, None)
}
if there is no user/password is known.
\end{methoddesc}
\begin{classdesc}
{
HTTPPasswordMgrWithDefaultRealm
}{}
These methods are available on
\class
{
HTTPPasswordMgr
}
and
Keep a database of
\class
{
HTTPPasswordMgrWithDefaultRealm
}
objects.
\code
{
(
\var
{
realm
}
,
\var
{
uri
}
) -> (
\var
{
user
}
,
\var
{
password
}
)
}
mapping.
A realm of
\code
{
None
}
is considered a catch-all realm, which is searched
if no other realm fits.
\end{classdesc}
\begin{methoddesc}
[HTTPPasswordMgrWithDefaultRealm]
{
add
_
password
}
\begin{methoddesc}
[HTTPPasswordMgr]
{
add
_
password
}{
realm, uri, user, passwd
}
{
realm, uri, user, passwd
}
\var
{
uri
}
can be either a single URI, or a sequene of URIs.
\var
{
realm
}
,
\var
{
uri
}
can be either a single URI, or a sequene of URIs.
\var
{
realm
}
,
\var
{
user
}
and
\var
{
passwd
}
must be strings. This causes
\var
{
user
}
and
\var
{
passwd
}
must be strings. This causes
\code
{
(
\var
{
user
}
,
\var
{
passwd
}
)
}
to be used as authentication tokens
\code
{
(
\var
{
user
}
,
\var
{
passwd
}
)
}
to be used as authentication tokens
when authentication for
\var
{
realm
}
and a super-URI of any of the
when authentication for
\var
{
realm
}
and a super-URI of any of the
given URIs is given.
given URIs is given.
\end{methoddesc}
\end{methoddesc}
\begin{methoddesc}
[HTTPPasswordMgr]
{
find
_
user
_
password
}{
realm, authuri
}
\begin{methoddesc}
[HTTPPasswordMgr]
{
find
_
user
_
password
}{
realm, authuri
}
Get user/password for given realm and URI, if any. This method will
Get user/password for given realm and URI, if any. This method will
return
\code
{
(None, None)
}
if there is no user/password is known.
return
\code
{
(None, None)
}
if there is no matching user/password.
If the given
\var
{
realm
}
has no user/password, the realm
\code
{
None
}
will be searched.
For
\class
{
HTTPPasswordMgrWithDefaultRealm
}
objects, the realm
\code
{
None
}
will be searched if the given
\var
{
realm
}
has no matching
user/password.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
[AbstractBasicAuthHandler]
{
\optional
{
password
_
mgr
}}
This is a mixin class, that helps with HTTP authentication, both
to the remote host and to a proxy.
\var
{
password
_
mgr
}
should be something that is compatible with
\subsection
{
AbstractBasicAuthHandler Objects
\class
{
HTTPPasswordMgr
}
--- supplies the documented interface above.
\label
{
abstract-basic-auth-handler
}}
\end{classdesc}
\begin{methoddesc}
[AbstractBasicAuthHandler]
{
handle
_
authentication
_
request
}
\begin{methoddesc}
[AbstractBasicAuthHandler]
{
handle
_
authentication
_
request
}
{
authreq, host, req, headers
}
{
authreq, host, req, headers
}
...
@@ -368,37 +454,29 @@ the realm, \var{host} is the host to authenticate too, \var{req} should be the
...
@@ -368,37 +454,29 @@ the realm, \var{host} is the host to authenticate too, \var{req} should be the
(failed)
\class
{
Request
}
object, and
\var
{
headers
}
should be the error headers.
(failed)
\class
{
Request
}
object, and
\var
{
headers
}
should be the error headers.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
HTTPBasicAuthHandler
}{
\optional
{
password
_
mgr
}}
Handle authentication with the remote host.
\subsection
{
HTTPBasicAuthHandler Objects
Valid
\var
{
password
_
mgr
}
, if given, are the same as for
\label
{
http-basic-auth-handler
}}
\class
{
AbstractBasicAuthHandler
}
.
\end{classdesc}
\begin{methoddesc}
[HTTPBasicAuthHandler]
{
http
_
error
_
401
}{
req, fp, code,
\begin{methoddesc}
[HTTPBasicAuthHandler]
{
http
_
error
_
401
}{
req, fp, code,
msg, hdrs
}
msg, hdrs
}
Retry the request with authentication info, if available.
Retry the request with authentication info, if available.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
ProxyBasicAuthHandler
}{
\optional
{
password
_
mgr
}}
Handle authentication with the proxy.
\subsection
{
ProxyBasicAuthHandler Objects
Valid
\var
{
password
_
mgr
}
, if given, are the same as for
\label
{
proxy-basic-auth-handler
}}
\class
{
AbstractBasicAuthHandler
}
.
\end{classdesc}
\begin{methoddesc}
[ProxyBasicAuthHandler]
{
http
_
error
_
407
}{
req, fp, code,
\begin{methoddesc}
[ProxyBasicAuthHandler]
{
http
_
error
_
407
}{
req, fp, code,
msg, hdrs
}
msg, hdrs
}
Retry the request with authentication info, if available.
Retry the request with authentication info, if available.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
AbstractDigestAuthHandler
}{
\optional
{
password
_
mgr
}}
This is a mixin class, that helps with HTTP authentication, both
to the remote host and to a proxy.
\var
{
password
_
mgr
}
should be something that is compatible with
\subsection
{
AbstractDigestAuthHandler Objects
\class
{
HTTPPasswordMgr
}
--- supplies the documented interface above.
\label
{
abstract-digest-auth-handler
}}
\end{classdesc}
\begin{methoddesc}
[Abstract
Basic
AuthHandler]
{
handle
_
authentication
_
request
}
\begin{methoddesc}
[Abstract
Digest
AuthHandler]
{
handle
_
authentication
_
request
}
{
authreq, host, req, headers
}
{
authreq, host, req, headers
}
\var
{
authreq
}
should be the name of the header where the information about
\var
{
authreq
}
should be the name of the header where the information about
the realm,
\var
{
host
}
should be the host to authenticate too,
\var
{
req
}
the realm,
\var
{
host
}
should be the host to authenticate too,
\var
{
req
}
...
@@ -406,83 +484,63 @@ should be the (failed) \class{Request} object, and \var{headers} should be the
...
@@ -406,83 +484,63 @@ should be the (failed) \class{Request} object, and \var{headers} should be the
error headers.
error headers.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
HTTPDigestAuthHandler
}{
\optional
{
password
_
mgr
}}
Handle authentication with the remote host.
\subsection
{
HTTPDigestAuthHandler Objects
Valid
\var
{
password
_
mgr
}
, if given, are the same as for
\label
{
http-digest-auth-handler
}}
\class
{
AbstractBasicAuthHandler
}
.
\end{classdesc}
\begin{methoddesc}
[HTTPDigestAuthHandler]
{
http
_
error
_
401
}{
req, fp, code,
\begin{methoddesc}
[HTTPDigestAuthHandler]
{
http
_
error
_
401
}{
req, fp, code,
msg, hdrs
}
msg, hdrs
}
Retry the request with authentication info, if available.
Retry the request with authentication info, if available.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
ProxyDigestAuthHandler
}{
\optional
{
password
_
mgr
}}
Handle authentication with the proxy.
\subsection
{
ProxyDigestAuthHandler Objects
\var
{
password
_
mgr
}
, if given, shoudl be the same as for
\label
{
proxy-digest-auth-handler
}}
the constructor of
\class
{
AbstractDigestAuthHandler
}
.
\end{classdesc}
\begin{methoddesc}
[ProxyDigestAuthHandler]
{
http
_
error
_
407
}{
req, fp, code,
\begin{methoddesc}
[ProxyDigestAuthHandler]
{
http
_
error
_
407
}{
req, fp, code,
msg, hdrs
}
msg, hdrs
}
Retry the request with authentication info, if available.
Retry the request with authentication info
rmation
, if available.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
HTTPHandler
}{}
A class to handle opening of HTTP URLs
\subsection
{
HTTPHandler Objects
\label
{
http-handler-objects
}}
\end{classdesc}
\begin{methoddesc}
[HTTPHandler]
{
http
_
open
}{
req
}
\begin{methoddesc}
[HTTPHandler]
{
http
_
open
}{
req
}
Send an HTTP request
(either GET or POST, depending on whether
Send an HTTP request
, whcih can be either GET or POST, depending on
\code
{
req
.has
_
data()
}
.
\code
{
\var
{
req
}
.has
_
data()
}
.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
HTTPSHandler
}{}
A class to handle opening of HTTPS URLs
\subsection
{
HTTPSHandler Objects
\label
{
https-handler-objects
}}
\end{classdesc}
\begin{methoddesc}
[HTTPSHandler]
{
https
_
open
}{
req
}
\begin{methoddesc}
[HTTPSHandler]
{
https
_
open
}{
req
}
Send an HTTPS request
(either GET or POST, depending on whether
Send an HTTPS request
, which can be either GET or POST, depending on
\code
{
req
.has
_
data()
}
.
\code
{
\var
{
req
}
.has
_
data()
}
.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
UknownHandler
}{}
A catch-all class to handle unknown URLs.
\end{classdesc}
\begin{methoddesc}
[UknownHandler]
{
unknown
_
open
}
\subsection
{
FileHandler Objects
\label
{
file-handler-objects
}}
Raise a
\exception
{
URLError
}
exception
\end{methoddesc}
\begin{classdesc}
{
FileHandler
}{}
Open local files.
\end{classdesc}
\begin{methoddesc}
[FileHandler]
{
file
_
open
}{
req
}
\begin{methoddesc}
[FileHandler]
{
file
_
open
}{
req
}
Open the file locally, if there is no host name, or
Open the file locally, if there is no host name, or
the host name is
\code
{
"localhost"
}
. Change the
the host name is
\code
{
'localhost'
}
. Change the
protocol to
\code
{
ftp
}
otherwise, and retry opening
protocol to
\code
{
ftp
}
otherwise, and retry opening
it using
\member
{
parent
}
.
it using
\member
{
parent
}
.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
FTPHandler
}{}
Open FTP URLs.
\subsection
{
FTPHandler Objects
\label
{
ftp-handler-objects
}}
\end{classdesc}
\begin{methoddesc}
[FTPHandler]
{
ftp
_
open
}{
req
}
\begin{methoddesc}
[FTPHandler]
{
ftp
_
open
}{
req
}
Open the FTP file indicated by
\var
{
req
}
.
Open the FTP file indicated by
\var
{
req
}
.
The login is always done with empty username and password.
The login is always done with empty username and password.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
CacheFTPHandler
}{}
Open FTP URLs, keeping a cache of open FTP connections to minimize
delays.
\end{classdesc}
\
begin{methoddesc}
[CacheFTPHandler]
{
ftp
_
open
}{
req
}
\
subsection
{
CacheFTPHandler Objects
\label
{
cacheftp-handler-objects
}
}
Open the FTP file indicated by
\var
{
req
}
.
The login is always done with empty username and password.
\class
{
CacheFTPHandler
}
objects are
\class
{
FTPHandler
}
objects with
\end{methoddesc}
the following additional methods:
\begin{methoddesc}
[CacheFTPHandler]
{
setTimeout
}{
t
}
\begin{methoddesc}
[CacheFTPHandler]
{
setTimeout
}{
t
}
Set timeout of connections to
\var
{
t
}
seconds.
Set timeout of connections to
\var
{
t
}
seconds.
...
@@ -492,10 +550,16 @@ Set timeout of connections to \var{t} seconds.
...
@@ -492,10 +550,16 @@ Set timeout of connections to \var{t} seconds.
Set maximum number of cached connections to
\var
{
m
}
.
Set maximum number of cached connections to
\var
{
m
}
.
\end{methoddesc}
\end{methoddesc}
\begin{classdesc}
{
GopherHandler
}{}
Open gopher URLs.
\subsection
{
GopherHandler Objects
\label
{
gopher-handler
}}
\end{classdesc}
\begin{methoddesc}
[GopherHandler]
{
gopher
_
open
}{
req
}
\begin{methoddesc}
[GopherHandler]
{
gopher
_
open
}{
req
}
Open the gopher resource indicated by
\var
{
req
}
.
Open the gopher resource indicated by
\var
{
req
}
.
\end{methoddesc}
\end{methoddesc}
\subsection
{
UnknownHandler Objects
\label
{
unknown-handler-objects
}}
\begin{methoddesc}
[UnknownHandler]
{
unknown
_
open
}
Raise a
\exception
{
URLError
}
exception.
\end{methoddesc}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment