1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
# ============================================================================
# FILE: logger.py
# AUTHOR: Tommy Allen <tommy at esdf.io>
# License: MIT license
# ============================================================================
import sys
import time
import logging
from functools import wraps
from collections import defaultdict
log_format = '%(asctime)s %(levelname)-8s (%(name)s) %(message)s'
log_message_cooldown = 0.5
root = logging.getLogger('deoplete')
root.propagate = False
init = False
def getLogger(name):
"""Get a logger that is a child of the 'root' logger.
"""
return root.getChild(name)
def setup(vim, level, output_file=None):
"""Setup logging for Deoplete
"""
global init
if init:
return
init = True
if output_file:
formatter = logging.Formatter(log_format)
handler = logging.FileHandler(filename=output_file)
handler.setFormatter(formatter)
handler.addFilter(DeopleteLogFilter(vim))
root.addHandler(handler)
level = str(level).upper()
if level not in ('DEBUG', 'INFO', 'WARN', 'WARNING', 'ERROR',
'CRITICAL', 'FATAL'):
level = 'DEBUG'
root.setLevel(getattr(logging, level))
try:
import pkg_resources
neovim_version = pkg_resources.get_distribution('neovim').version
except ImportError:
neovim_version = 'unknown'
log = getLogger('logging')
log.info('--- Deoplete Log Start ---')
log.info('%s, Python %s, neovim client %s',
vim.call('deoplete#util#neovim_version'),
'.'.join(map(str, sys.version_info[:3])),
neovim_version)
vim.call('deoplete#util#print_warning', 'Logging to %s' % output_file)
def logmethod(func):
"""Decorator for setting up the logger in LoggingMixin subclasses.
This does not guarantee that log messages will be generated. If
`LoggingMixin.debug_enabled` is True, it will be propagated up to the root
'deoplete' logger.
"""
@wraps(func)
def wrapper(self, *args, **kwargs):
if not init or not self.debug_enabled:
return
if self._logger is None:
self._logger = getLogger(getattr(self, 'name', 'unknown'))
return func(self, *args, **kwargs)
return wrapper
class LoggingMixin(object):
"""Class that adds logging functions to a subclass.
"""
debug_enabled = False
_logger = None # type: logging.Logger
@logmethod
def debug(self, msg, *args, **kwargs):
self._logger.debug(msg, *args, **kwargs)
@logmethod
def info(self, msg, *args, **kwargs):
self._logger.info(msg, *args, **kwargs)
@logmethod
def warning(self, msg, *args, **kwargs):
self._logger.warning(msg, *args, **kwargs)
warn = warning
@logmethod
def error(self, msg, *args, **kwargs):
self._logger.error(msg, *args, **kwargs)
@logmethod
def exception(self, msg, *args, **kwargs):
# This will not produce a log message if there is no exception to log.
self._logger.exception(msg, *args, **kwargs)
@logmethod
def critical(self, msg, *args, **kwargs):
self._logger.critical(msg, *args, **kwargs)
fatal = critical
class DeopleteLogFilter(logging.Filter):
def __init__(self, vim, name=''):
self.vim = vim
self.counter = defaultdict(int)
self.last_message_time = 0
self.last_message = None
def filter(self, record):
t = time.time()
elapsed = t - self.last_message_time
self.last_message_time = t
message = (record.levelno, record.name, record.msg, record.args)
if message == self.last_message and elapsed < log_message_cooldown:
# Ignore if the same message comes in too fast.
return False
self.last_message = message
if record.levelno >= logging.ERROR:
self.counter[record.name] += 1
if self.counter[record.name] <= 2:
# Only permit 2 errors in succession from a logging source to
# display errors inside of Neovim. After this, it is no longer
# permitted to emit any more errors and should be addressed.
self.vim.call('deoplete#util#print_error', record.getMessage())
if record.exc_info and record.stack_info:
# Add a penalty for messages that generate exceptions to avoid
# making the log harder to read with doubled stack traces.
self.counter[record.name] += 1
elif self.counter[record.name] < 2:
# If below the threshold for silencing a logging source, reset its
# counter.
self.counter[record.name] = 0
return True
|
