meerschaum 2.2.6__py3-none-any.whl → 2.2.7__py3-none-any.whl

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),
     )
-    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,
     )
 
 
@@ -268,3 +266,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
@@ -33,6 +34,7 @@ __all__ = sorted([
     'colored',
     'translate_rich_to_termcolor',
     'get_console',
+    'format_success_tuple',
     'print_tuple',
     'print_options',
     'fill_ansi',
@@ -222,16 +224,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 +250,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 +269,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(

meerschaum/utils/formatting/_jobs.py

@@ -7,7 +7,8 @@ Print jobs information.
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import List, Optional, Any
+import meerschaum as mrsm
+from meerschaum.utils.typing import List, Optional, Any, is_success_tuple
 from meerschaum.utils.daemon import (
     Daemon,
     get_daemons,
@@ -17,9 +18,9 @@ from meerschaum.utils.daemon import (
 )
 
 def pprint_jobs(
-        daemons: List[Daemon],
-        nopretty: bool = False,
-    ):
+    daemons: List[Daemon],
+    nopretty: bool = False,
+):
     """Pretty-print a list of Daemons."""
     from meerschaum.utils.formatting import make_header
     
@@ -48,10 +49,12 @@ def pprint_jobs(
                 pprint_job(d, nopretty=nopretty)
 
     def _pretty_print():
-        from meerschaum.utils.formatting import get_console, UNICODE, ANSI
+        from meerschaum.utils.formatting import get_console, UNICODE, ANSI, format_success_tuple
         from meerschaum.utils.packages import import_rich, attempt_import
         rich = import_rich()
-        rich_table, rich_text, rich_box = attempt_import('rich.table', 'rich.text', 'rich.box')
+        rich_table, rich_text, rich_box, rich_json, rich_panel, rich_console = attempt_import(
+            'rich.table', 'rich.text', 'rich.box', 'rich.json', 'rich.panel', 'rich.console',
+        )
         table = rich_table.Table(
             title = rich_text.Text('Jobs'),
             box = (rich_box.ROUNDED if UNICODE else rich_box.ASCII),
@@ -62,13 +65,42 @@ def pprint_jobs(
         table.add_column("Command")
         table.add_column("Status")
 
+        def get_success_text(d):
+            success_tuple = d.properties.get('result', None)
+            if isinstance(success_tuple, list):
+                success_tuple = tuple(success_tuple)
+            if not is_success_tuple(success_tuple):
+                return rich_text.Text('')
+
+            success = success_tuple[0]
+            msg = success_tuple[1]
+            lines = msg.split('\n')
+            msg = '\n'.join(line.lstrip().rstrip() for line in lines)
+            success_tuple = success, msg
+            success_tuple_str = (
+                format_success_tuple(success_tuple, left_padding=1)
+                if success_tuple is not None
+                else None
+            )
+            success_tuple_text = (
+                rich_text.Text.from_ansi(success_tuple_str)
+            ) if success_tuple_str is not None else None
+
+            if success_tuple_text is None:
+                return rich_text.Text('')
+
+            return rich_text.Text('\n') + success_tuple_text
+
+
         for d in running_daemons:
             if d.hidden:
                 continue
             table.add_row(
                 d.daemon_id,
                 d.label,
-                rich_text.Text(d.status, style=('green' if ANSI else ''))
+                rich_console.Group(
+                    rich_text.Text(d.status, style=('green' if ANSI else '')),
+                ),
             )
 
         for d in paused_daemons:
@@ -77,16 +109,22 @@ def pprint_jobs(
             table.add_row(
                 d.daemon_id,
                 d.label,
-                rich_text.Text(d.status, style=('yellow' if ANSI else ''))
+                rich_console.Group(
+                    rich_text.Text(d.status, style=('yellow' if ANSI else '')),
+                ),
             )
 
         for d in stopped_daemons:
             if d.hidden:
                 continue
+
             table.add_row(
                 d.daemon_id,
                 d.label,
-                rich_text.Text(d.status, style=('red' if ANSI else ''))
+                rich_console.Group(
+                    rich_text.Text(d.status, style=('red' if ANSI else '')),
+                    get_success_text(d)
+                ),
             )
         get_console().print(table)
 

meerschaum/utils/packages/__init__.py

@@ -816,6 +816,7 @@ def pip_install(
     """
     from meerschaum.config._paths import VIRTENV_RESOURCES_PATH
     from meerschaum.config import get_config
+    from meerschaum.config.static import STATIC_CONFIG
     from meerschaum.utils.warnings import warn
     from meerschaum.utils.misc import is_android
     if args is None:
@@ -827,6 +828,11 @@ def pip_install(
     if check_wheel:
         have_wheel = venv_contains_package('wheel', venv=venv, debug=debug)
 
+    daemon_env_var = STATIC_CONFIG['environment']['daemon_id']
+    inside_daemon = daemon_env_var in os.environ
+    if inside_daemon:
+        silent = True
+
     _args = list(args)
     have_pip = venv_contains_package('pip', venv=None, debug=debug)
     try:
@@ -844,16 +850,16 @@ def pip_install(
     if have_pip and not have_uv_pip and _install_uv_pip and not is_android():
         if not pip_install(
             'uv',
-            venv = None,
-            debug = debug,
-            _install_uv_pip = False,
-            check_update = False,
-            check_pypi = False,
-            check_wheel = False,
-        ):
+            venv=None,
+            debug=debug,
+            _install_uv_pip=False,
+            check_update=False,
+            check_pypi=False,
+            check_wheel=False,
+        ) and not silent:
             warn(
                 f"Failed to install `uv` for virtual environment '{venv}'.",
-                color = False,
+                color=False,
             )
 
     use_uv_pip = (
@@ -909,13 +915,13 @@ def pip_install(
                     check_wheel = False,
                     debug = debug,
                     _install_uv_pip = False,
-                ):
+                ) and not silent:
                     warn(
                         (
                             "Failed to install `setuptools`, `wheel`, and `uv` for virtual "
                             + f"environment '{venv}'."
                         ),
-                        color = False,
+                        color=False,
                     )
 
         if requirements_file_path is not None:
@@ -975,7 +981,7 @@ def pip_install(
                 if not completely_uninstall_package(
                     _install_no_version,
                     venv=venv, debug=debug,
-                ):
+                ) and not silent:
                     warn(
                         f"Failed to clean up package '{_install_no_version}'.",
                     )
@@ -989,9 +995,9 @@ def pip_install(
         rc = run_python_package(
             ('pip' if not use_uv_pip else 'uv'),
             _args + _packages,
-            venv = None,
-            env = _get_pip_os_env(color=color),
-            debug = debug,
+            venv=None,
+            env=_get_pip_os_env(color=color),
+            debug=debug,
         )
         if debug:
             print(f"{rc=}")
@@ -1003,7 +1009,7 @@ def pip_install(
     )
     if not silent:
         print(msg)
-    if debug:
+    if debug and not silent:
         print('pip ' + ('un' if _uninstall else '') + 'install returned:', success)
     return success
 

meerschaum/utils/prompt.py

@@ -14,6 +14,7 @@ def prompt(
         question: str,
         icon: bool = True,
         default: Union[str, Tuple[str, str], None] = None,
+        default_editable: Optional[str] = None,
         detect_password: bool = True,
         is_password: bool = False,
         wrap_lines: bool = True,
@@ -37,6 +38,9 @@ def prompt(
     default: Union[str, Tuple[str, str], None], default None
         If the response is '', return the default value.
 
+    default_editable: Optional[str], default None
+        If provided, auto-type this user-editable string in the prompt.
+
     detect_password: bool, default True
         If `True`, set the input method to a censored password box if the word `password`
         appears in the question.
@@ -102,6 +106,7 @@ def prompt(
         prompt_toolkit.prompt(
             prompt_toolkit.formatted_text.ANSI(question),
             wrap_lines = wrap_lines,
+            default = default_editable or '',
             **filter_keywords(prompt_toolkit.prompt, **kw)
         ) if not noask else ''
     )

meerschaum/utils/schedule.py

@@ -7,10 +7,12 @@ Schedule processes and threads.
 """
 
 from __future__ import annotations
-import sys
+import signal
+import traceback
 from datetime import datetime, timezone, timedelta
 import meerschaum as mrsm
 from meerschaum.utils.typing import Callable, Any, Optional, List, Dict
+from meerschaum.utils.warnings import warn, error
 
 STARTING_KEYWORD: str = 'starting'
 INTERVAL_UNITS: List[str] = ['months', 'weeks', 'days', 'hours', 'minutes', 'seconds', 'years']
@@ -70,15 +72,15 @@ SCHEDULE_ALIASES: Dict[str, str] = {
 
 _scheduler = None
 def schedule_function(
-        function: Callable[[Any], Any],
-        schedule: str,
-        *args,
-        debug: bool = False,
-        **kw
-    ) -> None:
+    function: Callable[[Any], Any],
+    schedule: str,
+    *args,
+    debug: bool = False,
+    **kw
+) -> mrsm.SuccessTuple:
     """
     Block the process and execute the function intermittently according to the frequency.
-    https://rocketry.readthedocs.io/en/stable/condition_syntax/index.html
+    https://meerschaum.io/reference/background-jobs/#-schedules
 
     Parameters
     ----------
@@ -88,10 +90,13 @@ def schedule_function(
     schedule: str
         The frequency schedule at which `function` should be executed (e.g. `'daily'`).
 
+    Returns
+    -------
+    A `SuccessTuple` upon exit.
     """
     import asyncio
-    from meerschaum.utils.warnings import warn
     from meerschaum.utils.misc import filter_keywords, round_time
+
     global _scheduler
     kw['debug'] = debug
     kw = filter_keywords(function, **kw)
@@ -105,15 +110,16 @@ def schedule_function(
     except RuntimeError:
         loop = asyncio.new_event_loop()
 
+
     async def run_scheduler():
         async with _scheduler:
             job = await _scheduler.add_schedule(
                 function,
                 trigger,
-                args = args,
-                kwargs = kw,
-                max_running_jobs = 1, 
-                conflict_policy = apscheduler.ConflictPolicy.replace,
+                args=args,
+                kwargs=kw,
+                max_running_jobs=1,
+                conflict_policy=apscheduler.ConflictPolicy.replace,
             )
             try:
                 await _scheduler.run_until_stopped()
@@ -126,12 +132,13 @@ def schedule_function(
     except (KeyboardInterrupt, SystemExit) as e:
         loop.run_until_complete(_stop_scheduler())
 
+    return True, "Success"
+
 
 def parse_schedule(schedule: str, now: Optional[datetime] = None):
     """
     Parse a schedule string (e.g. 'daily') into a Trigger object.
     """
-    from meerschaum.utils.warnings import error
     from meerschaum.utils.misc import items_str, is_int
     (
         apscheduler_triggers_cron,
@@ -279,7 +286,6 @@ def parse_start_time(schedule: str, now: Optional[datetime] = None) -> datetime:
     datetime.datetime(2024, 5, 13, 0, 30, tzinfo=datetime.timezone.utc)
     """
     from meerschaum.utils.misc import round_time
-    from meerschaum.utils.warnings import error, warn
     dateutil_parser = mrsm.attempt_import('dateutil.parser')
     starting_parts = schedule.split(STARTING_KEYWORD)
     starting_str = ('now' if len(starting_parts) == 1 else starting_parts[-1]).strip()

{meerschaum-2.2.6.dist-info → meerschaum-2.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meerschaum
-Version: 2.2.6
+Version: 2.2.7
 Summary: Sync Time-Series Pipes with Meerschaum
 Home-page: https://meerschaum.io
 Author: Bennett Meares