124 lines
3.5 KiB
Python
124 lines
3.5 KiB
Python
"""Logging utilities."""
|
|
import asyncio
|
|
from asyncio.events import AbstractEventLoop
|
|
import logging
|
|
import threading
|
|
from typing import Optional
|
|
|
|
from .async_ import run_coroutine_threadsafe
|
|
|
|
|
|
class HideSensitiveDataFilter(logging.Filter):
|
|
"""Filter API password calls."""
|
|
|
|
def __init__(self, text: str) -> None:
|
|
"""Initialize sensitive data filter."""
|
|
super().__init__()
|
|
self.text = text
|
|
|
|
def filter(self, record: logging.LogRecord) -> bool:
|
|
"""Hide sensitive data in messages."""
|
|
record.msg = record.msg.replace(self.text, '*******')
|
|
|
|
return True
|
|
|
|
|
|
# pylint: disable=invalid-name
|
|
class AsyncHandler:
|
|
"""Logging handler wrapper to add an async layer."""
|
|
|
|
def __init__(
|
|
self, loop: AbstractEventLoop, handler: logging.Handler) -> None:
|
|
"""Initialize async logging handler wrapper."""
|
|
self.handler = handler
|
|
self.loop = loop
|
|
self._queue = asyncio.Queue(loop=loop) # type: asyncio.Queue
|
|
self._thread = threading.Thread(target=self._process)
|
|
|
|
# Delegate from handler
|
|
self.setLevel = handler.setLevel
|
|
self.setFormatter = handler.setFormatter
|
|
self.addFilter = handler.addFilter
|
|
self.removeFilter = handler.removeFilter
|
|
self.filter = handler.filter
|
|
self.flush = handler.flush
|
|
self.handle = handler.handle
|
|
self.handleError = handler.handleError
|
|
self.format = handler.format
|
|
|
|
self._thread.start()
|
|
|
|
def close(self) -> None:
|
|
"""Wrap close to handler."""
|
|
self.emit(None)
|
|
|
|
async def async_close(self, blocking: bool = False) -> None:
|
|
"""Close the handler.
|
|
|
|
When blocking=True, will wait till closed.
|
|
"""
|
|
await self._queue.put(None)
|
|
|
|
if blocking:
|
|
while self._thread.is_alive():
|
|
await asyncio.sleep(0, loop=self.loop)
|
|
|
|
def emit(self, record: Optional[logging.LogRecord]) -> None:
|
|
"""Process a record."""
|
|
ident = self.loop.__dict__.get("_thread_ident")
|
|
|
|
# inside eventloop
|
|
if ident is not None and ident == threading.get_ident():
|
|
self._queue.put_nowait(record)
|
|
# from a thread/executor
|
|
else:
|
|
self.loop.call_soon_threadsafe(self._queue.put_nowait, record)
|
|
|
|
def __repr__(self) -> str:
|
|
"""Return the string names."""
|
|
return str(self.handler)
|
|
|
|
def _process(self) -> None:
|
|
"""Process log in a thread."""
|
|
while True:
|
|
record = run_coroutine_threadsafe(
|
|
self._queue.get(), self.loop).result()
|
|
|
|
if record is None:
|
|
self.handler.close()
|
|
return
|
|
|
|
self.handler.emit(record)
|
|
|
|
def createLock(self) -> None:
|
|
"""Ignore lock stuff."""
|
|
pass
|
|
|
|
def acquire(self) -> None:
|
|
"""Ignore lock stuff."""
|
|
pass
|
|
|
|
def release(self) -> None:
|
|
"""Ignore lock stuff."""
|
|
pass
|
|
|
|
@property
|
|
def level(self) -> int:
|
|
"""Wrap property level to handler."""
|
|
return self.handler.level
|
|
|
|
@property
|
|
def formatter(self) -> Optional[logging.Formatter]:
|
|
"""Wrap property formatter to handler."""
|
|
return self.handler.formatter
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
"""Wrap property set_name to handler."""
|
|
return self.handler.get_name() # type: ignore
|
|
|
|
@name.setter
|
|
def name(self, name: str) -> None:
|
|
"""Wrap property get_name to handler."""
|
|
self.handler.set_name(name) # type: ignore
|