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

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,113 @@
+#! /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,
+    executor_keys: Optional[str] = None,
+    **kwargs: Any
+) -> SuccessTuple:
+    """
+    Attach to a job, and prompt the user when blocking on input.
+    """
+    from meerschaum.actions import choose_subaction
+    attach_options = {
+        'jobs': _attach_jobs,
+        'logs': _attach_logs,
+    }
+    return choose_subaction(action, attach_options, executor_keys=executor_keys, **kwargs)
+
+
+def _complete_attach(
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
+    """
+    Override the default Meerschaum `complete_` function.
+    """
+    from meerschaum.actions.delete import _complete_delete_jobs
+
+    if action is None:
+        action = []
+
+    options = {
+        'job': _complete_delete_jobs,
+        'jobs': _complete_delete_jobs,
+        'log': _complete_delete_jobs,
+        'logs': _complete_delete_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.
+    """
+    action = action or []
+    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)
+    other_executor_keys = 'systemd' if executor_keys in (None, 'local') else 'local'
+    if not job.exists():
+        other_job = mrsm.Job(name, executor_keys=other_executor_keys)
+        if not other_job.exists():
+            return False, f"Job '{job.name}' does not exist."
+
+        job = other_job
+
+    success, message = True, "Success"
+
+    def _capture_result(result: SuccessTuple):
+        nonlocal success, message
+        success, message = result
+
+    try:
+        job.monitor_logs(
+            stop_callback_function=_capture_result,
+            accept_input=True,
+            stop_on_exit=True,
+            strip_timestamps=True,
+        )
+    except KeyboardInterrupt:
+        pass
+
+    return success, message
+
+
+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/copy.py

@@ -10,9 +10,9 @@ from __future__ import annotations
 from meerschaum.utils.typing import Union, Any, Sequence, SuccessTuple, Optional, Tuple, List
 
 def copy(
-        action: Optional[List[str]] = None,
-        **kw : Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    **kw : Any
+) -> SuccessTuple:
     """
     Duplicate connectors or pipes.
     
@@ -32,17 +32,16 @@ def copy(
 
 
 def _complete_copy(
-        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_copy_connectors,
         'connectors': _complete_copy_connectors,
@@ -61,15 +60,14 @@ def _complete_copy(
 
 
 def _copy_pipes(
-        yes: bool = False,
-        noask: bool = False,
-        force: bool = False,
-        debug: bool = False,
-        **kw
-    ) -> SuccessTuple:
+    yes: bool = False,
+    noask: bool = False,
+    force: bool = False,
+    debug: bool = False,
+    **kw
+) -> SuccessTuple:
     """
     Copy pipes' attributes and make new pipes.
-
     """
     from meerschaum import get_pipes, Pipe
     from meerschaum.utils.prompt import prompt, yes_no
@@ -132,16 +130,15 @@ def _copy_pipes(
 
     return successes > 0, msg
 
+
 def _copy_connectors(
-        action: Optional[List[str]] = None,
-        connector_keys: Optional[List[str]] = None,
-        nopretty: bool = False,
-        yes: bool = False,
-        force: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    connector_keys: Optional[List[str]] = None,
+    nopretty: bool = False,
+    force: bool = False,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Create a new connector from an existing one.
 
@@ -153,39 +150,69 @@ def _copy_connectors(
     from meerschaum.config._edit import write_config
     from meerschaum.utils.warnings import info, warn
     from meerschaum.utils.formatting import pprint
+    from meerschaum.actions import get_action
     cf = _config()
     if action is None:
         action = []
     if connector_keys is None:
         connector_keys = []
 
-    _keys = list(set(action + connector_keys))
+    _keys = (action or []) + connector_keys
 
     if not _keys:
         return False, "No connectors to copy."
 
-    for ck in _keys:
-        try:
-            conn = parse_connector_keys(ck)
-        except Exception as e:
-            warn(f"Unable to parse connector '{ck}'. Skipping...", stack=False)
-            continue
+    if len(_keys) < 1 or len(_keys) > 2:
+        return False, "Provide one set of connector keys."
 
-        attrs = get_config('meerschaum', 'connectors', conn.type, conn.label)
-        pprint(attrs, nopretty=nopretty)
+    ck = _keys[0]
 
-        asking = True
-        #  while asking:
-            #  new_ck = prompt("Please enter a new label for the new connector ():")
+    try:
+        conn = parse_connector_keys(ck)
+    except Exception as e:
+        return False, f"Unable to parse connector '{ck}'."
 
+    if len(_keys) == 2:
+        new_ck = _keys[1] if ':' in _keys[1] else None
+        new_label = _keys[1].split(':')[-1]
+    else:
+        new_ck = None
+        new_label = None
+
+    try:
+        if new_label is None:
+            new_label = prompt(f"Enter a label for the new '{conn.type}' connector:")
+    except KeyboardInterrupt:
+        return False, "Nothing was copied."
+
+    if new_ck is None:
+        new_ck = f"{conn.type}:{new_label}"
+
+    info(f"Registering connector '{new_ck}' from '{ck}'...")
+
+    attrs = get_config('meerschaum', 'connectors', conn.type, conn.label)
+    pprint(attrs, nopretty=nopretty)
+    if not force and not yes_no(
+        f"Register connector '{new_ck}' with the above attributes?",
+        default='n',
+        **kwargs
+    ):
+        return False, "Nothing was copied."
+
+    register_connector = get_action(['register', 'connector'])
+    register_success, register_msg = register_connector(
+        [new_ck],
+        params=attrs,
+        **kwargs
+    )
+    return register_success, register_msg
 
-    return False, "Not implemented."
 
 def _complete_copy_connectors(
-        action : Optional[List[str]] = None,
-        line : str = '',
-        **kw : Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None,
+    line: str = '',
+    **kw: Any
+) -> List[str]:
     from meerschaum.config import get_config
     from meerschaum.utils.misc import get_connector_labels
     types = list(get_config('meerschaum', 'connectors').keys())

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.
     """