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

meerschaum/actions/delete.py

@@ -10,9 +10,9 @@ from __future__ import annotations
 from meerschaum.utils.typing import Any, SuccessTuple, Union, Optional, List
 
 def delete(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> SuccessTuple:
     """
     Delete an element.
 
@@ -35,23 +35,21 @@ def delete(
 
 
 def _complete_delete(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
     """
     Override the default Meerschaum `complete_` function.
-
     """
-    from meerschaum.actions.start import _complete_start_jobs
     from meerschaum.actions.edit import _complete_edit_config
     if action is None:
         action = []
     options = {
         'connector': _complete_delete_connectors,
         'connectors': _complete_delete_connectors,
-        'config' : _complete_edit_config,
-        'job' : _complete_start_jobs,
-        'jobs' : _complete_start_jobs,
+        'config': _complete_edit_config,
+        'job': _complete_delete_jobs,
+        'jobs': _complete_delete_jobs,
     }
 
     if (
@@ -390,22 +388,27 @@ def _complete_delete_connectors(
 
 
 def _delete_jobs(
-        action: Optional[List[str]] = None,
-        noask: bool = False,
-        nopretty: bool = False,
-        force: bool = False,
-        yes: bool = False,
-        debug: bool = False,
-        **kw
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    executor_keys: Optional[str] = None,
+    noask: bool = False,
+    nopretty: bool = False,
+    force: bool = False,
+    yes: bool = False,
+    debug: bool = False,
+    **kw
+) -> SuccessTuple:
     """
     Remove a job's log files and delete the job's ID.
     
     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.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 +416,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,26 +480,81 @@ 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])}."),
     )
 
 
+def _complete_delete_jobs(
+    action: Optional[List[str]] = None,
+    executor_keys: Optional[str] = None,
+    line: str = '',
+    _get_job_method: Optional[str, List[str]] = None,
+    **kw
+) -> List[str]:
+    from meerschaum._internal.shell.Shell import shell_attrs
+    from meerschaum.jobs import (
+        get_jobs,
+        get_filtered_jobs,
+        get_restart_jobs,
+        get_stopped_jobs,
+        get_paused_jobs,
+        get_running_jobs,
+        get_executor_keys_from_context,
+    )
+    from meerschaum.utils.misc import remove_ansi
+    from meerschaum.connectors.parse import parse_executor_keys
+
+    executor_keys = (
+        executor_keys
+        or remove_ansi(
+            shell_attrs.get('executor_keys', get_executor_keys_from_context())
+        )
+    )
+
+    if parse_executor_keys(executor_keys, construct=False) is None:
+        return []
+
+    jobs = get_jobs(executor_keys, include_hidden=False)
+    if _get_job_method:
+        method_keys = [_get_job_method] if isinstance(_get_job_method, str) else _get_job_method
+        method_jobs = {}
+        for method_key in method_keys:
+            method_func = locals()[f'get_{method_key}_jobs']
+            method_jobs.update(method_func(jobs=jobs))
+        jobs = method_jobs
+
+    if not action:
+        return list(jobs)
+
+    possibilities = []
+    _line_end = line.split(' ')[-1]
+    for name in jobs:
+        if name in action:
+            continue
+        if _line_end == '':
+            possibilities.append(name)
+            continue
+        if name.startswith(action[-1]):
+            possibilities.append(name)
+    return possibilities
+
+
 def _delete_venvs(
-        action: Optional[List[str]] = None,
-        yes: bool = False,
-        force: bool = False,
-        **kwargs: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    yes: bool = False,
+    force: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Remove virtual environments.
     Specify which venvs to remove, or remove everything at once.

meerschaum/actions/edit.py

@@ -11,9 +11,9 @@ import meerschaum as mrsm
 from meerschaum.utils.typing import List, Any, SuccessTuple, Optional, Dict
 
 def edit(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> SuccessTuple:
     """
     Edit an existing element.
     """

meerschaum/actions/install.py

@@ -10,9 +10,9 @@ from __future__ import annotations
 from meerschaum.utils.typing import List, Any, SuccessTuple, Optional, Union
 
 def install(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> SuccessTuple:
     """
     Install Meerschaum plugins or Python packages.
     """
@@ -26,9 +26,9 @@ def install(
 
 
 def _complete_install(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
     """
     Override the default Meerschaum `complete_` function.
     """
@@ -52,13 +52,13 @@ def _complete_install(
 
 
 def _install_plugins(
-        action: Optional[List[str]] = None,
-        repository: Optional[str] = None,
-        skip_deps: bool = False,
-        force: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    repository: Optional[str] = None,
+    skip_deps: bool = False,
+    force: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Install a plugin.
     
@@ -103,10 +103,10 @@ def _install_plugins(
 
 
 def _complete_install_plugins(
-        action: Optional[List[str]] = None,
-        repository: Optional[str] = None,
-        **kw: Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None,
+    repository: Optional[str] = None,
+    **kw: Any
+) -> List[str]:
     """
     Search for plugins to autocomplete command line text.
     NOTE: Disabled for the time being so we don't interrupt the user typing.
@@ -143,12 +143,12 @@ class NoVenv:
     pass
 
 def _install_packages(
-        action: Optional[List[str]] = None,
-        sub_args: Optional[List[str]] = None,
-        venv: Union[str, NoVenv] = NoVenv,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    sub_args: Optional[List[str]] = None,
+    venv: Union[str, NoVenv] = NoVenv,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Install PyPI packages into the Meerschaum virtual environment.
     
@@ -179,19 +179,17 @@ def _install_packages(
     )
 
 
-def _complete_install_packages(
-        **kw : Any
-    ) -> List[str]:
+def _complete_install_packages(**kw : Any) -> List[str]:
     return []
 
 
 def _install_required(
-        action: Optional[List[str]] = None,
-        repository: Optional[str] = None,
-        force: bool = False,
-        debug: bool = False,
-        **kw
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    repository: Optional[str] = None,
+    force: bool = False,
+    debug: bool = False,
+    **kw
+) -> SuccessTuple:
     """
     Install the required packages for Meerschaum plugins.
     Each plugin's packages will be installed into its virtual environment.
@@ -237,6 +235,16 @@ def _complete_install_required(*args, **kw) -> List[str]:
     return _complete_uninstall_plugins(*args, **kw)
 
 
+def _install_systemd(
+    action: Optional[List[str]] = None,
+    **kwargs: Any
+) -> SuccessTuple:
+    """
+    Install the Meerschaum job monitor as a systemd service.
+    """
+    import sys
+
+
 ### NOTE: This must be the final statement of the module.
 ###       Any subactions added below these lines will not
 ###       be added to the `help` docstring.

meerschaum/actions/pause.py

@@ -27,13 +27,20 @@ def _complete_pause(
     """
     Override the default Meerschaum `complete_` function.
     """
-    from meerschaum.actions.start import _complete_start_jobs
+    from meerschaum.actions.delete import _complete_delete_jobs
+    from functools import partial
+
     if action is None:
         action = []
 
+    _complete_pause_jobs = partial(
+        _complete_delete_jobs,
+        _get_job_method='running',
+    )
+
     options = {
-        'job' : _complete_start_jobs,
-        'jobs' : _complete_start_jobs,
+        'job': _complete_pause_jobs,
+        'jobs': _complete_pause_jobs,
     }
 
     if (
@@ -49,43 +56,53 @@ def _complete_pause(
 
 
 def _pause_jobs(
-        action: Optional[List[str]] = None,
-        noask: bool = False,
-        force: bool = False,
-        yes: bool = False,
-        nopretty: bool = False,
-        **kw
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    executor_keys: Optional[str] = None,
+    noask: bool = False,
+    force: bool = False,
+    yes: bool = False,
+    nopretty: bool = False,
+    debug: bool = False,
+    **kw
+) -> SuccessTuple:
     """
-    Pause running jobs that were started with `-d` or `start job`.
-    
-    To see running jobs, run `show jobs`.
+    Pause (suspend) running jobs.
     """
     from meerschaum.utils.formatting._jobs import pprint_jobs
     from meerschaum.utils.daemon import (
         get_filtered_daemons, get_running_daemons, get_stopped_daemons, get_paused_daemons,
     )
+    from meerschaum.jobs import (
+        get_filtered_jobs,
+        get_running_jobs,
+        get_stopped_jobs,
+        get_paused_jobs,
+    )
     from meerschaum.utils.warnings import warn
     from meerschaum.utils.prompt import yes_no
     from meerschaum.utils.misc import items_str
-    daemons = get_filtered_daemons(action, warn=(not nopretty))
-    _running_daemons = get_running_daemons(daemons)
-    _paused_daemons = get_paused_daemons(daemons)
-    _stopped_daemons = get_stopped_daemons(daemons)
-    if action and _stopped_daemons and not nopretty:
+
+    jobs = get_filtered_jobs(executor_keys, action, debug=debug, warn=(not nopretty))
+    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)
+
+    if action and stopped_jobs and not nopretty:
         warn(
-            f"Skipping stopped job" + ("s" if len(_stopped_daemons) > 1 else '') + " '" +
-                ("', '".join(d.daemon_id for d in _stopped_daemons)) + "'.",
-            stack = False
+            f"Skipping stopped job" + ("s" if len(stopped_jobs) > 1 else '')
+            + " '"
+            + ("', '".join(stopped_jobs.keys()))
+            + "'.",
+            stack=False,
         )
 
-    daemons_to_pause = _running_daemons + _paused_daemons
-    if not daemons_to_pause:
+    jobs_to_pause = {**running_jobs, **paused_jobs}
+    if not jobs_to_pause:
         return False, "No running jobs to pause. You can start jobs with `-d` or `start jobs`."
 
     if not action:
         if not force:
-            pprint_jobs(_running_daemons)
+            pprint_jobs(running_jobs)
             if not yes_no(
                 "Pause all running jobs?",
                 noask=noask, yes=yes, default='n'
@@ -93,9 +110,9 @@ def _pause_jobs(
                 return False, "No jobs were paused."
 
     successes, fails = [], []
-    for d in daemons_to_pause:
-        pause_success, pause_msg = d.pause()
-        (successes if pause_success else fails).append(d.daemon_id)
+    for name, job in jobs_to_pause.items():
+        pause_success, pause_msg = job.pause()
+        (successes if pause_success else fails).append(name)
 
     msg = (
         (

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 == '':

meerschaum/actions/restart.py

@@ -0,0 +1,107 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Restart stopped jobs which have not been manually stopped.
+"""
+
+from meerschaum.utils.typing import SuccessTuple, Optional, List, Any
+
+def restart(
+    action: Optional[List[str]] = None,
+    executor_keys: Optional[str] = None,
+    **kwargs: Any
+) -> SuccessTuple:
+    """
+    Restart stopped jobs which have not been manually stopped.
+    """
+    from meerschaum.actions import choose_subaction
+    attach_options = {
+        'jobs': _restart_jobs,
+    }
+    return choose_subaction(action, attach_options, executor_keys=executor_keys, **kwargs)
+
+
+def _complete_restart(
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
+    """
+    Override the default Meerschaum `complete_` function.
+    """
+    from functools import partial
+    from meerschaum.actions.delete import _complete_delete_jobs
+
+    if action is None:
+        action = []
+
+    _complete_restart_jobs = partial(
+        _complete_delete_jobs,
+        _get_job_method='restart',
+    )
+
+    options = {
+        'job': _complete_restart_jobs,
+        'jobs': _complete_restart_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=(['restart'] + action), **kw)
+
+
+def _restart_jobs(
+    action: Optional[List[str]] = None,
+    executor_keys: Optional[str] = None,
+    loop: bool = False,
+    min_seconds: Optional[float] = 1.0,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
+    """
+    Restart stopped jobs which have not been manually stopped.
+    """
+    import time
+    from meerschaum.jobs import (
+        get_restart_jobs,
+        get_filtered_jobs,
+        check_restart_jobs,
+    )
+    from meerschaum.utils.misc import items_str
+    from meerschaum.utils.warnings import info
+    action = action or []
+
+    while True:
+        jobs = get_filtered_jobs(executor_keys, action, include_hidden=True, debug=debug)
+        restart_jobs = get_restart_jobs(executor_keys, jobs, debug=debug) if not action else jobs
+        if not restart_jobs and not loop:
+            return True, "No jobs need to be restarted."
+
+        info(
+            "Checking job"
+            + ('s' if len(restart_jobs) != 1 else '')
+            + ' '
+            + items_str(list(restart_jobs.keys()))
+            + '...'
+        )
+
+        check_success, check_msg = check_restart_jobs(
+            executor_keys,
+            restart_jobs,
+            debug=debug,
+        )
+        if not loop:
+            break
+
+        if min_seconds is not None and min_seconds != 0.0:
+            info(f"Sleeping for {min_seconds} seconds...")
+            time.sleep(min_seconds)
+
+    return check_success, check_msg