From d4040d73d914c044054eb2ac9b79806f44c6dd36 Mon Sep 17 00:00:00 2001 From: samus_ Date: Sat, 22 Nov 2008 19:20:53 +0000 Subject: [PATCH] added docstring --HG-- extra : convert_revision : svn%3Ab85faa78-f9eb-468e-a121-7cced6da292c%40394 --- scrapy/trunk/scrapy/utils/iterators.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/scrapy/trunk/scrapy/utils/iterators.py b/scrapy/trunk/scrapy/utils/iterators.py index 6bb1854ea..86a2ea19b 100644 --- a/scrapy/trunk/scrapy/utils/iterators.py +++ b/scrapy/trunk/scrapy/utils/iterators.py @@ -30,6 +30,18 @@ def xmliter(obj, nodename): yield XmlXPathSelector(text=nodetext).x('/' + nodename)[0] def csviter(obj, delimiter=None, headers=None): + """ Returns an iterator of dictionaries from the given csv object + + obj can be: + - a Response object + - a unicode string + - a string encoded as utf-8 + + delimiter is the character used to separate field on the given obj. + + headers is an iterable that when provided offers the keys + for the returned dictionaries, if not the first row is used. + """ def _getrow(csv_r): return [field.decode() for field in csv_r.next()]