Commit b044b2a7 authored by Georg Brandl's avatar Georg Brandl

Merged revisions 74821,74828-74831,74833,74835 via svnmerge from

svn+ssh://svn.python.org/python/branches/py3k

................
  r74821 | georg.brandl | 2009-09-16 11:42:19 +0200 (Mi, 16 Sep 2009) | 1 line

  #6885: run python 3 as python3.
................
  r74828 | georg.brandl | 2009-09-16 16:23:20 +0200 (Mi, 16 Sep 2009) | 1 line

  Use true booleans.
................
  r74829 | georg.brandl | 2009-09-16 16:24:29 +0200 (Mi, 16 Sep 2009) | 1 line

  Small PEP8 correction.
................
  r74830 | georg.brandl | 2009-09-16 16:36:22 +0200 (Mi, 16 Sep 2009) | 1 line

  Use true booleans.
................
  r74831 | georg.brandl | 2009-09-16 17:54:04 +0200 (Mi, 16 Sep 2009) | 1 line

  Use true booleans and PEP8 for argdefaults.
................
  r74833 | georg.brandl | 2009-09-16 17:58:14 +0200 (Mi, 16 Sep 2009) | 1 line

  Last round of adapting style of documenting argument default values.
................
  r74835 | georg.brandl | 2009-09-16 18:00:31 +0200 (Mi, 16 Sep 2009) | 33 lines

  Merged revisions 74817-74820,74822-74824 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r74817 | georg.brandl | 2009-09-16 11:05:11 +0200 (Mi, 16 Sep 2009) | 1 line

    Make deprecation notices as visible as warnings are right now.
  ........
    r74818 | georg.brandl | 2009-09-16 11:23:04 +0200 (Mi, 16 Sep 2009) | 1 line

    #6880: add reference to classes section in exceptions section, which comes earlier.
  ........
    r74819 | georg.brandl | 2009-09-16 11:24:57 +0200 (Mi, 16 Sep 2009) | 1 line

    #6876: fix base class constructor invocation in example.
  ........
    r74820 | georg.brandl | 2009-09-16 11:30:48 +0200 (Mi, 16 Sep 2009) | 1 line

    #6891: comment out dead link to Unicode article.
  ........
    r74822 | georg.brandl | 2009-09-16 12:12:06 +0200 (Mi, 16 Sep 2009) | 1 line

    #5621: refactor description of how class/instance attributes interact on a.x=a.x+1 or augassign.
  ........
    r74823 | georg.brandl | 2009-09-16 15:06:22 +0200 (Mi, 16 Sep 2009) | 1 line

    Remove strange trailing commas.
  ........
    r74824 | georg.brandl | 2009-09-16 15:11:06 +0200 (Mi, 16 Sep 2009) | 1 line

    #6892: fix optparse example involving help option.
  ........
................
parent f4b4623a
......@@ -212,11 +212,12 @@ To help understand the standard, Jukka Korpela has written an introductory guide
to reading the Unicode character tables, available at
<http://www.cs.tut.fi/~jkorpela/unicode/guide.html>.
Two other good introductory articles were written by Joel Spolsky
<http://www.joelonsoftware.com/articles/Unicode.html> and Jason Orendorff
<http://www.jorendorff.com/articles/unicode/>. If this introduction didn't make
things clear to you, you should try reading one of these alternate articles
before continuing.
Another good introductory article was written by Joel Spolsky
<http://www.joelonsoftware.com/articles/Unicode.html>.
If this introduction didn't make things clear to you, you should try reading this
alternate article before continuing.
.. Jason Orendorff XXX http://www.jorendorff.com/articles/unicode/ is broken
Wikipedia entries are often helpful; see the entries for "character encoding"
<http://en.wikipedia.org/wiki/Character_encoding> and UTF-8
......
......@@ -467,7 +467,7 @@ user-friendly (documented) options::
action="store_false", dest="verbose",
help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
metavar="FILE", help="write output to FILE"),
metavar="FILE", help="write output to FILE")
parser.add_option("-m", "--mode",
default="intermediate",
help="interaction mode: novice, intermediate, "
......@@ -1014,12 +1014,15 @@ must specify for any option using that action.
from optparse import OptionParser, SUPPRESS_HELP
parser = OptionParser()
parser.add_option("-h", "--help", action="help"),
# usually, a help option is added automatically, but that can
# be suppressed using the add_help_option argument
parser = OptionParser(add_help_option=False)
parser.add_option("-h", "--help", action="help")
parser.add_option("-v", action="store_true", dest="verbose",
help="Be moderately verbose")
parser.add_option("--file", dest="filename",
help="Input file to read data from"),
help="Input file to read data from")
parser.add_option("--secret", help=SUPPRESS_HELP)
If :mod:`optparse` sees either ``"-h"`` or ``"--help"`` on the command line, it
......
......@@ -41,7 +41,7 @@ of the debugger is::
:file:`pdb.py` can also be invoked as a script to debug other scripts. For
example::
python -m pdb myscript.py
python3 -m pdb myscript.py
When invoked as a script, pdb will automatically enter post-mortem debugging if
the program being debugged exits abnormally. After post-mortem debugging (or
......
......@@ -206,7 +206,7 @@ support history save/restore. ::
class HistoryConsole(code.InteractiveConsole):
def __init__(self, locals=None, filename="<console>",
histfile=os.path.expanduser("~/.console-history")):
code.InteractiveConsole.__init__(self)
code.InteractiveConsole.__init__(self, locals, filename)
self.init_history(histfile)
def init_history(self, histfile):
......
.. _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::
......
: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)
......
This diff is collapsed.
: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>
......
......@@ -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`.
......
:mod:`stringprep` --- Internet String Preparation
=================================================
......
.. _stringservices:
***************
......
: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`).
......
: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
......
:mod:`sunau` --- Read and write Sun AU files
============================================
......
:mod:`symbol` --- Constants used with Python parse trees
========================================================
......
:mod:`sys` --- System-specific parameters and functions
=======================================================
......
:mod:`syslog` --- Unix syslog library routines
==============================================
......
......@@ -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>
......
.. _tarfile-mod:
:mod:`tarfile` --- Read and write tar archive files
===================================================
......
: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.
......
: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.
......
: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
......
: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
......
: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="* ")
......
......@@ -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
......
:mod:`time` --- Time access and conversions
===========================================
......
: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.
......
......@@ -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.
......
......@@ -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
......
:mod:`token` --- Constants used with Python parse trees
=======================================================
......
: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
......
......@@ -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))``.
......
: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
......
.. _undoc:
********************
......
:mod:`unicodedata` --- Unicode Database
=======================================
......
......@@ -525,7 +525,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
......@@ -576,7 +576,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
......@@ -603,9 +603,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`.
......@@ -614,8 +614,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
......@@ -636,8 +636,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
......@@ -650,8 +650,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),
......@@ -666,8 +666,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
......@@ -708,7 +708,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
......@@ -801,8 +801,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
......@@ -811,8 +813,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()
......@@ -842,14 +844,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.
......@@ -857,7 +859,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.
......@@ -865,7 +867,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
......@@ -874,8 +876,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`
......@@ -885,7 +887,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.
......@@ -976,7 +978,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
......@@ -1006,7 +1008,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 which
......@@ -1020,7 +1022,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
......@@ -1127,7 +1129,7 @@ Loading and running tests
be useful when the fixtures are different and defined in subclasses.
.. method:: loadTestsFromName(name[, module])
.. method:: loadTestsFromName(name, module=None)
Return a suite of all tests cases given a string specifier.
......@@ -1152,7 +1154,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
......@@ -1369,7 +1371,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
......@@ -1382,7 +1384,7 @@ Loading and running tests
subclasses to provide a custom ``TestResult``.
.. function:: main([module[, defaultTest[, argv[, testRunner[, testLoader[, exit]]]]]])
.. function:: main(module='__main__', defaultTest=None, argv=None, testRunner=TextTestRunner, testLoader=unittest.defaultTestLoader, exit=True)
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
......
.. _unix:
**********************
......
......@@ -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
......
......@@ -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. The optional *safe*
......@@ -246,7 +247,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.
......@@ -255,7 +256,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.
......@@ -263,7 +265,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
......@@ -279,7 +282,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.
......@@ -288,6 +291,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
......@@ -302,7 +306,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*
......
......@@ -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
......
: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
......
: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
......
......@@ -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.
......
......@@ -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
......
: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
......
: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")
......
......@@ -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.
......
: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
......
......@@ -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
......
:mod:`xdrlib` --- Encode and decode XDR data
============================================
......
: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
......
: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)
...
......
: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
......
: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
......
:mod:`xml.sax.handler` --- Base classes for SAX handlers
========================================================
......
: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.
......
: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
......
: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 ``'&amp;'``, ``'&lt;'``, and ``'&gt;'`` 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
......
......@@ -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
......
......@@ -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
......
: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
......
:mod:`zipimport` --- Import modules from Zip archives
=====================================================
......
: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
......
......@@ -170,6 +170,25 @@ Assignment of an object to a single target is recursively defined as follows.
perform the assignment, it raises an exception (usually but not necessarily
:exc:`AttributeError`).
.. _attr-target-note:
Note: If the object is a class instance and the attribute reference occurs on
both sides of the assignment operator, the RHS expression, ``a.x`` can access
either an instance attribute or (if no instance attribute exists) a class
attribute. The LHS target ``a.x`` is always set as an instance attribute,
creating it if necessary. Thus, the two occurrences of ``a.x`` do not
necessarily refer to the same attribute: if the RHS expression refers to a
class attribute, the LHS creates a new instance attribute as the target of the
assignment::
class Cls:
x = 3 # class variable
inst = Cls()
inst.x = inst.x + 1 # writes inst.x as 4 leaving Cls.x as 3
This description does not necessarily apply to descriptor attributes, such as
properties created with :func:`property`.
.. index::
pair: subscription; assignment
object: mutable
......@@ -276,16 +295,8 @@ same way as normal assignments. Similarly, with the exception of the possible
*in-place* behavior, the binary operation performed by augmented assignment is
the same as the normal binary operations.
For targets which are attribute references, the initial value is retrieved with
a :meth:`getattr` and the result is assigned with a :meth:`setattr`. Notice
that the two methods do not necessarily refer to the same variable. When
:meth:`getattr` refers to a class variable, :meth:`setattr` still writes to an
instance variable. For example::
class A:
x = 3 # class variable
a = A()
a.x += 1 # writes a.x as 4 leaving A.x as 3
For targets which are attribute references, the same :ref:`caveat about class
and instance attributes <attr-target-note>` applies as for regular assignments.
.. _assert:
......
......@@ -20,6 +20,20 @@ Body.enum.converters['loweralpha'] = \
Body.enum.converters['lowerroman'] = \
Body.enum.converters['upperroman'] = lambda x: None
# monkey-patch HTML translator to give versionmodified paragraphs a class
def new_visit_versionmodified(self, node):
self.body.append(self.starttag(node, 'p', CLASS=node['type']))
text = versionlabels[node['type']] % node['version']
if len(node):
text += ': '
else:
text += '.'
self.body.append('<span class="versionmodified">%s</span>' % text)
from sphinx.writers.html import HTMLTranslator
from sphinx.locale import versionlabels
HTMLTranslator.visit_versionmodified = new_visit_versionmodified
def issue_role(typ, rawtext, text, lineno, inliner, options={}, content=[]):
issue = utils.unescape(text)
......
......@@ -5,15 +5,6 @@
/* -- main layout ----------------------------------------------------------- */
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 230px;
}
div.clearer {
clear: both;
}
......@@ -338,6 +329,12 @@ dl.glossary dt {
font-style: italic;
}
p.deprecated {
background-color: #ffe4e4;
border: 1px solid #f66;
padding: 7px
}
.system-message {
background-color: #fda;
padding: 5px;
......@@ -394,7 +391,7 @@ img.math {
vertical-align: middle;
}
div.math p {
div.body div.math p {
text-align: center;
}
......
......@@ -242,9 +242,10 @@ re-raise the exception::
User-defined Exceptions
=======================
Programs may name their own exceptions by creating a new exception class.
Exceptions should typically be derived from the :exc:`Exception` class, either
directly or indirectly. For example::
Programs may name their own exceptions by creating a new exception class (see
:ref:`tut-classes` for more about Python classes). Exceptions should typically
be derived from the :exc:`Exception` class, either directly or indirectly. For
example::
>>> class MyError(Exception):
... def __init__(self, value):
......
......@@ -97,7 +97,7 @@ class _RLock(_Verbose):
owner and owner.name,
self._count)
def acquire(self, blocking=1):
def acquire(self, blocking=True):
me = current_thread()
if self._owner is me:
self._count = self._count + 1
......@@ -289,7 +289,7 @@ class _Semaphore(_Verbose):
self._cond = Condition(Lock())
self._value = value
def acquire(self, blocking=1):
def acquire(self, blocking=True):
rc = False
self._cond.acquire()
while self._value == 0:
......
......@@ -70,11 +70,11 @@ def print_tb(tb, limit=None, file=None):
tb = tb.tb_next
n = n+1
def format_tb(tb, limit = None):
def format_tb(tb, limit=None):
"""A shorthand for 'format_list(extract_stack(f, limit))."""
return format_list(extract_tb(tb, limit))
def extract_tb(tb, limit = None):
def extract_tb(tb, limit=None):
"""Return list of up to limit pre-processed entries from traceback.
This is useful for alternate formatting of stack traces. If
......@@ -304,7 +304,7 @@ def format_stack(f=None, limit=None):
f = sys.exc_info()[2].tb_frame.f_back
return format_list(extract_stack(f, limit))
def extract_stack(f=None, limit = None):
def extract_stack(f=None, limit=None):
"""Extract the raw traceback from the current stack frame.
The return value has the same format as for extract_tb(). The
......
......@@ -329,7 +329,7 @@ def unquote(string, encoding='utf-8', errors='replace'):
res[-1] = b''.join(pct_sequence).decode(encoding, errors)
return ''.join(res)
def parse_qs(qs, keep_blank_values=0, strict_parsing=0):
def parse_qs(qs, keep_blank_values=False, strict_parsing=False):
"""Parse a query given as a string argument.
Arguments:
......@@ -355,7 +355,7 @@ def parse_qs(qs, keep_blank_values=0, strict_parsing=0):
dict[name] = [value]
return dict
def parse_qsl(qs, keep_blank_values=0, strict_parsing=0):
def parse_qsl(qs, keep_blank_values=False, strict_parsing=False):
"""Parse a query given as a string argument.
Arguments:
......@@ -509,7 +509,7 @@ def quote_from_bytes(bs, safe='/'):
_safe_quoters[cachekey] = quoter
return ''.join([quoter[char] for char in bs])
def urlencode(query, doseq=0):
def urlencode(query, doseq=False):
"""Encode a sequence of two-element tuples or dictionary into a URL query string.
If any values in the query arg are sequences and doseq is true, each
......
......@@ -80,7 +80,7 @@ def encode(in_file, out_file, name=None, mode=None):
out_file.write(b' \nend\n')
def decode(in_file, out_file=None, mode=None, quiet=0):
def decode(in_file, out_file=None, mode=None, quiet=False):
"""Decode uuencoded file"""
#
# Open the input file, if needed.
......
......@@ -29,7 +29,7 @@ def formatwarning(message, category, filename, lineno, line=None):
return s
def filterwarnings(action, message="", category=Warning, module="", lineno=0,
append=0):
append=False):
"""Insert an entry into the list of warnings filters (at the front).
Use assertions to check that all arguments have the right type."""
......@@ -49,7 +49,7 @@ def filterwarnings(action, message="", category=Warning, module="", lineno=0,
else:
filters.insert(0, item)
def simplefilter(action, category=Warning, lineno=0, append=0):
def simplefilter(action, category=Warning, lineno=0, append=False):
"""Insert a simple entry into the list of warnings filters (at the front).
A simple filter matches all modules and messages.
......
......@@ -67,7 +67,7 @@ def application_uri(environ):
url += quote(environ.get('SCRIPT_NAME') or '/')
return url
def request_uri(environ, include_query=1):
def request_uri(environ, include_query=True):
"""Return the full request URI, optionally including the query string"""
url = application_uri(environ)
from urllib.parse import quote
......
......@@ -36,7 +36,7 @@ def _good_enough(dom, features):
return 0
return 1
def getDOMImplementation(name = None, features = ()):
def getDOMImplementation(name=None, features=()):
"""getDOMImplementation(name = None, features = ()) -> DOM implementation.
Return a suitable DOM implementation. The name is either
......
......@@ -43,7 +43,7 @@ class Node(xml.dom.Node):
def __bool__(self):
return True
def toxml(self, encoding = None):
def toxml(self, encoding=None):
return self.toprettyxml("", "", encoding)
def toprettyxml(self, indent="\t", newl="\n", encoding=None):
......
......@@ -268,7 +268,7 @@ class XMLFilterBase(xmlreader.XMLReader):
# --- Utility functions
def prepare_input_source(source, base = ""):
def prepare_input_source(source, base=""):
"""This function takes an InputSource and an optional base URL and
returns a fully resolved InputSource object ready for reading."""
......
......@@ -480,7 +480,7 @@ class Marshaller:
# by the way, if you don't understand what's going on in here,
# that's perfectly ok.
def __init__(self, encoding=None, allow_none=0):
def __init__(self, encoding=None, allow_none=False):
self.memo = {}
self.data = None
self.encoding = encoding
......@@ -653,7 +653,7 @@ class Unmarshaller:
# and again, if you don't understand what's going on in here,
# that's perfectly ok.
def __init__(self, use_datetime=0):
def __init__(self, use_datetime=False):
self._type = None
self._stack = []
self._marks = []
......@@ -886,7 +886,7 @@ FastMarshaller = FastParser = FastUnmarshaller = None
#
# return A (parser, unmarshaller) tuple.
def getparser(use_datetime=0):
def getparser(use_datetime=False):
"""getparser() -> parser, unmarshaller
Create an instance of the fastest available parser, and attach it
......@@ -923,7 +923,7 @@ def getparser(use_datetime=0):
# @return A string containing marshalled data.
def dumps(params, methodname=None, methodresponse=None, encoding=None,
allow_none=0):
allow_none=False):
"""data [,options] -> marshalled data
Convert an argument tuple or a Fault instance to an XML-RPC
......@@ -999,7 +999,7 @@ def dumps(params, methodname=None, methodresponse=None, encoding=None,
# (None if not present).
# @see Fault
def loads(data, use_datetime=0):
def loads(data, use_datetime=False):
"""data -> unmarshalled data, method name
Convert an XML-RPC packet to unmarshalled data plus a method
......@@ -1040,7 +1040,7 @@ class Transport:
# client identifier (may be overridden)
user_agent = "xmlrpclib.py/%s (by www.pythonware.com)" % __version__
def __init__(self, use_datetime=0):
def __init__(self, use_datetime=False):
self._use_datetime = use_datetime
##
......@@ -1052,7 +1052,7 @@ class Transport:
# @param verbose Debugging flag.
# @return Parsed response.
def request(self, host, handler, request_body, verbose=0):
def request(self, host, handler, request_body, verbose=False):
# issue XML-RPC request
http_conn = self.send_request(host, handler, request_body, verbose)
......@@ -1234,8 +1234,8 @@ class ServerProxy:
the given encoding.
"""
def __init__(self, uri, transport=None, encoding=None, verbose=0,
allow_none=0, use_datetime=0):
def __init__(self, uri, transport=None, encoding=None, verbose=False,
allow_none=False, use_datetime=False):
# establish a "logical" server connection
# get the url
......
......@@ -201,7 +201,7 @@ class SimpleXMLRPCDispatcher:
self.instance = instance
self.allow_dotted_names = allow_dotted_names
def register_function(self, function, name = None):
def register_function(self, function, name=None):
"""Registers a function to respond to XML-RPC requests.
The optional name argument can be used to set a Unicode name
......@@ -578,7 +578,7 @@ class CGIXMLRPCRequestHandler(SimpleXMLRPCDispatcher):
sys.stdout.buffer.write(response)
sys.stdout.buffer.flush()
def handle_request(self, request_text = None):
def handle_request(self, request_text=None):
"""Handle a single XML-RPC request passed through a CGI post method.
If no XML data is given then it is read from stdin. The resulting
......@@ -837,7 +837,7 @@ class DocXMLRPCServer( SimpleXMLRPCServer,
"""
def __init__(self, addr, requestHandler=DocXMLRPCRequestHandler,
logRequests=1, allow_none=False, encoding=None,
logRequests=True, allow_none=False, encoding=None,
bind_and_activate=True):
SimpleXMLRPCServer.__init__(self, addr, requestHandler, logRequests,
allow_none, encoding, bind_and_activate)
......
......@@ -1255,7 +1255,7 @@ class ZipFile:
class PyZipFile(ZipFile):
"""Class to create ZIP archives with Python library files and packages."""
def writepy(self, pathname, basename = ""):
def writepy(self, pathname, basename=""):
"""Add all files from "pathname" to the ZIP archive.
If pathname is a package directory, search the directory and
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment