Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

#20628: wrap lines to < 80.

This commit is contained in:
R David Murray 2014-02-24 15:32:54 -05:00
parent df714b9f70
commit f031a6f334
1 changed files with 32 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
Doc/library/csv.rst
View File

@ -142,40 +142,43 @@ The :mod:`csv` module defines the following functions:
The :mod:`csv` module defines the following classes: The :mod:`csv` module defines the following classes:
.. class:: DictReader(csvfile, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds) .. class:: DictReader(csvfile, fieldnames=None, restkey=None, restval=None, \
dialect='excel', *args, **kwds)
Create an object which operates like a regular reader but maps the information Create an object which operates like a regular reader but maps the
read into a dict whose keys are given by the optional *fieldnames* parameter. information read into a dict whose keys are given by the optional
The *fieldnames* parameter is a :mod:`sequence <collections.abc>` whose elements *fieldnames* parameter. The *fieldnames* parameter is a :mod:`sequence
are associated with the fields of the input data in order. These elements <collections.abc>` whose elements are associated with the fields of the
become the keys of the resulting dictionary. input data in order. These elements become the keys of the resulting
If the *fieldnames* parameter is omitted, the values in the first row of the dictionary. If the *fieldnames* parameter is omitted, the values in the
*csvfile* will be used as the fieldnames. If the row read has more fields first row of the *csvfile* will be used as the fieldnames. If the row read
than the fieldnames sequence, the remaining data is added as a sequence has more fields than the fieldnames sequence, the remaining data is added as
keyed by the value of *restkey*. If the row read has fewer fields than the a sequence keyed by the value of *restkey*. If the row read has fewer
fieldnames sequence, the remaining keys take the value of the optional fields than the fieldnames sequence, the remaining keys take the value of
*restval* parameter. Any other optional or keyword arguments are passed to the optional *restval* parameter. Any other optional or keyword arguments
the underlying :class:`reader` instance. are passed to the underlying :class:`reader` instance.
.. class:: DictWriter(csvfile, fieldnames, restval='', extrasaction='raise', dialect='excel', *args, **kwds) .. class:: DictWriter(csvfile, fieldnames, restval='', extrasaction='raise', \
dialect='excel', *args, **kwds)
Create an object which operates like a regular writer but maps dictionaries onto Create an object which operates like a regular writer but maps dictionaries
output rows. The *fieldnames* parameter is a :mod:`sequence onto output rows. The *fieldnames* parameter is a :mod:`sequence
<collections.abc>` of keys that identify the order in which values in <collections.abc>` of keys that identify the order in which values in the
the dictionary passed to the :meth:`writerow` method are written to the dictionary passed to the :meth:`writerow` method are written to the
*csvfile*. The optional *restval* parameter specifies the value to be written *csvfile*. The optional *restval* parameter specifies the value to be
if the dictionary is missing a key in *fieldnames*. If the dictionary passed to written if the dictionary is missing a key in *fieldnames*. If the
the :meth:`writerow` method contains a key not found in *fieldnames*, the dictionary passed to the :meth:`writerow` method contains a key not found in
optional *extrasaction* parameter indicates what action to take. If it is set *fieldnames*, the optional *extrasaction* parameter indicates what action to
to ``'raise'`` a :exc:`ValueError` is raised. If it is set to ``'ignore'``, take. If it is set to ``'raise'`` a :exc:`ValueError` is raised. If it is
extra values in the dictionary are ignored. Any other optional or keyword set to ``'ignore'``, extra values in the dictionary are ignored. Any other
arguments are passed to the underlying :class:`writer` instance. optional or keyword arguments are passed to the underlying :class:`writer`
instance.
Note that unlike the :class:`DictReader` class, the *fieldnames* parameter of Note that unlike the :class:`DictReader` class, the *fieldnames* parameter
the :class:`DictWriter` is not optional. Since Python's :class:`dict` objects of the :class:`DictWriter` is not optional. Since Python's :class:`dict`
are not ordered, there is not enough information available to deduce the order objects are not ordered, there is not enough information available to deduce
in which the row should be written to the *csvfile*. the order in which the row should be written to the *csvfile*.
.. class:: Dialect .. class:: Dialect