Module build

source code

Provides the building methods for the cjklib package.

Each table that needs to be created has to be implemented by a TableBuilder. The DatabaseBuilder is the central instance for managing the build process. As the creation of a table can depend on other tables the DatabaseBuilder keeps track of dependencies to process a build in the correct order.

Building is tested on the following storage methods:

• SQLite
• MySQL

Some TableBuilder implementations aren't used by the CJK library but are provided here for additional usage.

For MS Windows default versions provided seem to be a "narrow build" and not support characters outside the BMP (see e.g. http://wordaligned.org/articles/narrow-python). Currently no Unicode characters outside the BMP will thus be supported on Windows platforms.

Examples

The following examples should give a quick view into how to use this package.

• Create the DatabaseBuilder object with default settings (read from cjklib.conf or using 'cjklib.db' in same directory as default):

  >>> from cjklib import build
  >>> dbBuilder = build.DatabaseBuilder(dataPath=['./cjklib/data/'])
  Removing conflicting builder(s) 'CharacterVariantBMPBuilder' in favour
  of 'CharacterVariantBuilder'
  Removing conflicting builder(s) 'SlimUnihanBuilder', 'UnihanBuilder',
  'UnihanBMPBuilder' in favour of 'SlimUnihanBMPBuilder'
  Removing conflicting builder(s) 'StrokeCountBuilder' in favour of
  'CombinedStrokeCountBuilder'
  Removing conflicting builder(s) 'CharacterResidualStrokeCountBuilder' in
  favour of 'CombinedCharacterResidualStrokeCountBuilder'

• Build the table of Jyutping syllables from a csv file:

  >>> dbBuilder.build(['JyutpingSyllables'])
  building table 'JyutpingSyllables' with builder
  'JyutpingSyllablesBuilder'...
  Reading table definition from file './cjklib/data/jyutpingsyllables.sql'
  Reading table 'JyutpingSyllables' from file
  './cjklib/data/jyutpingsyllables.csv'