doc/api/dataimport.rst
author Rémi Cardona <remi.cardona@logilab.fr>
Fri, 18 Sep 2015 11:54:12 +0200
changeset 10706 b261d90149d0
parent 10495 5bd914ebf3ae
child 12814 75e0377ed3c2
permissions -rw-r--r--
[server] Port BFSS to py3k The BFSS API changes in python 3: * 'defaultdir' MUST be a unicode object * 'fsencoding' MUST NOT be set In python 2, fsencoding handles both the encoding of file paths on the file system (utf-8 by default, but the system may actually be using something else) and the encoding of file paths that will be stored in the database. So in python 3, we wipe the slate clean: * rely on sys.getfilesystemencoding() to convert unicode objects to bytes * always encode paths to utf-8 for storage in the database Caveat emptor / here be dragons: * sys.getfilesystemencoding() depends on the current locale, which therefore MUST be set properly * when migrating an existing instance from py2 to py3, one MAY need to reencode file paths stored in the database

.. _dataimport_module:

:mod:`cubicweb.dataimport`
==========================

.. automodule:: cubicweb.dataimport

    Utilities
    ---------

    .. autofunction:: count_lines

    .. autofunction:: ucsvreader_pb

    .. autofunction:: ucsvreader

    .. autofunction:: callfunc_every

    .. autofunction:: lazytable

    .. autofunction:: lazydbtable

    .. autofunction:: mk_entity

    Sanitizing/coercing functions
    -----------------------------

    .. autofunction:: optional
    .. autofunction:: required
    .. autofunction:: todatetime
    .. autofunction:: call_transform_method
    .. autofunction:: call_check_method

    Integrity functions
    -------------------

    .. autofunction:: check_doubles
    .. autofunction:: check_doubles_not_none

    Object Stores
    -------------

    .. autoclass:: ObjectStore
        :members:

    .. autoclass:: RQLObjectStore
        :show-inheritance:
        :members:

    .. autoclass:: NoHookRQLObjectStore
        :show-inheritance:
        :members:

    .. autoclass:: SQLGenObjectStore
        :show-inheritance:
        :members:

    Import Controller
    -----------------

    .. autoclass:: CWImportController
        :show-inheritance:
        :members: