biothings.web.settings

biothings.web.settings.configs

class biothings.web.settings.configs.ConfigModule(config=None, parent=None, validators=(), **kwargs)

Bases: object

A wrapper for the settings that configure the web API.

• Environment variables can override settings of the same names.

• Default values are defined in biothings.web.settings.default.

class biothings.web.settings.configs.ConfigPackage(root, modules)

Bases: NamedTuple

Create new instance of ConfigPackage(root, modules)

modules: Collection

Alias for field number 1

root: object

Alias for field number 0

biothings.web.settings.configs.load(config='config')

biothings.web.settings.configs.load_module(config, default=None)

Load a config module.

config:

1. a module object

2. a fully qualified module name

3. a file path to a module

biothings.web.settings.default

Biothings Web Settings Default

biothings.web.settings.validators

class biothings.web.settings.validators.DBParamValidator

Bases: object

validate(config)

class biothings.web.settings.validators.MongoParamValidaor

Bases: object

validate(config)

class biothings.web.settings.validators.SubmoduleValidator

Bases: object

validate(config)

class biothings.web.settings.validators.WebAPIValidator

Bases: object

validate(config)