Skip to content

csv readers take iterables as well as iterators #2653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

csv readers take iterables as well as iterators #2653

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Doc/library/csv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ The :mod:`csv` module defines the following functions:
.. function:: reader(csvfile, dialect='excel', **fmtparams)

Return a reader object which will iterate over lines in the given *csvfile*.
*csvfile* can be any object which supports the :term:`iterator` protocol and returns a
string each time its :meth:`!__next__` method is called --- :term:`file objects
*csvfile* can be any object which supports the :term:`iterable` protocol and returns an
iterator that returns a string each time its :term`iterator`'s :meth:`!__next__` method
is called when its :meth:`!__iter__` method is called --- :term:`file objects
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest instead changing the original with the following minimal change:
...can be any iterable object whose iterator returns a string each time its...

<file object>` and list objects are both suitable. If *csvfile* is a file object,
it should be opened with ``newline=''``. [1]_ An optional
*dialect* parameter can be given which is used to define a set of parameters
Expand Down Expand Up @@ -416,7 +417,7 @@ Reader objects have the following public attributes:

.. attribute:: csvreader.line_num

The number of lines read from the source iterator. This is not the same as the
The number of lines read from the source iterable. This is not the same as the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why change this? If there is only one iterator involved, the original would be more precise.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point, iterator is more correct here.

number of records returned, as records can span multiple lines.


Expand Down