Module Pootle.storage.api

Abstract classes (interfaces) that define the Pootle backend API.

These classes only describe the available operations.  New backends should
implement operations described here.

Fields marked as optional can have the value None.

You can use the function validateModule to check that a set of backend classes
implements the interfaces described here.


Here is a rough sketch of the class containment hierarchy:

  IDatabase
    IFolder
      ...
        IModule (maps to a set of translations for a .pot file)
          ITranslationStore (one for each language)
            ITranslationUnit (maps to an msgid+msgstr)


Object lifecycle semantics
==========================

All content objects (folders, modules, translation stores, etc.) are
to be simultaneously created and added to a container.  Afterwards their
name or reference to parent must not be changed. The only exception is
TranslationUnits which are constructed and added in separate steps.

This policy allows the backend to commit changes immediately and avoid floating
unserialized objects.