[openstack-dev] [Heat][oslo-incubator][oslo-log] Logging Unicode characters

Qiming Teng tengqim at linux.vnet.ibm.com
Wed Dec 24 09:48:56 UTC 2014


When trying to enable stack names in Heat to use unicode strings, I am
stuck by a weird behavior of logging.

Suppose I have a stack name assigned some non-ASCII string, then when
stack tries to log something here:


 536     LOG.info(_LI('Stack %(action)s %(status)s (%(name)s): '
 537                  '%(reason)s'),
 538              {'action': action,
 539               'status': status,
 540               'name': self.name,   # type(self.name)==unicode here
 541               'reason': reason})

I'm seeing the following errors from h-eng session:

Traceback (most recent call last):
  File "/usr/lib64/python2.6/logging/__init__.py", line 799, in emit
    stream.write(fs % msg.decode('utf-8'))
  File "/usr/lib64/python2.6/encodings/utf_8.py", line 16, in decode
    return codecs.utf_8_decode(input, errors, True)
UnicodeEncodeError: 'ascii' codec can't encode characters in position 114-115: 
 ordinal not in range(128)

This means logging cannot handle Unicode correctly?  No.  I did the
following experiments:

$ cat logtest

#!/usr/bin/env python

import sys

from oslo.utils import encodeutils
from oslo import i18n

from heat.common.i18n import _LI
from heat.openstack.common import log as logging


LOG = logging.getLogger('logtest')

print('sys.stdin.encoding: %s' % sys.stdin.encoding)
print('sys.getdefaultencoding: %s' % sys.getdefaultencoding())

s = sys.argv[1]
print('s is: %s' % type(s))

stack_name = encodeutils.safe_decode(unis)
print('stack_name is: %s' % type(stack_name))

# stack_name is unicode here
LOG.error(_LI('stack name: %(name)s') % {'name': stack_name})

$ ./logtest <some Chinese here>

[tengqm at node1 heat]$ ./logtest 中文
sys.stdin.encoding: UTF-8
sys.getdefaultencoding: ascii
s is: <type 'str'>
stack_name is: <type 'unicode'>
2014-12-24 17:51:13.799 29194 ERROR logtest [-] stack name: 中文

It worked.  

After spending more than one day on this, I'm seeking help from people
here.  What's wrong with Unicode stack names here?

Any hints are appreciated.

  - Qiming

More information about the OpenStack-dev mailing list