Documentation

• hachoir-core API
• hachoir-parser code example

Source of the documentation: source:trunk/hachoir-core/doc/ (most up to date)

A few graphs

Old schema (may be outdated):

• uml_field.png: Field classes UML diagram.
• uml_field_set.png: FieldSet classes UML diagram.
• adding_fields.png: Graph describing what happens when fields are added.

Tests

There are many tests in Hachoir to check non-regression:

• hachoir_core/test_doc.py
• hachoir_regex/test_doc.py
• hachoir_parser/tests/run_testcase.py
• hachoir_metadata/test_doc.py
• hachoir_metadata/run_testcase.py

The script test_code.sh run alls tests.

run_testcase.py requires Hachoir testcase.

Coverage

Use coverage_test.sh (use coverage_test.py).

You will need patched version of doctest module: use zope.testing or see patch for doctest.py.

Performance testing

See: optimization.

Coding style

See: wiki:CodingStyle

Python checkers

Some tools are used to check common errors:

• "make pylint": pylint
• "make pychecker": pychecker

See also:

• pyflakes
• pycheesecake