[Python-checkins] cpython (3.6): Issue #16026: Fix parameter names of DictReader and DictWriter
berker.peksag
python-checkins at python.org
Sat Jan 7 01:30:35 EST 2017
https://hg.python.org/cpython/rev/198edd926751
changeset: 106026:198edd926751
branch: 3.6
parent: 106022:f8e24a0a1124
user: Berker Peksag <berker.peksag at gmail.com>
date: Sat Jan 07 09:32:56 2017 +0300
summary:
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.
files:
Doc/library/csv.rst | 12 ++++++------
1 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst
--- a/Doc/library/csv.rst
+++ b/Doc/library/csv.rst
@@ -146,7 +146,7 @@
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 @@
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 @@
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 @@
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::
--
Repository URL: https://hg.python.org/cpython
More information about the Python-checkins
mailing list