Skip to content

Commit

Permalink
gh-113046: Revise csv.reader doc (#113207)
Browse files Browse the repository at this point in the history
Clarify nature of csvfile.
  • Loading branch information
terryjreedy authored Dec 16, 2023
1 parent 5ae75e1 commit 84df317
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions Doc/library/csv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,11 @@ 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
<file object>` and list objects are both suitable. If *csvfile* is a file object,
Return a :ref:`reader object <reader-objects>` that will process
lines from the given *csvfile*. A csvfile must be an iterable of
strings, each in the reader's defined csv format.
A csvfile is most commonly a file-like object or list.
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
specific to a particular CSV dialect. It may be an instance of a subclass of
Expand Down Expand Up @@ -449,6 +450,8 @@ Dialects support the following attributes:
When ``True``, raise exception :exc:`Error` on bad CSV input.
The default is ``False``.

.. _reader-objects:

Reader Objects
--------------

Expand Down

0 comments on commit 84df317

Please sign in to comment.