homepage

The documentation for the csv.DictReader constructor (and presumably csv.DictWriter also) has the wrong name written for the first argument. This prevents the argument from being called by name.
>>> file = open("file.txt", 'a')
>>> csv.DictReader(csvfile=file)
Traceback (most recent call last):
 File "<stdin>", line 1, in <module>
TypeError: __init__() takes at least 2 arguments (1 given)
>>> csv.DictReader(f=file)
<csv.DictReader instance at 0x04D97A08>
>>> # how could i have known it was named 'f'?
Please change the documentation.

In the python3 docs it is given as 'f'. In the python2 docs, it is not. I suppose a doc backport was missed.

Side-note: You say "how could i have known it was named 'f'?"
>>> help(csv.DictReader)
class DictReader
 | Methods defined here:
 |
 | __init__(self, f, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)
... rest of class help ...
Not saying the docs shouldn't be fixed, but the name is correctly given in the __init__ prototype (being implemented in Python, the names are always available to help() introspection, barring really specific cases of manual parsing of **kwargs). Just a general tip for the future.

I just fixed the documentation, but I think we should change the name of the first parameter in master for 3.8. Maybe for 3.7, because we have to fix the docs. 
@david, what is your opinion?
I am going to propose a PR for the naming of the first argument

See issue16026 for the fix in 3.x.

Hi @Serhiy
I try to use the cherry-picking method for the patch from 3.6 but without success, I preferred to reuse my initial commit and remove the News.d entry.

Stéphane: I don't understand your question about changing the name of the parameter. As far as I can see the only thing to do here is backport the doc fix to 2.7.

Hi David, 
At the final, I didn't propose my PR with the renaming. because PyPy and CPython use f as the first parameter of these classes.
If @Serhiy does the review of my PR, we can close this issue.

New changeset 672fd7d8162f76aff8423fa5c7bfd2b1e91faf57 by Mariatta (Stéphane Wirtel) in branch '2.7':
bpo-32784: Wrong argument name for csv.DictReader in documentation (GH-5575)
https://github.com/python/cpython/commit/672fd7d8162f76aff8423fa5c7bfd2b1e91faf57

Thanks everyone!

Hi, thanks for the quick action on this!
The documentation is still wrong for 3.5 . I had selected 3.5 for the affected versions, but I guess it got removed?

3.5 is for security fixes only now. We don't do documentation or regular bug fixes there anymore.