Issue #16206: Merge dict documentation improvements from 3.3.

Improve the documentation of the dict constructor.  This change includes
replacing the single-line signature documentation with a more complete
multiple-line signature.
This commit is contained in:
Chris Jerdonek 2012-10-13 03:26:10 -07:00
commit fe4985a1bb
2 changed files with 38 additions and 27 deletions

View file

@ -271,14 +271,17 @@ are always available. They are listed here in alphabetical order.
.. _func-dict: .. _func-dict:
.. function:: dict([arg]) .. function:: dict(**kwarg)
dict(mapping, **kwarg)
dict(iterable, **kwarg)
:noindex: :noindex:
Create a new data dictionary, optionally with items taken from *arg*. Create a new dictionary. The :class:`dict` object is the dictionary class.
The dictionary type is described in :ref:`typesmapping`. See :class:`dict` and :ref:`typesmapping` for documentation about this
class.
For other containers see the built in :class:`list`, :class:`set`, and For other containers see the built-in :class:`list`, :class:`set`, and
:class:`tuple` classes, and the :mod:`collections` module. :class:`tuple` classes, as well as the :mod:`collections` module.
.. function:: dir([object]) .. function:: dir([object])

View file

@ -2953,33 +2953,41 @@ Dictionaries can be created by placing a comma-separated list of ``key: value``
pairs within braces, for example: ``{'jack': 4098, 'sjoerd': 4127}`` or ``{4098: pairs within braces, for example: ``{'jack': 4098, 'sjoerd': 4127}`` or ``{4098:
'jack', 4127: 'sjoerd'}``, or by the :class:`dict` constructor. 'jack', 4127: 'sjoerd'}``, or by the :class:`dict` constructor.
.. class:: dict([arg]) .. class:: dict(**kwarg)
dict(mapping, **kwarg)
dict(iterable, **kwarg)
Return a new dictionary initialized from an optional positional argument or Return a new dictionary initialized from an optional positional argument
from a set of keyword arguments. If no arguments are given, return a new and a possibly empty set of keyword arguments.
empty dictionary. If the positional argument *arg* is a mapping object,
return a dictionary mapping the same keys to the same values as does the If no positional argument is given, an empty dictionary is created.
mapping object. Otherwise the positional argument must be a sequence, a If a positional argument is given and it is a mapping object, a dictionary
container that supports iteration, or an iterator object. The elements of is created with the same key-value pairs as the mapping object. Otherwise,
the argument must each also be of one of those kinds, and each must in turn the positional argument must be an :term:`iterator` object. Each item in
contain exactly two objects. The first is used as a key in the new the iterable must itself be an iterator with exactly two objects. The
dictionary, and the second as the key's value. If a given key is seen more first object of each item becomes a key in the new dictionary, and the
than once, the last value associated with it is retained in the new second object the corresponding value. If a key occurs more than once, the
last value for that key becomes the corresponding value in the new
dictionary. dictionary.
If keyword arguments are given, the keywords themselves with their associated If keyword arguments are given, the keyword arguments and their values are
values are added as items to the dictionary. If a key is specified both in added to the dictionary created from the positional argument. If a key
the positional argument and as a keyword argument, the value associated with being added is already present, the value from the keyword argument
the keyword is retained in the dictionary. For example, these all return a replaces the value from the positional argument.
dictionary equal to ``{"one": 1, "two": 2}``:
* ``dict(one=1, two=2)`` To illustrate, the following examples all return a dictionary equal to
* ``dict({'one': 1, 'two': 2})`` ``{"one": 1, "two": 2}``::
* ``dict(zip(('one', 'two'), (1, 2)))``
* ``dict([['two', 2], ['one', 1]])``
The first example only works for keys that are valid Python identifiers; the >>> a = dict(one=1, two=2)
others work with any valid keys. >>> b = dict({'one': 1, 'two': 2})
>>> c = dict(zip(('one', 'two'), (1, 2)))
>>> d = dict([['two', 2], ['one', 1]])
>>> e = {"one": 1, "two": 2}
>>> a == b == c == d == e
True
Providing keyword arguments as in the first example only works for keys that
are valid Python identifiers. Otherwise, any valid keys can be used.
These are the operations that dictionaries support (and therefore, custom These are the operations that dictionaries support (and therefore, custom