3f10890319
These are just the doc strings I created as I was spelunking
through to see how Sugar manages launching applications. The
resulting auto-documentation is neither polished or finished,
but it should help people reading the code somewhat.
There are a few minor code cleanups:
* activityhandle (replacing C idiom for initialisation with
a Python one)
* bundle registry (using a parameterised directory name so
that it shows up in the documentation)
* validate_activity_id function, use isinstance( item, (str,unicode))
for the query, rather than two separate checks with isinstance
114 lines
3.2 KiB
Python
114 lines
3.2 KiB
Python
"""Logging module configuration for Sugar"""
|
|
# Copyright (C) 2006, Red Hat, Inc.
|
|
#
|
|
# This library is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU Lesser General Public
|
|
# License as published by the Free Software Foundation; either
|
|
# version 2 of the License, or (at your option) any later version.
|
|
#
|
|
# This library is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
# Lesser General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public
|
|
# License along with this library; if not, write to the
|
|
# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
# Boston, MA 02111-1307, USA.
|
|
|
|
import sys
|
|
import os
|
|
import logging
|
|
import traceback
|
|
from cStringIO import StringIO
|
|
|
|
from sugar import env
|
|
|
|
_log_writer = None
|
|
|
|
STDOUT_LEVEL = 1000
|
|
STDERR_LEVEL = 2000
|
|
|
|
class LogWriter:
|
|
def __init__(self, module_id):
|
|
self._module_id = module_id
|
|
|
|
logs_dir = _get_logs_dir()
|
|
log_path = os.path.join(logs_dir, module_id + '.log')
|
|
self._log_file = open(log_path, 'w')
|
|
|
|
def write_record(self, record):
|
|
self.write(record.levelno, record.msg)
|
|
|
|
def write(self, level, msg):
|
|
if level == logging.ERROR:
|
|
level_txt = 'ERROR'
|
|
elif level == logging.WARNING:
|
|
level_txt = 'WARNING'
|
|
elif level == logging.DEBUG:
|
|
level_txt = 'DEBUG'
|
|
elif level == logging.INFO:
|
|
level_txt = 'INFO'
|
|
elif level == STDERR_LEVEL:
|
|
level_txt = 'STDERR'
|
|
elif level == STDOUT_LEVEL:
|
|
level_txt = 'STDOUT'
|
|
|
|
if msg[len(msg) - 1] != '\n':
|
|
msg += "\n"
|
|
fmt = "%s - %s" % (level_txt, msg)
|
|
fmt = fmt.encode("utf8")
|
|
self._log_file.write(fmt)
|
|
self._log_file.flush()
|
|
|
|
class Handler(logging.Handler):
|
|
def __init__(self, writer):
|
|
logging.Handler.__init__(self)
|
|
|
|
self._writer = writer
|
|
|
|
def emit(self, record):
|
|
self._writer.write_record(record)
|
|
|
|
class StdoutCatcher:
|
|
def write(self, txt):
|
|
_log_writer.write(STDOUT_LEVEL, txt)
|
|
sys.__stdout__.write(txt)
|
|
|
|
class StderrCatcher:
|
|
def write(self, txt):
|
|
_log_writer.write(STDERR_LEVEL, txt)
|
|
sys.__stderr__.write(txt)
|
|
|
|
def __exception_handler(typ, exc, tb):
|
|
trace = StringIO()
|
|
traceback.print_exception(typ, exc, tb, None, trace)
|
|
print >> sys.stderr, trace.getvalue()
|
|
|
|
_log_writer.write(logging.ERROR, trace.getvalue())
|
|
|
|
def _get_logs_dir():
|
|
logs_dir = os.path.join(env.get_profile_path(), 'logs')
|
|
if not os.path.isdir(logs_dir):
|
|
os.makedirs(logs_dir)
|
|
return logs_dir
|
|
|
|
def start(module_id):
|
|
log_writer = LogWriter(module_id)
|
|
|
|
root_logger = logging.getLogger('')
|
|
root_logger.setLevel(logging.DEBUG)
|
|
root_logger.addHandler(Handler(log_writer))
|
|
|
|
sys.stdout = StdoutCatcher()
|
|
sys.stderr = StderrCatcher()
|
|
|
|
global _log_writer
|
|
_log_writer = log_writer
|
|
sys.excepthook = __exception_handler
|
|
|
|
def cleanup():
|
|
logs_dir = _get_logs_dir()
|
|
for f in os.listdir(logs_dir):
|
|
os.remove(os.path.join(logs_dir, f))
|