5ce463c433
Provide more detailed guidelines based on the info we have in the wiki at https://wiki.openstack.org/wiki/LoggingStandards#Guidelines Provide API documentation for the gettextutils module. Fix up some formatting issues with the contributing page that kept it from being included in the table of contents. Add a description to the README. Other minor section and document title fixes, and remove unused pages. Change-Id: I1e0a2be2918fe8f5d4194fc5a82b19edb225c1d0
92 lines
3.2 KiB
Python
92 lines
3.2 KiB
Python
# Copyright 2012 Red Hat, Inc.
|
|
# Copyright 2013 IBM Corp.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
"""logging utilities for translation
|
|
"""
|
|
|
|
from logging import handlers
|
|
|
|
from oslo.i18n import _translate
|
|
|
|
|
|
class TranslationHandler(handlers.MemoryHandler):
|
|
"""Handler that translates records before logging them.
|
|
|
|
The TranslationHandler takes a locale and a target logging.Handler object
|
|
to forward LogRecord objects to after translating them. This handler
|
|
depends on Message objects being logged, instead of regular strings.
|
|
|
|
The handler can be configured declaratively in the
|
|
``logging.conf`` as follows::
|
|
|
|
[handlers]
|
|
keys = translatedlog, translator
|
|
|
|
[handler_translatedlog]
|
|
class = handlers.WatchedFileHandler
|
|
args = ('/var/log/api-localized.log',)
|
|
formatter = context
|
|
|
|
[handler_translator]
|
|
class = oslo.i18n.log.TranslationHandler
|
|
target = translatedlog
|
|
args = ('zh_CN',)
|
|
|
|
If the specified locale is not available in the system, the handler will
|
|
log in the default locale.
|
|
|
|
"""
|
|
|
|
def __init__(self, locale=None, target=None):
|
|
"""Initialize a TranslationHandler
|
|
|
|
:param locale: locale to use for translating messages
|
|
:param target: logging.Handler object to forward
|
|
LogRecord objects to after translation
|
|
"""
|
|
# NOTE(luisg): In order to allow this handler to be a wrapper for
|
|
# other handlers, such as a FileHandler, and still be able to
|
|
# configure it using logging.conf, this handler has to extend
|
|
# MemoryHandler because only the MemoryHandlers' logging.conf
|
|
# parsing is implemented such that it accepts a target handler.
|
|
handlers.MemoryHandler.__init__(self, capacity=0, target=target)
|
|
self.locale = locale
|
|
|
|
def setFormatter(self, fmt):
|
|
self.target.setFormatter(fmt)
|
|
|
|
def emit(self, record):
|
|
# We save the message from the original record to restore it
|
|
# after translation, so other handlers are not affected by this
|
|
original_msg = record.msg
|
|
original_args = record.args
|
|
|
|
try:
|
|
self._translate_and_log_record(record)
|
|
finally:
|
|
record.msg = original_msg
|
|
record.args = original_args
|
|
|
|
def _translate_and_log_record(self, record):
|
|
record.msg = _translate.translate(record.msg, self.locale)
|
|
|
|
# In addition to translating the message, we also need to translate
|
|
# arguments that were passed to the log method that were not part
|
|
# of the main message e.g., log.info(_('Some message %s'), this_one))
|
|
record.args = _translate.translate_args(record.args, self.locale)
|
|
|
|
self.target.emit(record)
|