|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293 |
- import logging
-
- """
- _logging.py
- websocket - WebSocket client library for Python
-
- Copyright 2023 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):
- def emit(self, record) -> None:
- pass
-
- _logger.addHandler(NullHandler())
-
- _traceEnabled = False
-
- __all__ = ["enableTrace", "dump", "error", "warning", "debug", "trace",
- "isEnabledForError", "isEnabledForDebug", "isEnabledForTrace"]
-
-
- def enableTrace(traceable: bool,
- handler: logging.StreamHandler = logging.StreamHandler(),
- level: str = "DEBUG") -> None:
- """
- Turn on/off the traceability.
-
- Parameters
- ----------
- traceable: bool
- If set to True, traceability is enabled.
- """
- global _traceEnabled
- _traceEnabled = traceable
- if traceable:
- _logger.addHandler(handler)
- _logger.setLevel(getattr(logging, level))
-
-
- def dump(title: str, message: str) -> None:
- if _traceEnabled:
- _logger.debug("--- " + 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
|