Changeset 4162 for waeup/branches

Timestamp:

24 May 2009, 10:13:21 (15 years ago)

Author:

uli

Message:

Update tests.

File:

• waeup/branches/ulif-rewrite/src/waeup/university/facultycontainer.txt (modified) (1 diff)

waeup/branches/ulif-rewrite/src/waeup/university/facultycontainer.txt

@@ -69 +69 @@
 like. It might be a string of integers, a name or whatever; you cannot
 know before.
+
+Importing from CSV files
+------------------------
+
+We create a facultycontainer, which we want to populate with some CSV
+data afterwards:
+
+    >>> from waeup.university.facultycontainer import FacultyContainer
+    >>> mycontainer = FacultyContainer()
+
+Next, we create a CSV file we want to import:
+
+    >>> open('myfaculties.csv', 'wb').write(
+    ... """code,review_state,title,title_prefix
+    ... AGR,static,Agriculture,faculty
+    ... ART,static,Arts,faculty
+    ... DEN,static,Dentistry,faculty
+    ... """)
+
+We get a suitable importer by asking for an adapter to
+IWAeUPCSVExporter (see section above for details):
+
+    >>> from waeup.interfaces import IWAeUPCSVImporter
+    >>> importer = IWAeUPCSVImporter(mycontainer)
+    >>> importer
+    <waeup.university.facultycontainer.FacultyCSVImporter object at 0x...>
+
+This importer complies with the IWAeUPCSVImporter interface:
+
+    >>> from waeup.university.facultycontainer import FacultyCSVImporter
+    >>> IWAeUPCSVImporter.implementedBy(FacultyCSVImporter)
+    True
+
+    >>> from zope.interface.verify import verifyClass
+    >>> verifyClass(IWAeUPCSVImporter, FacultyCSVImporter)
+    True
+
+The container is still empty:
+
+    >>> len(mycontainer)
+    0
+
+Now we can easily import the data:
+
+    >>> importer.doImport('myfaculties.csv')
+
+The container is now filled:
+
+    >>> len(mycontainer)
+    3
+
+    >>> print [(x.code, x.title) for x in list(mycontainer.values())]
+    [('AGR', 'Agriculture'), ('ART', 'Arts'), ('DEN', 'Dentistry')]
+
+
+We can validate data of CSV files without actually importing
+them. This can help for instance while checking uploaded files:
+
+    >>> importer.validate('myfaculties.csv')
+    True
+
+Clean up:
+
+    >>> import os
+    >>> os.unlink('myfaculties.csv')