Changeset 4283 for waeup/branches

Timestamp:

13 Jun 2009, 18:29:47 (16 years ago)

Author:

uli

Message:

Make waeup.csvfile README more sphinx aware.

File:

• waeup/branches/ulif-rewrite/src/waeup/csvfile/README.txt (modified) (1 diff)

waeup/branches/ulif-rewrite/src/waeup/csvfile/README.txt

@@ -1 @@
-waeup.csvfile
-*************
-
-Generic support for handling CSV files.
+:mod:`waeup.csvfile` -- generic support for handling CSV files
+**************************************************************
 
 :Test-Layer: unit
+
+.. module:: waeup.csvfile
+   :synopsis: generic support for handling CSV files.
+
+.. Module Contents
+.. ================
+
+.. class:: CSVFile(filepath)
+
+   Wrapper around the path to a real CSV file. :class:`CSVFile` is an
+   adapter that adapts basestring objects (aka regular and unicode
+   strings).
+
+   .. method:: grok.context(basestring)
+      :noindex:
+
+      We bind to basestring objects.
+
+   .. method:: grok.implements(ICSVFile)
+      :noindex:
+
+   .. attribute:: required_fields=[]
+
+      A list of header fields (strings) required for this kind of
+      CSVFile. Using the default constructor will fail with paths to
+      files that do *not* provide those fields.
+
+      The defaul value (empty list) means: no special fields required
+      at all.
+
+      Deriving classes can override this attribute to accept only
+      files that provide the appropriate header fields. The default
+      constructor already checks this.
+
+   .. attribute:: path
+
+      A string describing the path to the associated CSV file.
+
+   .. method:: getData()
+
+      Returns a generator delivering one data row of the denoted file
+      at a time.
+
+      Each data row is delivered as a dictionary mapping from header
+      field names to the values. Therefore a source line like this::
+
+        field1,field2
+        ...
+        data 1,data 2
+
+      will become a dictionary like this::
+
+        {'field1' : 'data 1', 
+         'field2' : 'data 2'}
+
+      The :meth:`getData` method does not evaluate file
+      values for correct data types or so.
+