Initial commit.

2024-08-05 22:21:48 +02:00
commit a911dae525
22 changed files with 2122 additions and 0 deletions
@@ -0,0 +1,139 @@
+#     Nyanger is a simple logger designed to be simple to use and simple to modify.
+#
+#     Copyright (C) 2024  Kirill Harmatulla Shakirov  kirill.shakirov@protonmail.com
+#
+#     This program is free software: you can redistribute it and/or modify
+#     it under the terms of the GNU General Public License as published by
+#     the Free Software Foundation, either version 3 of the License, or
+#     (at your option) any later version.
+#
+#     This program is distributed in the hope that it will be useful,
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#     GNU General Public License for more details.
+#
+#     You should have received a copy of the GNU General Public License
+#     along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+from typing import Optional
+import sys
+import asyncio
+from nyanger.asynchronous.nyan import LogLevel, LogMessage, LogWriter
+
+
+class Colors:
+    """Console color codes."""
+    RESET = '\033[0m'
+    BOLD = '\033[01m'
+    DISABLE = '\033[02m'
+    UNDERLINE = '\033[04m'
+    REVERSE = '\033[07m'
+    STRIKETHROUGH = '\033[09m'
+    INVISIBLE = '\033[08m'
+
+    class FColor:
+        """Foreground colors."""
+        BLACK = '\033[30m'
+        RED = '\033[31m'
+        GREEN = '\033[32m'
+        ORANGE = '\033[33m'
+        BLUE = '\033[34m'
+        PURPLE = '\033[35m'
+        CYAN = '\033[36m'
+        LIGHT_GRAY = '\033[37m'
+        DARK_GRAY = '\033[90m'
+        LIGHT_RED = '\033[91m'
+        LIGHT_GREEN = '\033[92m'
+        YELLOW = '\033[93m'
+        LIGHT_BLUE = '\033[94m'
+        PINK = '\033[95m'
+        LIGHT_CYAN = '\033[96m'
+
+    class BColor:
+        """Background colors."""
+        BLACK = '\033[40m'
+        RED = '\033[41m'
+        GREEN = '\033[42m'
+        ORANGE = '\033[43m'
+        BLUE = '\033[44m'
+        PURPLE = '\033[45m'
+        CYAN = '\033[46m'
+        LIGHT_GRAY = '\033[47m'
+
+
+# no support for asyncio stdio yet on Windows, see https://github.com/python/cpython/issues/71019
+# use an executor to read from stdio and write to stdout
+# note: if nothing ever drains the writer explicitly, no flushing ever takes place!
+class _Win32StdoutWriter:
+    def __init__(self, loop: asyncio.AbstractEventLoop):
+        self.buffer = []
+        self.stdout = sys.stdout.buffer
+        self.loop = loop
+
+    def write(self, data):
+        self.buffer.append(data)
+
+    async def drain(self):
+        data, self.buffer = self.buffer, []
+        # a single call to sys.stdout.writelines() is thread-safe
+        return await self.loop.run_in_executor(None, sys.stdout.writelines, data)
+
+
+async def _get_async_stdout(loop: asyncio.AbstractEventLoop) -> asyncio.StreamWriter | _Win32StdoutWriter:
+    """
+    Getting object allowing for asynchronous writes to stdout.
+    :param loop: event loop.
+    :return: asyncio.StreamWriter or Win32StdoutWriter both having write and asynchronous drain methods
+    """
+
+    if sys.platform == 'win32':
+        return _Win32StdoutWriter(loop)
+
+    loop = asyncio.get_event_loop()
+    w_transport, w_protocol = await loop.connect_write_pipe(asyncio.streams.FlowControlMixin, sys.stdout)
+    writer = asyncio.StreamWriter(w_transport, w_protocol, None, loop)
+    return writer
+
+
+class ConsoleWriter(LogWriter):
+    """
+    Simple implementation of LogWriter.
+    Writes colored formatted messages to console.
+    """
+
+    def __init__(self, loging_level: LogLevel = LogLevel.DEBUG, color_map: Optional[dict[LogLevel, str]] = None):
+        """
+        Initialize ConsoleWriter instance.
+        :param loging_level: messages with severity less than this field value will be filtered out.
+        :param color_map: dictionary mapping console color codes to logging levels.
+        """
+        self._loging_level = loging_level
+
+        if color_map is None:
+            self._color_map = {
+                LogLevel.OTHER: Colors.FColor.YELLOW,
+                LogLevel.INFO: Colors.FColor.GREEN,
+                LogLevel.WARNING: Colors.FColor.BLUE,
+                LogLevel.ERROR: Colors.BOLD + Colors.FColor.RED,
+                LogLevel.DEBUG: Colors.FColor.CYAN}
+        else:
+            self._color_map = color_map
+
+        self._writer: Optional[asyncio.StreamWriter | _Win32StdoutWriter] = None
+
+    async def start(self, loop: asyncio.AbstractEventLoop):
+        self._writer = _get_async_stdout(loop)
+
+    async def write(self, msg: LogMessage):
+        """
+        Formats and writes msg to (sys.stdout).
+        :param msg: message to be logged.
+        """
+        if msg.severity.value <= self._loging_level.value:
+            log_text = f"{self._color_map[msg.severity]}{msg.time.isoformat()} {msg.severity.name}: {msg.text}\n{Colors.RESET}"
+            self._writer.write(log_text)
+            await self._writer.drain()
+
+    async def stop(self):
+        """Drain writer"""
+        await self._writer.drain()