summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTerry Jan Reedy <tjreedy@udel.edu>2023-12-16 08:12:39 (GMT)
committerGitHub <noreply@github.com>2023-12-16 08:12:39 (GMT)
commit84df3172efe8767ddf5c28bdb6696b3f216bcaa6 (patch)
tree426e42edd8c8cdd00457f57cb0bf288ddf56019a
parent5ae75e1be24bd6b031a68040cfddb71732461f67 (diff)
downloadcpython-84df3172efe8767ddf5c28bdb6696b3f216bcaa6.zip
cpython-84df3172efe8767ddf5c28bdb6696b3f216bcaa6.tar.gz
cpython-84df3172efe8767ddf5c28bdb6696b3f216bcaa6.tar.bz2
gh-113046: Revise csv.reader doc (#113207)
Clarify nature of csvfile.
-rw-r--r--Doc/library/csv.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst
index 4d52254..7a5589e 100644
--- a/Doc/library/csv.rst
+++ b/Doc/library/csv.rst
@@ -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
@@ -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
--------------