psychopy.log - control what gets logged

Provides functions for logging error and other messages to one or more files and/or the console, using python’s own logging module. Some warning messages and error messages are generated by PsychoPy itself. The user can generate more using the functions in this module.

There are various levels for logged messages; ranging from ERROR, through WARNING, to INFO and DEBUG. When setting the level for a particular log (file or console) the user can set the minimum level that is required for messages to enter the log. For example, setting a level of INFO will result in INFO, WARNING and ERROR messages to be recorded but not DEBUG nessages.

By default, PsychoPy will record messages of WARNING level and above to the console and INFO upwards to a psychopy.log in the current directory. The user can silence both by setting them to receive only CRITICAL messages, which (PsychoPy doesn’t use) using the commands;

from psychopy import log
log.console.setLevel(log.CRITICAL)

class psychopy.log.LogFile(filename, filemode='a', level=20, format='%(asctime)-s %(levelname)-8s %(message)s', dateFormat='%y-%m-%d %H:%M')

Creates an object to help with logging events to a file

Arguments: - filename - filemode = ‘a’(ppend) or ‘w’(rite). The latter will remove the previous file - level = the minimum level of the messages to be entered into the log - format = a string defining the format of messages - datefmt = a string specifying just the date part of the message

getLevel()

Returns the current level for this log (numerically) The values correspond to:

• 40:Error
• 35 Data
• 30:Warning
• 20:Info
• 10:Debug

setLevel(level)

Sets the current level for this log (numerically) The values correspond to:

• 40:Error
• 35 Data
• 30:Warning
• 20:Info
• 10:Debug

write(text)

Write arbitrary text to the logfile (and no other file). Consider using functions like psychopy.log.info instead, to write the message to all logfiles of a given level.

writeline(text)

As LogFile.write but adds a at the end of the text

psychopy.log.data(msg, *args, **kwargs)

log.data(message) Send the message to any receiver of logging info (e.g. a LogFile) of level log.DATA or higher

psychopy.log.debug

log.debug(message) Send the message to any receiver of logging info (e.g. a LogFile) of level log.DEBUG or higher

psychopy.log.error

log.error(message) Send the message to any receiver of logging info (e.g. a LogFile) of level log.ERROR or higher

psychopy.log.info

log.info(message) Send the message to any receiver of logging info (e.g. a LogFile) of level log.INFO or higher

psychopy.log.warning

log.warning(message) Send the message to any receiver of logging info (e.g. a LogFile) of level log.WARNING or higher

psychopy.info()

Fetching data about the system