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

meerschaum/_internal/shell/updates.py

@@ -0,0 +1,175 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+
+"""
+If configured, check `api:mrsm` for announcement messages.
+"""
+
+import json
+from datetime import datetime, timezone, timedelta
+
+import meerschaum as mrsm
+from meerschaum.utils.typing import Union, SuccessTuple, Optional
+from meerschaum.config import get_config
+from meerschaum.utils.formatting import CHARSET, ANSI, colored
+from meerschaum.utils.misc import string_width, remove_ansi
+from meerschaum.config.paths import (
+    UPDATES_LOCK_PATH,
+    UPDATES_CACHE_PATH,
+)
+from meerschaum.utils.threading import Thread
+
+
+def cache_remote_version(debug: bool = False) -> SuccessTuple:
+    """
+    Fetch and cache the latest version if available.
+    """
+    allow_update_check = get_config('shell', 'updates', 'check_remote')
+    if not allow_update_check:
+        return True, "Update checks are disabled."
+
+    refresh_minutes = get_config('shell', 'updates', 'refresh_minutes')
+    update_delta = timedelta(minutes=refresh_minutes)
+
+    if UPDATES_CACHE_PATH.exists():
+        try:
+            with open(UPDATES_CACHE_PATH, 'r', encoding='utf8') as f:
+                cache_dict = json.load(f)
+        except Exception:
+            cache_dict = {}
+    else:
+        cache_dict = {}
+
+    now = datetime.now(timezone.utc)
+    last_check_ts_str = cache_dict.get('last_check_ts')
+    last_check_ts = datetime.fromisoformat(last_check_ts_str) if last_check_ts_str else None
+
+    need_update = (
+        last_check_ts_str is None
+        or ((now - last_check_ts) >= update_delta)
+    )
+
+    if not need_update:
+        return True, "No updates are needed."
+
+    try:
+        conn = mrsm.get_connector('api:mrsm')
+        remote_version = conn.get_mrsm_version(debug=debug, timeout=3)
+    except Exception:
+        remote_version = None
+
+    if remote_version is None:
+        return False, "Could not determine remote version."
+
+    with open(UPDATES_CACHE_PATH, 'w+', encoding='utf-8') as f:
+        json.dump(
+            {
+                'last_check_ts': now.isoformat(),
+                'remote_version': remote_version,
+            },
+            f,
+        )
+
+    return True, "Updated remote version cache."
+
+
+def run_version_check_thread(debug: bool = False) -> Union[Thread, None]:
+    """
+    Run the version update check in a separate thread.
+    """
+    allow_update_check = get_config('shell', 'updates', 'check_remote')
+    if not allow_update_check:
+        return None
+
+    thread = Thread(
+        target=cache_remote_version,
+        daemon=True,
+        kwargs={'debug': debug},
+    )
+    thread.start()
+    return thread
+
+
+_remote_version: Optional[str] = None
+def get_remote_version_from_cache() -> Optional[str]:
+    """
+    Return the version string from the local cache file.
+    """
+    global _remote_version
+    try:
+        with open(UPDATES_CACHE_PATH, 'r', encoding='utf-8') as f:
+            cache_dict = json.load(f)
+    except Exception:
+        return None
+
+    _remote_version = cache_dict.get('remote_version')
+    return _remote_version
+
+
+_out_of_date: Optional[bool] = None
+def mrsm_out_of_date() -> bool:
+    """
+    Determine whether to print the upgrade message.
+    """
+    global _out_of_date
+    if _out_of_date is not None:
+        return _out_of_date
+
+    ### NOTE: Remote version is cached asynchronously.
+    if not UPDATES_CACHE_PATH.exists():
+        return False
+
+    remote_version_str = get_remote_version_from_cache()
+
+    packaging_version = mrsm.attempt_import('packaging.version')
+    current_version = packaging_version.parse(mrsm.__version__)
+    remote_version = packaging_version.parse(remote_version_str)
+
+    _out_of_date = remote_version > current_version
+    return _out_of_date
+
+
+def get_update_message() -> str:
+    """
+    Return the formatted message for when the current version is behind the latest release.
+    """
+    if not mrsm_out_of_date():
+        return ''
+
+    intro = get_config('shell', CHARSET, 'intro')
+    update_message = get_config('shell', CHARSET, 'update_message')
+    remote_version = get_remote_version_from_cache()
+    if not remote_version:
+        return ''
+
+    intro_width = string_width(intro)
+    msg_width = string_width(update_message)
+    update_left_padding = ' ' * ((intro_width - msg_width) // 2)
+
+    update_line = (
+        colored(
+            update_message,
+            *get_config('shell', 'ansi', 'update_message', 'color')
+        ) if ANSI
+        else update_message
+    )
+    update_instruction = (
+        colored("Run ", 'white')
+        + colored("upgrade mrsm", 'green')
+        + colored(" to install ", 'white')
+        + colored(f'v{remote_version}', 'yellow')
+        + '.'
+    )
+    update_instruction_clean = remove_ansi(update_instruction)
+    instruction_width = string_width(update_instruction_clean)
+    instruction_left_padding = ' ' * ((intro_width - instruction_width) // 2)
+
+    return (
+        '\n\n'
+        + update_left_padding
+        + update_line
+        + '\n'
+        + instruction_left_padding
+        + update_instruction
+    )

meerschaum/actions/api.py

@@ -10,12 +10,12 @@ import os
 from meerschaum.utils.typing import SuccessTuple, Optional, List, Any
 
 def api(
-        action: Optional[List[str]] = None,
-        sysargs: Optional[List[str]] = None,
-        debug: bool = False,
-        mrsm_instance: Optional[str] = None,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    sysargs: Optional[List[str]] = None,
+    debug: bool = False,
+    mrsm_instance: Optional[str] = None,
+    **kw: Any
+) -> SuccessTuple:
     """
     Send commands to a Meerschaum WebAPI instance.
     
@@ -37,7 +37,8 @@ def api(
     """
     from meerschaum.utils.warnings import warn, info
     from meerschaum.utils.formatting import print_tuple
-    from meerschaum.utils.packages import attempt_import
+    from meerschaum._internal.arguments._parse_arguments import parse_dict_to_sysargs
+
     if action is None:
         action = []
     if sysargs is None:
@@ -52,7 +53,6 @@ def api(
 
     from meerschaum.config import get_config
     from meerschaum.connectors import get_connector
-    requests = attempt_import('requests')
     if debug:
         from meerschaum.utils.formatting import pprint
     api_configs = get_config('meerschaum', 'connectors', 'api', patch=True)
@@ -68,12 +68,13 @@ def api(
         del action[0]
         if len(args_to_send) > 1:
             del args_to_send[0]
+
     kw['action'] = action
     kw['debug'] = debug
     kw['sysargs'] = args_to_send
     kw['yes'] = True
  
-    api_conn = get_connector(type='api', label=api_label)
+    api_conn = get_connector(f'api:{api_label}')
     
     if mrsm_instance is not None and str(mrsm_instance) == str(api_conn):
         warn(
@@ -83,9 +84,8 @@ def api(
     elif mrsm_instance is not None:
         kw['mrsm_instance'] = str(mrsm_instance)
 
-    success, message = api_conn.do_action(**kw)
-    print_tuple((success, message), common_only=True)
-    msg = f"Action " + ('succeeded' if success else 'failed') + " with message:\n" + str(message)
+    sysargs = parse_dict_to_sysargs(kw)
+    success, message = api_conn.do_action(sysargs)
     return success, message
 
 def _api_start(

meerschaum/actions/attach.py

@@ -0,0 +1,95 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+
+"""
+Attach to running jobs.
+"""
+
+import meerschaum as mrsm
+from meerschaum.utils.typing import Optional, List, Any, SuccessTuple
+
+def attach(
+    action: Optional[List[str]] = None,
+    **kwargs: Any
+) -> SuccessTuple:
+    """
+    Attach to a job.
+    """
+    from meerschaum.actions import choose_subaction
+    attach_options = {
+        'jobs': _attach_jobs,
+        'logs': _attach_logs,
+    }
+    return choose_subaction(action, attach_options, **kwargs)
+
+
+def _complete_attach(
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
+    """
+    Override the default Meerschaum `complete_` function.
+    """
+    from meerschaum.actions.start import _complete_start_jobs
+
+    if action is None:
+        action = []
+
+    options = {
+        'job': _complete_start_jobs,
+        'jobs': _complete_start_jobs,
+        'log': _complete_start_jobs,
+        'logs': _complete_start_jobs,
+    }
+
+    if (
+        len(action) > 0 and action[0] in options
+            and kw.get('line', '').split(' ')[-1] != action[0]
+    ):
+        sub = action[0]
+        del action[0]
+        return options[sub](action=action, **kw)
+
+    from meerschaum._internal.shell import default_action_completer
+    return default_action_completer(action=(['attach'] + action), **kw)
+
+
+def _attach_jobs(
+    action: Optional[List[str]] = None,
+    name: Optional[str] = None,
+    executor_keys: Optional[str] = None,
+    **kwargs: Any
+) -> SuccessTuple:
+    """
+    Attach to a job, and prompt the user when blocking on input.
+    """
+    if not action and not name:
+        return False, "Provide the name of the job to attach to."
+
+    name = name or action[0]
+    job = mrsm.Job(name, executor_keys=executor_keys)
+    if not job.exists():
+        return False, f"Job '{job.name}' does not exist."
+
+    job.monitor_logs(
+        stop_on_exit=True,
+        strip_timestamps=True,
+    )
+
+    return True, "Success"
+
+
+def _attach_logs(*args, **kwargs) -> SuccessTuple:
+    """
+    Attach to jobs' logs.
+    """
+    from meerschaum.actions.show import _show_logs
+    return _show_logs(*args, **kwargs)
+
+
+### NOTE: This must be the final statement of the module.
+###       Any subactions added below these lines will not
+###       be added to the `help` docstring.
+from meerschaum.actions import choices_docstring as _choices_docstring
+attach.__doc__ += _choices_docstring('attach')

meerschaum/actions/delete.py

@@ -391,6 +391,7 @@ def _complete_delete_connectors(
 
 def _delete_jobs(
         action: Optional[List[str]] = None,
+        executor_keys: Optional[str] = None,
         noask: bool = False,
         nopretty: bool = False,
         force: bool = False,
@@ -404,8 +405,12 @@ def _delete_jobs(
     If the job is running, ask to kill the job first.
 
     """
-    from meerschaum.utils.daemon import (
-        Daemon, get_running_daemons, get_stopped_daemons, get_filtered_daemons, get_paused_daemons
+    from meerschaum.utils.jobs import (
+        Job,
+        get_running_jobs,
+        get_stopped_jobs,
+        get_filtered_jobs,
+        get_paused_jobs,
     )
     from meerschaum.utils.prompt import yes_no
     from meerschaum.utils.formatting._jobs import pprint_jobs
@@ -413,49 +418,53 @@ def _delete_jobs(
     from meerschaum.utils.warnings import warn
     from meerschaum.utils.misc import items_str
     from meerschaum.actions import actions
-    daemons = get_filtered_daemons(action, warn=(not nopretty))
-    if not daemons:
+
+    jobs = get_filtered_jobs(executor_keys, action, debug=debug)
+    if not jobs:
         return True, "No jobs to delete; nothing to do."
 
     _delete_all_jobs = False
     if not action:
         if not force:
-            pprint_jobs(daemons)
+            pprint_jobs(jobs)
             if not yes_no(
                 "Delete all jobs? This cannot be undone!",
                 noask=noask, yes=yes, default='n'
             ):
                 return False, "No jobs were deleted."
+
             _delete_all_jobs = True
-    _running_daemons = get_running_daemons(daemons)
-    _paused_daemons = get_paused_daemons(daemons)
-    _stopped_daemons = get_stopped_daemons(daemons)
-    _to_delete = _stopped_daemons
 
-    to_stop_daemons = _running_daemons + _paused_daemons
-    if to_stop_daemons:
+    _running_jobs = get_running_jobs(executor_keys, jobs, debug=debug)
+    _paused_jobs = get_paused_jobs(executor_keys, jobs, debug=debug)
+    _stopped_jobs = get_stopped_jobs(executor_keys, jobs, debug=debug)
+    _to_delete = _stopped_jobs
+
+    to_stop_jobs =  {**_running_jobs, **_paused_jobs}
+    if to_stop_jobs:
         clear_screen(debug=debug)
         if not force:
-            pprint_jobs(to_stop_daemons, nopretty=nopretty)
+            pprint_jobs(to_stop_jobs, nopretty=nopretty)
         if force or yes_no(
             "Stop these jobs?",
             default='n', yes=yes, noask=noask
         ):
             actions['stop'](
-                action = (['jobs'] + [d.daemon_id for d in to_stop_daemons]),
-                nopretty = nopretty,
-                yes = yes,
-                force = force,
-                noask = noask,
-                debug = debug,
+                action=(['jobs'] + [_name for _name in to_stop_jobs]),
+                executor_keys=executor_keys,
+                nopretty=nopretty,
+                yes=yes,
+                force=force,
+                noask=noask,
+                debug=debug,
                 **kw
             )
             ### Ensure the running jobs are dead.
-            if get_running_daemons(daemons):
+            if get_running_jobs(executor_keys, jobs, debug=debug):
                 return False, (
                     f"Failed to kill running jobs. Please stop these jobs before deleting."
                 )
-            _to_delete += to_stop_daemons
+            _to_delete.update(to_stop_jobs)
 
         ### User decided not to kill running jobs.
         else:
@@ -473,17 +482,17 @@ def _delete_jobs(
             return False, "No jobs were deleted."
 
     _deleted = []
-    for d in _to_delete:
-        d.cleanup()
-        if d.path.exists() and not nopretty:
-            warn(f"Failed to delete job '{d.daemon_id}'.", stack=False)
+    for name, job in _to_delete.items():
+        delete_success, delete_msg = job.delete()
+        if not delete_success:
+            warn(f"Failed to delete job '{name}'.", stack=False)
             continue
-        _deleted.append(d)
+        _deleted.append(name)
 
     return (
         len(_deleted) > 0,
         ("Deleted job" + ("s" if len(_deleted) != 1 else '')
-            + f" {items_str([d.daemon_id for d in _deleted])}."),
+            + f" {items_str([_name for _name in _deleted])}."),
     )
 
 

meerschaum/actions/register.py

@@ -203,14 +203,23 @@ def _register_plugins(
     successes = {}
 
     for name, plugin in plugins_to_register.items():
-        desc = None
         plugin.attributes = repo_connector.get_plugin_attributes(plugin, debug=debug)
         if plugin.attributes is None:
             plugin.attributes = {}
+
+        try:
+            description_text = plugin.attributes.get('description', '')
+            doc_text = plugin.module.__doc__.lstrip().rstrip()
+        except Exception:
+            description_text = ''
+            doc_text = ''
+
+        desc = description_text or doc_text or ''
+
         question = f"Would you like to add a description to plugin '{name}'?"
-        if plugin.attributes.get('description', None):
+        if desc:
             info(f"Found existing description for plugin '{plugin}':")
-            print(plugin.attributes['description'])
+            print(desc)
             question = (
                 "Would you like to overwrite this description?\n"
                 + "To edit the existing text, visit /dash/plugins for this repository."
@@ -220,9 +229,14 @@ def _register_plugins(
             default='n',
             yes=yes
         ):
-            info('Press (Esc + Enter) to submit the description, (CTRL + C) to cancel.')
+            info('Press (Esc + Enter) to submit, (CTRL + C) to cancel.')
             try:
-                desc = prompt('', multiline=True, icon=False)
+                desc = prompt(
+                    '',
+                    multiline=True,
+                    icon=False,
+                    default_editable=desc.lstrip().rstrip(),
+                )
             except KeyboardInterrupt:
                 desc = None
             if desc == '':