Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit df714b9

Browse files
committed
#20628: make it clear that DictReader/Writer *fieldnames* is a Sequence.
Patch by Sean Rodman.
1 parent 6b53234 commit df714b9

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

Doc/library/csv.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,10 @@ The :mod:`csv` module defines the following classes:
145145
.. class:: DictReader(csvfile, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)
146146

147147
Create an object which operates like a regular reader but maps the information
148-
read into a dict whose keys are given by the optional *fieldnames* parameter.
148+
read into a dict whose keys are given by the optional *fieldnames* parameter.
149+
The *fieldnames* parameter is a :mod:`sequence <collections.abc>` whose elements
150+
are associated with the fields of the input data in order. These elements
151+
become the keys of the resulting dictionary.
149152
If the *fieldnames* parameter is omitted, the values in the first row of the
150153
*csvfile* will be used as the fieldnames. If the row read has more fields
151154
than the fieldnames sequence, the remaining data is added as a sequence
@@ -158,7 +161,8 @@ The :mod:`csv` module defines the following classes:
158161
.. class:: DictWriter(csvfile, fieldnames, restval='', extrasaction='raise', dialect='excel', *args, **kwds)
159162

160163
Create an object which operates like a regular writer but maps dictionaries onto
161-
output rows. The *fieldnames* parameter identifies the order in which values in
164+
output rows. The *fieldnames* parameter is a :mod:`sequence
165+
<collections.abc>` of keys that identify the order in which values in
162166
the dictionary passed to the :meth:`writerow` method are written to the
163167
*csvfile*. The optional *restval* parameter specifies the value to be written
164168
if the dictionary is missing a key in *fieldnames*. If the dictionary passed to

0 commit comments

Comments
 (0)