dosma.debug

dosma.debug(value: Optional[bool] = None) → bool[source]

Return (and optionally set) debug mode.

Parameters: value (bool, optional) – If specified, sets the debug status. If not specified, debug mode is not set, only returned.
Returns: If True, debug mode is active.
Return type: bool
Raises: ValueError – If value is not a supported value.

Note

Changing the debug state changes the stream handler logging level for the default dosma logger. If debug state is turned off, logging level is set to logging.INFO. If debug state is turned on, logging level is set to logging.DEBUG.

Examples

>>> debug()  # get debug status, defaults to False
False
>>> debug(True)  # turn on debug mode
True
>>> debug()  # get debug status
True