Merge 3.2
This commit is contained in:
commit
24d6cc6f4f
|
@ -101,8 +101,8 @@ one command from a terminal::
|
||||||
|
|
||||||
python setup.py install
|
python setup.py install
|
||||||
|
|
||||||
For Windows, this command should be run from a command prompt windows ("DOS
|
For Windows, this command should be run from a command prompt windows
|
||||||
box")::
|
(:menuselection:`Start --> Accessories`)::
|
||||||
|
|
||||||
setup.py install
|
setup.py install
|
||||||
|
|
||||||
|
@ -144,7 +144,7 @@ archive file to :file:`C:\\Temp`, then it would unpack into
|
||||||
:file:`C:\\Temp\\foo-1.0`; you can use either a archive manipulator with a
|
:file:`C:\\Temp\\foo-1.0`; you can use either a archive manipulator with a
|
||||||
graphical user interface (such as WinZip) or a command-line tool (such as
|
graphical user interface (such as WinZip) or a command-line tool (such as
|
||||||
:program:`unzip` or :program:`pkunzip`) to unpack the archive. Then, open a
|
:program:`unzip` or :program:`pkunzip`) to unpack the archive. Then, open a
|
||||||
command prompt window ("DOS box"), and run::
|
command prompt window and run::
|
||||||
|
|
||||||
cd c:\Temp\foo-1.0
|
cd c:\Temp\foo-1.0
|
||||||
python setup.py install
|
python setup.py install
|
||||||
|
|
|
@ -84,8 +84,8 @@ terminal::
|
||||||
|
|
||||||
python setup.py sdist
|
python setup.py sdist
|
||||||
|
|
||||||
For Windows, open a command prompt windows ("DOS box") and change the command
|
For Windows, open a command prompt window (:menuselection:`Start -->
|
||||||
to::
|
Accessories`) and change the command to::
|
||||||
|
|
||||||
setup.py sdist
|
setup.py sdist
|
||||||
|
|
||||||
|
|
|
@ -163,8 +163,8 @@ Glossary
|
||||||
well-designed code improves its flexibility by allowing polymorphic
|
well-designed code improves its flexibility by allowing polymorphic
|
||||||
substitution. Duck-typing avoids tests using :func:`type` or
|
substitution. Duck-typing avoids tests using :func:`type` or
|
||||||
:func:`isinstance`. (Note, however, that duck-typing can be complemented
|
:func:`isinstance`. (Note, however, that duck-typing can be complemented
|
||||||
with :term:`abstract base class`\ es.) Instead, it typically employs
|
with :term:`abstract base classes <abstract base class>`.) Instead, it
|
||||||
:func:`hasattr` tests or :term:`EAFP` programming.
|
typically employs :func:`hasattr` tests or :term:`EAFP` programming.
|
||||||
|
|
||||||
EAFP
|
EAFP
|
||||||
Easier to ask for forgiveness than permission. This common Python coding
|
Easier to ask for forgiveness than permission. This common Python coding
|
||||||
|
|
|
@ -119,12 +119,9 @@ command::
|
||||||
|
|
||||||
pysetup run install_dist
|
pysetup run install_dist
|
||||||
|
|
||||||
How you actually run this command depends on the platform and the command line
|
This is a command that should be run in a terminal. On Windows, it is called a
|
||||||
interface it provides:
|
command prompt and found in :menuselection:`Start --> Accessories`; Powershell
|
||||||
|
is a popular alternative.
|
||||||
* **Unix**: Use a shell prompt.
|
|
||||||
* **Windows**: Open a command prompt ("DOS console") or use :command:`Powershell`.
|
|
||||||
* **OS X**: Open a :command:`Terminal`.
|
|
||||||
|
|
||||||
|
|
||||||
.. _packaging-platform-variations:
|
.. _packaging-platform-variations:
|
||||||
|
@ -147,8 +144,7 @@ archive file to :file:`C:\\Temp`, then it would unpack into
|
||||||
:file:`C:\\Temp\\foo-1.0`. To actually unpack the archive, you can use either
|
:file:`C:\\Temp\\foo-1.0`. To actually unpack the archive, you can use either
|
||||||
an archive manipulator with a graphical user interface (such as WinZip or 7-Zip)
|
an archive manipulator with a graphical user interface (such as WinZip or 7-Zip)
|
||||||
or a command-line tool (such as :program:`unzip`, :program:`pkunzip` or, again,
|
or a command-line tool (such as :program:`unzip`, :program:`pkunzip` or, again,
|
||||||
:program:`7z`). Then, open a command prompt window ("DOS box" or
|
:program:`7z`). Then, open a command prompt window and run::
|
||||||
Powershell), and run::
|
|
||||||
|
|
||||||
cd c:\Temp\foo-1.0
|
cd c:\Temp\foo-1.0
|
||||||
pysetup run install_dist
|
pysetup run install_dist
|
||||||
|
@ -279,7 +275,8 @@ different recipe for each platform. Under Unix, just type :command:`python` at
|
||||||
the shell prompt. Under Windows (assuming the Python executable is on your
|
the shell prompt. Under Windows (assuming the Python executable is on your
|
||||||
:envvar:`PATH`, which is the usual case), you can choose :menuselection:`Start --> Run`,
|
:envvar:`PATH`, which is the usual case), you can choose :menuselection:`Start --> Run`,
|
||||||
type ``python`` and press ``enter``. Alternatively, you can simply execute
|
type ``python`` and press ``enter``. Alternatively, you can simply execute
|
||||||
:command:`python` at a command prompt ("DOS console" or Powershell).
|
:command:`python` at a command prompt (:menuselection:`Start --> Accessories`)
|
||||||
|
or in Powershell.
|
||||||
|
|
||||||
Once the interpreter is started, you type Python code at the prompt. For
|
Once the interpreter is started, you type Python code at the prompt. For
|
||||||
example, on my Linux system, I type the three Python statements shown below,
|
example, on my Linux system, I type the three Python statements shown below,
|
||||||
|
|
|
@ -6,10 +6,10 @@
|
||||||
.. moduleauthor:: Steven Bethard <steven.bethard@gmail.com>
|
.. moduleauthor:: Steven Bethard <steven.bethard@gmail.com>
|
||||||
.. sectionauthor:: Steven Bethard <steven.bethard@gmail.com>
|
.. sectionauthor:: Steven Bethard <steven.bethard@gmail.com>
|
||||||
|
|
||||||
**Source code:** :source:`Lib/argparse.py`
|
|
||||||
|
|
||||||
.. versionadded:: 3.2
|
.. versionadded:: 3.2
|
||||||
|
|
||||||
|
**Source code:** :source:`Lib/argparse.py`
|
||||||
|
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
The :mod:`argparse` module makes it easy to write user-friendly command-line
|
The :mod:`argparse` module makes it easy to write user-friendly command-line
|
||||||
|
@ -109,7 +109,7 @@ Parsing arguments
|
||||||
|
|
||||||
:class:`ArgumentParser` parses arguments through the
|
:class:`ArgumentParser` parses arguments through the
|
||||||
:meth:`~ArgumentParser.parse_args` method. This will inspect the command line,
|
:meth:`~ArgumentParser.parse_args` method. This will inspect the command line,
|
||||||
convert each arg to the appropriate type and then invoke the appropriate action.
|
convert each argument to the appropriate type and then invoke the appropriate action.
|
||||||
In most cases, this means a simple :class:`Namespace` object will be built up from
|
In most cases, this means a simple :class:`Namespace` object will be built up from
|
||||||
attributes parsed out of the command line::
|
attributes parsed out of the command line::
|
||||||
|
|
||||||
|
@ -244,7 +244,7 @@ This can be achieved by passing ``False`` as the ``add_help=`` argument to
|
||||||
--foo FOO foo help
|
--foo FOO foo help
|
||||||
|
|
||||||
The help option is typically ``-h/--help``. The exception to this is
|
The help option is typically ``-h/--help``. The exception to this is
|
||||||
if the ``prefix_chars=`` is specified and does not include ``'-'``, in
|
if the ``prefix_chars=`` is specified and does not include ``-``, in
|
||||||
which case ``-h`` and ``--help`` are not valid options. In
|
which case ``-h`` and ``--help`` are not valid options. In
|
||||||
this case, the first character in ``prefix_chars`` is used to prefix
|
this case, the first character in ``prefix_chars`` is used to prefix
|
||||||
the help options::
|
the help options::
|
||||||
|
@ -260,7 +260,7 @@ the help options::
|
||||||
prefix_chars
|
prefix_chars
|
||||||
^^^^^^^^^^^^
|
^^^^^^^^^^^^
|
||||||
|
|
||||||
Most command-line options will use ``'-'`` as the prefix, e.g. ``-f/--foo``.
|
Most command-line options will use ``-`` as the prefix, e.g. ``-f/--foo``.
|
||||||
Parsers that need to support different or additional prefix
|
Parsers that need to support different or additional prefix
|
||||||
characters, e.g. for options
|
characters, e.g. for options
|
||||||
like ``+f`` or ``/foo``, may specify them using the ``prefix_chars=`` argument
|
like ``+f`` or ``/foo``, may specify them using the ``prefix_chars=`` argument
|
||||||
|
@ -273,7 +273,7 @@ to the ArgumentParser constructor::
|
||||||
Namespace(bar='Y', f='X')
|
Namespace(bar='Y', f='X')
|
||||||
|
|
||||||
The ``prefix_chars=`` argument defaults to ``'-'``. Supplying a set of
|
The ``prefix_chars=`` argument defaults to ``'-'``. Supplying a set of
|
||||||
characters that does not include ``'-'`` will cause ``-f/--foo`` options to be
|
characters that does not include ``-`` will cause ``-f/--foo`` options to be
|
||||||
disallowed.
|
disallowed.
|
||||||
|
|
||||||
|
|
||||||
|
@ -778,7 +778,7 @@ single action to be taken. The ``nargs`` keyword argument associates a
|
||||||
different number of command-line arguments with a single action. The supported
|
different number of command-line arguments with a single action. The supported
|
||||||
values are:
|
values are:
|
||||||
|
|
||||||
* N (an integer). N arguments from the command line will be gathered together into a
|
* ``N`` (an integer). ``N`` arguments from the command line will be gathered together into a
|
||||||
list. For example::
|
list. For example::
|
||||||
|
|
||||||
>>> parser = argparse.ArgumentParser()
|
>>> parser = argparse.ArgumentParser()
|
||||||
|
@ -790,11 +790,11 @@ values are:
|
||||||
Note that ``nargs=1`` produces a list of one item. This is different from
|
Note that ``nargs=1`` produces a list of one item. This is different from
|
||||||
the default, in which the item is produced by itself.
|
the default, in which the item is produced by itself.
|
||||||
|
|
||||||
* ``'?'``. One arg will be consumed from the command line if possible, and
|
* ``'?'``. One argument will be consumed from the command line if possible, and
|
||||||
produced as a single item. If no command-line arg is present, the value from
|
produced as a single item. If no command-line argument is present, the value from
|
||||||
default_ will be produced. Note that for optional arguments, there is an
|
default_ will be produced. Note that for optional arguments, there is an
|
||||||
additional case - the option string is present but not followed by a
|
additional case - the option string is present but not followed by a
|
||||||
command-line arg. In this case the value from const_ will be produced. Some
|
command-line argument. In this case the value from const_ will be produced. Some
|
||||||
examples to illustrate this::
|
examples to illustrate this::
|
||||||
|
|
||||||
>>> parser = argparse.ArgumentParser()
|
>>> parser = argparse.ArgumentParser()
|
||||||
|
@ -836,7 +836,7 @@ values are:
|
||||||
|
|
||||||
* ``'+'``. Just like ``'*'``, all command-line args present are gathered into a
|
* ``'+'``. Just like ``'*'``, all command-line args present are gathered into a
|
||||||
list. Additionally, an error message will be generated if there wasn't at
|
list. Additionally, an error message will be generated if there wasn't at
|
||||||
least one command-line arg present. For example::
|
least one command-line argument present. For example::
|
||||||
|
|
||||||
>>> parser = argparse.ArgumentParser(prog='PROG')
|
>>> parser = argparse.ArgumentParser(prog='PROG')
|
||||||
>>> parser.add_argument('foo', nargs='+')
|
>>> parser.add_argument('foo', nargs='+')
|
||||||
|
@ -847,7 +847,7 @@ values are:
|
||||||
PROG: error: too few arguments
|
PROG: error: too few arguments
|
||||||
|
|
||||||
If the ``nargs`` keyword argument is not provided, the number of arguments consumed
|
If the ``nargs`` keyword argument is not provided, the number of arguments consumed
|
||||||
is determined by the action_. Generally this means a single command-line arg
|
is determined by the action_. Generally this means a single command-line argument
|
||||||
will be consumed and a single item (not a list) will be produced.
|
will be consumed and a single item (not a list) will be produced.
|
||||||
|
|
||||||
|
|
||||||
|
@ -866,7 +866,7 @@ the various :class:`ArgumentParser` actions. The two most common uses of it are
|
||||||
(like ``-f`` or ``--foo``) and ``nargs='?'``. This creates an optional
|
(like ``-f`` or ``--foo``) and ``nargs='?'``. This creates an optional
|
||||||
argument that can be followed by zero or one command-line arguments.
|
argument that can be followed by zero or one command-line arguments.
|
||||||
When parsing the command line, if the option string is encountered with no
|
When parsing the command line, if the option string is encountered with no
|
||||||
command-line arg following it, the value of ``const`` will be assumed instead.
|
command-line argument following it, the value of ``const`` will be assumed instead.
|
||||||
See the nargs_ description for examples.
|
See the nargs_ description for examples.
|
||||||
|
|
||||||
The ``const`` keyword argument defaults to ``None``.
|
The ``const`` keyword argument defaults to ``None``.
|
||||||
|
@ -878,7 +878,7 @@ default
|
||||||
All optional arguments and some positional arguments may be omitted at the
|
All optional arguments and some positional arguments may be omitted at the
|
||||||
command line. The ``default`` keyword argument of
|
command line. The ``default`` keyword argument of
|
||||||
:meth:`~ArgumentParser.add_argument`, whose value defaults to ``None``,
|
:meth:`~ArgumentParser.add_argument`, whose value defaults to ``None``,
|
||||||
specifies what value should be used if the command-line arg is not present.
|
specifies what value should be used if the command-line argument is not present.
|
||||||
For optional arguments, the ``default`` value is used when the option string
|
For optional arguments, the ``default`` value is used when the option string
|
||||||
was not present at the command line::
|
was not present at the command line::
|
||||||
|
|
||||||
|
@ -889,8 +889,8 @@ was not present at the command line::
|
||||||
>>> parser.parse_args(''.split())
|
>>> parser.parse_args(''.split())
|
||||||
Namespace(foo=42)
|
Namespace(foo=42)
|
||||||
|
|
||||||
For positional arguments with nargs_ ``='?'`` or ``'*'``, the ``default`` value
|
For positional arguments with nargs_ equal to ``?`` or ``*``, the ``default`` value
|
||||||
is used when no command-line arg was present::
|
is used when no command-line argument was present::
|
||||||
|
|
||||||
>>> parser = argparse.ArgumentParser()
|
>>> parser = argparse.ArgumentParser()
|
||||||
>>> parser.add_argument('foo', nargs='?', default=42)
|
>>> parser.add_argument('foo', nargs='?', default=42)
|
||||||
|
@ -976,8 +976,8 @@ choices
|
||||||
Some command-line arguments should be selected from a restricted set of values.
|
Some command-line arguments should be selected from a restricted set of values.
|
||||||
These can be handled by passing a container object as the ``choices`` keyword
|
These can be handled by passing a container object as the ``choices`` keyword
|
||||||
argument to :meth:`~ArgumentParser.add_argument`. When the command line is
|
argument to :meth:`~ArgumentParser.add_argument`. When the command line is
|
||||||
parsed, arg values will be checked, and an error message will be displayed if
|
parsed, argument values will be checked, and an error message will be displayed if
|
||||||
the arg was not one of the acceptable values::
|
the argument was not one of the acceptable values::
|
||||||
|
|
||||||
>>> parser = argparse.ArgumentParser(prog='PROG')
|
>>> parser = argparse.ArgumentParser(prog='PROG')
|
||||||
>>> parser.add_argument('foo', choices='abc')
|
>>> parser.add_argument('foo', choices='abc')
|
||||||
|
@ -1080,7 +1080,7 @@ value as the "name" of each object. By default, for positional argument
|
||||||
actions, the dest_ value is used directly, and for optional argument actions,
|
actions, the dest_ value is used directly, and for optional argument actions,
|
||||||
the dest_ value is uppercased. So, a single positional argument with
|
the dest_ value is uppercased. So, a single positional argument with
|
||||||
``dest='bar'`` will that argument will be referred to as ``bar``. A single
|
``dest='bar'`` will that argument will be referred to as ``bar``. A single
|
||||||
optional argument ``--foo`` that should be followed by a single command-line arg
|
optional argument ``--foo`` that should be followed by a single command-line argument
|
||||||
will be referred to as ``FOO``. An example::
|
will be referred to as ``FOO``. An example::
|
||||||
|
|
||||||
>>> parser = argparse.ArgumentParser()
|
>>> parser = argparse.ArgumentParser()
|
||||||
|
@ -1152,10 +1152,10 @@ attribute is determined by the ``dest`` keyword argument of
|
||||||
|
|
||||||
For optional argument actions, the value of ``dest`` is normally inferred from
|
For optional argument actions, the value of ``dest`` is normally inferred from
|
||||||
the option strings. :class:`ArgumentParser` generates the value of ``dest`` by
|
the option strings. :class:`ArgumentParser` generates the value of ``dest`` by
|
||||||
taking the first long option string and stripping away the initial ``'--'``
|
taking the first long option string and stripping away the initial ``--``
|
||||||
string. If no long option strings were supplied, ``dest`` will be derived from
|
string. If no long option strings were supplied, ``dest`` will be derived from
|
||||||
the first short option string by stripping the initial ``'-'`` character. Any
|
the first short option string by stripping the initial ``-`` character. Any
|
||||||
internal ``'-'`` characters will be converted to ``'_'`` characters to make sure
|
internal ``-`` characters will be converted to ``_`` characters to make sure
|
||||||
the string is a valid attribute name. The examples below illustrate this
|
the string is a valid attribute name. The examples below illustrate this
|
||||||
behavior::
|
behavior::
|
||||||
|
|
||||||
|
@ -1187,7 +1187,7 @@ The parse_args() method
|
||||||
created and how they are assigned. See the documentation for
|
created and how they are assigned. See the documentation for
|
||||||
:meth:`add_argument` for details.
|
:meth:`add_argument` for details.
|
||||||
|
|
||||||
By default, the arg strings are taken from :data:`sys.argv`, and a new empty
|
By default, the argument strings are taken from :data:`sys.argv`, and a new empty
|
||||||
:class:`Namespace` object is created for the attributes.
|
:class:`Namespace` object is created for the attributes.
|
||||||
|
|
||||||
|
|
||||||
|
@ -1258,15 +1258,15 @@ it exits and prints the error along with a usage message::
|
||||||
PROG: error: extra arguments found: badger
|
PROG: error: extra arguments found: badger
|
||||||
|
|
||||||
|
|
||||||
Arguments containing ``"-"``
|
Arguments containing ``-``
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
The :meth:`~ArgumentParser.parse_args` method attempts to give errors whenever
|
The :meth:`~ArgumentParser.parse_args` method attempts to give errors whenever
|
||||||
the user has clearly made a mistake, but some situations are inherently
|
the user has clearly made a mistake, but some situations are inherently
|
||||||
ambiguous. For example, the command-line arg ``'-1'`` could either be an
|
ambiguous. For example, the command-line argument ``-1`` could either be an
|
||||||
attempt to specify an option or an attempt to provide a positional argument.
|
attempt to specify an option or an attempt to provide a positional argument.
|
||||||
The :meth:`~ArgumentParser.parse_args` method is cautious here: positional
|
The :meth:`~ArgumentParser.parse_args` method is cautious here: positional
|
||||||
arguments may only begin with ``'-'`` if they look like negative numbers and
|
arguments may only begin with ``-`` if they look like negative numbers and
|
||||||
there are no options in the parser that look like negative numbers::
|
there are no options in the parser that look like negative numbers::
|
||||||
|
|
||||||
>>> parser = argparse.ArgumentParser(prog='PROG')
|
>>> parser = argparse.ArgumentParser(prog='PROG')
|
||||||
|
@ -1299,7 +1299,7 @@ there are no options in the parser that look like negative numbers::
|
||||||
usage: PROG [-h] [-1 ONE] [foo]
|
usage: PROG [-h] [-1 ONE] [foo]
|
||||||
PROG: error: argument -1: expected one argument
|
PROG: error: argument -1: expected one argument
|
||||||
|
|
||||||
If you have positional arguments that must begin with ``'-'`` and don't look
|
If you have positional arguments that must begin with ``-`` and don't look
|
||||||
like negative numbers, you can insert the pseudo-argument ``'--'`` which tells
|
like negative numbers, you can insert the pseudo-argument ``'--'`` which tells
|
||||||
:meth:`~ArgumentParser.parse_args` that everything after that is a positional
|
:meth:`~ArgumentParser.parse_args` that everything after that is a positional
|
||||||
argument::
|
argument::
|
||||||
|
@ -1417,7 +1417,7 @@ Sub-commands
|
||||||
>>> parser_b = subparsers.add_parser('b', help='b help')
|
>>> parser_b = subparsers.add_parser('b', help='b help')
|
||||||
>>> parser_b.add_argument('--baz', choices='XYZ', help='baz help')
|
>>> parser_b.add_argument('--baz', choices='XYZ', help='baz help')
|
||||||
>>>
|
>>>
|
||||||
>>> # parse some arg lists
|
>>> # parse some argument lists
|
||||||
>>> parser.parse_args(['a', '12'])
|
>>> parser.parse_args(['a', '12'])
|
||||||
Namespace(bar=12, foo=False)
|
Namespace(bar=12, foo=False)
|
||||||
>>> parser.parse_args(['--foo', 'b', '--baz', 'Z'])
|
>>> parser.parse_args(['--foo', 'b', '--baz', 'Z'])
|
||||||
|
@ -1426,8 +1426,8 @@ Sub-commands
|
||||||
Note that the object returned by :meth:`parse_args` will only contain
|
Note that the object returned by :meth:`parse_args` will only contain
|
||||||
attributes for the main parser and the subparser that was selected by the
|
attributes for the main parser and the subparser that was selected by the
|
||||||
command line (and not any other subparsers). So in the example above, when
|
command line (and not any other subparsers). So in the example above, when
|
||||||
the ``"a"`` command is specified, only the ``foo`` and ``bar`` attributes are
|
the ``a`` command is specified, only the ``foo`` and ``bar`` attributes are
|
||||||
present, and when the ``"b"`` command is specified, only the ``foo`` and
|
present, and when the ``b`` command is specified, only the ``foo`` and
|
||||||
``baz`` attributes are present.
|
``baz`` attributes are present.
|
||||||
|
|
||||||
Similarly, when a help message is requested from a subparser, only the help
|
Similarly, when a help message is requested from a subparser, only the help
|
||||||
|
|
|
@ -6,6 +6,9 @@
|
||||||
.. moduleauthor:: Skip Montanaro <skip@pobox.com>
|
.. moduleauthor:: Skip Montanaro <skip@pobox.com>
|
||||||
.. sectionauthor:: Skip Montanaro <skip@pobox.com>
|
.. sectionauthor:: Skip Montanaro <skip@pobox.com>
|
||||||
|
|
||||||
|
**Source code:** :source:`Lib/atexit.py`
|
||||||
|
|
||||||
|
--------------
|
||||||
|
|
||||||
The :mod:`atexit` module defines functions to register and unregister cleanup
|
The :mod:`atexit` module defines functions to register and unregister cleanup
|
||||||
functions. Functions thus registered are automatically executed upon normal
|
functions. Functions thus registered are automatically executed upon normal
|
||||||
|
|
|
@ -205,6 +205,9 @@ Instances of :class:`Cmd` subclasses have some public instance variables:
|
||||||
:mod:`readline`, on systems that support it, the interpreter will automatically
|
:mod:`readline`, on systems that support it, the interpreter will automatically
|
||||||
support :program:`Emacs`\ -like line editing and command-history keystrokes.)
|
support :program:`Emacs`\ -like line editing and command-history keystrokes.)
|
||||||
|
|
||||||
|
|
||||||
|
.. _cmd-example:
|
||||||
|
|
||||||
Cmd Example
|
Cmd Example
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
:mod:`collections` --- Container datatypes
|
:mod:`collections` --- Container datatypes
|
||||||
==========================================
|
==========================================
|
||||||
|
|
||||||
|
@ -977,7 +976,7 @@ original insertion position is changed and moved to the end::
|
||||||
del self[key]
|
del self[key]
|
||||||
OrderedDict.__setitem__(self, key, value)
|
OrderedDict.__setitem__(self, key, value)
|
||||||
|
|
||||||
An ordered dictionary can combined with the :class:`Counter` class
|
An ordered dictionary can be combined with the :class:`Counter` class
|
||||||
so that the counter remembers the order elements are first encountered::
|
so that the counter remembers the order elements are first encountered::
|
||||||
|
|
||||||
class OrderedCounter(Counter, OrderedDict):
|
class OrderedCounter(Counter, OrderedDict):
|
||||||
|
|
|
@ -4,11 +4,11 @@
|
||||||
.. module:: concurrent.futures
|
.. module:: concurrent.futures
|
||||||
:synopsis: Execute computations concurrently using threads or processes.
|
:synopsis: Execute computations concurrently using threads or processes.
|
||||||
|
|
||||||
|
.. versionadded:: 3.2
|
||||||
|
|
||||||
**Source code:** :source:`Lib/concurrent/futures/thread.py`
|
**Source code:** :source:`Lib/concurrent/futures/thread.py`
|
||||||
and :source:`Lib/concurrent/futures/process.py`
|
and :source:`Lib/concurrent/futures/process.py`
|
||||||
|
|
||||||
.. versionadded:: 3.2
|
|
||||||
|
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
The :mod:`concurrent.futures` module provides a high-level interface for
|
The :mod:`concurrent.futures` module provides a high-level interface for
|
||||||
|
|
|
@ -624,7 +624,8 @@ are always available. They are listed here in alphabetical order.
|
||||||
.. function:: isinstance(object, classinfo)
|
.. function:: isinstance(object, classinfo)
|
||||||
|
|
||||||
Return true if the *object* argument is an instance of the *classinfo*
|
Return true if the *object* argument is an instance of the *classinfo*
|
||||||
argument, or of a (direct or indirect) subclass thereof. If *object* is not
|
argument, or of a (direct, indirect or :term:`virtual <abstract base
|
||||||
|
class>`) subclass thereof. If *object* is not
|
||||||
an object of the given type, the function always returns false. If
|
an object of the given type, the function always returns false. If
|
||||||
*classinfo* is not a class (type object), it may be a tuple of type objects,
|
*classinfo* is not a class (type object), it may be a tuple of type objects,
|
||||||
or may recursively contain other such tuples (other sequence types are not
|
or may recursively contain other such tuples (other sequence types are not
|
||||||
|
@ -634,7 +635,8 @@ are always available. They are listed here in alphabetical order.
|
||||||
|
|
||||||
.. function:: issubclass(class, classinfo)
|
.. function:: issubclass(class, classinfo)
|
||||||
|
|
||||||
Return true if *class* is a subclass (direct or indirect) of *classinfo*. A
|
Return true if *class* is a subclass (direct, indirect or :term:`virtual
|
||||||
|
<abstract base class>`) of *classinfo*. A
|
||||||
class is considered a subclass of itself. *classinfo* may be a tuple of class
|
class is considered a subclass of itself. *classinfo* may be a tuple of class
|
||||||
objects, in which case every entry in *classinfo* will be checked. In any other
|
objects, in which case every entry in *classinfo* will be checked. In any other
|
||||||
case, a :exc:`TypeError` exception is raised.
|
case, a :exc:`TypeError` exception is raised.
|
||||||
|
|
|
@ -799,7 +799,7 @@ possible, while any potentially slow operations (such as sending an email via
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. queue-listener:
|
.. _queue-listener:
|
||||||
|
|
||||||
QueueListener
|
QueueListener
|
||||||
^^^^^^^^^^^^^
|
^^^^^^^^^^^^^
|
||||||
|
|
|
@ -7,14 +7,14 @@
|
||||||
.. moduleauthor:: Greg Ward <gward@python.net>
|
.. moduleauthor:: Greg Ward <gward@python.net>
|
||||||
.. sectionauthor:: Greg Ward <gward@python.net>
|
.. sectionauthor:: Greg Ward <gward@python.net>
|
||||||
|
|
||||||
|
.. deprecated:: 3.2
|
||||||
|
The :mod:`optparse` module is deprecated and will not be developed further;
|
||||||
|
development will continue with the :mod:`argparse` module.
|
||||||
|
|
||||||
**Source code:** :source:`Lib/optparse.py`
|
**Source code:** :source:`Lib/optparse.py`
|
||||||
|
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
.. deprecated:: 2.7
|
|
||||||
The :mod:`optparse` module is deprecated and will not be developed further;
|
|
||||||
development will continue with the :mod:`argparse` module.
|
|
||||||
|
|
||||||
:mod:`optparse` is a more convenient, flexible, and powerful library for parsing
|
:mod:`optparse` is a more convenient, flexible, and powerful library for parsing
|
||||||
command-line options than the old :mod:`getopt` module. :mod:`optparse` uses a
|
command-line options than the old :mod:`getopt` module. :mod:`optparse` uses a
|
||||||
more declarative style of command-line parsing: you create an instance of
|
more declarative style of command-line parsing: you create an instance of
|
||||||
|
|
|
@ -4,6 +4,9 @@
|
||||||
.. module:: string
|
.. module:: string
|
||||||
:synopsis: Common string operations.
|
:synopsis: Common string operations.
|
||||||
|
|
||||||
|
**Source code:** :source:`Lib/string.py`
|
||||||
|
|
||||||
|
--------------
|
||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
|
@ -11,10 +14,6 @@
|
||||||
|
|
||||||
:ref:`string-methods`
|
:ref:`string-methods`
|
||||||
|
|
||||||
**Source code:** :source:`Lib/string.py`
|
|
||||||
|
|
||||||
--------------
|
|
||||||
|
|
||||||
String constants
|
String constants
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
|
|
@ -3,15 +3,16 @@
|
||||||
|
|
||||||
.. module:: sysconfig
|
.. module:: sysconfig
|
||||||
:synopsis: Python's configuration information
|
:synopsis: Python's configuration information
|
||||||
.. moduleauthor:: Tarek Ziade <tarek@ziade.org>
|
.. moduleauthor:: Tarek Ziadé <tarek@ziade.org>
|
||||||
.. sectionauthor:: Tarek Ziade <tarek@ziade.org>
|
.. sectionauthor:: Tarek Ziadé <tarek@ziade.org>
|
||||||
|
|
||||||
.. index::
|
.. index::
|
||||||
single: configuration information
|
single: configuration information
|
||||||
|
|
||||||
**Source code:** :source:`Lib/sysconfig.py`
|
|
||||||
|
|
||||||
.. versionadded:: 3.2
|
.. versionadded:: 3.2
|
||||||
|
|
||||||
|
**Source code:** :source:`Lib/sysconfig.py`
|
||||||
|
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
The :mod:`sysconfig` module provides access to Python's configuration
|
The :mod:`sysconfig` module provides access to Python's configuration
|
||||||
|
|
|
@ -12,6 +12,10 @@
|
||||||
pair: URL; parsing
|
pair: URL; parsing
|
||||||
pair: relative; URL
|
pair: relative; URL
|
||||||
|
|
||||||
|
**Source code:** :source:`Lib/urllib/parse.py`
|
||||||
|
|
||||||
|
--------------
|
||||||
|
|
||||||
This module defines a standard interface to break Uniform Resource Locator (URL)
|
This module defines a standard interface to break Uniform Resource Locator (URL)
|
||||||
strings up in components (addressing scheme, network location, path etc.), to
|
strings up in components (addressing scheme, network location, path etc.), to
|
||||||
combine the components back into a URL string, and to convert a "relative URL"
|
combine the components back into a URL string, and to convert a "relative URL"
|
||||||
|
|
|
@ -30,15 +30,16 @@ The module defines the following items:
|
||||||
|
|
||||||
.. exception:: BadZipFile
|
.. exception:: BadZipFile
|
||||||
|
|
||||||
The error raised for bad ZIP files (old name: ``zipfile.error``).
|
The error raised for bad ZIP files.
|
||||||
|
|
||||||
.. versionadded:: 3.2
|
.. versionadded:: 3.2
|
||||||
|
|
||||||
|
|
||||||
.. exception:: BadZipfile
|
.. exception:: BadZipfile
|
||||||
|
|
||||||
This is an alias for :exc:`BadZipFile` that exists for compatibility with
|
Alias of :exc:`BadZipFile`, for compatibility with older Python versions.
|
||||||
Python versions prior to 3.2. Usage is deprecated.
|
|
||||||
|
.. deprecated:: 3.2
|
||||||
|
|
||||||
|
|
||||||
.. exception:: LargeZipFile
|
.. exception:: LargeZipFile
|
||||||
|
|
|
@ -399,7 +399,7 @@ def _make_tarball(base_name, base_dir, compress="gzip", verbose=0, dry_run=0,
|
||||||
|
|
||||||
if not os.path.exists(archive_dir):
|
if not os.path.exists(archive_dir):
|
||||||
if logger is not None:
|
if logger is not None:
|
||||||
logger.info("creating %s" % archive_dir)
|
logger.info("creating %s", archive_dir)
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
os.makedirs(archive_dir)
|
os.makedirs(archive_dir)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue