Skip to content

API reference

The reference is generated from the docstrings in the source code. It is the code's own documentation, and it stays accurate because it lives right next to the code. The reference has three parts:

  • Settings API — the application API of advexp.settings: the Settings class and its operations, the library configuration, the attribute parameters, the source builders with their file binders, the errors and sentinels, and the secret wrappers.
  • Configuration API — the application API of advexp.configuration: the read-only Configuration class, its source chains and the links they are built from, the attribute parameters, the errors and sentinels, and the same secret wrappers.
  • Plugin API — the contracts for backend and source authors: the vocabulary shared by the extension points of both packages, together with the layered side that the configuration package adds.

The bundled backends are documented on their own pages: Backends, Configuration and Dynamic settings. For these backends, the docstrings of their packages serve as the reference.