From: Berker Peksag <berker.peksag@gmail.com>
Date: Mon, 24 Nov 2014 21:46:30 +0000 (+0200)
Subject: Issue #20351: Add examples for csv.DictReader and csv.DictWriter.
X-Git-Tag: v3.4.3rc1~310
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c8c64e30e889c04ce266bf9e49d58cb97d835329;p=python

Issue #20351: Add examples for csv.DictReader and csv.DictWriter.

Patch by Charles-Axel Dein.
---

diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst
index ccc9dc6e4c..9f7b58afa7 100644
--- a/Doc/library/csv.rst
+++ b/Doc/library/csv.rst
@@ -158,6 +158,18 @@ The :mod:`csv` module defines the following classes:
    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)
@@ -180,6 +192,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