forked from tornadoweb/tornado
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move LogFormatter from options.py to log.py
- Loading branch information
Showing
5 changed files
with
217 additions
and
188 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| #!/usr/bin/env python | ||
| # | ||
| # Copyright 2012 Facebook | ||
| # | ||
| # 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. | ||
| from __future__ import absolute_import, division, with_statement | ||
|
|
||
| import contextlib | ||
| import logging | ||
| import os | ||
| import re | ||
| import tempfile | ||
| import warnings | ||
|
|
||
| from tornado.escape import utf8 | ||
| from tornado.log import LogFormatter | ||
| from tornado.test.util import unittest | ||
| from tornado.util import b, bytes_type | ||
|
|
||
| @contextlib.contextmanager | ||
| def ignore_bytes_warning(): | ||
| if not hasattr(warnings, 'catch_warnings'): | ||
| # python 2.5 doesn't have catch_warnings, but it doesn't have | ||
| # BytesWarning either so there's nothing to catch. | ||
| yield | ||
| return | ||
| with warnings.catch_warnings(): | ||
| warnings.simplefilter('ignore', category=BytesWarning) | ||
| yield | ||
|
|
||
|
|
||
| class LogFormatterTest(unittest.TestCase): | ||
| LINE_RE = re.compile(b("\x01\\[E [0-9]{6} [0-9]{2}:[0-9]{2}:[0-9]{2} log_test:[0-9]+\\]\x02 (.*)")) | ||
|
|
||
| def setUp(self): | ||
| self.formatter = LogFormatter(color=False) | ||
| # Fake color support. We can't guarantee anything about the $TERM | ||
| # variable when the tests are run, so just patch in some values | ||
| # for testing. (testing with color off fails to expose some potential | ||
| # encoding issues from the control characters) | ||
| self.formatter._colors = { | ||
| logging.ERROR: u"\u0001", | ||
| } | ||
| self.formatter._normal = u"\u0002" | ||
| self.formatter._color = True | ||
| # construct a Logger directly to bypass getLogger's caching | ||
| self.logger = logging.Logger('LogFormatterTest') | ||
| self.logger.propagate = False | ||
| self.tempdir = tempfile.mkdtemp() | ||
| self.filename = os.path.join(self.tempdir, 'log.out') | ||
| self.handler = self.make_handler(self.filename) | ||
| self.handler.setFormatter(self.formatter) | ||
| self.logger.addHandler(self.handler) | ||
|
|
||
| def tearDown(self): | ||
| self.handler.close() | ||
| os.unlink(self.filename) | ||
| os.rmdir(self.tempdir) | ||
|
|
||
| def make_handler(self, filename): | ||
| # Base case: default setup without explicit encoding. | ||
| # In python 2, supports arbitrary byte strings and unicode objects | ||
| # that contain only ascii. In python 3, supports ascii-only unicode | ||
| # strings (but byte strings will be repr'd automatically). | ||
| return logging.FileHandler(filename) | ||
|
|
||
| def get_output(self): | ||
| with open(self.filename, "rb") as f: | ||
| line = f.read().strip() | ||
| m = LogFormatterTest.LINE_RE.match(line) | ||
| if m: | ||
| return m.group(1) | ||
| else: | ||
| raise Exception("output didn't match regex: %r" % line) | ||
|
|
||
| def test_basic_logging(self): | ||
| self.logger.error("foo") | ||
| self.assertEqual(self.get_output(), b("foo")) | ||
|
|
||
| def test_bytes_logging(self): | ||
| with ignore_bytes_warning(): | ||
| # This will be "\xe9" on python 2 or "b'\xe9'" on python 3 | ||
| self.logger.error(b("\xe9")) | ||
| self.assertEqual(self.get_output(), utf8(repr(b("\xe9")))) | ||
|
|
||
| def test_utf8_logging(self): | ||
| self.logger.error(u"\u00e9".encode("utf8")) | ||
| if issubclass(bytes_type, basestring): | ||
| # on python 2, utf8 byte strings (and by extension ascii byte | ||
| # strings) are passed through as-is. | ||
| self.assertEqual(self.get_output(), utf8(u"\u00e9")) | ||
| else: | ||
| # on python 3, byte strings always get repr'd even if | ||
| # they're ascii-only, so this degenerates into another | ||
| # copy of test_bytes_logging. | ||
| self.assertEqual(self.get_output(), utf8(repr(utf8(u"\u00e9")))) | ||
|
|
||
|
|
||
| class UnicodeLogFormatterTest(LogFormatterTest): | ||
| def make_handler(self, filename): | ||
| # Adding an explicit encoding configuration allows non-ascii unicode | ||
| # strings in both python 2 and 3, without changing the behavior | ||
| # for byte strings. | ||
| return logging.FileHandler(filename, encoding="utf8") | ||
|
|
||
| def test_unicode_logging(self): | ||
| self.logger.error(u"\u00e9") | ||
| self.assertEqual(self.get_output(), utf8(u"\u00e9")) |
Oops, something went wrong.