mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

#20628: make it clear that DictReader/Writer *fieldnames* is a Sequence.

Browse source 
Patch by Sean Rodman.
This commit is contained in:
R David Murray 2014-02-24 15:29:22 -05:00
parent 6b532349d0
commit df714b9f70
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/library/csv.rst
View file

@ -145,7 +145,10 @@ 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 information
read into a dict whose keys are given by the optional *fieldnames* parameter. read into a dict whose keys are given by the optional *fieldnames* parameter.
The *fieldnames* parameter is a :mod:`sequence <collections.abc>` whose elements
are associated with the fields of the input data in order. These elements
become the keys of the resulting dictionary.
If the *fieldnames* parameter is omitted, the values in the first row of the If the *fieldnames* parameter is omitted, the values in the first row of the
*csvfile* will be used as the fieldnames. If the row read has more fields *csvfile* will be used as the fieldnames. If the row read has more fields
than the fieldnames sequence, the remaining data is added as a sequence than the fieldnames sequence, the remaining data is added as a sequence
@ -158,7 +161,8 @@ The :mod:`csv` module defines the following classes:
.. 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 onto
output rows. The *fieldnames* parameter identifies the order in which values in output rows. The *fieldnames* parameter is a :mod:`sequence
<collections.abc>` of keys that identify the order in which values in
the dictionary passed to the :meth:`writerow` method are written to the 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 written
if the dictionary is missing a key in *fieldnames*. If the dictionary passed to if the dictionary is missing a key in *fieldnames*. If the dictionary passed to