meerschaum 2.2.6__py3-none-any.whl → 2.3.0.dev1__py3-none-any.whl

meerschaum/utils/daemon/FileDescriptorInterceptor.py

@@ -9,10 +9,12 @@ Intercept OS-level file descriptors.
 import os
 import select
 import traceback
+import errno
 from threading import Event
 from datetime import datetime
 from meerschaum.utils.typing import Callable
 from meerschaum.utils.warnings import warn
+from meerschaum.config.paths import DAEMON_ERROR_LOG_PATH
 
 FD_CLOSED: int = 9
 STOP_READING_FD_EVENT: Event = Event()
@@ -65,8 +67,13 @@ class FileDescriptorInterceptor:
             except BlockingIOError:
                 continue
             except OSError as e:
-                from meerschaum.utils.warnings import warn
-                warn(f"OSError in FileDescriptorInterceptor: {e}")
+                if e.errno == errno.EBADF:
+                    ### File descriptor is closed.
+                    pass
+                elif e.errno == errno.EINTR:
+                    continue  # Interrupted system call, just try again
+                else:
+                    warn(f"OSError in FileDescriptorInterceptor: {e}")
                 break
 
             try:
@@ -86,9 +93,11 @@ class FileDescriptorInterceptor:
                     else data.replace(b'\n', b'\n' + injected_bytes)
                 )
                 os.write(self.new_file_descriptor, modified_data)
-            except Exception as e:
-                from meerschaum.utils.warnings import warn
-                warn(f"Error in FileDescriptorInterceptor data processing: {e}")
+            except (BrokenPipeError, OSError):
+                break
+            except Exception:
+                with open(DAEMON_ERROR_LOG_PATH, 'a+', encoding='utf-8') as f:
+                    f.write(traceback.format_exc())
                 break
 
 
@@ -103,7 +112,7 @@ class FileDescriptorInterceptor:
         except OSError as e:
             if e.errno != FD_CLOSED:
                 warn(
-                    f"Error while trying to close the duplicated file descriptor:\n"
+                    "Error while trying to close the duplicated file descriptor:\n"
                     + f"{traceback.format_exc()}"
                 )
 
@@ -112,7 +121,7 @@ class FileDescriptorInterceptor:
         except OSError as e:
             if e.errno != FD_CLOSED:
                 warn(
-                    f"Error while trying to close the write-pipe "
+                    "Error while trying to close the write-pipe "
                     + "to the intercepted file descriptor:\n"
                     + f"{traceback.format_exc()}"
                 )
@@ -121,7 +130,7 @@ class FileDescriptorInterceptor:
         except OSError as e:
             if e.errno != FD_CLOSED:
                 warn(
-                    f"Error while trying to close the read-pipe "
+                    "Error while trying to close the read-pipe "
                     + "to the intercepted file descriptor:\n"
                     + f"{traceback.format_exc()}"
                 )
@@ -131,7 +140,7 @@ class FileDescriptorInterceptor:
         except OSError as e:
             if e.errno != FD_CLOSED:
                 warn(
-                    f"Error while trying to close the signal-read-pipe "
+                    "Error while trying to close the signal-read-pipe "
                     + "to the intercepted file descriptor:\n"
                     + f"{traceback.format_exc()}"
                 )
@@ -141,7 +150,7 @@ class FileDescriptorInterceptor:
         except OSError as e:
             if e.errno != FD_CLOSED:
                 warn(
-                    f"Error while trying to close the signal-write-pipe "
+                    "Error while trying to close the signal-write-pipe "
                     + "to the intercepted file descriptor:\n"
                     + f"{traceback.format_exc()}"
                 )

meerschaum/utils/daemon/RotatingFile.py

@@ -63,6 +63,9 @@ class RotatingFile(io.IOBase):
 
         write_timestamps: bool, default False
             If `True`, prepend the current UTC timestamp to each line of the file.
+
+        timestamp_format: str, default '%Y-%m-%d %H:%M'
+            If `write_timestamps` is `True`, use this format for the timestamps.
         """
         self.file_path = pathlib.Path(file_path)
         if num_files_to_keep is None:
@@ -232,10 +235,10 @@ class RotatingFile(io.IOBase):
 
 
     def refresh_files(
-            self,
-            potential_new_len: int = 0,
-            start_interception: bool = False,
-        ) -> '_io.TextUIWrapper':
+        self,
+        potential_new_len: int = 0,
+        start_interception: bool = False,
+    ) -> '_io.TextUIWrapper':
         """
         Check the state of the subfiles.
         If the latest subfile is too large, create a new file and delete old ones.
@@ -339,7 +342,7 @@ class RotatingFile(io.IOBase):
 
     def get_timestamp_prefix_str(self) -> str:
         """
-        Return the current minute prefixm string.
+        Return the current minute prefix string.
         """
         return datetime.now(timezone.utc).strftime(self.timestamp_format) + ' | '
 
@@ -371,6 +374,9 @@ class RotatingFile(io.IOBase):
                 self._current_file_obj.write(data)
                 if suffix_str:
                     self._current_file_obj.write(suffix_str)
+            except BrokenPipeError:
+                warn("BrokenPipeError encountered. The daemon may have been terminated.")
+                return
             except Exception as e:
                 warn(f"Failed to write to subfile:\n{traceback.format_exc()}")
             self.flush()
@@ -565,7 +571,8 @@ class RotatingFile(io.IOBase):
             return
 
         self._cursor = (max_ix, position)
-        self._current_file_obj.seek(position)
+        if self._current_file_obj is not None:
+            self._current_file_obj.seek(position)
 
     
     def flush(self) -> None:
@@ -581,10 +588,14 @@ class RotatingFile(io.IOBase):
         if self.redirect_streams:
             try:
                 sys.stdout.flush()
+            except BrokenPipeError:
+                pass
             except Exception as e:
                 warn(f"Failed to flush STDOUT:\n{traceback.format_exc()}")
             try:
                 sys.stderr.flush()
+            except BrokenPipeError:
+                pass
             except Exception as e:
                 warn(f"Failed to flush STDERR:\n{traceback.format_exc()}")
 
@@ -596,7 +607,6 @@ class RotatingFile(io.IOBase):
         if not self.write_timestamps:
             return
 
-        threads = self.__dict__.get('_interceptor_threads', [])
         self._stdout_interceptor = FileDescriptorInterceptor(
             sys.stdout.fileno(),
             self.get_timestamp_prefix_str,
@@ -639,6 +649,7 @@ class RotatingFile(io.IOBase):
         """
         if not self.write_timestamps:
             return
+
         interceptors = self.__dict__.get('_interceptors', [])
         interceptor_threads = self.__dict__.get('_interceptor_threads', [])
 

meerschaum/utils/daemon/StdinFile.py

@@ -0,0 +1,110 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+
+"""
+Create a file manager to pass STDIN to the Daemon.
+"""
+
+import io
+import pathlib
+import time
+import os
+import selectors
+import traceback
+
+from meerschaum.utils.typing import Optional
+from meerschaum.utils.warnings import warn
+
+
+class StdinFile(io.TextIOBase):
+    """
+    Redirect user input into a Daemon's context.
+    """
+    def __init__(
+        self,
+        file_path: pathlib.Path,
+        lock_file_path: Optional[pathlib.Path] = None,
+    ):
+        self.file_path = file_path
+        self.blocking_file_path = (
+            lock_file_path
+            if lock_file_path is not None
+            else (file_path.parent / (file_path.name + '.block'))
+        )
+        self._file_handler = None
+        self._fd = None
+        self.sel = selectors.DefaultSelector()
+
+    @property
+    def file_handler(self):
+        """
+        Return the read file handler to the provided file path.
+        """
+        if self._file_handler is not None:
+            return self._file_handler
+
+        if self.file_path.exists():
+            self.file_path.unlink()
+
+        os.mkfifo(self.file_path.as_posix(), mode=0o600)
+
+        self._fd = os.open(self.file_path, os.O_RDONLY | os.O_NONBLOCK)
+        self._file_handler = os.fdopen(self._fd, 'rb', buffering=0)
+        self.sel.register(self._file_handler, selectors.EVENT_READ)
+        return self._file_handler
+
+    def write(self, data):
+        if isinstance(data, str):
+            data = data.encode('utf-8')
+
+        with open(self.file_path, 'wb') as f:
+            f.write(data)
+
+    def fileno(self):
+        fileno = self.file_handler.fileno()
+        return fileno
+
+    def read(self, size=-1):
+        """
+        Read from the FIFO pipe, blocking on EOFError.
+        """
+        _ = self.file_handler
+        while True:
+            try:
+                data = self._file_handler.read(size)
+                if data:
+                    try:
+                        if self.blocking_file_path.exists():
+                            self.blocking_file_path.unlink()
+                    except Exception:
+                        warn(traceback.format_exc())
+                    return data.decode('utf-8')
+            except (OSError, EOFError):
+                pass
+
+            self.blocking_file_path.touch()
+            time.sleep(0.1)
+
+    def readline(self, size=-1):
+        line = ''
+        while True:
+            data = self.read(1)
+            if not data or data == '\n':
+                break
+            line += data
+
+        return line
+
+    def close(self):
+        if self._file_handler is not None:
+            self.sel.unregister(self._file_handler)
+            self._file_handler.close()
+            os.close(self._fd)
+            self._file_handler = None
+            self._fd = None
+
+        super().close()
+
+    def is_open(self):
+        return self._file_handler is not None

meerschaum/utils/daemon/__init__.py

@@ -67,19 +67,17 @@ def daemon_entry(sysargs: Optional[List[str]] = None) -> SuccessTuple:
             if daemon.status == 'running':
                 return True, f"Daemon '{daemon}' is already running."
             return daemon.run(
-                debug = debug,
-                allow_dirty_run = True,
+                debug=debug,
+                allow_dirty_run=True,
             )
 
     success_tuple = run_daemon(
         entry,
         filtered_sysargs,
-        daemon_id = _args.get('name', None) if _args else None,
-        label = label,
-        keep_daemon_output = ('--rm' not in sysargs)
+        daemon_id=_args.get('name', None) if _args else None,
+        label=label,
+        keep_daemon_output=('--rm' not in (sysargs or [])),
     )
-    if not isinstance(success_tuple, tuple):
-        success_tuple = False, str(success_tuple)
     return success_tuple
 
 
@@ -109,25 +107,25 @@ def daemon_action(**kw) -> SuccessTuple:
 
 
 def run_daemon(
-        func: Callable[[Any], Any],
-        *args,
-        daemon_id: Optional[str] = None,
-        keep_daemon_output: bool = False,
-        allow_dirty_run: bool = False,
-        label: Optional[str] = None,
-        **kw
-    ) -> Any:
+    func: Callable[[Any], Any],
+    *args,
+    daemon_id: Optional[str] = None,
+    keep_daemon_output: bool = True,
+    allow_dirty_run: bool = False,
+    label: Optional[str] = None,
+    **kw
+) -> Any:
     """Execute a function as a daemon."""
     daemon = Daemon(
         func,
-        daemon_id = daemon_id,
-        target_args = [arg for arg in args],
-        target_kw = kw,
-        label = label,
+        daemon_id=daemon_id,
+        target_args=[arg for arg in args],
+        target_kw=kw,
+        label=label,
     )
     return daemon.run(
-        keep_daemon_output = keep_daemon_output,
-        allow_dirty_run = allow_dirty_run,
+        keep_daemon_output=keep_daemon_output,
+        allow_dirty_run=allow_dirty_run,
     )
 
 
@@ -183,7 +181,11 @@ def get_daemon_ids() -> List[str]:
     """
     Return the IDs of all daemons on disk.
     """
-    return sorted(os.listdir(DAEMON_RESOURCES_PATH))
+    return [
+        daemon_dir
+        for daemon_dir in sorted(os.listdir(DAEMON_RESOURCES_PATH))
+        if (DAEMON_RESOURCES_PATH / daemon_dir / 'properties.json').exists()
+    ]
 
 
 def get_running_daemons(daemons: Optional[List[Daemon]] = None) -> List[Daemon]:
@@ -227,10 +229,11 @@ def get_stopped_daemons(daemons: Optional[List[Daemon]] = None) -> List[Daemon]:
 
 
 def get_filtered_daemons(
-        filter_list: Optional[List[str]] = None,
-        warn: bool = False,
-    ) -> List[Daemon]:
-    """Return a list of `Daemons` filtered by a list of `daemon_ids`.
+    filter_list: Optional[List[str]] = None,
+    warn: bool = False,
+) -> List[Daemon]:
+    """
+    Return a list of `Daemons` filtered by a list of `daemon_ids`.
     Only `Daemons` that exist are returned.
     
     If `filter_list` is `None` or empty, return all `Daemons` (from `get_daemons()`).
@@ -252,13 +255,14 @@ def get_filtered_daemons(
     if not filter_list:
         daemons = get_daemons()
         return [d for d in daemons if not d.hidden]
+
     from meerschaum.utils.warnings import warn as _warn
     daemons = []
     for d_id in filter_list:
         try:
             d = Daemon(daemon_id=d_id)
             _exists = d.path.exists()
-        except Exception as e:
+        except Exception:
             _exists = False
         if not _exists:
             if warn:
@@ -268,3 +272,12 @@ def get_filtered_daemons(
             pass
         daemons.append(d)
     return daemons
+
+
+def running_in_daemon() -> bool:
+    """
+    Return whether the current thread is running in a Daemon context.
+    """
+    from meerschaum.config.static import STATIC_CONFIG
+    daemon_env_var = STATIC_CONFIG['environment']['daemon_id']
+    return daemon_env_var in os.environ

meerschaum/utils/formatting/__init__.py

@@ -10,6 +10,7 @@ from __future__ import annotations
 import platform
 import os
 import sys
+import meerschaum as mrsm
 from meerschaum.utils.typing import Optional, Union, Any, Dict
 from meerschaum.utils.formatting._shell import make_header
 from meerschaum.utils.formatting._pprint import pprint
@@ -27,12 +28,14 @@ _attrs = {
     'ANSI': None,
     'UNICODE': None,
     'CHARSET': None,
+    'RESET': '\033[0m',
 }
 __all__ = sorted([
-    'ANSI', 'CHARSET', 'UNICODE',
+    'ANSI', 'CHARSET', 'UNICODE', 'RESET',
     'colored',
     'translate_rich_to_termcolor',
     'get_console',
+    'format_success_tuple',
     'print_tuple',
     'print_options',
     'fill_ansi',
@@ -222,16 +225,17 @@ def get_console():
 
 
 def print_tuple(
-        tup: tuple,
-        skip_common: bool = True,
-        common_only: bool = False,
-        upper_padding: int = 0,
-        lower_padding: int = 0,
-        calm: bool = False,
-        _progress: Optional['rich.progress.Progress'] = None,
-    ) -> None:
+    tup: mrsm.SuccessTuple,
+    skip_common: bool = True,
+    common_only: bool = False,
+    upper_padding: int = 0,
+    lower_padding: int = 0,
+    left_padding: int = 1,
+    calm: bool = False,
+    _progress: Optional['rich.progress.Progress'] = None,
+) -> None:
     """
-    Print `meerschaum.utils.typing.SuccessTuple`.
+    Format `meerschaum.utils.typing.SuccessTuple`.
 
     Parameters
     ----------
@@ -247,24 +251,18 @@ def print_tuple(
     lower_padding: int, default 0
         How many newlines to append to the message.
 
+    left_padding: int, default 1
+        How mant spaces to preprend to the message.
+
     calm: bool, default False
         If `True`, use the default emoji and color scheme.
+
     """
     from meerschaum.config.static import STATIC_CONFIG
-    _init()
-    try:
-        status = 'success' if tup[0] else 'failure'
-    except TypeError:
-        status = 'failure'
-        tup = None, None
-
-    if calm:
-        status += '_calm'
+    do_print = True
 
     omit_messages = STATIC_CONFIG['system']['success']['ignore']
 
-    do_print = True
-
     if common_only:
         skip_common = False
         do_print = tup[1] in omit_messages
@@ -272,22 +270,70 @@ def print_tuple(
     if skip_common:
         do_print = tup[1] not in omit_messages
 
-    if do_print:
-        ANSI, CHARSET = __getattr__('ANSI'), __getattr__('CHARSET')
-        from meerschaum.config import get_config
-        status_config = get_config('formatting', status, patch=True)
-
-        msg = ' ' + status_config[CHARSET]['icon'] + ' ' + str(tup[1])
-        lines = msg.split('\n')
-        lines = [lines[0]] + [
-            (('    ' + line if not line.startswith(' ') else line))
-            for line in lines[1:]
-        ]
-        if ANSI:
-            lines[0] = fill_ansi(highlight_pipes(lines[0]), **status_config['ansi']['rich'])
-        msg = '\n'.join(lines)
-        msg = ('\n' * upper_padding) + msg + ('\n' * lower_padding)
-        print(msg)
+    if not do_print:
+        return
+
+    print(format_success_tuple(
+        tup,
+        upper_padding=upper_padding,
+        lower_padding=lower_padding,
+        calm=calm,
+        _progress=_progress,
+    ))
+
+
+def format_success_tuple(
+    tup: mrsm.SuccessTuple,
+    upper_padding: int = 0,
+    lower_padding: int = 0,
+    left_padding: int = 1,
+    calm: bool = False,
+    _progress: Optional['rich.progress.Progress'] = None,
+) -> str:
+    """
+    Format `meerschaum.utils.typing.SuccessTuple`.
+
+    Parameters
+    ----------
+    upper_padding: int, default 0
+        How many newlines to prepend to the message.
+
+    lower_padding: int, default 0
+        How many newlines to append to the message.
+
+    left_padding: int, default 1
+        How mant spaces to preprend to the message.
+
+    calm: bool, default False
+        If `True`, use the default emoji and color scheme.
+    """
+    from meerschaum.config.static import STATIC_CONFIG
+    _init()
+    try:
+        status = 'success' if tup[0] else 'failure'
+    except TypeError:
+        status = 'failure'
+        tup = None, None
+
+    if calm:
+        status += '_calm'
+
+    ANSI, CHARSET = __getattr__('ANSI'), __getattr__('CHARSET')
+    from meerschaum.config import get_config
+    status_config = get_config('formatting', status, patch=True)
+
+    msg = (' ' * left_padding) + status_config[CHARSET]['icon'] + ' ' + str(tup[1])
+    lines = msg.split('\n')
+    lines = [lines[0]] + [
+        (('    ' + line if not line.startswith(' ') else line))
+        for line in lines[1:]
+    ]
+    if ANSI:
+        lines[0] = fill_ansi(highlight_pipes(lines[0]), **status_config['ansi']['rich'])
+
+    msg = '\n'.join(lines)
+    msg = ('\n' * upper_padding) + msg + ('\n' * lower_padding)
+    return msg
 
 
 def print_options(