Package sabayon :: Module debuglog
[hide private]
[frames] | no frames]

Module debuglog

source code

Classes [hide private]
  DebugLog
This class is internal.

Functions [hide private]
  uprint(fmt, *args)
Logs a non-milestone message in the USER domain.
  _debug_log_lock()
  _debug_log_unlock()
  debug_log(is_milestone, domain, msg)
Logs a message to the debug log.
  debug_log_current_exception(domain)
Logs the current exception as a milestone.
  debug_log_load_configuration(config_filename)
Loads the configuration for the debug log from a file.
  debug_log_is_domain_enabled(domain)
Returns whether a certain domain is enabled in the debug log.
  debug_log_get_force_dump()
Returns True if the debug log configuration specifies that the log should be dumped at the end of the program's execution; False otherwise (the default).
  debug_log_dump_as_list(config_filename)
Returns a list with the contents of the debug log, ready to be sent to a file.
  debug_log_dump_to_file(config_filename, file)
Dumps the debug log to a file.
  debug_log_dump_configuration(file)
Dumps the current configuration to the specified file object.
  debug_log_dump_to_dated_file(config_filename)
Dumps the debug log to a unique file, convenient for reading by the user.

Variables [hide private]
  DEBUG_LOG_DOMAIN_USER = 'USER'
  DEBUG_LOG_DOMAIN_SABAYON_APPLY = 'sabayon-apply'
  DEBUG_LOG_DOMAIN_SABAYON_SESSION = 'sabayon-session'
  DEBUG_LOG_DOMAIN_DEPRECATED = 'deprecated'
  DEBUG_LOG_DOMAIN_USER_PROFILE = 'user-profile'
  DEBUG_LOG_DOMAIN_STORAGE = 'storage'
  DEBUG_LOG_DOMAIN_PROTO_SESSION = 'proto-session'
  DEBUG_LOG_DOMAIN_USERMOD = 'usermod'
  DEBUG_LOG_DOMAIN_DIR_MONITOR = 'dir-monitor'
  DEBUG_LOG_DOMAIN_GCONF_SOURCE = 'gconf-source'
  DEBUG_LOG_DOMAIN_PANEL_DELEGATE = 'panel-delegate'
  DEBUG_LOG_DOMAIN_FILES_SOURCE = 'files-source'
  DEBUG_LOG_DOMAIN_MOZILLA_SOURCE = 'mozilla-source'
  DEBUG_LOG_DOMAIN_ADMIN_TOOL = 'admin-tool'
  DEBUG_LOG_DOMAIN_USER_DB = 'user-db'
  DEBUG_LOG_DOMAIN_CACHE = 'cache'
  DEBUG_LOG_DOMAIN_PESSULUS = 'pessulus'
  DEBUG_LOG_DOMAIN_SESSION_WIDGET = 'session-widget'
  _debug_log_log = <sabayon.cache.cacheRepository instance at 0x11c7170>
  _debug_log_the_lock = <thread.lock object at 0x295fc734168>
  __package__ = 'sabayon'

Function Details [hide private]

uprint(fmt, *args)

source code 
Logs a non-milestone message in the USER domain.

_debug_log_lock()

source code 
None

_debug_log_unlock()

source code 
None

debug_log(is_milestone, domain, msg)

source code 
Logs a message to the debug log.

debug_log_current_exception(domain)

source code 
Logs the current exception as a milestone.

debug_log_load_configuration(config_filename)

source code 
Loads the configuration for the debug log from a file. Does nothing if the file does not exist or if it is unreadable.

debug_log_is_domain_enabled(domain)

source code 
Returns whether a certain domain is enabled in the debug log. If generating a log message is an expensive operation, you can first use this function to test whether the message needs to be logged at all.

debug_log_get_force_dump()

source code 
Returns True if the debug log configuration specifies that the log should be dumped at the end of the program's execution; False otherwise (the default).

debug_log_dump_as_list(config_filename)

source code 
Returns a list with the contents of the debug log, ready to be sent to a file. This list contains both the milestones and the actual ring buffer used for logging.

debug_log_dump_to_file(config_filename, file)

source code 
Dumps the debug log to a file.

debug_log_dump_configuration(file)

source code 
Dumps the current configuration to the specified file object.

debug_log_dump_to_dated_file(config_filename)

source code 
Dumps the debug log to a unique file, convenient for reading by the user.

Variables Details [hide private]

DEBUG_LOG_DOMAIN_USER

None
Value:
'USER'                                                                 
      

DEBUG_LOG_DOMAIN_SABAYON_APPLY

None
Value:
'sabayon-apply'                                                        
      

DEBUG_LOG_DOMAIN_SABAYON_SESSION

None
Value:
'sabayon-session'                                                      
      

DEBUG_LOG_DOMAIN_DEPRECATED

None
Value:
'deprecated'                                                           
      

DEBUG_LOG_DOMAIN_USER_PROFILE

None
Value:
'user-profile'                                                         
      

DEBUG_LOG_DOMAIN_STORAGE

None
Value:
'storage'                                                              
      

DEBUG_LOG_DOMAIN_PROTO_SESSION

None
Value:
'proto-session'                                                        
      

DEBUG_LOG_DOMAIN_USERMOD

None
Value:
'usermod'                                                              
      

DEBUG_LOG_DOMAIN_DIR_MONITOR

None
Value:
'dir-monitor'                                                          
      

DEBUG_LOG_DOMAIN_GCONF_SOURCE

None
Value:
'gconf-source'                                                         
      

DEBUG_LOG_DOMAIN_PANEL_DELEGATE

None
Value:
'panel-delegate'                                                       
      

DEBUG_LOG_DOMAIN_FILES_SOURCE

None
Value:
'files-source'                                                         
      

DEBUG_LOG_DOMAIN_MOZILLA_SOURCE

None
Value:
'mozilla-source'                                                       
      

DEBUG_LOG_DOMAIN_ADMIN_TOOL

None
Value:
'admin-tool'                                                           
      

DEBUG_LOG_DOMAIN_USER_DB

None
Value:
'user-db'                                                              
      

DEBUG_LOG_DOMAIN_CACHE

None
Value:
'cache'                                                                
      

DEBUG_LOG_DOMAIN_PESSULUS

None
Value:
'pessulus'                                                             
      

DEBUG_LOG_DOMAIN_SESSION_WIDGET

None
Value:
'session-widget'                                                       
      

_debug_log_log

None
Value:
<sabayon.cache.cacheRepository instance at 0x11c7170>                  
      

_debug_log_the_lock

None
Value:
<thread.lock object at 0x295fc734168>                                  
      

__package__

None
Value:
'sabayon'