diff options
59 files changed, 522 insertions, 567 deletions
diff --git a/Doc/library/someos.rst b/Doc/library/someos.rst index 8140270..baa1989 100644 --- a/Doc/library/someos.rst +++ b/Doc/library/someos.rst @@ -1,4 +1,3 @@ - .. _someos: ********************************** @@ -8,7 +7,7 @@ Optional Operating System Services The modules described in this chapter provide interfaces to operating system features that are available on selected operating systems only. The interfaces are generally modeled after the Unix or C interfaces but they are available on -some other systems as well (e.g. Windows or NT). Here's an overview: +some other systems as well (e.g. Windows). Here's an overview: .. toctree:: diff --git a/Doc/library/spwd.rst b/Doc/library/spwd.rst index ce51d14..add611f 100644 --- a/Doc/library/spwd.rst +++ b/Doc/library/spwd.rst @@ -1,4 +1,3 @@ - :mod:`spwd` --- The shadow password database ============================================ @@ -48,7 +47,7 @@ below, see ``<shadow.h>``): The sp_nam and sp_pwd items are strings, all others are integers. :exc:`KeyError` is raised if the entry asked for cannot be found. -It defines the following items: +The following functions are defined: .. function:: getspnam(name) diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 1f30a61..702c52f 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -1,6 +1,5 @@ - :mod:`ssl` --- SSL wrapper for socket objects -==================================================================== +============================================= .. module:: ssl :synopsis: SSL wrapper for socket objects @@ -13,32 +12,29 @@ .. index:: TLS, SSL, Transport Layer Security, Secure Sockets Layer -This module provides access to Transport Layer Security (often known -as "Secure Sockets Layer") encryption and peer authentication -facilities for network sockets, both client-side and server-side. -This module uses the OpenSSL library. It is available on all modern -Unix systems, Windows, Mac OS X, and probably additional -platforms, as long as OpenSSL is installed on that platform. +This module provides access to Transport Layer Security (often known as "Secure +Sockets Layer") encryption and peer authentication facilities for network +sockets, both client-side and server-side. This module uses the OpenSSL +library. It is available on all modern Unix systems, Windows, Mac OS X, and +probably additional platforms, as long as OpenSSL is installed on that platform. .. note:: - Some behavior may be platform dependent, since calls are made to the operating - system socket APIs. The installed version of OpenSSL may also cause - variations in behavior. + Some behavior may be platform dependent, since calls are made to the + operating system socket APIs. The installed version of OpenSSL may also + cause variations in behavior. -This section documents the objects and functions in the ``ssl`` module; -for more general information about TLS, SSL, and certificates, the -reader is referred to the documents in the "See Also" section at -the bottom. +This section documents the objects and functions in the ``ssl`` module; for more +general information about TLS, SSL, and certificates, the reader is referred to +the documents in the "See Also" section at the bottom. -This module provides a class, :class:`ssl.SSLSocket`, which is -derived from the :class:`socket.socket` type, and provides -a socket-like wrapper that also encrypts and decrypts the data -going over the socket with SSL. It supports additional -:meth:`read` and :meth:`write` methods, along with a method, :meth:`getpeercert`, -to retrieve the certificate of the other side of the connection, and -a method, :meth:`cipher`, to retrieve the cipher being used for the -secure connection. +This module provides a class, :class:`ssl.SSLSocket`, which is derived from the +:class:`socket.socket` type, and provides a socket-like wrapper that also +encrypts and decrypts the data going over the socket with SSL. It supports +additional :meth:`read` and :meth:`write` methods, along with a method, +:meth:`getpeercert`, to retrieve the certificate of the other side of the +connection, and a method, :meth:`cipher`, to retrieve the cipher being used for +the secure connection. Functions, Constants, and Exceptions ------------------------------------ @@ -46,31 +42,33 @@ Functions, Constants, and Exceptions .. exception:: SSLError Raised to signal an error from the underlying SSL implementation. This - signifies some problem in the higher-level - encryption and authentication layer that's superimposed on the underlying - network connection. This error is a subtype of :exc:`socket.error`, which - in turn is a subtype of :exc:`IOError`. - -.. function:: wrap_socket (sock, keyfile=None, certfile=None, server_side=False, cert_reqs=CERT_NONE, ssl_version={see docs}, ca_certs=None, do_handshake_on_connect=True, suppress_ragged_eofs=True) - - Takes an instance ``sock`` of :class:`socket.socket`, and returns an instance of :class:`ssl.SSLSocket`, a subtype - of :class:`socket.socket`, which wraps the underlying socket in an SSL context. - For client-side sockets, the context construction is lazy; if the underlying socket isn't - connected yet, the context construction will be performed after :meth:`connect` is called - on the socket. For server-side sockets, if the socket has no remote peer, it is assumed - to be a listening socket, and the server-side SSL wrapping is automatically performed - on client connections accepted via the :meth:`accept` method. :func:`wrap_socket` may - raise :exc:`SSLError`. - - The ``keyfile`` and ``certfile`` parameters specify optional files which contain a certificate - to be used to identify the local side of the connection. See the discussion of :ref:`ssl-certificates` - for more information on how the certificate is stored in the ``certfile``. - - Often the private key is stored - in the same file as the certificate; in this case, only the ``certfile`` parameter need be - passed. If the private key is stored in a separate file, both parameters must be used. - If the private key is stored in the ``certfile``, it should come before the first certificate - in the certificate chain:: + signifies some problem in the higher-level encryption and authentication + layer that's superimposed on the underlying network connection. This error + is a subtype of :exc:`socket.error`, which in turn is a subtype of + :exc:`IOError`. + +.. function:: wrap_socket(sock, keyfile=None, certfile=None, server_side=False, cert_reqs=CERT_NONE, ssl_version={see docs}, ca_certs=None, do_handshake_on_connect=True, suppress_ragged_eofs=True) + + Takes an instance ``sock`` of :class:`socket.socket`, and returns an instance + of :class:`ssl.SSLSocket`, a subtype of :class:`socket.socket`, which wraps + the underlying socket in an SSL context. For client-side sockets, the + context construction is lazy; if the underlying socket isn't connected yet, + the context construction will be performed after :meth:`connect` is called on + the socket. For server-side sockets, if the socket has no remote peer, it is + assumed to be a listening socket, and the server-side SSL wrapping is + automatically performed on client connections accepted via the :meth:`accept` + method. :func:`wrap_socket` may raise :exc:`SSLError`. + + The ``keyfile`` and ``certfile`` parameters specify optional files which + contain a certificate to be used to identify the local side of the + connection. See the discussion of :ref:`ssl-certificates` for more + information on how the certificate is stored in the ``certfile``. + + Often the private key is stored in the same file as the certificate; in this + case, only the ``certfile`` parameter need be passed. If the private key is + stored in a separate file, both parameters must be used. If the private key + is stored in the ``certfile``, it should come before the first certificate in + the certificate chain:: -----BEGIN RSA PRIVATE KEY----- ... (private key in base64 encoding) ... @@ -79,31 +77,33 @@ Functions, Constants, and Exceptions ... (certificate in base64 PEM encoding) ... -----END CERTIFICATE----- - The parameter ``server_side`` is a boolean which identifies whether server-side or client-side - behavior is desired from this socket. - - The parameter ``cert_reqs`` specifies whether a certificate is - required from the other side of the connection, and whether it will - be validated if provided. It must be one of the three values - :const:`CERT_NONE` (certificates ignored), :const:`CERT_OPTIONAL` (not required, - but validated if provided), or :const:`CERT_REQUIRED` (required and - validated). If the value of this parameter is not :const:`CERT_NONE`, then - the ``ca_certs`` parameter must point to a file of CA certificates. - - The ``ca_certs`` file contains a set of concatenated "certification authority" certificates, - which are used to validate certificates passed from the other end of the connection. - See the discussion of :ref:`ssl-certificates` for more information about how to arrange - the certificates in this file. - - The parameter ``ssl_version`` specifies which version of the SSL protocol to use. - Typically, the server chooses a particular protocol version, and the client - must adapt to the server's choice. Most of the versions are not interoperable - with the other versions. If not specified, for client-side operation, the - default SSL version is SSLv3; for server-side operation, SSLv23. These - version selections provide the most compatibility with other versions. - - Here's a table showing which versions in a client (down the side) - can connect to which versions in a server (along the top): + The parameter ``server_side`` is a boolean which identifies whether + server-side or client-side behavior is desired from this socket. + + The parameter ``cert_reqs`` specifies whether a certificate is required from + the other side of the connection, and whether it will be validated if + provided. It must be one of the three values :const:`CERT_NONE` + (certificates ignored), :const:`CERT_OPTIONAL` (not required, but validated + if provided), or :const:`CERT_REQUIRED` (required and validated). If the + value of this parameter is not :const:`CERT_NONE`, then the ``ca_certs`` + parameter must point to a file of CA certificates. + + The ``ca_certs`` file contains a set of concatenated "certification + authority" certificates, which are used to validate certificates passed from + the other end of the connection. See the discussion of + :ref:`ssl-certificates` for more information about how to arrange the + certificates in this file. + + The parameter ``ssl_version`` specifies which version of the SSL protocol to + use. Typically, the server chooses a particular protocol version, and the + client must adapt to the server's choice. Most of the versions are not + interoperable with the other versions. If not specified, for client-side + operation, the default SSL version is SSLv3; for server-side operation, + SSLv23. These version selections provide the most compatibility with other + versions. + + Here's a table showing which versions in a client (down the side) can connect + to which versions in a server (along the top): .. table:: @@ -116,51 +116,52 @@ Functions, Constants, and Exceptions *TLSv1* no no yes yes ======================== ========= ========= ========== ========= - In some older versions of OpenSSL (for instance, 0.9.7l on OS X 10.4), - an SSLv2 client could not connect to an SSLv23 server. + In some older versions of OpenSSL (for instance, 0.9.7l on OS X 10.4), an + SSLv2 client could not connect to an SSLv23 server. The parameter ``do_handshake_on_connect`` specifies whether to do the SSL handshake automatically after doing a :meth:`socket.connect`, or whether the - application program will call it explicitly, by invoking the :meth:`SSLSocket.do_handshake` - method. Calling :meth:`SSLSocket.do_handshake` explicitly gives the program control over - the blocking behavior of the socket I/O involved in the handshake. + application program will call it explicitly, by invoking the + :meth:`SSLSocket.do_handshake` method. Calling + :meth:`SSLSocket.do_handshake` explicitly gives the program control over the + blocking behavior of the socket I/O involved in the handshake. - The parameter ``suppress_ragged_eofs`` specifies how the :meth:`SSLSocket.read` - method should signal unexpected EOF from the other end of the connection. If specified - as :const:`True` (the default), it returns a normal EOF in response to unexpected - EOF errors raised from the underlying socket; if :const:`False`, it will raise - the exceptions back to the caller. + The parameter ``suppress_ragged_eofs`` specifies how the + :meth:`SSLSocket.read` method should signal unexpected EOF from the other end + of the connection. If specified as :const:`True` (the default), it returns a + normal EOF in response to unexpected EOF errors raised from the underlying + socket; if :const:`False`, it will raise the exceptions back to the caller. .. function:: RAND_status() - Returns True if the SSL pseudo-random number generator has been - seeded with 'enough' randomness, and False otherwise. You can use - :func:`ssl.RAND_egd` and :func:`ssl.RAND_add` to increase the randomness - of the pseudo-random number generator. + Returns True if the SSL pseudo-random number generator has been seeded with + 'enough' randomness, and False otherwise. You can use :func:`ssl.RAND_egd` + and :func:`ssl.RAND_add` to increase the randomness of the pseudo-random + number generator. .. function:: RAND_egd(path) If you are running an entropy-gathering daemon (EGD) somewhere, and ``path`` - is the pathname of a socket connection open to it, this will read - 256 bytes of randomness from the socket, and add it to the SSL pseudo-random number generator - to increase the security of generated secret keys. This is typically only - necessary on systems without better sources of randomness. + is the pathname of a socket connection open to it, this will read 256 bytes + of randomness from the socket, and add it to the SSL pseudo-random number + generator to increase the security of generated secret keys. This is + typically only necessary on systems without better sources of randomness. - See http://egd.sourceforge.net/ or http://prngd.sourceforge.net/ for - sources of entropy-gathering daemons. + See http://egd.sourceforge.net/ or http://prngd.sourceforge.net/ for sources + of entropy-gathering daemons. .. function:: RAND_add(bytes, entropy) - Mixes the given ``bytes`` into the SSL pseudo-random number generator. - The parameter ``entropy`` (a float) is a lower bound on the entropy - contained in string (so you can always use :const:`0.0`). - See :rfc:`1750` for more information on sources of entropy. + Mixes the given ``bytes`` into the SSL pseudo-random number generator. The + parameter ``entropy`` (a float) is a lower bound on the entropy contained in + string (so you can always use :const:`0.0`). See :rfc:`1750` for more + information on sources of entropy. .. function:: cert_time_to_seconds(timestring) - Returns a floating-point value containing a normal seconds-after-the-epoch time - value, given the time-string representing the "notBefore" or "notAfter" date - from a certificate. + Returns a floating-point value containing a normal seconds-after-the-epoch + time value, given the time-string representing the "notBefore" or "notAfter" + date from a certificate. Here's an example:: @@ -172,50 +173,47 @@ Functions, Constants, and Exceptions 'Wed May 9 00:00:00 2007' >>> -.. function:: get_server_certificate (addr, ssl_version=PROTOCOL_SSLv3, ca_certs=None) +.. function:: get_server_certificate(addr, ssl_version=PROTOCOL_SSLv3, ca_certs=None) - Given the address ``addr`` of an SSL-protected server, as a - (*hostname*, *port-number*) pair, fetches the server's certificate, - and returns it as a PEM-encoded string. If ``ssl_version`` is - specified, uses that version of the SSL protocol to attempt to - connect to the server. If ``ca_certs`` is specified, it should be - a file containing a list of root certificates, the same format as - used for the same parameter in :func:`wrap_socket`. The call will - attempt to validate the server certificate against that set of root + Given the address ``addr`` of an SSL-protected server, as a (*hostname*, + *port-number*) pair, fetches the server's certificate, and returns it as a + PEM-encoded string. If ``ssl_version`` is specified, uses that version of + the SSL protocol to attempt to connect to the server. If ``ca_certs`` is + specified, it should be a file containing a list of root certificates, the + same format as used for the same parameter in :func:`wrap_socket`. The call + will attempt to validate the server certificate against that set of root certificates, and will fail if the validation attempt fails. -.. function:: DER_cert_to_PEM_cert (DER_cert_bytes) +.. function:: DER_cert_to_PEM_cert(DER_cert_bytes) Given a certificate as a DER-encoded blob of bytes, returns a PEM-encoded string version of the same certificate. -.. function:: PEM_cert_to_DER_cert (PEM_cert_string) +.. function:: PEM_cert_to_DER_cert(PEM_cert_string) - Given a certificate as an ASCII PEM string, returns a DER-encoded - sequence of bytes for that same certificate. + Given a certificate as an ASCII PEM string, returns a DER-encoded sequence of + bytes for that same certificate. .. data:: CERT_NONE - Value to pass to the ``cert_reqs`` parameter to :func:`sslobject` - when no certificates will be required or validated from the other - side of the socket connection. + Value to pass to the ``cert_reqs`` parameter to :func:`sslobject` when no + certificates will be required or validated from the other side of the socket + connection. .. data:: CERT_OPTIONAL - Value to pass to the ``cert_reqs`` parameter to :func:`sslobject` - when no certificates will be required from the other side of the - socket connection, but if they are provided, will be validated. - Note that use of this setting requires a valid certificate - validation file also be passed as a value of the ``ca_certs`` - parameter. + Value to pass to the ``cert_reqs`` parameter to :func:`sslobject` when no + certificates will be required from the other side of the socket connection, + but if they are provided, will be validated. Note that use of this setting + requires a valid certificate validation file also be passed as a value of the + ``ca_certs`` parameter. .. data:: CERT_REQUIRED - Value to pass to the ``cert_reqs`` parameter to :func:`sslobject` - when certificates will be required from the other side of the - socket connection. Note that use of this setting requires a valid certificate - validation file also be passed as a value of the ``ca_certs`` - parameter. + Value to pass to the ``cert_reqs`` parameter to :func:`sslobject` when + certificates will be required from the other side of the socket connection. + Note that use of this setting requires a valid certificate validation file + also be passed as a value of the ``ca_certs`` parameter. .. data:: PROTOCOL_SSLv2 @@ -223,22 +221,21 @@ Functions, Constants, and Exceptions .. data:: PROTOCOL_SSLv23 - Selects SSL version 2 or 3 as the channel encryption protocol. - This is a setting to use with servers for maximum compatibility - with the other end of an SSL connection, but it may cause the - specific ciphers chosen for the encryption to be of fairly low - quality. + Selects SSL version 2 or 3 as the channel encryption protocol. This is a + setting to use with servers for maximum compatibility with the other end of + an SSL connection, but it may cause the specific ciphers chosen for the + encryption to be of fairly low quality. .. data:: PROTOCOL_SSLv3 - Selects SSL version 3 as the channel encryption protocol. - For clients, this is the maximally compatible SSL variant. + Selects SSL version 3 as the channel encryption protocol. For clients, this + is the maximally compatible SSL variant. .. data:: PROTOCOL_TLSv1 - Selects TLS version 1 as the channel encryption protocol. This is - the most modern version, and probably the best choice for maximum - protection, if both sides can speak it. + Selects TLS version 1 as the channel encryption protocol. This is the most + modern version, and probably the best choice for maximum protection, if both + sides can speak it. SSLSocket Objects @@ -247,25 +244,23 @@ SSLSocket Objects .. method:: SSLSocket.read(nbytes=1024, buffer=None) Reads up to ``nbytes`` bytes from the SSL-encrypted channel and returns them. - If the ``buffer`` is specified, it will attempt to read into the buffer - the minimum of the size of the buffer and ``nbytes``, if that is specified. - If no buffer is specified, an immutable buffer is allocated and returned - with the data read from the socket. + If the ``buffer`` is specified, it will attempt to read into the buffer the + minimum of the size of the buffer and ``nbytes``, if that is specified. If + no buffer is specified, an immutable buffer is allocated and returned with + the data read from the socket. .. method:: SSLSocket.write(data) - Writes the ``data`` to the other side of the connection, using the - SSL channel to encrypt. Returns the number of bytes written. + Writes the ``data`` to the other side of the connection, using the SSL + channel to encrypt. Returns the number of bytes written. .. method:: SSLSocket.do_handshake() - Performs the SSL setup handshake. If the socket is non-blocking, - this method may raise :exc:`SSLError` with the value of the exception - instance's ``args[0]`` - being either :const:`SSL_ERROR_WANT_READ` or - :const:`SSL_ERROR_WANT_WRITE`, and should be called again until - it stops raising those exceptions. Here's an example of how to do - that:: + Performs the SSL setup handshake. If the socket is non-blocking, this method + may raise :exc:`SSLError` with the value of the exception instance's + ``args[0]`` being either :const:`SSL_ERROR_WANT_READ` or + :const:`SSL_ERROR_WANT_WRITE`, and should be called again until it stops + raising those exceptions. Here's an example of how to do that:: while True: try: @@ -281,34 +276,31 @@ SSLSocket Objects .. method:: SSLSocket.unwrap() - Performs the SSL shutdown handshake, which removes the TLS layer - from the underlying socket, and returns the underlying socket - object. This can be used to go from encrypted operation over a - connection to unencrypted. The returned socket should always be - used for further communication with the other side of the - connection, rather than the original socket + Performs the SSL shutdown handshake, which removes the TLS layer from the + underlying socket, and returns the underlying socket object. This can be + used to go from encrypted operation over a connection to unencrypted. The + returned socket should always be used for further communication with the + other side of the connection, rather than the original socket .. method:: SSLSocket.getpeercert(binary_form=False) - If there is no certificate for the peer on the other end of the - connection, returns ``None``. - - If the parameter ``binary_form`` is :const:`False`, and a - certificate was received from the peer, this method returns a - :class:`dict` instance. If the certificate was not validated, the - dict is empty. If the certificate was validated, it returns a dict - with the keys ``subject`` (the principal for which the certificate - was issued), and ``notAfter`` (the time after which the certificate - should not be trusted). The certificate was already validated, so - the ``notBefore`` and ``issuer`` fields are not returned. If a - certificate contains an instance of the *Subject Alternative Name* - extension (see :rfc:`3280`), there will also be a - ``subjectAltName`` key in the dictionary. + If there is no certificate for the peer on the other end of the connection, + returns ``None``. + + If the parameter ``binary_form`` is :const:`False`, and a certificate was + received from the peer, this method returns a :class:`dict` instance. If the + certificate was not validated, the dict is empty. If the certificate was + validated, it returns a dict with the keys ``subject`` (the principal for + which the certificate was issued), and ``notAfter`` (the time after which the + certificate should not be trusted). The certificate was already validated, + so the ``notBefore`` and ``issuer`` fields are not returned. If a + certificate contains an instance of the *Subject Alternative Name* extension + (see :rfc:`3280`), there will also be a ``subjectAltName`` key in the + dictionary. The "subject" field is a tuple containing the sequence of relative - distinguished names (RDNs) given in the certificate's data - structure for the principal, and each RDN is a sequence of - name-value pairs:: + distinguished names (RDNs) given in the certificate's data structure for the + principal, and each RDN is a sequence of name-value pairs:: {'notAfter': 'Feb 16 16:54:50 2013 GMT', 'subject': ((('countryName', 'US'),), @@ -318,31 +310,28 @@ SSLSocket Objects (('organizationalUnitName', 'SSL'),), (('commonName', 'somemachine.python.org'),))} - If the ``binary_form`` parameter is :const:`True`, and a - certificate was provided, this method returns the DER-encoded form - of the entire certificate as a sequence of bytes, or :const:`None` if the - peer did not provide a certificate. This return - value is independent of validation; if validation was required - (:const:`CERT_OPTIONAL` or :const:`CERT_REQUIRED`), it will have + If the ``binary_form`` parameter is :const:`True`, and a certificate was + provided, this method returns the DER-encoded form of the entire certificate + as a sequence of bytes, or :const:`None` if the peer did not provide a + certificate. This return value is independent of validation; if validation + was required (:const:`CERT_OPTIONAL` or :const:`CERT_REQUIRED`), it will have been validated, but if :const:`CERT_NONE` was used to establish the connection, the certificate, if present, will not have been validated. .. method:: SSLSocket.cipher() - Returns a three-value tuple containing the name of the cipher being - used, the version of the SSL protocol that defines its use, and the - number of secret bits being used. If no connection has been - established, returns ``None``. + Returns a three-value tuple containing the name of the cipher being used, the + version of the SSL protocol that defines its use, and the number of secret + bits being used. If no connection has been established, returns ``None``. .. method:: SSLSocket.unwrap() - Performs the SSL shutdown handshake, which removes the TLS layer - from the underlying socket, and returns the underlying socket - object. This can be used to go from encrypted operation over a - connection to unencrypted. The returned socket should always be - used for further communication with the other side of the - connection, rather than the original socket + Performs the SSL shutdown handshake, which removes the TLS layer from the + underlying socket, and returns the underlying socket object. This can be + used to go from encrypted operation over a connection to unencrypted. The + returned socket should always be used for further communication with the + other side of the connection, rather than the original socket. .. index:: single: certificates @@ -353,57 +342,54 @@ SSLSocket Objects Certificates ------------ -Certificates in general are part of a public-key / private-key system. In this system, each *principal*, -(which may be a machine, or a person, or an organization) is assigned a unique two-part encryption key. -One part of the key is public, and is called the *public key*; the other part is kept secret, and is called -the *private key*. The two parts are related, in that if you encrypt a message with one of the parts, you can -decrypt it with the other part, and **only** with the other part. - -A certificate contains information about two principals. It contains -the name of a *subject*, and the subject's public key. It also -contains a statement by a second principal, the *issuer*, that the -subject is who he claims to be, and that this is indeed the subject's -public key. The issuer's statement is signed with the issuer's -private key, which only the issuer knows. However, anyone can verify -the issuer's statement by finding the issuer's public key, decrypting -the statement with it, and comparing it to the other information in -the certificate. The certificate also contains information about the -time period over which it is valid. This is expressed as two fields, -called "notBefore" and "notAfter". - -In the Python use of certificates, a client or server -can use a certificate to prove who they are. The other -side of a network connection can also be required to produce a certificate, -and that certificate can be validated to the satisfaction -of the client or server that requires such validation. -The connection attempt can be set to raise an exception if -the validation fails. Validation is done -automatically, by the underlying OpenSSL framework; the -application need not concern itself with its mechanics. -But the application does usually need to provide -sets of certificates to allow this process to take place. - -Python uses files to contain certificates. They should be formatted -as "PEM" (see :rfc:`1422`), which is a base-64 encoded form wrapped -with a header line and a footer line:: +Certificates in general are part of a public-key / private-key system. In this +system, each *principal*, (which may be a machine, or a person, or an +organization) is assigned a unique two-part encryption key. One part of the key +is public, and is called the *public key*; the other part is kept secret, and is +called the *private key*. The two parts are related, in that if you encrypt a +message with one of the parts, you can decrypt it with the other part, and +**only** with the other part. + +A certificate contains information about two principals. It contains the name +of a *subject*, and the subject's public key. It also contains a statement by a +second principal, the *issuer*, that the subject is who he claims to be, and +that this is indeed the subject's public key. The issuer's statement is signed +with the issuer's private key, which only the issuer knows. However, anyone can +verify the issuer's statement by finding the issuer's public key, decrypting the +statement with it, and comparing it to the other information in the certificate. +The certificate also contains information about the time period over which it is +valid. This is expressed as two fields, called "notBefore" and "notAfter". + +In the Python use of certificates, a client or server can use a certificate to +prove who they are. The other side of a network connection can also be required +to produce a certificate, and that certificate can be validated to the +satisfaction of the client or server that requires such validation. The +connection attempt can be set to raise an exception if the validation fails. +Validation is done automatically, by the underlying OpenSSL framework; the +application need not concern itself with its mechanics. But the application +does usually need to provide sets of certificates to allow this process to take +place. + +Python uses files to contain certificates. They should be formatted as "PEM" +(see :rfc:`1422`), which is a base-64 encoded form wrapped with a header line +and a footer line:: -----BEGIN CERTIFICATE----- ... (certificate in base64 PEM encoding) ... -----END CERTIFICATE----- -The Python files which contain certificates can contain a sequence -of certificates, sometimes called a *certificate chain*. This chain -should start with the specific certificate for the principal who "is" -the client or server, and then the certificate for the issuer of that -certificate, and then the certificate for the issuer of *that* certificate, -and so on up the chain till you get to a certificate which is *self-signed*, -that is, a certificate which has the same subject and issuer, -sometimes called a *root certificate*. The certificates should just -be concatenated together in the certificate file. For example, suppose -we had a three certificate chain, from our server certificate to the -certificate of the certification authority that signed our server certificate, -to the root certificate of the agency which issued the certification authority's -certificate:: +The Python files which contain certificates can contain a sequence of +certificates, sometimes called a *certificate chain*. This chain should start +with the specific certificate for the principal who "is" the client or server, +and then the certificate for the issuer of that certificate, and then the +certificate for the issuer of *that* certificate, and so on up the chain till +you get to a certificate which is *self-signed*, that is, a certificate which +has the same subject and issuer, sometimes called a *root certificate*. The +certificates should just be concatenated together in the certificate file. For +example, suppose we had a three certificate chain, from our server certificate +to the certificate of the certification authority that signed our server +certificate, to the root certificate of the agency which issued the +certification authority's certificate:: -----BEGIN CERTIFICATE----- ... (certificate for your server)... @@ -417,32 +403,29 @@ certificate:: If you are going to require validation of the other side of the connection's certificate, you need to provide a "CA certs" file, filled with the certificate -chains for each issuer you are willing to trust. Again, this file just -contains these chains concatenated together. For validation, Python will -use the first chain it finds in the file which matches. -Some "standard" root certificates are available from various certification -authorities: -`CACert.org <http://www.cacert.org/index.php?id=3>`_, -`Thawte <http://www.thawte.com/roots/>`_, -`Verisign <http://www.verisign.com/support/roots.html>`_, -`Positive SSL <http://www.PositiveSSL.com/ssl-certificate-support/cert_installation/UTN-USERFirst-Hardware.crt>`_ (used by python.org), -`Equifax and GeoTrust <http://www.geotrust.com/resources/root_certificates/index.asp>`_. - -In general, if you are using -SSL3 or TLS1, you don't need to put the full chain in your "CA certs" file; -you only need the root certificates, and the remote peer is supposed to -furnish the other certificates necessary to chain from its certificate to -a root certificate. -See :rfc:`4158` for more discussion of the way in which -certification chains can be built. - -If you are going to create a server that provides SSL-encrypted -connection services, you will need to acquire a certificate for that -service. There are many ways of acquiring appropriate certificates, -such as buying one from a certification authority. Another common -practice is to generate a self-signed certificate. The simplest -way to do this is with the OpenSSL package, using something like -the following:: +chains for each issuer you are willing to trust. Again, this file just contains +these chains concatenated together. For validation, Python will use the first +chain it finds in the file which matches. Some "standard" root certificates are +available from various certification authorities: `CACert.org +<http://www.cacert.org/index.php?id=3>`_, `Thawte +<http://www.thawte.com/roots/>`_, `Verisign +<http://www.verisign.com/support/roots.html>`_, `Positive SSL +<http://www.PositiveSSL.com/ssl-certificate-support/cert_installation/UTN-USERFirst-Hardware.crt>`_ +(used by python.org), `Equifax and GeoTrust +<http://www.geotrust.com/resources/root_certificates/index.asp>`_. + +In general, if you are using SSL3 or TLS1, you don't need to put the full chain +in your "CA certs" file; you only need the root certificates, and the remote +peer is supposed to furnish the other certificates necessary to chain from its +certificate to a root certificate. See :rfc:`4158` for more discussion of the +way in which certification chains can be built. + +If you are going to create a server that provides SSL-encrypted connection +services, you will need to acquire a certificate for that service. There are +many ways of acquiring appropriate certificates, such as buying one from a +certification authority. Another common practice is to generate a self-signed +certificate. The simplest way to do this is with the OpenSSL package, using +something like the following:: % openssl req -new -x509 -days 365 -nodes -out cert.pem -keyout cert.pem Generating a 1024 bit RSA private key @@ -466,9 +449,9 @@ the following:: Email Address []:ops@myserver.mygroup.myorganization.com % -The disadvantage of a self-signed certificate is that it is its -own root certificate, and no one else will have it in their cache -of known (and trusted) root certificates. +The disadvantage of a self-signed certificate is that it is its own root +certificate, and no one else will have it in their cache of known (and trusted) +root certificates. Examples @@ -477,7 +460,8 @@ Examples Testing for SSL support ^^^^^^^^^^^^^^^^^^^^^^^ -To test for the presence of SSL support in a Python installation, user code should use the following idiom:: +To test for the presence of SSL support in a Python installation, user code +should use the following idiom:: try: import ssl @@ -489,8 +473,8 @@ To test for the presence of SSL support in a Python installation, user code shou Client-side operation ^^^^^^^^^^^^^^^^^^^^^ -This example connects to an SSL server, prints the server's address and certificate, -sends some bytes, and reads part of the response:: +This example connects to an SSL server, prints the server's address and +certificate, sends some bytes, and reads part of the response:: import socket, ssl, pprint @@ -518,8 +502,8 @@ sends some bytes, and reads part of the response:: # note that closing the SSLSocket will also close the underlying socket ssl_sock.close() -As of September 6, 2007, the certificate printed by this program -looked like this:: +As of September 6, 2007, the certificate printed by this program looked like +this:: {'notAfter': 'May 8 23:59:59 2009 GMT', 'subject': ((('serialNumber', '2497886'),), @@ -542,9 +526,9 @@ which is a fairly poorly-formed ``subject`` field. Server-side operation ^^^^^^^^^^^^^^^^^^^^^ -For server operation, typically you'd need to have a server certificate, and private key, each in a file. -You'd open a socket, bind it to a port, call :meth:`listen` on it, then start waiting for clients -to connect:: +For server operation, typically you'd need to have a server certificate, and +private key, each in a file. You'd open a socket, bind it to a port, call +:meth:`listen` on it, then start waiting for clients to connect:: import socket, ssl @@ -552,8 +536,9 @@ to connect:: bindsocket.bind(('myaddr.mydomain.com', 10023)) bindsocket.listen(5) -When one did, you'd call :meth:`accept` on the socket to get the new socket from the other -end, and use :func:`wrap_socket` to create a server-side SSL context for it:: +When one did, you'd call :meth:`accept` on the socket to get the new socket from +the other end, and use :func:`wrap_socket` to create a server-side SSL context +for it:: while True: newsocket, fromaddr = bindsocket.accept() @@ -564,7 +549,8 @@ end, and use :func:`wrap_socket` to create a server-side SSL context for it:: ssl_version=ssl.PROTOCOL_TLSv1) deal_with_client(connstream) -Then you'd read data from the ``connstream`` and do something with it till you are finished with the client (or the client is finished with you):: +Then you'd read data from the ``connstream`` and do something with it till you +are finished with the client (or the client is finished with you):: def deal_with_client(connstream): diff --git a/Doc/library/stat.rst b/Doc/library/stat.rst index b318bb7..9100910 100644 --- a/Doc/library/stat.rst +++ b/Doc/library/stat.rst @@ -1,9 +1,9 @@ - :mod:`stat` --- Interpreting :func:`stat` results ================================================= .. module:: stat - :synopsis: Utilities for interpreting the results of os.stat(), os.lstat() and os.fstat(). + :synopsis: Utilities for interpreting the results of os.stat(), + os.lstat() and os.fstat(). .. sectionauthor:: Skip Montanaro <skip@automatrix.com> diff --git a/Doc/library/string.rst b/Doc/library/string.rst index 8098651..3466af6 100644 --- a/Doc/library/string.rst +++ b/Doc/library/string.rst @@ -479,19 +479,19 @@ these rules. The methods of :class:`Template` are: The constructor takes a single argument which is the template string. - .. method:: substitute(mapping[, **kws]) + .. method:: substitute(mapping, **kwds) Performs the template substitution, returning a new string. *mapping* is any dictionary-like object with keys that match the placeholders in the template. Alternatively, you can provide keyword arguments, where the - keywords are the placeholders. When both *mapping* and *kws* are given - and there are duplicates, the placeholders from *kws* take precedence. + keywords are the placeholders. When both *mapping* and *kwds* are given + and there are duplicates, the placeholders from *kwds* take precedence. - .. method:: safe_substitute(mapping[, **kws]) + .. method:: safe_substitute(mapping, **kwds) Like :meth:`substitute`, except that if placeholders are missing from - *mapping* and *kws*, instead of raising a :exc:`KeyError` exception, the + *mapping* and *kwds*, instead of raising a :exc:`KeyError` exception, the original placeholder will appear in the resulting string intact. Also, unlike with :meth:`substitute`, any other appearances of the ``$`` will simply return ``$`` instead of raising :exc:`ValueError`. diff --git a/Doc/library/stringprep.rst b/Doc/library/stringprep.rst index cf49ad7..47144a6 100644 --- a/Doc/library/stringprep.rst +++ b/Doc/library/stringprep.rst @@ -1,4 +1,3 @@ - :mod:`stringprep` --- Internet String Preparation ================================================= diff --git a/Doc/library/strings.rst b/Doc/library/strings.rst index b5f8345..08f1658 100644 --- a/Doc/library/strings.rst +++ b/Doc/library/strings.rst @@ -1,4 +1,3 @@ - .. _stringservices: *************** diff --git a/Doc/library/struct.rst b/Doc/library/struct.rst index 28b0104..da8cc04 100644 --- a/Doc/library/struct.rst +++ b/Doc/library/struct.rst @@ -1,6 +1,5 @@ - :mod:`struct` --- Interpret bytes as packed binary data -========================================================= +======================================================= .. module:: struct :synopsis: Interpret bytes as packed binary data. @@ -46,7 +45,7 @@ The module defines the following exception and functions: (``len(bytes)`` must equal ``calcsize(fmt)``). -.. function:: unpack_from(fmt, buffer[,offset=0]) +.. function:: unpack_from(fmt, buffer, offset=0) Unpack the *buffer* according to the given format. The result is a tuple even if it contains exactly one item. The *buffer* must contain at least the amount @@ -286,7 +285,7 @@ The :mod:`struct` module also defines the following type: (``len(bytes)`` must equal :attr:`self.size`). - .. method:: unpack_from(buffer[, offset=0]) + .. method:: unpack_from(buffer, offset=0) Identical to the :func:`unpack_from` function, using the compiled format. (``len(buffer[offset:])`` must be at least :attr:`self.size`). diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index 4c4a56a..524161e 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -1,4 +1,3 @@ - :mod:`subprocess` --- Subprocess management =========================================== @@ -121,9 +120,10 @@ This module defines one class called :class:`Popen`: .. note:: - This feature is only available if Python is built with universal newline support - (the default). Also, the newlines attribute of the file objects :attr:`stdout`, - :attr:`stdin` and :attr:`stderr` are not updated by the :meth:`communicate` method. + This feature is only available if Python is built with universal newline + support (the default). Also, the newlines attribute of the file objects + :attr:`stdout`, :attr:`stdin` and :attr:`stderr` are not updated by the + :meth:`communicate` method. The *startupinfo* and *creationflags*, if given, will be passed to the underlying CreateProcess() function. They can specify things such as appearance diff --git a/Doc/library/sunau.rst b/Doc/library/sunau.rst index 3f231b4..fc141e9 100644 --- a/Doc/library/sunau.rst +++ b/Doc/library/sunau.rst @@ -1,4 +1,3 @@ - :mod:`sunau` --- Read and write Sun AU files ============================================ diff --git a/Doc/library/symbol.rst b/Doc/library/symbol.rst index 1735276..5134d47 100644 --- a/Doc/library/symbol.rst +++ b/Doc/library/symbol.rst @@ -1,4 +1,3 @@ - :mod:`symbol` --- Constants used with Python parse trees ======================================================== diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index d0e4d65..eac4151 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -1,4 +1,3 @@ - :mod:`sys` --- System-specific parameters and functions ======================================================= diff --git a/Doc/library/syslog.rst b/Doc/library/syslog.rst index 549f26b..89dd38f 100644 --- a/Doc/library/syslog.rst +++ b/Doc/library/syslog.rst @@ -1,4 +1,3 @@ - :mod:`syslog` --- Unix syslog library routines ============================================== diff --git a/Doc/library/tabnanny.rst b/Doc/library/tabnanny.rst index c5d8236..549ce36 100644 --- a/Doc/library/tabnanny.rst +++ b/Doc/library/tabnanny.rst @@ -2,8 +2,8 @@ ====================================================== .. module:: tabnanny - :synopsis: Tool for detecting white space related problems in Python source files in a - directory tree. + :synopsis: Tool for detecting white space related problems in Python + source files in a directory tree. .. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net> .. sectionauthor:: Peter Funk <pf@artcom-gmbh.de> diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst index 0002143..1f53037 100644 --- a/Doc/library/tarfile.rst +++ b/Doc/library/tarfile.rst @@ -1,5 +1,3 @@ -.. _tarfile-mod: - :mod:`tarfile` --- Read and write tar archive files =================================================== diff --git a/Doc/library/telnetlib.rst b/Doc/library/telnetlib.rst index 134ddb6..f3d914a 100644 --- a/Doc/library/telnetlib.rst +++ b/Doc/library/telnetlib.rst @@ -1,4 +1,3 @@ - :mod:`telnetlib` --- Telnet client ================================== @@ -23,7 +22,7 @@ SE (Subnegotiation End), NOP (No Operation), DM (Data Mark), BRK (Break), IP Character), EL (Erase Line), GA (Go Ahead), SB (Subnegotiation Begin). -.. class:: Telnet([host[, port[, timeout]]]) +.. class:: Telnet(host=None, port=0[, timeout]) :class:`Telnet` represents a connection to a Telnet server. The instance is initially not connected by default; the :meth:`open` method must be used to @@ -60,7 +59,7 @@ Telnet Objects :class:`Telnet` instances have the following methods: -.. method:: Telnet.read_until(expected[, timeout]) +.. method:: Telnet.read_until(expected, timeout=None) Read until a given byte string, *expected*, is encountered or until *timeout* seconds have passed. @@ -123,7 +122,7 @@ Telnet Objects This method never blocks. -.. method:: Telnet.open(host[, port[, timeout]]) +.. method:: Telnet.open(host, port=0[, timeout]) Connect to a host. The optional second argument is the port number, which defaults to the standard Telnet port (23). The optional *timeout* parameter @@ -133,7 +132,7 @@ Telnet Objects Do not try to reopen an already connected instance. -.. method:: Telnet.msg(msg[, *args]) +.. method:: Telnet.msg(msg, *args) Print a debug message when the debug level is ``>`` 0. If extra arguments are present, they are substituted in the message using the standard string @@ -178,7 +177,7 @@ Telnet Objects Multithreaded version of :meth:`interact`. -.. method:: Telnet.expect(list[, timeout]) +.. method:: Telnet.expect(list, timeout=None) Read until one from a list of a regular expressions matches. diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst index 722c5ee..014d673 100644 --- a/Doc/library/tempfile.rst +++ b/Doc/library/tempfile.rst @@ -1,4 +1,3 @@ - :mod:`tempfile` --- Generate temporary files and directories ============================================================ @@ -29,7 +28,7 @@ is recommended to use keyword arguments for clarity. The module defines the following user-callable functions: -.. function:: TemporaryFile([mode='w+b'[, bufsize=-1[, suffix=''[, prefix='tmp'[, dir=None]]]]]) +.. function:: TemporaryFile(mode='w+b', bufsize=-1, suffix='', prefix='tmp', dir=None) Return a file-like object that can be used as a temporary storage area. The file is created using :func:`mkstemp`. It will be destroyed as soon @@ -53,7 +52,7 @@ The module defines the following user-callable functions: :keyword:`with` statement, just like a normal file. -.. function:: NamedTemporaryFile([mode='w+b'[, bufsize=-1[, suffix=''[, prefix='tmp'[, dir=None[, delete=True]]]]]]) +.. function:: NamedTemporaryFile(mode='w+b', bufsize=-1, suffix='', prefix='tmp', dir=None, delete=True) This function operates exactly as :func:`TemporaryFile` does, except that the file is guaranteed to have a visible name in the file system (on @@ -68,7 +67,7 @@ The module defines the following user-callable functions: be used in a :keyword:`with` statement, just like a normal file. -.. function:: SpooledTemporaryFile([max_size=0, [mode='w+b'[, bufsize=-1[, suffix=''[, prefix='tmp'[, dir=None]]]]]]) +.. function:: SpooledTemporaryFile(max_size=0, mode='w+b', bufsize=-1, suffix='', prefix='tmp', dir=None) This function operates exactly as :func:`TemporaryFile` does, except that data is spooled in memory until the file size exceeds *max_size*, or @@ -85,7 +84,7 @@ The module defines the following user-callable functions: used in a :keyword:`with` statement, just like a normal file. -.. function:: mkstemp([suffix=''[, prefix='tmp'[, dir=None[, text=False]]]]) +.. function:: mkstemp(suffix='', prefix='tmp', dir=None, text=False) Creates a temporary file in the most secure manner possible. There are no race conditions in the file's creation, assuming that the platform @@ -123,7 +122,7 @@ The module defines the following user-callable functions: of that file, in that order. -.. function:: mkdtemp([suffix=''[, prefix='tmp'[, dir=None]]]) +.. function:: mkdtemp(suffix='', prefix='tmp', dir=None) Creates a temporary directory in the most secure manner possible. There are no race conditions in the directory's creation. The directory is @@ -138,7 +137,7 @@ The module defines the following user-callable functions: :func:`mkdtemp` returns the absolute pathname of the new directory. -.. function:: mktemp([suffix=''[, prefix='tmp'[, dir=None]]]) +.. function:: mktemp(suffix='', prefix='tmp', dir=None) .. deprecated:: 2.3 Use :func:`mkstemp` instead. diff --git a/Doc/library/termios.rst b/Doc/library/termios.rst index 54fb065..df29496 100644 --- a/Doc/library/termios.rst +++ b/Doc/library/termios.rst @@ -1,4 +1,3 @@ - :mod:`termios` --- POSIX style tty control ========================================== @@ -80,11 +79,11 @@ The module defines the following functions: Convenience functions for common terminal control operations. +.. _termios-example: + Example ------- -.. _termios-example: - Here's a function that prompts for a password with echoing turned off. Note the technique using a separate :func:`tcgetattr` call and a :keyword:`try` ... :keyword:`finally` statement to ensure that the old tty attributes are restored diff --git a/Doc/library/test.rst b/Doc/library/test.rst index 353715b..cc7ff4d 100644 --- a/Doc/library/test.rst +++ b/Doc/library/test.rst @@ -1,4 +1,3 @@ - :mod:`test` --- Regression tests package for Python =================================================== @@ -180,7 +179,7 @@ tests. :mod:`test.support` --- Utility functions for tests -======================================================== +=================================================== .. module:: test.support :synopsis: Support for Python regression tests. @@ -247,7 +246,7 @@ The :mod:`test.support` module defines the following functions: tests. -.. function:: requires(resource[, msg]) +.. function:: requires(resource, msg=None) Raises :exc:`ResourceDenied` if *resource* is not available. *msg* is the argument to :exc:`ResourceDenied` if it is raised. Always returns true if called @@ -372,7 +371,7 @@ The :mod:`test.support` module defines the following functions: The :mod:`test.support` module defines the following classes: -.. class:: TransientResource(exc[, **kwargs]) +.. class:: TransientResource(exc, **kwargs) Instances are a context manager that raises :exc:`ResourceDenied` if the specified exception type is raised. Any keyword arguments are treated as diff --git a/Doc/library/textwrap.rst b/Doc/library/textwrap.rst index 883d5f9..f66416f 100644 --- a/Doc/library/textwrap.rst +++ b/Doc/library/textwrap.rst @@ -1,4 +1,3 @@ - :mod:`textwrap` --- Text wrapping and filling ============================================= @@ -15,16 +14,17 @@ or two text strings, the convenience functions should be good enough; otherwise, you should use an instance of :class:`TextWrapper` for efficiency. -.. function:: wrap(text[, width[, ...]]) +.. function:: wrap(text, width=70, **kwargs) - Wraps the single paragraph in *text* (a string) so every line is at most *width* - characters long. Returns a list of output lines, without final newlines. + Wraps the single paragraph in *text* (a string) so every line is at most + *width* characters long. Returns a list of output lines, without final + newlines. Optional keyword arguments correspond to the instance attributes of :class:`TextWrapper`, documented below. *width* defaults to ``70``. -.. function:: fill(text[, width[, ...]]) +.. function:: fill(text, width=70, **kwargs) Wraps the single paragraph in *text*, and returns a single string containing the wrapped paragraph. :func:`fill` is shorthand for :: @@ -70,11 +70,11 @@ indentation from strings that have unwanted whitespace to the left of the text. print(repr(dedent(s))) # prints 'hello\n world\n' -.. class:: TextWrapper(...) +.. class:: TextWrapper(**kwargs) The :class:`TextWrapper` constructor accepts a number of optional keyword - arguments. Each argument corresponds to one instance attribute, so for example - :: + arguments. Each keyword argument corresponds to an instance attribute, so + for example :: wrapper = TextWrapper(initial_indent="* ") diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index 86a9bf8..aa7f46a 100644 --- a/Doc/library/threading.rst +++ b/Doc/library/threading.rst @@ -89,7 +89,7 @@ This module defines the following functions and objects: thread must release it once for each time it has acquired it. -.. function:: Semaphore([value]) +.. function:: Semaphore(value=1) :noindex: A factory function that returns a new semaphore object. A semaphore manages a @@ -99,7 +99,7 @@ This module defines the following functions and objects: given, *value* defaults to 1. -.. function:: BoundedSemaphore([value]) +.. function:: BoundedSemaphore(value=1) A factory function that returns a new bounded semaphore object. A bounded semaphore checks to make sure its current value doesn't exceed its initial @@ -253,7 +253,7 @@ impossible to detect the termination of alien threads. the *target* argument, if any, with sequential and keyword arguments taken from the *args* and *kwargs* arguments, respectively. - .. method:: join([timeout]) + .. method:: join(timeout=None) Wait until the thread terminates. This blocks the calling thread until the thread whose :meth:`join` method is called terminates -- either normally @@ -349,7 +349,7 @@ and may vary across implementations. All methods are executed atomically. -.. method:: Lock.acquire([blocking=1]) +.. method:: Lock.acquire(blocking=True) Acquire a lock, blocking or non-blocking. @@ -396,7 +396,7 @@ pair) resets the lock to unlocked and allows another thread blocked in :meth:`acquire` to proceed. -.. method:: RLock.acquire([blocking=1]) +.. method:: RLock.acquire(blocking=True) Acquire a lock, blocking or non-blocking. @@ -487,7 +487,7 @@ in a typical producer-consumer situation, adding one item to the buffer only needs to wake up one consumer thread. -.. class:: Condition([lock]) +.. class:: Condition(lock=None) If the *lock* argument is given and not ``None``, it must be a :class:`Lock` or :class:`RLock` object, and it is used as the underlying lock. Otherwise, @@ -503,7 +503,7 @@ needs to wake up one consumer thread. Release the underlying lock. This method calls the corresponding method on the underlying lock; there is no return value. - .. method:: wait([timeout]) + .. method:: wait(timeout=None) Wait until notified or until a timeout occurs. If the calling thread has not acquired the lock when this method is called, a :exc:`RuntimeError` is @@ -566,13 +566,13 @@ can never go below zero; when :meth:`acquire` finds that it is zero, it blocks, waiting until some other thread calls :meth:`release`. -.. class:: Semaphore([value]) +.. class:: Semaphore(value=1) The optional argument gives the initial *value* for the internal counter; it defaults to ``1``. If the *value* given is less than 0, :exc:`ValueError` is raised. - .. method:: acquire([blocking]) + .. method:: acquire(blocking=True) Acquire a semaphore. @@ -659,7 +659,7 @@ An event object manages an internal flag that can be set to true with the :meth:`wait` will block until :meth:`.set` is called to set the internal flag to true again. - .. method:: wait([timeout]) + .. method:: wait(timeout=None) Block until the internal flag is true. If the internal flag is true on entry, return immediately. Otherwise, block until another thread calls diff --git a/Doc/library/time.rst b/Doc/library/time.rst index cdc623d..ceae8fa 100644 --- a/Doc/library/time.rst +++ b/Doc/library/time.rst @@ -1,4 +1,3 @@ - :mod:`time` --- Time access and conversions =========================================== diff --git a/Doc/library/timeit.rst b/Doc/library/timeit.rst index a85fa3e..89ea7b0 100644 --- a/Doc/library/timeit.rst +++ b/Doc/library/timeit.rst @@ -1,4 +1,3 @@ - :mod:`timeit` --- Measure execution time of small code snippets =============================================================== @@ -18,7 +17,7 @@ for measuring execution times. See also Tim Peters' introduction to the The module defines the following public class: -.. class:: Timer([stmt='pass' [, setup='pass' [, timer=<timer function>]]]) +.. class:: Timer(stmt='pass', setup='pass', timer=<timer function>) Class for timing execution speed of small code snippets. @@ -38,7 +37,7 @@ The module defines the following public class: little larger in this case because of the extra function calls. -.. method:: Timer.print_exc([file=None]) +.. method:: Timer.print_exc(file=None) Helper to print a traceback from the timed code. @@ -55,7 +54,7 @@ The module defines the following public class: traceback is sent; it defaults to ``sys.stderr``. -.. method:: Timer.repeat([repeat=3 [, number=1000000]]) +.. method:: Timer.repeat(repeat=3, number=1000000) Call :meth:`timeit` a few times. @@ -76,7 +75,7 @@ The module defines the following public class: and apply common sense rather than statistics. -.. method:: Timer.timeit([number=1000000]) +.. method:: Timer.timeit(number=1000000) Time *number* executions of the main statement. This executes the setup statement once, and then returns the time it takes to execute the main statement @@ -98,14 +97,14 @@ The module defines the following public class: The module also defines two convenience functions: -.. function:: repeat(stmt[, setup[, timer[, repeat=3 [, number=1000000]]]]) +.. function:: repeat(stmt='pass', setup='pass', timer=<default timer>, repeat=3, number=1000000) Create a :class:`Timer` instance with the given statement, setup code and timer function and run its :meth:`repeat` method with the given repeat count and *number* executions. -.. function:: timeit(stmt[, setup[, timer[, number=1000000]]]) +.. function:: timeit(stmt='pass', setup='pass', timer=<default timer>, number=1000000) Create a :class:`Timer` instance with the given statement, setup code and timer function and run its :meth:`timeit` method with *number* executions. diff --git a/Doc/library/tkinter.tix.rst b/Doc/library/tkinter.tix.rst index 7cd343c..6298bac 100644 --- a/Doc/library/tkinter.tix.rst +++ b/Doc/library/tkinter.tix.rst @@ -45,7 +45,7 @@ Using Tix --------- -.. class:: Tix(screenName[, baseName[, className]]) +.. class:: Tk(screenName=None, baseName=None, className='Tix') Toplevel widget of Tix which represents mostly the main window of an application. It has an associated Tcl interpreter. diff --git a/Doc/library/tkinter.ttk.rst b/Doc/library/tkinter.ttk.rst index 4b83794..72875f4 100644 --- a/Doc/library/tkinter.ttk.rst +++ b/Doc/library/tkinter.ttk.rst @@ -262,7 +262,7 @@ methods :meth:`tkinter.Widget.cget` and :meth:`tkinter.Widget.configure`. *x* and *y* are pixel coordinates relative to the widget. - .. method:: instate(statespec[, callback=None[, *args[, **kw]]]) + .. method:: instate(statespec, callback=None, *args, **kw) Test the widget's state. If a callback is not specified, returns True if the widget state matches *statespec* and False otherwise. If callback @@ -270,7 +270,7 @@ methods :meth:`tkinter.Widget.cget` and :meth:`tkinter.Widget.configure`. *statespec*. - .. method:: state([statespec=None]) + .. method:: state(statespec=None) Modify or inquire widget state. If *statespec* is specified, sets the widget state according to it and return a new *statespec* indicating @@ -349,7 +349,7 @@ ttk.Combobox .. class:: Combobox - .. method:: current([newindex=None]) + .. method:: current(newindex=None) If *newindex* is specified, sets the combobox value to the element position *newindex*. Otherwise, returns the index of the current value or @@ -510,7 +510,7 @@ ttk.Notebook See `Tab Options`_ for the list of available options. - .. method:: select([tab_id]) + .. method:: select(tab_id=None) Selects the specified *tab_id*. @@ -519,7 +519,7 @@ ttk.Notebook omitted, returns the widget name of the currently selected pane. - .. method:: tab(tab_id[, option=None[, **kw]]) + .. method:: tab(tab_id, option=None, **kw) Query or modify the options of the specific *tab_id*. @@ -600,14 +600,14 @@ ttk.Progressbar .. class:: Progressbar - .. method:: start([interval]) + .. method:: start(interval=None) Begin autoincrement mode: schedules a recurring timer event that calls :meth:`Progressbar.step` every *interval* milliseconds. If omitted, *interval* defaults to 50 milliseconds. - .. method:: step([amount]) + .. method:: step(amount=None) Increments the progress bar's value by *amount*. @@ -842,7 +842,7 @@ ttk.Treeview .. class:: Treeview - .. method:: bbox(item[, column=None]) + .. method:: bbox(item, column=None) Returns the bounding box (relative to the treeview widget's window) of the specified *item* in the form (x, y, width, height). @@ -852,7 +852,7 @@ ttk.Treeview scrolled offscreen), returns an empty string. - .. method:: get_children([item]) + .. method:: get_children(item=None) Returns the list of children belonging to *item*. @@ -869,7 +869,7 @@ ttk.Treeview *item*'s children. - .. method:: column(column[, option=None[, **kw]]) + .. method:: column(column, option=None, **kw) Query or modify the options for the specified *column*. @@ -918,13 +918,13 @@ ttk.Treeview Returns True if the specified *item* is present in the tree. - .. method:: focus([item=None]) + .. method:: focus(item=None) If *item* is specified, sets the focus item to *item*. Otherwise, returns the current focus item, or '' if there is none. - .. method:: heading(column[, option=None[, **kw]]) + .. method:: heading(column, option=None, **kw) Query or modify the heading options for the specified *column*. @@ -997,7 +997,7 @@ ttk.Treeview Returns the integer index of *item* within its parent's list of children. - .. method:: insert(parent, index[, iid=None[, **kw]]) + .. method:: insert(parent, index, iid=None, **kw) Creates a new item and returns the item identifier of the newly created item. @@ -1014,7 +1014,7 @@ ttk.Treeview See `Item Options`_ for the list of available points. - .. method:: item(item[, option[, **kw]]) + .. method:: item(item, option=None, **kw) Query or modify the options for the specified *item*. @@ -1066,7 +1066,7 @@ ttk.Treeview the tree. - .. method:: selection([selop=None[, items=None]]) + .. method:: selection(selop=None, items=None) If *selop* is not specified, returns selected items. Otherwise, it will act according to the following selection methods. @@ -1092,7 +1092,7 @@ ttk.Treeview Toggle the selection state of each item in *items*. - .. method:: set(item[, column=None[, value=None]]) + .. method:: set(item, column=None, value=None) With one argument, returns a dictionary of column/value pairs for the specified *item*. With two arguments, returns the current value of the @@ -1100,14 +1100,14 @@ ttk.Treeview *column* in given *item* to the specified *value*. - .. method:: tag_bind(tagname[, sequence=None[, callback=None]]) + .. method:: tag_bind(tagname, sequence=None, callback=None) Bind a callback for the given event *sequence* to the tag *tagname*. When an event is delivered to an item, the callbacks for each of the item's tags option are called. - .. method:: tag_configure(tagname[, option=None[, **kw]]) + .. method:: tag_configure(tagname, option=None, **kw) Query or modify the options for the specified *tagname*. @@ -1117,7 +1117,7 @@ ttk.Treeview corresponding values for the given *tagname*. - .. method:: tag_has(tagname[, item]) + .. method:: tag_has(tagname, item=None) If *item* is specified, returns 1 or 0 depending on whether the specified *item* has the given *tagname*. Otherwise, returns a list of all items @@ -1216,7 +1216,7 @@ option. If you don't know the class name of a widget, use the method blue foreground when the widget were in active or pressed states. - .. method:: lookup(style, option[, state=None[, default=None]]) + .. method:: lookup(style, option, state=None, default=None) Returns the value specified for *option* in *style*. @@ -1231,7 +1231,7 @@ option. If you don't know the class name of a widget, use the method print(ttk.Style().lookup("TButton", "font")) - .. method:: layout(style[, layoutspec=None]) + .. method:: layout(style, layoutspec=None) Define the widget layout for given *style*. If *layoutspec* is omitted, return the layout specification for given style. @@ -1314,7 +1314,7 @@ option. If you don't know the class name of a widget, use the method Returns the list of *elementname*'s options. - .. method:: theme_create(themename[, parent=None[, settings=None]]) + .. method:: theme_create(themename, parent=None, settings=None) Create a new theme. @@ -1366,7 +1366,7 @@ option. If you don't know the class name of a widget, use the method Returns a list of all known themes. - .. method:: theme_use([themename]) + .. method:: theme_use(themename=None) If *themename* is not given, returns the theme in use. Otherwise, sets the current theme to *themename*, refreshes all widgets and emits a diff --git a/Doc/library/token.rst b/Doc/library/token.rst index 5bf0ea8..bc5c19e 100644 --- a/Doc/library/token.rst +++ b/Doc/library/token.rst @@ -1,4 +1,3 @@ - :mod:`token` --- Constants used with Python parse trees ======================================================= diff --git a/Doc/library/trace.rst b/Doc/library/trace.rst index f79d7e5..f90f44b 100644 --- a/Doc/library/trace.rst +++ b/Doc/library/trace.rst @@ -1,4 +1,3 @@ - :mod:`trace` --- Trace or track Python statement execution ========================================================== @@ -80,7 +79,7 @@ Programming Interface --------------------- -.. class:: Trace([count=1[, trace=1[, countfuncs=0[, countcallers=0[, ignoremods=()[, ignoredirs=()[, infile=None[, outfile=None[, timing=False]]]]]]]]]) +.. class:: Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False) Create an object to trace execution of a single statement or expression. All parameters are optional. *count* enables counting of line numbers. *trace* @@ -98,7 +97,7 @@ Programming Interface Run *cmd* under control of the Trace object with the current tracing parameters. -.. method:: Trace.runctx(cmd[, globals=None[, locals=None]]) +.. method:: Trace.runctx(cmd, globals=None, locals=None) Run *cmd* under control of the Trace object with the current tracing parameters in the defined global and local environments. If not defined, *globals* and diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst index 5c42740..1450797 100644 --- a/Doc/library/traceback.rst +++ b/Doc/library/traceback.rst @@ -20,7 +20,7 @@ the :data:`sys.last_traceback` variable and returned as the third item from The module defines the following functions: -.. function:: print_tb(traceback[, limit[, file]]) +.. function:: print_tb(traceback, limit=None, file=None) Print up to *limit* stack trace entries from *traceback*. If *limit* is omitted or ``None``, all entries are printed. If *file* is omitted or ``None``, the @@ -28,7 +28,7 @@ The module defines the following functions: object to receive the output. -.. function:: print_exception(type, value, traceback[, limit[, file[, chain]]]) +.. function:: print_exception(type, value, traceback, limit=None, file=None, chain=True) Print exception information and up to *limit* stack trace entries from *traceback* to *file*. This differs from :func:`print_tb` in the following @@ -47,19 +47,19 @@ The module defines the following functions: exception. -.. function:: print_exc([limit[, file[, chain]]]) +.. function:: print_exc(limit=None, file=None, chain=True) This is a shorthand for ``print_exception(*sys.exc_info())``. -.. function:: print_last([limit[, file[, chain]]]) +.. function:: print_last(limit=None, file=None, chain=True) This is a shorthand for ``print_exception(sys.last_type, sys.last_value, sys.last_traceback, limit, file)``. In general it will work only after an exception has reached an interactive prompt (see :data:`sys.last_type`). -.. function:: print_stack([f[, limit[, file]]]) +.. function:: print_stack(f=None, limit=None, file=None) This function prints a stack trace from its invocation point. The optional *f* argument can be used to specify an alternate stack frame to start. The optional @@ -67,7 +67,7 @@ The module defines the following functions: :func:`print_exception`. -.. function:: extract_tb(traceback[, limit]) +.. function:: extract_tb(traceback, limit=None) Return a list of up to *limit* "pre-processed" stack trace entries extracted from the traceback object *traceback*. It is useful for alternate formatting of @@ -78,7 +78,7 @@ The module defines the following functions: stripped; if the source is not available it is ``None``. -.. function:: extract_stack([f[, limit]]) +.. function:: extract_stack(f=None, limit=None) Extract the raw traceback from the current stack frame. The return value has the same format as for :func:`extract_tb`. The optional *f* and *limit* @@ -105,7 +105,7 @@ The module defines the following functions: occurred is the always last string in the list. -.. function:: format_exception(type, value, tb[, limit[, chain]]) +.. function:: format_exception(type, value, tb, limit=None, chain=True) Format a stack trace and the exception information. The arguments have the same meaning as the corresponding arguments to :func:`print_exception`. The @@ -114,18 +114,18 @@ The module defines the following functions: same text is printed as does :func:`print_exception`. -.. function:: format_exc([limit[, chain]]) +.. function:: format_exc(limit=None, chain=True) This is like ``print_exc(limit)`` but returns a string instead of printing to a file. -.. function:: format_tb(tb[, limit]) +.. function:: format_tb(tb, limit=None) A shorthand for ``format_list(extract_tb(tb, limit))``. -.. function:: format_stack([f[, limit]]) +.. function:: format_stack(f=None, limit=None) A shorthand for ``format_list(extract_stack(f, limit))``. diff --git a/Doc/library/tty.rst b/Doc/library/tty.rst index 688faee..d13c6f9 100644 --- a/Doc/library/tty.rst +++ b/Doc/library/tty.rst @@ -1,4 +1,3 @@ - :mod:`tty` --- Terminal control functions ========================================= @@ -17,14 +16,14 @@ Because it requires the :mod:`termios` module, it will work only on Unix. The :mod:`tty` module defines the following functions: -.. function:: setraw(fd[, when]) +.. function:: setraw(fd, when=termios.TCSAFLUSH) Change the mode of the file descriptor *fd* to raw. If *when* is omitted, it defaults to :const:`termios.TCSAFLUSH`, and is passed to :func:`termios.tcsetattr`. -.. function:: setcbreak(fd[, when]) +.. function:: setcbreak(fd, when=termios.TCSAFLUSH) Change the mode of file descriptor *fd* to cbreak. If *when* is omitted, it defaults to :const:`termios.TCSAFLUSH`, and is passed to diff --git a/Doc/library/undoc.rst b/Doc/library/undoc.rst index 6dd1aed..80386d2 100644 --- a/Doc/library/undoc.rst +++ b/Doc/library/undoc.rst @@ -1,4 +1,3 @@ - .. _undoc: ******************** diff --git a/Doc/library/unicodedata.rst b/Doc/library/unicodedata.rst index 2358285..e1e6dc1 100644 --- a/Doc/library/unicodedata.rst +++ b/Doc/library/unicodedata.rst @@ -1,4 +1,3 @@ - :mod:`unicodedata` --- Unicode Database ======================================= diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index 283d2fd..9abf727 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -591,7 +591,7 @@ This section describes in depth the API of :mod:`unittest`. Test cases ~~~~~~~~~~ -.. class:: TestCase([methodName]) +.. class:: TestCase(methodName='runTest') Instances of the :class:`TestCase` class represent the smallest testable units in the :mod:`unittest` universe. This class is intended to be used as a base @@ -642,7 +642,7 @@ Test cases the outcome of the test method. The default implementation does nothing. - .. method:: run([result]) + .. method:: run(result=None) Run the test, collecting the result into the test result object passed as *result*. If *result* is omitted or :const:`None`, a temporary result @@ -669,9 +669,9 @@ Test cases failures. - .. method:: assertTrue(expr[, msg]) - assert_(expr[, msg]) - failUnless(expr[, msg]) + .. method:: assertTrue(expr, msg=None) + assert_(expr, msg=None) + failUnless(expr, msg=None) Signal a test failure if *expr* is false; the explanation for the failure will be *msg* if given, otherwise it will be :const:`None`. @@ -680,8 +680,8 @@ Test cases :meth:`failUnless`. - .. method:: assertEqual(first, second[, msg]) - failUnlessEqual(first, second[, msg]) + .. method:: assertEqual(first, second, msg=None) + failUnlessEqual(first, second, msg=None) Test that *first* and *second* are equal. If the values do not compare equal, the test will fail with the explanation given by *msg*, or @@ -702,8 +702,8 @@ Test cases :meth:`failUnlessEqual`. - .. method:: assertNotEqual(first, second[, msg]) - failIfEqual(first, second[, msg]) + .. method:: assertNotEqual(first, second, msg=None) + failIfEqual(first, second, msg=None) Test that *first* and *second* are not equal. If the values do compare equal, the test will fail with the explanation given by *msg*, or @@ -716,8 +716,8 @@ Test cases :meth:`failIfEqual`. - .. method:: assertAlmostEqual(first, second[, places[, msg]]) - failUnlessAlmostEqual(first, second[, places[, msg]]) + .. method:: assertAlmostEqual(first, second, *, places=7, msg=None) + failUnlessAlmostEqual(first, second, *, places=7, msg=None) Test that *first* and *second* are approximately equal by computing the difference, rounding to the given number of decimal *places* (default 7), @@ -732,8 +732,8 @@ Test cases :meth:`failUnlessAlmostEqual`. - .. method:: assertNotAlmostEqual(first, second[, places[, msg]]) - failIfAlmostEqual(first, second[, places[, msg]]) + .. method:: assertNotAlmostEqual(first, second, *, places=7, msg=None) + failIfAlmostEqual(first, second, *, places=7, msg=None) Test that *first* and *second* are not approximately equal by computing the difference, rounding to the given number of decimal *places* (default @@ -774,7 +774,7 @@ Test cases .. versionadded:: 3.1 - .. method:: assertRegexpMatches(text, regexp[, msg=None]): + .. method:: assertRegexpMatches(text, regexp, msg=None): Verifies that a *regexp* search matches *text*. Fails with an error message including the pattern and the *text*. *regexp* may be @@ -867,8 +867,10 @@ Test cases .. versionadded:: 3.1 - .. method:: assertRaises(exception[, callable, ...]) - failUnlessRaises(exception[, callable, ...]) + .. method:: assertRaises(exception, callable, *args, **kwds) + failUnlessRaises(exception, callable, *args, **kwds) + assertRaises(exception) + failUnlessRaises(exception) Test that an exception is raised when *callable* is called with any positional or keyword arguments that are also passed to @@ -877,8 +879,8 @@ Test cases To catch any of a group of exceptions, a tuple containing the exception classes may be passed as *exception*. - If *callable* is omitted or None, returns a context manager so that the - code under test can be written inline rather than as a function:: + If only the *exception* argument is given, returns a context manager so + that the code under test can be written inline rather than as a function:: with self.failUnlessRaises(some_error_class): do_something() @@ -908,14 +910,14 @@ Test cases .. versionadded:: 3.1 - .. method:: assertIsNone(expr[, msg]) + .. method:: assertIsNone(expr, msg=None) This signals a test failure if *expr* is not None. .. versionadded:: 3.1 - .. method:: assertIsNotNone(expr[, msg]) + .. method:: assertIsNotNone(expr, msg=None) The inverse of the :meth:`assertIsNone` method. This signals a test failure if *expr* is None. @@ -923,7 +925,7 @@ Test cases .. versionadded:: 3.1 - .. method:: assertIs(expr1, expr2[, msg]) + .. method:: assertIs(expr1, expr2, msg=None) This signals a test failure if *expr1* and *expr2* don't evaluate to the same object. @@ -931,7 +933,7 @@ Test cases .. versionadded:: 3.1 - .. method:: assertIsNot(expr1, expr2[, msg]) + .. method:: assertIsNot(expr1, expr2, msg=None) The inverse of the :meth:`assertIs` method. This signals a test failure if *expr1* and *expr2* evaluate to the same @@ -940,8 +942,8 @@ Test cases .. versionadded:: 3.1 - .. method:: assertFalse(expr[, msg]) - failIf(expr[, msg]) + .. method:: assertFalse(expr, msg=None) + failIf(expr, msg=None) The inverse of the :meth:`assertTrue` method is the :meth:`assertFalse` method. This signals a test failure if *expr* is true, with *msg* or :const:`None` @@ -951,7 +953,7 @@ Test cases :meth:`failIf`. - .. method:: fail([msg]) + .. method:: fail(msg=None) Signals a test failure unconditionally, with *msg* or :const:`None` for the error message. @@ -1042,7 +1044,7 @@ Test cases .. versionadded:: 3.1 - .. method:: addCleanup(function[, *args[, **kwargs]]) + .. method:: addCleanup(function, *args, **kwargs) Add a function to be called after :meth:`tearDown` to cleanup resources used during the test. Functions will be called in reverse order to the @@ -1072,7 +1074,7 @@ Test cases .. versionadded:: 2.7 -.. class:: FunctionTestCase(testFunc[, setUp[, tearDown[, description]]]) +.. class:: FunctionTestCase(testFunc, setUp=None, tearDown=None, description=None) This class implements the portion of the :class:`TestCase` interface which allows the test runner to drive the test, but does not provide the methods @@ -1086,7 +1088,7 @@ Test cases Grouping tests ~~~~~~~~~~~~~~ -.. class:: TestSuite([tests]) +.. class:: TestSuite(tests=()) This class represents an aggregation of individual tests cases and test suites. The class presents the interface needed by the test runner to allow it to be run @@ -1200,7 +1202,7 @@ Loading and running tests Support for ``load_tests`` added. - .. method:: loadTestsFromName(name[, module]) + .. method:: loadTestsFromName(name, module=None) Return a suite of all tests cases given a string specifier. @@ -1225,7 +1227,7 @@ Loading and running tests The method optionally resolves *name* relative to the given *module*. - .. method:: loadTestsFromNames(names[, module]) + .. method:: loadTestsFromNames(names, module=None) Similar to :meth:`loadTestsFromName`, but takes a sequence of names rather than a single name. The return value is a test suite which supports all @@ -1467,7 +1469,7 @@ Loading and running tests instead of repeatedly creating new instances. -.. class:: TextTestRunner([stream[, descriptions[, verbosity]]]) +.. class:: TextTestRunner(stream=sys.stderr, descriptions=True, verbosity=1) A basic test runner implementation which prints results on standard error. It has a few configurable parameters, but is essentially very simple. Graphical @@ -1480,7 +1482,7 @@ Loading and running tests subclasses to provide a custom ``TestResult``. -.. function:: main([module[, defaultTest[, argv[, testRunner[, testLoader[, exit, [verbosity]]]]]]]) +.. function:: main(module='__main__', defaultTest=None, argv=None, testRunner=None, testLoader=unittest.loader.defaultTestLoader, exit=True, verbosity=1) A command-line program that runs a set of tests; this is primarily for making test modules conveniently executable. The simplest use for this function is to diff --git a/Doc/library/unix.rst b/Doc/library/unix.rst index 7cb54c2..04d4081 100644 --- a/Doc/library/unix.rst +++ b/Doc/library/unix.rst @@ -1,4 +1,3 @@ - .. _unix: ********************** diff --git a/Doc/library/urllib.error.rst b/Doc/library/urllib.error.rst index 714ee47..282329f 100644 --- a/Doc/library/urllib.error.rst +++ b/Doc/library/urllib.error.rst @@ -39,7 +39,7 @@ The following exceptions are raised by :mod:`urllib.error` as appropriate: to a value found in the dictionary of codes as found in :attr:`http.server.BaseHTTPRequestHandler.responses`. -.. exception:: ContentTooShortError(msg[, content]) +.. exception:: ContentTooShortError(msg, content) This exception is raised when the :func:`urlretrieve` function detects that the amount of the downloaded data is less than the expected amount (given by diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst index 2163e6c..f251852 100644 --- a/Doc/library/urllib.parse.rst +++ b/Doc/library/urllib.parse.rst @@ -26,7 +26,7 @@ following URL schemes: ``file``, ``ftp``, ``gopher``, ``hdl``, ``http``, The :mod:`urllib.parse` module defines the following functions: -.. function:: urlparse(urlstring[, default_scheme[, allow_fragments]]) +.. function:: urlparse(urlstring, default_scheme='', allow_fragments=True) Parse a URL into six components, returning a 6-tuple. This corresponds to the general structure of a URL: ``scheme://netloc/path;parameters?query#fragment``. @@ -89,7 +89,7 @@ The :mod:`urllib.parse` module defines the following functions: object. -.. function:: parse_qs(qs[, keep_blank_values[, strict_parsing]]) +.. function:: parse_qs(qs, keep_blank_values=False, strict_parsing=False) Parse a query string given as a string argument (data of type :mimetype:`application/x-www-form-urlencoded`). Data are returned as a @@ -110,7 +110,7 @@ The :mod:`urllib.parse` module defines the following functions: dictionaries into query strings. -.. function:: parse_qsl(qs[, keep_blank_values[, strict_parsing]]) +.. function:: parse_qsl(qs, keep_blank_values=False, strict_parsing=False) Parse a query string given as a string argument (data of type :mimetype:`application/x-www-form-urlencoded`). Data are returned as a list of @@ -139,7 +139,7 @@ The :mod:`urllib.parse` module defines the following functions: states that these are equivalent). -.. function:: urlsplit(urlstring[, default_scheme[, allow_fragments]]) +.. function:: urlsplit(urlstring, default_scheme='', allow_fragments=True) This is similar to :func:`urlparse`, but does not split the params from the URL. This should generally be used instead of :func:`urlparse` if the more recent URL @@ -187,7 +187,7 @@ The :mod:`urllib.parse` module defines the following functions: with an empty query; the RFC states that these are equivalent). -.. function:: urljoin(base, url[, allow_fragments]) +.. function:: urljoin(base, url, allow_fragments=True) Construct a full ("absolute") URL by combining a "base URL" (*base*) with another URL (*url*). Informally, this uses components of the base URL, in @@ -223,7 +223,8 @@ The :mod:`urllib.parse` module defines the following functions: string. If there is no fragment identifier in *url*, return *url* unmodified and an empty string. -.. function:: quote(string[, safe[, encoding[, errors]]]) + +.. function:: quote(string, safe='/', encoding=None, errors=None) Replace special characters in *string* using the ``%xx`` escape. Letters, digits, and the characters ``'_.-'`` are never quoted. By default, this @@ -247,7 +248,7 @@ The :mod:`urllib.parse` module defines the following functions: Example: ``quote('/El Niño/')`` yields ``'/El%20Ni%C3%B1o/'``. -.. function:: quote_plus(string[, safe[, encoding[, errors]]]) +.. function:: quote_plus(string, safe='', encoding=None, errors=None) Like :func:`quote`, but also replace spaces by plus signs, as required for quoting HTML form values when building up a query string to go into a URL. @@ -256,7 +257,8 @@ The :mod:`urllib.parse` module defines the following functions: Example: ``quote_plus('/El Niño/')`` yields ``'%2FEl+Ni%C3%B1o%2F'``. -.. function:: quote_from_bytes(bytes[, safe]) + +.. function:: quote_from_bytes(bytes, safe='/') Like :func:`quote`, but accepts a :class:`bytes` object rather than a :class:`str`, and does not perform string-to-bytes encoding. @@ -264,7 +266,8 @@ The :mod:`urllib.parse` module defines the following functions: Example: ``quote_from_bytes(b'a&\xef')`` yields ``'a%26%EF'``. -.. function:: unquote(string[, encoding[, errors]]) + +.. function:: unquote(string, encoding='utf-8', errors='replace') Replace ``%xx`` escapes by their single-character equivalent. The optional *encoding* and *errors* parameters specify how to decode @@ -280,7 +283,7 @@ The :mod:`urllib.parse` module defines the following functions: Example: ``unquote('/El%20Ni%C3%B1o/')`` yields ``'/El Niño/'``. -.. function:: unquote_plus(string[, encoding[, errors]]) +.. function:: unquote_plus(string, encoding='utf-8', errors='replace') Like :func:`unquote`, but also replace plus signs by spaces, as required for unquoting HTML form values. @@ -289,6 +292,7 @@ The :mod:`urllib.parse` module defines the following functions: Example: ``unquote_plus('/El+Ni%C3%B1o/')`` yields ``'/El Niño/'``. + .. function:: unquote_to_bytes(string) Replace ``%xx`` escapes by their single-octet equivalent, and return a @@ -303,7 +307,7 @@ The :mod:`urllib.parse` module defines the following functions: ``b'a&\xef'``. -.. function:: urlencode(query[, doseq]) +.. function:: urlencode(query, doseq=False) Convert a mapping object or a sequence of two-element tuples to a "url-encoded" string, suitable to pass to :func:`urlopen` above as the optional *data* diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index fdf6c8a..b05641c 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -14,7 +14,7 @@ authentication, redirections, cookies and more. The :mod:`urllib.request` module defines the following functions: -.. function:: urlopen(url[, data][, timeout]) +.. function:: urlopen(url, data=None[, timeout]) Open the URL *url*, which can be either a string or a :class:`Request` object. @@ -75,13 +75,14 @@ The :mod:`urllib.request` module defines the following functions: :class:`HTTPRedirectHandler`, :class:`FTPHandler`, :class:`FileHandler`, :class:`HTTPErrorProcessor`. - If the Python installation has SSL support (i.e., if the :mod:`ssl` module can be imported), - :class:`HTTPSHandler` will also be added. + If the Python installation has SSL support (i.e., if the :mod:`ssl` module + can be imported), :class:`HTTPSHandler` will also be added. A :class:`BaseHandler` subclass may also change its :attr:`handler_order` member variable to modify its position in the handlers list. -.. function:: urlretrieve(url[, filename[, reporthook[, data]]]) + +.. function:: urlretrieve(url, filename=None, reporthook=None, data=None) Copy a network object denoted by a URL to a local file, if necessary. If the URL points to a local file, or a valid cached copy of the object exists, the object @@ -160,9 +161,10 @@ The :mod:`urllib.request` module defines the following functions: path. This does not accept a complete URL. This function uses :func:`unquote` to decode *path*. + The following classes are provided: -.. class:: Request(url[, data][, headers][, origin_req_host][, unverifiable]) +.. class:: Request(url, data=None, headers={}, origin_req_host=None, unverifiable=False) This class is an abstraction of a URL request. @@ -205,7 +207,8 @@ The following classes are provided: document, and the user had no option to approve the automatic fetching of the image, this should be true. -.. class:: URLopener([proxies[, **x509]]) + +.. class:: URLopener(proxies=None, **x509) Base class for opening and reading URLs. Unless you need to support opening objects using schemes other than :file:`http:`, :file:`ftp:`, or :file:`file:`, @@ -230,7 +233,7 @@ The following classes are provided: :class:`URLopener` objects will raise an :exc:`IOError` exception if the server returns an error code. - .. method:: open(fullurl[, data]) + .. method:: open(fullurl, data=None) Open *fullurl* using the appropriate protocol. This method sets up cache and proxy information, then calls the appropriate open method with its input @@ -239,12 +242,12 @@ The following classes are provided: :func:`urlopen`. - .. method:: open_unknown(fullurl[, data]) + .. method:: open_unknown(fullurl, data=None) Overridable interface to open unknown URL types. - .. method:: retrieve(url[, filename[, reporthook[, data]]]) + .. method:: retrieve(url, filename=None, reporthook=None, data=None) Retrieves the contents of *url* and places it in *filename*. The return value is a tuple consisting of a local filename and either a @@ -337,12 +340,12 @@ The following classes are provided: A class to handle redirections. -.. class:: HTTPCookieProcessor([cookiejar]) +.. class:: HTTPCookieProcessor(cookiejar=None) A class to handle HTTP Cookies. -.. class:: ProxyHandler([proxies]) +.. class:: ProxyHandler(proxies=None) Cause requests to go through a proxy. If *proxies* is given, it must be a dictionary mapping protocol names to URLs of proxies. The default is to read the @@ -362,7 +365,7 @@ The following classes are provided: fits. -.. class:: AbstractBasicAuthHandler([password_mgr]) +.. class:: AbstractBasicAuthHandler(password_mgr=None) This is a mixin class that helps with HTTP authentication, both to the remote host and to a proxy. *password_mgr*, if given, should be something that is @@ -371,7 +374,7 @@ The following classes are provided: supported. -.. class:: HTTPBasicAuthHandler([password_mgr]) +.. class:: HTTPBasicAuthHandler(password_mgr=None) Handle authentication with the remote host. *password_mgr*, if given, should be something that is compatible with :class:`HTTPPasswordMgr`; refer to section @@ -379,7 +382,7 @@ The following classes are provided: supported. -.. class:: ProxyBasicAuthHandler([password_mgr]) +.. class:: ProxyBasicAuthHandler(password_mgr=None) Handle authentication with the proxy. *password_mgr*, if given, should be something that is compatible with :class:`HTTPPasswordMgr`; refer to section @@ -387,7 +390,7 @@ The following classes are provided: supported. -.. class:: AbstractDigestAuthHandler([password_mgr]) +.. class:: AbstractDigestAuthHandler(password_mgr=None) This is a mixin class that helps with HTTP authentication, both to the remote host and to a proxy. *password_mgr*, if given, should be something that is @@ -396,7 +399,7 @@ The following classes are provided: supported. -.. class:: HTTPDigestAuthHandler([password_mgr]) +.. class:: HTTPDigestAuthHandler(password_mgr=None) Handle authentication with the remote host. *password_mgr*, if given, should be something that is compatible with :class:`HTTPPasswordMgr`; refer to section @@ -404,7 +407,7 @@ The following classes are provided: supported. -.. class:: ProxyDigestAuthHandler([password_mgr]) +.. class:: ProxyDigestAuthHandler(password_mgr=None) Handle authentication with the proxy. *password_mgr*, if given, should be something that is compatible with :class:`HTTPPasswordMgr`; refer to section @@ -597,7 +600,7 @@ OpenerDirector Objects post-process *protocol* responses. -.. method:: OpenerDirector.open(url[, data][, timeout]) +.. method:: OpenerDirector.open(url, data=None[, timeout]) Open the given *url* (which can be a request object or a string), optionally passing the given *data*. Arguments, return values and exceptions raised are @@ -609,7 +612,7 @@ OpenerDirector Objects HTTP, HTTPS, FTP and FTPS connections). -.. method:: OpenerDirector.error(proto[, arg[, ...]]) +.. method:: OpenerDirector.error(proto, *args) Handle an error of the given protocol. This will call the registered error handlers for the given protocol with the given arguments (which are protocol diff --git a/Doc/library/uu.rst b/Doc/library/uu.rst index 7973439..7813e44 100644 --- a/Doc/library/uu.rst +++ b/Doc/library/uu.rst @@ -1,4 +1,3 @@ - :mod:`uu` --- Encode and decode uuencode files ============================================== @@ -25,7 +24,7 @@ This code was contributed by Lance Ellinghouse, and modified by Jack Jansen. The :mod:`uu` module defines the following functions: -.. function:: encode(in_file, out_file[, name[, mode]]) +.. function:: encode(in_file, out_file, name=None, mode=None) Uuencode file *in_file* into file *out_file*. The uuencoded file will have the header specifying *name* and *mode* as the defaults for the results of @@ -33,7 +32,7 @@ The :mod:`uu` module defines the following functions: and ``0o666`` respectively. -.. function:: decode(in_file[, out_file[, mode[, quiet]]]) +.. function:: decode(in_file, out_file=None, mode=None, quiet=False) This call decodes uuencoded file *in_file* placing the result on file *out_file*. If *out_file* is a pathname, *mode* is used to set the permission diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst index 6ab4889..0ec2ed3 100644 --- a/Doc/library/uuid.rst +++ b/Doc/library/uuid.rst @@ -1,4 +1,3 @@ - :mod:`uuid` --- UUID objects according to RFC 4122 ================================================== @@ -18,7 +17,7 @@ a UUID containing the computer's network address. :func:`uuid4` creates a random UUID. -.. class:: UUID([hex[, bytes[, bytes_le[, fields[, int[, version]]]]]]) +.. class:: UUID(hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None) Create a UUID from either a string of 32 hexadecimal digits, a string of 16 bytes as the *bytes* argument, a string of 16 bytes in little-endian order as @@ -43,8 +42,8 @@ random UUID. variant and version number set according to RFC 4122, overriding bits in the given *hex*, *bytes*, *bytes_le*, *fields*, or *int*. -:class:`UUID` instances have these read-only attributes: +:class:`UUID` instances have these read-only attributes: .. attribute:: UUID.bytes @@ -126,7 +125,7 @@ The :mod:`uuid` module defines the following functions: .. index:: single: getnode -.. function:: uuid1([node[, clock_seq]]) +.. function:: uuid1(node=None, clock_seq=None) Generate a UUID from a host ID, sequence number, and the current time. If *node* is not given, :func:`getnode` is used to obtain the hardware address. If diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst index 260323e..36d47ad 100644 --- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -234,7 +234,7 @@ Available Functions ------------------- -.. function:: warn(message[, category[, stacklevel]]) +.. function:: warn(message, category=None, stacklevel=1) Issue a warning, or maybe ignore it or raise an exception. The *category* argument, if given, must be a warning category class (see above); it defaults to @@ -253,7 +253,7 @@ Available Functions of the warning message). -.. function:: warn_explicit(message, category, filename, lineno[, module[, registry[, module_globals]]]) +.. function:: warn_explicit(message, category, filename, lineno, module=None, registry=None, module_globals=None) This is a low-level interface to the functionality of :func:`warn`, passing in explicitly the message, category, filename and line number, and optionally the @@ -270,7 +270,7 @@ Available Functions sources). -.. function:: showwarning(message, category, filename, lineno[, file[, line]]) +.. function:: showwarning(message, category, filename, lineno, file=None, line=None) Write a warning to a file. The default implementation calls ``formatwarning(message, category, filename, lineno, line)`` and writes the @@ -282,7 +282,7 @@ Available Functions try to read the line specified by *filename* and *lineno*. -.. function:: formatwarning(message, category, filename, lineno[, line]) +.. function:: formatwarning(message, category, filename, lineno, line=None) Format a warning the standard way. This returns a string which may contain embedded newlines and ends in a newline. *line* is a line of source code to @@ -291,7 +291,7 @@ Available Functions *lineno*. -.. function:: filterwarnings(action[, message[, category[, module[, lineno[, append]]]]]) +.. function:: filterwarnings(action, message='', category=Warning, module='', lineno=0, append=False) Insert an entry into the list of :ref:`warnings filter specifications <warning-filter>`. The entry is inserted at the front by default; if @@ -303,7 +303,7 @@ Available Functions everything. -.. function:: simplefilter(action[, category[, lineno[, append]]]) +.. function:: simplefilter(action, category=Warning, lineno=0, append=False) Insert a simple entry into the list of :ref:`warnings filter specifications <warning-filter>`. The meaning of the function parameters is as for @@ -322,7 +322,7 @@ Available Functions Available Context Managers -------------------------- -.. class:: catch_warnings([\*, record=False, module=None]) +.. class:: catch_warnings(\*, record=False, module=None) A context manager that copies and, upon exit, restores the warnings filter and the :func:`showwarning` function. diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst index 3be0343..794559b 100644 --- a/Doc/library/wave.rst +++ b/Doc/library/wave.rst @@ -12,7 +12,7 @@ It does not support compression/decompression, but it does support mono/stereo. The :mod:`wave` module defines the following function and exception: -.. function:: open(file[, mode]) +.. function:: open(file, mode=None) If *file* is a string, open the file by that name, other treat it as a seekable file-like object. *mode* can be any of diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst index 7c7be95..9aaa58a 100644 --- a/Doc/library/weakref.rst +++ b/Doc/library/weakref.rst @@ -1,4 +1,3 @@ - :mod:`weakref` --- Weak references ================================== @@ -92,10 +91,10 @@ Extension types can easily be made to support weak references; see but cannot be propagated; they are handled in exactly the same way as exceptions raised from an object's :meth:`__del__` method. - Weak references are :term:`hashable` if the *object* is hashable. They will maintain - their hash value even after the *object* was deleted. If :func:`hash` is called - the first time only after the *object* was deleted, the call will raise - :exc:`TypeError`. + Weak references are :term:`hashable` if the *object* is hashable. They will + maintain their hash value even after the *object* was deleted. If + :func:`hash` is called the first time only after the *object* was deleted, + the call will raise :exc:`TypeError`. Weak references support tests for equality, but not ordering. If the referents are still alive, two references have the same equality relationship as their diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst index 01720d1..202d7c1 100644 --- a/Doc/library/webbrowser.rst +++ b/Doc/library/webbrowser.rst @@ -1,4 +1,3 @@ - :mod:`webbrowser` --- Convenient Web-browser controller ======================================================= @@ -46,7 +45,7 @@ The following exception is defined: The following functions are defined: -.. function:: open(url[, new=0[, autoraise=True]]) +.. function:: open(url, new=0, autoraise=True) Display *url* using the default browser. If *new* is 0, the *url* is opened in the same browser window if possible. If *new* is 1, a new browser window @@ -72,14 +71,14 @@ The following functions are defined: equivalent to :func:`open_new`. -.. function:: get([name]) +.. function:: get(using=None) - Return a controller object for the browser type *name*. If *name* is empty, - return a controller for a default browser appropriate to the caller's - environment. + Return a controller object for the browser type *using*. If *using* is + ``None``, return a controller for a default browser appropriate to the + caller's environment. -.. function:: register(name, constructor[, instance]) +.. function:: register(name, constructor, instance=None) Register the browser type *name*. Once a browser type is registered, the :func:`get` function can return a controller for that browser type. If @@ -175,7 +174,7 @@ Browser controllers provide these methods which parallel three of the module-level convenience functions: -.. method:: controller.open(url[, new[, autoraise=True]]) +.. method:: controller.open(url, new=0, autoraise=True) Display *url* using the browser handled by this controller. If *new* is 1, a new browser window is opened if possible. If *new* is 2, a new browser page ("tab") diff --git a/Doc/library/winreg.rst b/Doc/library/winreg.rst index ad46bc3..9932c60 100644 --- a/Doc/library/winreg.rst +++ b/Doc/library/winreg.rst @@ -183,7 +183,7 @@ This module offers the following functions: :const:`HKEY_LOCAL_MACHINE` tree. This may or may not be true. -.. function:: OpenKey(key, sub_key[, res=0][, sam=KEY_READ]) +.. function:: OpenKey(key, sub_key, res=0, sam=KEY_READ) Opens the specified key, returning a :dfn:`handle object` @@ -195,7 +195,7 @@ This module offers the following functions: *res* is a reserved integer, and must be zero. The default is zero. *sam* is an integer that specifies an access mask that describes the desired - security access for the key. Default is :const:`KEY_READ` + security access for the key. Default is :const:`KEY_READ`. The result is a new handle to the specified key. diff --git a/Doc/library/winsound.rst b/Doc/library/winsound.rst index f42ff18..d54c999 100644 --- a/Doc/library/winsound.rst +++ b/Doc/library/winsound.rst @@ -1,4 +1,3 @@ - :mod:`winsound` --- Sound-playing interface for Windows ======================================================= @@ -31,7 +30,7 @@ provided by Windows platforms. It includes functions and several constants. indicates an error, :exc:`RuntimeError` is raised. -.. function:: MessageBeep([type=MB_OK]) +.. function:: MessageBeep(type=MB_OK) Call the underlying :cfunc:`MessageBeep` function from the Platform API. This plays a sound as specified in the registry. The *type* argument specifies which diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index de2eb37..803db26 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -57,7 +57,7 @@ parameter expect a WSGI-compliant dictionary to be supplied; please see found, and "http" otherwise. -.. function:: request_uri(environ [, include_query=1]) +.. function:: request_uri(environ, include_query=True) Return the full request URI, optionally including the query string, using the algorithm found in the "URL Reconstruction" section of :pep:`333`. If @@ -146,7 +146,7 @@ also provides these miscellaneous utilities: :rfc:`2616`. -.. class:: FileWrapper(filelike [, blksize=8192]) +.. class:: FileWrapper(filelike, blksize=8192) A wrapper to convert a file-like object to an :term:`iterator`. The resulting objects support both :meth:`__getitem__` and :meth:`__iter__` iteration styles, for @@ -269,7 +269,7 @@ request. (E.g., using the :func:`shift_path_info` function from :mod:`wsgiref.util`.) -.. function:: make_server(host, port, app [, server_class=WSGIServer [, handler_class=WSGIRequestHandler]]) +.. function:: make_server(host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler) Create a new WSGI server listening on *host* and *port*, accepting connections for *app*. The return value is an instance of the supplied *server_class*, and @@ -458,7 +458,7 @@ input, output, and error streams. environment. -.. class:: BaseCGIHandler(stdin, stdout, stderr, environ [, multithread=True [, multiprocess=False]]) +.. class:: BaseCGIHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False) Similar to :class:`CGIHandler`, but instead of using the :mod:`sys` and :mod:`os` modules, the CGI environment and I/O streams are specified explicitly. @@ -473,7 +473,7 @@ input, output, and error streams. instead of :class:`SimpleHandler`. -.. class:: SimpleHandler(stdin, stdout, stderr, environ [,multithread=True [, multiprocess=False]]) +.. class:: SimpleHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False) Similar to :class:`BaseCGIHandler`, but designed for use with HTTP origin servers. If you are writing an HTTP server implementation, you will probably diff --git a/Doc/library/xdrlib.rst b/Doc/library/xdrlib.rst index e9d9367..4fcb9cd 100644 --- a/Doc/library/xdrlib.rst +++ b/Doc/library/xdrlib.rst @@ -1,4 +1,3 @@ - :mod:`xdrlib` --- Encode and decode XDR data ============================================ diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst index b7e4216..98e7586 100644 --- a/Doc/library/xml.dom.minidom.rst +++ b/Doc/library/xml.dom.minidom.rst @@ -1,4 +1,3 @@ - :mod:`xml.dom.minidom` --- Lightweight DOM implementation ========================================================= @@ -28,7 +27,7 @@ DOM applications typically start by parsing some XML into a DOM. With The :func:`parse` function can take either a filename or an open file object. -.. function:: parse(filename_or_file[, parser[, bufsize]]) +.. function:: parse(filename_or_file, parser=None, bufsize=None) Return a :class:`Document` from the given input. *filename_or_file* may be either a file name, or a file-like object. *parser*, if given, must be a SAX2 @@ -40,7 +39,7 @@ If you have XML in a string, you can use the :func:`parseString` function instead: -.. function:: parseString(string[, parser]) +.. function:: parseString(string, parser=None) Return a :class:`Document` that represents the *string*. This method creates a :class:`StringIO` object for the string and passes that on to :func:`parse`. @@ -126,7 +125,7 @@ module documentation. This section lists the differences between the API and to discard children of that node. -.. method:: Node.writexml(writer[, indent=""[, addindent=""[, newl=""[, encoding=""]]]]) +.. method:: Node.writexml(writer, indent="", addindent="", newl="", encoding="") Write XML to the writer object. The writer should have a :meth:`write` method which matches that of the file object interface. The *indent* parameter is the @@ -138,7 +137,7 @@ module documentation. This section lists the differences between the API and used to specify the encoding field of the XML header. -.. method:: Node.toxml([encoding]) +.. method:: Node.toxml(encoding=None) Return the XML that the DOM represents as a string. @@ -153,7 +152,7 @@ module documentation. This section lists the differences between the API and encoding argument should be specified as "utf-8". -.. method:: Node.toprettyxml([indent=""[, newl=""[, encoding=""]]]) +.. method:: Node.toprettyxml(indent="", newl="", encoding="") Return a pretty-printed version of the document. *indent* specifies the indentation string and defaults to a tabulator; *newl* specifies the string diff --git a/Doc/library/xml.dom.pulldom.rst b/Doc/library/xml.dom.pulldom.rst index 18b166f..1893fba 100644 --- a/Doc/library/xml.dom.pulldom.rst +++ b/Doc/library/xml.dom.pulldom.rst @@ -1,4 +1,3 @@ - :mod:`xml.dom.pulldom` --- Support for building partial DOM trees ================================================================= @@ -11,7 +10,7 @@ Object Model representation of a document from SAX events. -.. class:: PullDOM([documentFactory]) +.. class:: PullDOM(documentFactory=None) :class:`xml.sax.handler.ContentHandler` implementation that ... @@ -21,17 +20,17 @@ Object Model representation of a document from SAX events. ... -.. class:: SAX2DOM([documentFactory]) +.. class:: SAX2DOM(documentFactory=None) :class:`xml.sax.handler.ContentHandler` implementation that ... -.. function:: parse(stream_or_string[, parser[, bufsize]]) +.. function:: parse(stream_or_string, parser=None, bufsize=None) ... -.. function:: parseString(string[, parser]) +.. function:: parseString(string, parser=None) ... diff --git a/Doc/library/xml.dom.rst b/Doc/library/xml.dom.rst index bf1b151..fe21804 100644 --- a/Doc/library/xml.dom.rst +++ b/Doc/library/xml.dom.rst @@ -1,4 +1,3 @@ - :mod:`xml.dom` --- The Document Object Model API ================================================ @@ -96,7 +95,7 @@ The :mod:`xml.dom` contains the following functions: implementation supports some customization). -.. function:: getDOMImplementation([name[, features]]) +.. function:: getDOMImplementation(name=None, features=()) Return a suitable DOM implementation. The *name* is either well-known, the module name of a DOM implementation, or ``None``. If it is not ``None``, imports diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index 939af6e..0d3f61c 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -1,4 +1,3 @@ - :mod:`xml.etree.ElementTree` --- The ElementTree XML API ======================================================== @@ -41,7 +40,7 @@ Functions --------- -.. function:: Comment([text]) +.. function:: Comment(text=None) Comment element factory. This factory function creates a special element that will be serialized as an XML comment. The comment string can be either @@ -61,7 +60,7 @@ Functions *elem* is an element tree or an individual element. -.. function:: Element(tag[, attrib][, **extra]) +.. function:: Element(tag, attrib={}, **extra) Element factory. This function returns an object implementing the standard Element interface. The exact class or type of that object is implementation @@ -87,7 +86,7 @@ Functions element instance. Returns a true value if this is an element object. -.. function:: iterparse(source[, events]) +.. function:: iterparse(source, events=None) Parses an XML section into an element tree incrementally, and reports what's going on to the user. *source* is a filename or file object containing XML data. @@ -105,7 +104,7 @@ Functions If you need a fully populated element, look for "end" events instead. -.. function:: parse(source[, parser]) +.. function:: parse(source, parser=None) Parses an XML section into an element tree. *source* is a filename or file object containing XML data. *parser* is an optional parser instance. If not @@ -113,7 +112,7 @@ Functions instance. -.. function:: ProcessingInstruction(target[, text]) +.. function:: ProcessingInstruction(target, text=None) PI element factory. This factory function creates a special element that will be serialized as an XML processing instruction. *target* is a string containing @@ -121,7 +120,7 @@ Functions an element instance, representing a processing instruction. -.. function:: SubElement(parent, tag[, attrib[, **extra]]) +.. function:: SubElement(parent, tag, attrib={}, **extra) Subelement factory. This function creates an element instance, and appends it to an existing element. @@ -133,7 +132,7 @@ Functions as keyword arguments. Returns an element instance. -.. function:: tostring(element[, encoding]) +.. function:: tostring(element, encoding=None) Generates a string representation of an XML element, including all subelements. *element* is an Element instance. *encoding* is the output encoding (default is @@ -202,7 +201,7 @@ The following dictionary-like methods work on the element attributes. attributes, and sets the text and tail attributes to None. -.. method:: Element.get(key[, default=None]) +.. method:: Element.get(key, default=None) Gets the element attribute named *key*. @@ -246,7 +245,7 @@ The following methods work on the element's children (subelements). Returns an iterable yielding all matching elements in document order. -.. method:: Element.findtext(condition[, default=None]) +.. method:: Element.findtext(condition, default=None) Finds text for the first subelement matching *condition*. *condition* may be a tag name or path. Returns the text content of the first matching element, or @@ -259,7 +258,7 @@ The following methods work on the element's children (subelements). Returns all subelements. The elements are returned in document order. -.. method:: Element.getiterator([tag=None]) +.. method:: Element.getiterator(tag=None) Creates a tree iterator with the current element as the root. The iterator iterates over this element and all elements below it, in document (depth first) @@ -305,7 +304,7 @@ ElementTree Objects ------------------- -.. class:: ElementTree([element,] [file]) +.. class:: ElementTree(element=None, file=None) ElementTree wrapper class. This class represents an entire element hierarchy, and adds some extra support for serialization to and from standard XML. @@ -336,7 +335,7 @@ ElementTree Objects order. - .. method:: findtext(path[, default]) + .. method:: findtext(path, default=None) Finds the element text for the first toplevel element with given tag. Same as getroot().findtext(path). *path* is the toplevel element to look @@ -346,7 +345,7 @@ ElementTree Objects found, but has no text content, this method returns an empty string. - .. method:: getiterator([tag]) + .. method:: getiterator(tag=None) Creates and returns a tree iterator for the root element. The iterator loops over all elements in this tree, in section order. *tag* is the tag @@ -358,7 +357,7 @@ ElementTree Objects Returns the root element for this tree. - .. method:: parse(source[, parser]) + .. method:: parse(source, parser=None) Loads an external XML section into this element tree. *source* is a file name or file object. *parser* is an optional parser instance. If not @@ -366,7 +365,7 @@ ElementTree Objects root element. - .. method:: write(file[, encoding]) + .. method:: write(file, encoding=None) Writes the element tree to a file, as XML. *file* is a file name, or a file object opened for writing. *encoding* [1]_ is the output encoding @@ -406,7 +405,7 @@ QName Objects ------------- -.. class:: QName(text_or_uri[, tag]) +.. class:: QName(text_or_uri, tag=None) QName wrapper. This can be used to wrap a QName attribute value, in order to get proper namespace handling on output. *text_or_uri* is a string containing @@ -422,7 +421,7 @@ TreeBuilder Objects ------------------- -.. class:: TreeBuilder([element_factory]) +.. class:: TreeBuilder(element_factory=None) Generic element structure builder. This builder converts a sequence of start, data, and end method calls to a well-formed element structure. You can use this @@ -461,7 +460,7 @@ XMLTreeBuilder Objects ---------------------- -.. class:: XMLTreeBuilder([html,] [target]) +.. class:: XMLTreeBuilder(html=0, target=None) Element structure builder for XML source data, based on the expat parser. *html* are predefined HTML entities. This flag is not supported by the current diff --git a/Doc/library/xml.sax.handler.rst b/Doc/library/xml.sax.handler.rst index c7dbdb5..0fa238d 100644 --- a/Doc/library/xml.sax.handler.rst +++ b/Doc/library/xml.sax.handler.rst @@ -1,4 +1,3 @@ - :mod:`xml.sax.handler` --- Base classes for SAX handlers ======================================================== diff --git a/Doc/library/xml.sax.reader.rst b/Doc/library/xml.sax.reader.rst index 5d0b0dd..fb91389 100644 --- a/Doc/library/xml.sax.reader.rst +++ b/Doc/library/xml.sax.reader.rst @@ -1,4 +1,3 @@ - :mod:`xml.sax.xmlreader` --- Interface for XML parsers ====================================================== @@ -48,7 +47,7 @@ a new parser object. methods may return ``None``. -.. class:: InputSource([systemId]) +.. class:: InputSource(system_id=None) Encapsulation of the information needed by the :class:`XMLReader` to read entities. diff --git a/Doc/library/xml.sax.rst b/Doc/library/xml.sax.rst index 163833c..1bf55b4 100644 --- a/Doc/library/xml.sax.rst +++ b/Doc/library/xml.sax.rst @@ -1,4 +1,3 @@ - :mod:`xml.sax` --- Support for SAX2 parsers =========================================== @@ -17,7 +16,7 @@ the SAX API. The convenience functions are: -.. function:: make_parser([parser_list]) +.. function:: make_parser(parser_list=[]) Create and return a SAX :class:`XMLReader` object. The first parser found will be used. If *parser_list* is provided, it must be a sequence of strings which @@ -25,7 +24,7 @@ The convenience functions are: in *parser_list* will be used before modules in the default list of parsers. -.. function:: parse(filename_or_stream, handler[, error_handler]) +.. function:: parse(filename_or_stream, handler, error_handler=handler.ErrorHandler()) Create a SAX parser and use it to parse a document. The document, passed in as *filename_or_stream*, can be a filename or a file object. The *handler* @@ -35,7 +34,7 @@ The convenience functions are: return value; all work must be done by the *handler* passed in. -.. function:: parseString(string, handler[, error_handler]) +.. function:: parseString(string, handler, error_handler=handler.ErrorHandler()) Similar to :func:`parse`, but parses from a buffer *string* received as a parameter. @@ -66,7 +65,7 @@ In addition to these classes, :mod:`xml.sax` provides the following exception classes. -.. exception:: SAXException(msg[, exception]) +.. exception:: SAXException(msg, exception=None) Encapsulate an XML error or warning. This class can contain basic error or warning information from either the XML parser or the application: it can be @@ -90,14 +89,14 @@ classes. interface as well as the :class:`SAXException` interface. -.. exception:: SAXNotRecognizedException(msg[, exception]) +.. exception:: SAXNotRecognizedException(msg, exception=None) Subclass of :exc:`SAXException` raised when a SAX :class:`XMLReader` is confronted with an unrecognized feature or property. SAX applications and extensions may use this class for similar purposes. -.. exception:: SAXNotSupportedException(msg[, exception]) +.. exception:: SAXNotSupportedException(msg, exception=None) Subclass of :exc:`SAXException` raised when a SAX :class:`XMLReader` is asked to enable a feature that is not supported, or to set a property to a value that the diff --git a/Doc/library/xml.sax.utils.rst b/Doc/library/xml.sax.utils.rst index 43bf69e..95099f6 100644 --- a/Doc/library/xml.sax.utils.rst +++ b/Doc/library/xml.sax.utils.rst @@ -1,4 +1,3 @@ - :mod:`xml.sax.saxutils` --- SAX Utilities ========================================= @@ -13,7 +12,7 @@ that are commonly useful when creating SAX applications, either in direct use, or as base classes. -.. function:: escape(data[, entities]) +.. function:: escape(data, entities={}) Escape ``'&'``, ``'<'``, and ``'>'`` in a string of data. @@ -23,7 +22,7 @@ or as base classes. ``'>'`` are always escaped, even if *entities* is provided. -.. function:: unescape(data[, entities]) +.. function:: unescape(data, entities={}) Unescape ``'&'``, ``'<'``, and ``'>'`` in a string of data. @@ -33,7 +32,7 @@ or as base classes. are always unescaped, even if *entities* is provided. -.. function:: quoteattr(data[, entities]) +.. function:: quoteattr(data, entities={}) Similar to :func:`escape`, but also prepares *data* to be used as an attribute value. The return value is a quoted version of *data* with any @@ -51,7 +50,7 @@ or as base classes. using the reference concrete syntax. -.. class:: XMLGenerator([out[, encoding]]) +.. class:: XMLGenerator(out=None, encoding='iso-8859-1') This class implements the :class:`ContentHandler` interface by writing SAX events back into an XML document. In other words, using an :class:`XMLGenerator` @@ -69,7 +68,7 @@ or as base classes. requests as they pass through. -.. function:: prepare_input_source(source[, base]) +.. function:: prepare_input_source(source, base='') This function takes an input source and an optional base URL and returns a fully resolved :class:`InputSource` object ready for reading. The input source can be diff --git a/Doc/library/xmlrpc.client.rst b/Doc/library/xmlrpc.client.rst index e004fa7..52d236e 100644 --- a/Doc/library/xmlrpc.client.rst +++ b/Doc/library/xmlrpc.client.rst @@ -17,7 +17,7 @@ supports writing XML-RPC client code; it handles all the details of translating between conformable Python objects and XML on the wire. -.. class:: ServerProxy(uri[, transport[, encoding[, verbose[, allow_none[, use_datetime]]]]]) +.. class:: ServerProxy(uri, transport=None, encoding=None, verbose=False, allow_none=False, use_datetime=False) A :class:`ServerProxy` instance is an object that manages communication with a remote XML-RPC server. The required first argument is a URI (Uniform Resource @@ -458,7 +458,7 @@ The client code for the preceding server:: Convenience Functions --------------------- -.. function:: dumps(params[, methodname[, methodresponse[, encoding[, allow_none]]]]) +.. function:: dumps(params, methodname=None, methodresponse=None, encoding=None, allow_none=False) Convert *params* into an XML-RPC request. or into a response if *methodresponse* is true. *params* can be either a tuple of arguments or an instance of the @@ -469,7 +469,7 @@ Convenience Functions it via an extension, provide a true value for *allow_none*. -.. function:: loads(data[, use_datetime]) +.. function:: loads(data, use_datetime=False) Convert an XML-RPC request or response into Python objects, a ``(params, methodname)``. *params* is a tuple of argument; *methodname* is a string, or diff --git a/Doc/library/xmlrpc.server.rst b/Doc/library/xmlrpc.server.rst index 0d75206..4a391b7 100644 --- a/Doc/library/xmlrpc.server.rst +++ b/Doc/library/xmlrpc.server.rst @@ -13,7 +13,7 @@ servers written in Python. Servers can either be free standing, using :class:`CGIXMLRPCRequestHandler`. -.. class:: SimpleXMLRPCServer(addr[, requestHandler[, logRequests[, allow_none[, encoding[, bind_and_activate]]]]]) +.. class:: SimpleXMLRPCServer(addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True) Create a new server instance. This class provides methods for registration of functions that can be called by the XML-RPC protocol. The *requestHandler* @@ -29,7 +29,7 @@ servers written in Python. Servers can either be free standing, using the *allow_reuse_address* class variable before the address is bound. -.. class:: CGIXMLRPCRequestHandler([allow_none[, encoding]]) +.. class:: CGIXMLRPCRequestHandler(allow_none=False, encoding=None) Create a new instance to handle XML-RPC requests in a CGI environment. The *allow_none* and *encoding* parameters are passed on to :mod:`xmlrpc.client` @@ -53,7 +53,7 @@ The :class:`SimpleXMLRPCServer` class is based on alone XML-RPC servers. -.. method:: SimpleXMLRPCServer.register_function(function[, name]) +.. method:: SimpleXMLRPCServer.register_function(function, name=None) Register a function that can respond to XML-RPC requests. If *name* is given, it will be the method name associated with *function*, otherwise @@ -62,7 +62,7 @@ alone XML-RPC servers. the period character. -.. method:: SimpleXMLRPCServer.register_instance(instance[, allow_dotted_names]) +.. method:: SimpleXMLRPCServer.register_instance(instance, allow_dotted_names=False) Register an object which is used to expose method names which have not been registered using :meth:`register_function`. If *instance* contains a @@ -167,7 +167,7 @@ The :class:`CGIXMLRPCRequestHandler` class can be used to handle XML-RPC requests sent to Python CGI scripts. -.. method:: CGIXMLRPCRequestHandler.register_function(function[, name]) +.. method:: CGIXMLRPCRequestHandler.register_function(function, name=None) Register a function that can respond to XML-RPC requests. If *name* is given, it will be the method name associated with function, otherwise @@ -201,7 +201,7 @@ requests sent to Python CGI scripts. Register the XML-RPC multicall function ``system.multicall``. -.. method:: CGIXMLRPCRequestHandler.handle_request([request_text = None]) +.. method:: CGIXMLRPCRequestHandler.handle_request(request_text=None) Handle a XML-RPC request. If *request_text* is given, it should be the POST data provided by the HTTP server, otherwise the contents of stdin will be used. @@ -229,7 +229,7 @@ to HTTP GET requests. Servers can either be free standing, using :class:`DocCGIXMLRPCRequestHandler`. -.. class:: DocXMLRPCServer(addr[, requestHandler[, logRequests[, allow_none[, encoding[, bind_and_activate]]]]]) +.. class:: DocXMLRPCServer(addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True) Create a new server instance. All parameters have the same meaning as for :class:`SimpleXMLRPCServer`; *requestHandler* defaults to diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index a4c7e4e..a7fb842 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -1,4 +1,3 @@ - :mod:`zipfile` --- Work with ZIP archives ========================================= @@ -49,7 +48,7 @@ The module defines the following items: Class for creating ZIP archives containing Python libraries. -.. class:: ZipInfo([filename[, date_time]]) +.. class:: ZipInfo(filename='NoName', date_time=(1980,1,1,0,0,0)) Class used to represent information about a member of an archive. Instances of this class are returned by the :meth:`getinfo` and :meth:`infolist` @@ -98,7 +97,7 @@ ZipFile Objects --------------- -.. class:: ZipFile(file[, mode[, compression[, allowZip64]]]) +.. class:: ZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=False) Open a ZIP file, where *file* can be either a path to a file (a string) or a file-like object. The *mode* parameter should be ``'r'`` to read an existing @@ -149,7 +148,7 @@ ZipFile Objects Return a list of archive members by name. -.. method:: ZipFile.open(name[, mode[, pwd]]) +.. method:: ZipFile.open(name, mode='r', pwd=None) Extract a member from the archive as a file-like object (ZipExtFile). *name* is the name of the file in the archive, or a :class:`ZipInfo` object. The *mode* @@ -182,7 +181,7 @@ ZipFile Objects ZIP file that contains members with duplicate names. -.. method:: ZipFile.extract(member[, path[, pwd]]) +.. method:: ZipFile.extract(member, path=None, pwd=None) Extract a member from the archive to the current working directory; *member* must be its full name or a :class:`ZipInfo` object). Its file information is @@ -191,7 +190,7 @@ ZipFile Objects *pwd* is the password used for encrypted files. -.. method:: ZipFile.extractall([path[, members[, pwd]]]) +.. method:: ZipFile.extractall(path=None, members=None, pwd=None) Extract all members from the archive to the current working directory. *path* specifies a different directory to extract to. *members* is optional and must @@ -209,7 +208,7 @@ ZipFile Objects Set *pwd* as default password to extract encrypted files. -.. method:: ZipFile.read(name[, pwd]) +.. method:: ZipFile.read(name, pwd=None) Return the bytes of the file *name* in the archive. *name* is the name of the file in the archive, or a :class:`ZipInfo` object. The archive must be open for @@ -225,7 +224,7 @@ ZipFile Objects :meth:`testzip` on a closed ZipFile will raise a :exc:`RuntimeError`. -.. method:: ZipFile.write(filename[, arcname[, compress_type]]) +.. method:: ZipFile.write(filename, arcname=None, compress_type=None) Write the file named *filename* to the archive, giving it the archive name *arcname* (by default, this will be the same as *filename*, but without a drive @@ -297,7 +296,7 @@ The :class:`PyZipFile` constructor takes the same parameters as the :class:`ZipFile` objects. -.. method:: PyZipFile.writepy(pathname[, basename]) +.. method:: PyZipFile.writepy(pathname, basename='') Search for files :file:`\*.py` and add the corresponding file to the archive. The corresponding file is a :file:`\*.pyo` file if available, else a diff --git a/Doc/library/zipimport.rst b/Doc/library/zipimport.rst index 2315823..1b23b4c 100644 --- a/Doc/library/zipimport.rst +++ b/Doc/library/zipimport.rst @@ -1,4 +1,3 @@ - :mod:`zipimport` --- Import modules from Zip archives ===================================================== diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst index 030f706..4bd8019 100644 --- a/Doc/library/zlib.rst +++ b/Doc/library/zlib.rst @@ -1,10 +1,9 @@ - :mod:`zlib` --- Compression compatible with :program:`gzip` =========================================================== .. module:: zlib - :synopsis: Low-level interface to compression and decompression routines compatible with - gzip. + :synopsis: Low-level interface to compression and decompression routines + compatible with gzip. For applications that require data compression, the functions in this module |