Skip to content

gh-151556: Show sample CSV file content in csv module docs #151563

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

Merged
StanFromIreland merged 9 commits into from
Jun 23, 2026
+31 −0
Merged

gh-151556: Show sample CSV file content in csv module docs #151563

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3fa714c
gh-151556: Show sample CSV file content in csv module docs
lul-cas Jun 16, 2026
d32cec1
Merge branch 'main' into gh-151556
lul-cas Jun 17, 2026
ef44100
gh-151556: Place CSV sample output after writer examples
lul-cas Jun 17, 2026
f6dcea7
Merge branch 'main' into gh-151556
lul-cas Jun 17, 2026
00e028e
Merge branch 'main' into gh-151556
lul-cas Jun 17, 2026
435ed1e
Merge branch 'main' into gh-151556
lul-cas Jun 17, 2026
41b98e4
gh-151556: Place CSV sample input after reader usage examples
lul-cas Jun 22, 2026
3da4caa
gh-151556: Tweak wording of writer example file output
lul-cas Jun 23, 2026
c37b277
Merge branch 'main' into gh-151556
lul-cas Jun 23, 2026
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
31 changes: 31 additions & 0 deletions Doc/library/csv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,13 @@ The :mod:`!csv` module defines the following functions:
Spam, Spam, Spam, Spam, Spam, Baked Beans
Spam, Lovely Spam, Wonderful Spam

where :file:`eggs.csv` contains:

.. code-block:: text

Spam Spam Spam Spam Spam |Baked Beans|
Spam |Lovely Spam| |Wonderful Spam|


.. function:: writer(csvfile, /, dialect='excel', **fmtparams)

Expand Down Expand Up @@ -110,6 +117,13 @@ The :mod:`!csv` module defines the following functions:
spamwriter.writerow(['Spam'] * 5 + ['Baked Beans'])
spamwriter.writerow(['Spam', 'Lovely Spam', 'Wonderful Spam'])

which writes :file:`eggs.csv` containing:

.. code-block:: text

Spam Spam Spam Spam Spam |Baked Beans|
Spam |Lovely Spam| |Wonderful Spam|


.. function:: register_dialect(name, /, dialect='excel', **fmtparams)

Expand Down Expand Up @@ -191,6 +205,14 @@ The :mod:`!csv` module defines the following classes:
>>> print(row)
{'first_name': 'John', 'last_name': 'Cleese'}

where :file:`names.csv` contains:

.. code-block:: text

first_name,last_name
Eric,Idle
John,Cleese


.. class:: DictWriter(f, fieldnames, restval='', extrasaction='raise', \
dialect='excel', *args, **kwds)
Expand Down Expand Up @@ -228,6 +250,15 @@ The :mod:`!csv` module defines the following classes:
writer.writerow({'first_name': 'Lovely', 'last_name': 'Spam'})
writer.writerow({'first_name': 'Wonderful', 'last_name': 'Spam'})

which writes :file:`names.csv` containing:

.. code-block:: text

first_name,last_name
Baked,Beans
Lovely,Spam
Wonderful,Spam


.. class:: Dialect

Expand Down
Loading