Skip to content

Latest commit

 

History

History
71 lines (41 loc) · 1.85 KB

conf.rst

File metadata and controls

71 lines (41 loc) · 1.85 KB
Raw

xobox' Application Configuration

xobox.conf

xobox' application configuration module provides an interface for accessing built-in default configuration constants. Instead of scattering default constants all over the application's code, default values shall be centralized in :pyxobox.conf.default. This being the case, these configuration defaults can be accessed by either the function interface, or by a class interface.

Function Interface

xobox.conf.get_conf

Class Interface

get_instance(args,*kwargs)

Obtain the reference to the instance of :py~xobox.conf.ApplicationConf. If no instance exists yet, one will be created and its reference returned.

Note

Although the :py~xobox.conf.ApplicationConf.get_instance method accepts arbitrary positional and keyword arguments, they will be ignored by the constructor.

Default Configuration Values

xobox.conf.default

Core Settings

xobox.conf.default.DEFAULT_CHARSET

xobox.conf.default.DEFAULT_PICKLE_PROTOCOL

xobox.conf.default.DEFAULT_XOBOX_EXECUTABLE

xobox.conf.default.DEFAULT_CONF_FILE

Logging Settings

xobox.conf.default.DEFAULT_LOG_TYPE

xobox.conf.default.DEFAULT_LOG_LEVEL

xobox.conf.default.DEFAULT_LOG_FILE

xobox.conf.default.DEFAULT_LOG_TIMESTAMP

xobox.conf.default.DEFAULT_LOG_COLOR