import logging
from typing import Any, Optional
"""
_logging.py
websocket - WebSocket client library for Python
Copyright 2025 engn33r
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.
"""
_logger = logging.getLogger("websocket")
try:
from logging import NullHandler
except ImportError:
class NullHandler(logging.Handler): # type: ignore[no-redef]
def emit(self, record: Any) -> None:
pass
_logger.addHandler(NullHandler())
_traceEnabled = False
_trace_handler: Optional[logging.Handler] = None
_default_level = _logger.getEffectiveLevel()
__all__ = [
"enableTrace",
"dump",
"error",
"warning",
"debug",
"trace",
"isEnabledForError",
"isEnabledForDebug",
"isEnabledForTrace",
]
[docs]
def enableTrace(
traceable: bool,
handler: Optional[logging.Handler] = None,
level: str = "DEBUG",
) -> None:
"""
Turn on/off the traceability.
Parameters
----------
traceable: bool
If set to True, traceability is enabled.
"""
global _traceEnabled, _trace_handler
if traceable:
if handler is None:
handler = logging.StreamHandler()
if _trace_handler and _trace_handler in _logger.handlers:
_logger.removeHandler(_trace_handler)
_trace_handler = handler
if handler not in _logger.handlers:
_logger.addHandler(handler)
_logger.setLevel(getattr(logging, level))
_traceEnabled = True
else:
_traceEnabled = False
if _trace_handler and _trace_handler in _logger.handlers:
_logger.removeHandler(_trace_handler)
_trace_handler = None
_logger.setLevel(_default_level)
def dump(title: str, message: str) -> None:
if _traceEnabled:
_logger.debug(f"--- {title} ---")
_logger.debug(message)
_logger.debug("-----------------------")
def error(msg: str) -> None:
_logger.error(msg)
def warning(msg: str) -> None:
_logger.warning(msg)
def debug(msg: str) -> None:
_logger.debug(msg)
def info(msg: str) -> None:
_logger.info(msg)
def trace(msg: str) -> None:
if _traceEnabled:
_logger.debug(msg)
def isEnabledForError() -> bool:
return _logger.isEnabledFor(logging.ERROR)
def isEnabledForDebug() -> bool:
return _logger.isEnabledFor(logging.DEBUG)
def isEnabledForTrace() -> bool:
return _traceEnabled