Skip to content

[3.13] gh-151556: Show example CSV file content in the csv module docs (GH-151563) #151986

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 1 commit into from
Jun 23, 2026
+31 −0
Merged

[3.13] gh-151556: Show example CSV file content in the csv module docs (GH-151563) #151986

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
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 @@ -83,6 +83,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 @@ -112,6 +119,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 @@ -193,6 +207,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 @@ -230,6 +252,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