homepage

The documentation for the csv.DictReader constructor is
.. class:: DictReader(csvfile, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)
but the implementation is
def __init__(self, f, fieldnames=None, restkey=None, restval=None, dialect="excel", *args, **kwds):
The name of the first argument is documented incorrectly, leading to surprise errors when attempting to use key word arguments.

This diff shows a correction of the documentation to reflect the name for the csv file used in the implementation - this change seemed like the easiest and simplest thing to do and avoids potential backwards incompatibility issues.

Eric, iirc you're the de facto csv guy? Does this seem reasonable to you?

I’m not a dedicated maintainer for csv (for one thing I don’t know C :), I just happen to reply to many bug reports.
This doc patch looks good to me.

It is not consistent with reader and writer.
I propose to close the issue as "won't fix" or change the argument name in the sources. Unfortunately, Python syntax does not allow to specify the positional-only arguments.

I don’t understand the proposal. Changing the code has a high bar; here it would break code without benefit. Fixing the doc so that it reflects the code accurately is a no-cost improvement. (Inconsistency is unfortunate, but we’ll have to live with that.)

Changing the documentation is changing the specification, it has the higher bar than changing the implementation. It can break the alternative implementations.
This is unlikely to break somebody's existing code, because the one who used the argument as a keyword argument should have paid attention to the discrepancy of the documentation. But fixing the name, we will be difficult to change it in the future (to eliminate inconsistency).
I believe this change is too serious for bugfix. This is the case when never is better than *right* now.

I disagree that we can never fix argument names in the docs, as we have done it already. You raise a good point however, that we should check what other VMs do. I would not be surprised if they followed the code instead of the docs.

Hi Éric, I think the documentation should be changed to match the arguments' names.

James Salt's patch looks good to me, but it doesn't apply cleanly anymore.
For the record, PyPy uses the same parameter name as Lib/csv.py: https://bitbucket.org/pypy/pypy/src/55a9404c80d6557854cac092addd92a6e0b683cc/lib-python/2.7/csv.py?at=default&fileviewer=file-view-default#csv.py-74 

Here's a revised patch file for Python 3.7. This is my first ever submission to an open source project, so please be gentle.

Welcome and thanks for the patch, Greg. csv.rst-patch looks good to me. I will commit it this week if there are no objections.
Documentation updates can go into all active branches so I'm adding 3.5 and 3.6 back (we can pass 2.7 at this point since this is a trivial change)

Thanks for the patches James and Greg!

New changeset 198edd926751 by Berker Peksag in branch '3.6':
Issue #16026: Fix parameter names of DictReader and DictWriter
https://hg.python.org/cpython/rev/198edd926751
New changeset 63c5531cfdf7 by Berker Peksag in branch 'default':
Issue #16026: Merge from 3.6
https://hg.python.org/cpython/rev/63c5531cfdf7