December 2004 Meeting

   1 def basicConfig(**kwargs):
   2     """
   3     Do basic configuration for the logging system.
   4 
   5     This function does nothing if the root logger already has handlers
   6     configured. It is a convenience method intended for use by simple scripts
   7     to do one-shot configuration of the logging package.
   8 
   9     The default behaviour is to create a StreamHandler which writes to
  10     sys.stderr, set a formatter using the BASIC_FORMAT format string, and
  11     add the handler to the root logger.
  12 
  13     A number of optional keyword arguments may be specified, which can alter
  14     the default behaviour.
  15 
  16     filename  Specifies that a FileHandler be created, using the specified
  17               filename, rather than a StreamHandler.
  18     filemode  Specifies the mode to open the file, if filename is specified
  19               (if filemode is unspecified, it defaults to "a").
  20     format    Use the specified format string for the handler.
  21     datefmt   Use the specified date/time format.
  22     level     Set the root logger level to the specified level.
  23     stream    Use the specified stream to initialize the StreamHandler. Note
  24               that this argument is incompatible with 'filename' - if both
  25               are present, 'stream' is ignored.
  26 
  27     Note that you could specify a stream created using open(filename, mode)
  28     rather than passing the filename and mode in. However, it should be
  29     remembered that StreamHandler does not close its stream (since it may be
  30     using sys.stdout or sys.stderr), whereas FileHandler closes its stream
  31     when the handler is closed.
  32     """