ophyd_async.core.config_ophyd_async_logging#
- ophyd_async.core.config_ophyd_async_logging(file=<colorama.ansitowin32.StreamWrapper object>, fmt='%(log_color)s[%(levelname)1.1s %(asctime)s.%(msecs)03d %(module)s:%(lineno)d] %(message)s', datefmt='%y%m%d %H:%M:%S', color=True, level='WARNING')[source]#
Set a new handler on the
logging.getLogger('ophyd_async')
logger. If this is called more than once, the handler from the previous invocation is removed (if still present) and replaced.- Parameters:
file (object with
write
method or filename string) – Default issys.stdout
.fmt (Overall logging format)
datefmt (string) – Date format. Default is
'%H:%M:%S'
.color (boolean) – Use ANSI color codes. True by default.
level (str or int) – Python logging level, given as string or corresponding integer. Default is ‘WARNING’.
- Returns:
handler – The handler, which has already been added to the ‘ophyd_async’ logger.
- Return type:
Examples
Log to a file.
config_ophyd_async_logging(file=’/tmp/what_is_happening.txt’)
Include the date along with the time. (The log messages will always include microseconds, which are configured separately, not as part of ‘datefmt’.)
config_ophyd_async_logging(datefmt=”%Y-%m-%d %H:%M:%S”)
Turn off ANSI color codes.
config_ophyd_async_logging(color=False)
Increase verbosity: show level DEBUG or higher.
config_ophyd_async_logging(level=’DEBUG’)