Changeset 4965 for main/waeup.sirp/trunk

Timestamp:

1 Feb 2010, 16:29:02 (15 years ago)

Author:

uli

Message:

Remove tests of quick-import functionality.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/utils/importexport.txt (modified) (1 diff)

main/waeup.sirp/trunk/src/waeup/sirp/utils/importexport.txt

@@ -141 +141 @@
     >>> import os
     >>> os.unlink('myexport.xml')
-
-
-Importing CSV data
-==================
-
-The WAeUP portal supports import of CSV data for several different
-data types like faculties, students, and the like.
-
-For our purposes we define CSV imports as tuples, containing a CSV
-source and a CSV receiver:
-
-  ``CSV Import := <CSVSource, CSVReceiver>``
-
-CSV sources
------------
-
-CSV sources build a plugin framework inside the WAeUP portal (that
-might be factored out one day). See `waeup.sirp.csvfile` to learn more
-about that.
-
-A `waeup.sirp.csvfile.CSVFile` plugin cares for a special kind of CSV file.
-
-To make clear what that means, we start by creating a simple CSV
-file.
-
-CSVFile objects are abstractions of simple .csv-files. But as not
-every CSV file contains the same kind of data, we can create different
-flavours of it, for instance to import departments or faculties. As
-each kind of import needs different kind of data, we have different
-kinds of CSV sources.
-
-CSV sources can check their associated files for consistency,
-importability, etc.
-
-We create a simple CSV file with cave data:
-
-    >>> open('mycavedata.csv', 'wb').write(
-    ... """size,owner
-    ... 42,Manfred
-    ... """)
-
-We have a very simple CSVFile available, which is registered as an
-adapter for strings. To make this work, the string should be a path to
-a file:
-
-    >>> from waeup.sirp.csvfile import getCSVFile
-    >>> mysource = getCSVFile('mycavedata.csv')
-    >>> mysource
-    <waeup.sirp.csvfile.csvfile.CSVFile object at 0x...>
-
-We define caves like this:
-
-    >>> class Cave(object):
-    ...   def __init__(self, size, owner):
-    ...     self.size = size
-    ...     self.owner = owner
-    ...   def __repr__(self):
-    ...     return '<Cave object [size: %s, owner: %s]>' % (
-    ...       self.size, self.owner)
-
-Let's assume, we have a container for caves:
-
-    >>> from zope.interface import Interface
-    >>> class ICaveContainer(Interface):
-    ...   """A container for caves."""
-
-    >>> class CaveContainer(object):
-    ...   grok.implements(ICaveContainer)
-    ...   caves = []
-    ...   def addCave(self, cave):
-    ...     self.caves.append(cave)
-
-    >>> mycaves = CaveContainer()
-
-Now, if we want to import caves from CSV files, we also need an
-importer, that imports data to the container:
-
-    >>> from waeup.sirp.csvfile.interfaces import ICSVFile
-    >>> from waeup.sirp.utils.importexport import CSVImporter
-    >>> from waeup.sirp.interfaces import IWAeUPCSVImporter
-    >>> class CaveImporter(CSVImporter):
-    ...   # Tell, what kinds of objects we connect...
-    ...   grok.adapts(ICSVFile, ICaveContainer)
-    ...   # Tell the world, that we are an importer...
-    ...   grok.provides(IWAeUPCSVImporter)
-    ...   # The datatype can be used by UI components and is required
-    ...   # by the interface...
-    ...   datatype = u'Cave Importer'
-    ...   def doImport(self):
-    ...     # CSVImporter instances have a `csvfile` and a `receiver`
-    ...     # object defined which refer to the CSV file and the container.
-    ...     for row in self.csvfile.getData():
-    ...       cave = Cave(size = row['size'],
-    ...                   owner = row['owner'])
-    ...       self.receiver.addCave(cave) 
-
-
-An CSV importer must be grokked before we can use it. In real life,
-this is normally done on startup automatically:
-
-    >>> grok.testing.grok_component('CaveImporter', CaveImporter)
-    True
-
-Importers are multi-adapters, so we need to ask for one:
-
-    >>> from zope.component import getMultiAdapter
-    >>> myimporter = getMultiAdapter((mysource, mycaves), IWAeUPCSVImporter)
-
-Now we can finally do the import:
-
-    >>> myimporter.doImport()
-
-The import was really done:
-
-    >>> mycaves.caves
-    [<Cave object [size: 42, owner: Manfred]>]
-
-**Important note**:
-
-  This importer adapts ICSVFile and ICaveContainer, which means that
-  the type of data receiver is specified correctly. For the CSV
-  source, however, the importer cannot be sure to find a column
-  ``size`` or ``owner`` in the file.
-
-  This can be prevented, by defining a more special CSVFile type and
-  adapting this instead of ICSVData.
-
-  In the `waeup.sirp.csvfile` subpackage's README it is shown, how this can
-  be accomplished.
-
-  Summing up we would define an ICaveCSVFile type, provide an
-  appropriate CSV file wrapper and then let our importer adapt::
-
-    (ICaveCSVFile, ICaveContainer)
-
-**Another note**:
-
-  The importer we defined above does not support the ``clear_old_data``
-  and ``overwrite`` keywords as would be required by the
-  IWAeUPImporter interface.
-
-  In real life this keywords should be supported.
-
-Clean up:
-
-   >>> import os
-   >>> os.unlink('mycavedata.csv')