summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2014-11-24 23:50:46 +0200
committerBerker Peksag <berker.peksag@gmail.com>2014-11-24 23:50:46 +0200
commit24c43808b582f95072c40dd24d6a92d0127b3fe8 (patch)
tree91dd7b729a197616e3cce2ceb47ad48e00ad66fb
parentf148cb6d5f97e2d4c7851828f3a546154dcecfdd (diff)
downloadcpython-24c43808b582f95072c40dd24d6a92d0127b3fe8.tar.gz
Issue #20351: Add examples for csv.DictReader and csv.DictWriter.
Patch by Charles-Axel Dein.
-rw-r--r--Doc/library/csv.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst
index 2054ce649e..1f5ae65d53 100644
--- a/Doc/library/csv.rst
+++ b/Doc/library/csv.rst
@@ -180,6 +180,18 @@ The :mod:`csv` module defines the following classes:
of the optional *restval* parameter. Any other optional or keyword
arguments are passed to the underlying :class:`reader` instance.
+ A short usage example::
+
+ >>> import csv
+ >>> with open('names.csv') as csvfile:
+ ... reader = csv.DictReader(csvfile)
+ ... for row in reader:
+ ... print(row['first_name'], row['last_name'])
+ ...
+ Baked Beans
+ Lovely Spam
+ Wonderful Spam
+
.. class:: DictWriter(csvfile, fieldnames, restval='', extrasaction='raise', \
dialect='excel', *args, **kwds)
@@ -202,6 +214,19 @@ The :mod:`csv` module defines the following classes:
objects are not ordered, there is not enough information available to deduce
the order in which the row should be written to the *csvfile*.
+ A short usage example::
+
+ import csv
+
+ with open('names.csv', 'w') as csvfile:
+ fieldnames = ['first_name', 'last_name']
+ writer = csv.DictWriter(csvfile, fieldnames=fieldnames)
+
+ writer.writeheader()
+ writer.writerow({'first_name': 'Baked', 'last_name': 'Beans'})
+ writer.writerow({'first_name': 'Lovely', 'last_name': 'Spam'})
+ writer.writerow({'first_name': 'Wonderful', 'last_name': 'Spam'})
+
.. class:: Dialect