Configuration

Neba offers a configuration framework that is:

• strict: parameters are defined beforehand in Python code, any unknown or invalid parameter will raise errors

• structured: parameters can be organized in (nested) sections

• documented: docstrings of parameters are re-used in configuration files, command line help, and static documentation via a Sphinx extension

The parameters values can be recovered from configuration files (TOML, YAML, Python files, or JSON) and from the command line.

Here is a simple example:

from neba.config import Application, Section
from traitlets import Enum, Float, List, Unicode

class App(Application):
    """The application will retrieve and store parameters."""

    result_dir = Unicode("/data/results", help="Directory containing results")

    class model(Section):
        """A nested section."""
        coefficients = List(Float(), [0.5, 1.5, 10.0], help="Some coefficients for computation.")
        style = Enum(["serial", "parallel"], "serial", help="Only some values are accepted.")

app = App()
print(app.model.style)

Note

Neba is based on the traitlets package. The main difference is that Neba allows nested configurations. To do that, it replace the traitlets.config.Configurable class with Section and uses its own Application class. The objects reading the configuration from files and command line arguments have also been rewritten and expanded.