diff options
author | Berker Peksag <berker.peksag@gmail.com> | 2017-01-07 06:32:56 (GMT) |
---|---|---|
committer | Berker Peksag <berker.peksag@gmail.com> | 2017-01-07 06:32:56 (GMT) |
commit | 631ada842454dbb18beb8d3677bd37569be153c8 (patch) | |
tree | 0f194b8b0333e4170cc1b618f550aa9f46038458 /Doc/library/csv.rst | |
parent | ff558f5aba40bd173f336503def886a12f8db016 (diff) | |
download | cpython-631ada842454dbb18beb8d3677bd37569be153c8.zip cpython-631ada842454dbb18beb8d3677bd37569be153c8.tar.gz cpython-631ada842454dbb18beb8d3677bd37569be153c8.tar.bz2 |
Issue #16026: Fix parameter names of DictReader and DictWriter
CPython and PyPy use f as the name of the first parameter of
DictReader and DictWriter classes.
Patch by James Salt and Greg Bengeult.
Diffstat (limited to 'Doc/library/csv.rst')
-rw-r--r-- | Doc/library/csv.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst index f916572..52a8a31 100644 --- a/Doc/library/csv.rst +++ b/Doc/library/csv.rst @@ -146,7 +146,7 @@ The :mod:`csv` module defines the following functions: The :mod:`csv` module defines the following classes: -.. class:: DictReader(csvfile, fieldnames=None, restkey=None, restval=None, \ +.. class:: DictReader(f, fieldnames=None, restkey=None, restval=None, \ dialect='excel', *args, **kwds) Create an object that operates like a regular reader but maps the @@ -154,7 +154,7 @@ The :mod:`csv` module defines the following classes: whose keys are given by the optional *fieldnames* parameter. The *fieldnames* parameter is a :term:`sequence`. If *fieldnames* is - omitted, the values in the first row of the *csvfile* will be used as the + omitted, the values in the first row of file *f* will be used as the fieldnames. Regardless of how the fieldnames are determined, the ordered dictionary preserves their original ordering. @@ -184,14 +184,14 @@ The :mod:`csv` module defines the following classes: OrderedDict([('first_name', 'John'), ('last_name', 'Cleese')]) -.. class:: DictWriter(csvfile, fieldnames, restval='', extrasaction='raise', \ +.. class:: DictWriter(f, fieldnames, restval='', extrasaction='raise', \ dialect='excel', *args, **kwds) Create an object which operates like a regular writer but maps dictionaries onto 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 - *csvfile*. The optional *restval* parameter specifies the value to be + dictionary passed to the :meth:`writerow` method are written to file + *f*. The optional *restval* parameter specifies the value to be written if the dictionary is missing a key in *fieldnames*. If the dictionary passed to the :meth:`writerow` method contains a key not found in *fieldnames*, the optional *extrasaction* parameter indicates what action to @@ -205,7 +205,7 @@ The :mod:`csv` module defines the following classes: Note that unlike the :class:`DictReader` class, the *fieldnames* parameter of the :class:`DictWriter` is not optional. Since Python's :class:`dict` objects are not ordered, there is not enough information available to deduce - the order in which the row should be written to the *csvfile*. + the order in which the row should be written to file *f*. A short usage example:: |