Changeset 4337 for waeup/branches

Timestamp:

23 Jun 2009, 09:56:31 (15 years ago)

Author:

uli

Message:

Add convenience type caster 'toBool' in csvfile module.

Location:

waeup/branches/ulif-rewrite/src/waeup/csvfile

Files:

• README.txt (modified) (2 diffs)
• __init__.py (modified) (1 diff)
• util.py (added)

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

@@ -84 +84 @@
 
 :func:`getCSVFile`
-----------------------
+------------------
 
 .. function:: getCSVFile(filepath)
@@ -102 +102 @@
 
       :ref:`getcsvfiledecision`
+
+Helpers
+=======
+
+Some helper functions provide convenience methods for handling CSV
+data.
+
+:func:`toBool`
+--------------
+
+.. function:: toBool(string)
+
+   `string`
+      String containing some CSV data.
+
+   Turn a string into a boolean value.
+
+   If the string contains one of the values ``'true'``, ``'yes'``,
+   ``'y'``, ``'on'`` or ``'checked'`` then ``True`` is returned,
+   ``False`` otherwise.
+
+   The string can be uppercase, lowercase or mixed:
+
+     >>> from waeup.csvfile import toBool
+     >>> toBool('y')
+     True
+
+     >>> toBool('Yes')
+     True
+
+     >>> toBool('TRUE')
+     True
 
 Basic example

waeup/branches/ulif-rewrite/src/waeup/csvfile/__init__.py

@@ -1 +1 @@
 # Make this a package.
 from waeup.csvfile.csvfile import getCSVFile, CSVFile
+from waeup.csvfile.util import toBool