meerschaum 3.0.0rc4__py3-none-any.whl → 3.0.0rc8__py3-none-any.whl

meerschaum/actions/api.py

@@ -6,7 +6,10 @@ Start the Meerschaum WebAPI with the `api` action.
 """
 
 from __future__ import annotations
+
 import os
+
+import meerschaum as mrsm
 from meerschaum.utils.typing import SuccessTuple, Optional, List, Any
 
 
@@ -93,6 +96,7 @@ def _api_start(
     action: Optional[List[str]] = None,
     host: Optional[str] = None,
     port: Optional[int] = None,
+    webterm_port: Optional[int] = None,
     workers: Optional[int] = None,
     mrsm_instance: Optional[str] = None,
     no_dash: bool = False,
@@ -119,6 +123,10 @@ def _api_start(
         The address to bind to.
         If `None`, use '0.0.0.0'.
 
+    webterm_port: Optional[int], default None
+        Port to bind the webterm server to.
+        If `None`, use 8765.
+
     workers: Optional[int], default None
         How many worker threads to run.
         If `None`, defaults to the number of CPU cores or 1 on Android.
@@ -149,8 +157,6 @@ def _api_start(
 
     from meerschaum.utils.packages import (
         attempt_import,
-        venv_contains_package,
-        pip_install,
         run_python_package,
     )
     from meerschaum.utils.misc import is_int, filter_keywords
@@ -164,9 +170,10 @@ def _api_start(
         API_UVICORN_CONFIG_PATH,
         CACHE_RESOURCES_PATH,
         PACKAGE_ROOT_PATH,
+        ROOT_DIR_PATH,
     )
     from meerschaum.config._patch import apply_patch_to_config
-    from meerschaum.config._environment import get_env_vars
+    from meerschaum.config.environment import get_env_vars
     from meerschaum._internal.static import STATIC_CONFIG, SERVER_ID
     from meerschaum.connectors.parse import parse_instance_keys
     from meerschaum.utils.pool import get_pool
@@ -187,9 +194,9 @@ def _api_start(
     uvicorn_config_path = API_UVICORN_RESOURCES_PATH / SERVER_ID / 'config.json'
     uvicorn_env_path = API_UVICORN_RESOURCES_PATH / SERVER_ID / 'uvicorn.env'
 
-    api_config = deepcopy(get_config('system', 'api'))
+    api_config = deepcopy(get_config('api'))
     cf = _config()
-    forwarded_allow_ips = get_config('system', 'api', 'uvicorn', 'forwarded_allow_ips')
+    forwarded_allow_ips = get_config('api', 'uvicorn', 'forwarded_allow_ips')
     uvicorn_config = api_config['uvicorn']
     if port is None:
         ### default
@@ -223,7 +230,7 @@ def _api_start(
     instance_connector = parse_instance_keys(mrsm_instance, debug=debug)
     if instance_connector.type == 'api' and instance_connector.protocol != 'https':
         allow_http_parent = get_config(
-            'system', 'api', 'permissions', 'chaining', 'insecure_parent_instance'
+            'api', 'permissions', 'chaining', 'insecure_parent_instance'
         )
         if not allow_http_parent:
             return False, (
@@ -233,7 +240,7 @@ def _api_start(
                 f"  - Ensure that '{instance_connector}' is available over HTTPS, " +
                 "and with `edit config`,\n" +
                 f"    change the `protocol` for '{instance_connector}' to 'https'.\n\n" +
-                "  - Run `edit config system` and search for `permissions`.\n" +
+                "  - Run `edit config api` and search for `permissions`.\n" +
                 "    Under `api:permissions:chaining`, change the value of " +
                 "`insecure_parent_instance` to `true`,\n" +
                 "    then restart the API process."
@@ -244,6 +251,7 @@ def _api_start(
         'host': host,
         'env_file': str(uvicorn_env_path.as_posix()),
         'mrsm_instance': mrsm_instance,
+        'webterm_port': webterm_port,
         'no_dash': no_dash,
         'no_webterm': no_webterm or no_auth,
         'no_auth': no_auth,
@@ -261,9 +269,22 @@ def _api_start(
     uvicorn_config['use_colors'] = (not nopretty) if nopretty else ANSI
 
     api_config['uvicorn'] = uvicorn_config
-    cf['system']['api']['uvicorn'] = uvicorn_config
+    cf['api']['uvicorn'] = uvicorn_config
     if secure:
-        cf['system']['api']['permissions']['actions']['non_admin'] = False
+        cf['api']['permissions']['actions']['non_admin'] = False
+
+    if not uvicorn_config['no_webterm']:
+        from meerschaum._internal.term.tools import is_webterm_running
+        if webterm_port is None:
+            webterm_port = int(mrsm.get_config('api', 'webterm', 'port'))
+        if is_webterm_running(port=webterm_port):
+            return (
+                False,
+                (
+                    f"Webterm is running on port {webterm_port}. "
+                    "Start the API again with `--webterm-port`."
+                )
+            )
 
     custom_keys = [
         'mrsm_instance',
@@ -273,6 +294,7 @@ def _api_start(
         'private',
         'debug',
         'production',
+        'webterm_port',
     ]
 
     ### write config to a temporary file to communicate with uvicorn threads
@@ -299,6 +321,7 @@ def _api_start(
         MRSM_SERVER_ID: SERVER_ID,
         MRSM_RUNTIME: 'api',
         MRSM_CONFIG: json.loads(os.environ.get(MRSM_CONFIG, '{}')),
+        MRSM_ROOT_DIR: ROOT_DIR_PATH.as_posix(),
         'FORWARDED_ALLOW_IPS': forwarded_allow_ips,
         'TERM': os.environ.get('TERM', 'screen-256color'),
         'SHELL': os.environ.get('SHELL', '/bin/bash'),
@@ -326,10 +349,10 @@ def _api_start(
     env_text = ''
     for key, val in env_dict.items():
         value = str(
-            json.dumps(val, default=json_serialize_value)
+            json.dumps(val, default=json_serialize_value, separators=(',', ':'))
             if isinstance(val, (dict))
             else val
-        ).replace('\\', '\\\\').replace("'", "'\\''")
+        ).replace('\\', '\\\\').replace("'", "\\'")
         env_text += f"{key}='{value}'\n"
     with open(uvicorn_env_path, 'w+', encoding='utf-8') as f:
         if debug:
@@ -394,11 +417,16 @@ def _api_start(
         except KeyboardInterrupt:
             pass
 
+    old_stdin = sys.stdin
+    sys.stdin = None
+
     if production:
         _run_gunicorn()
     else:
         _run_uvicorn()
 
+    sys.stdin = old_stdin
+
     ### Cleanup
     if uvicorn_config_path.parent.exists():
         shutil.rmtree(uvicorn_config_path.parent)

meerschaum/actions/attach.py

@@ -9,6 +9,7 @@ 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,

meerschaum/actions/delete.py

@@ -18,7 +18,7 @@ def delete(
     Delete an element.
 
     Command:
-        `delete {config, pipes, plugins, users, connectors, jobs}`
+        `delete {config, pipes, plugins, users, connectors, jobs, venvs}`
 
     """
     from meerschaum.actions import choose_subaction
@@ -159,7 +159,9 @@ def _delete_config(
         answer = yes_no(
             "Are you sure you want to delete the following configuration files?" +
             f"{sep + sep.join([str(p) for p in paths])}\n",
-            default='n', noask=noask, yes=yes
+            default='n',
+            noask=noask,
+            yes=yes,
         )
 
     if answer or force:

meerschaum/actions/edit.py

@@ -67,7 +67,12 @@ def _complete_edit(
     return default_action_completer(action=(['edit'] + action), **kw)
 
 
-def _edit_config(action: Optional[List[str]] = None, **kw: Any) -> SuccessTuple:
+def _edit_config(
+    action: Optional[List[str]] = None,
+    noask: bool = False,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Edit Meerschaum configuration files.
 
@@ -87,11 +92,26 @@ def _edit_config(action: Optional[List[str]] = None, **kw: Any) -> SuccessTuple:
         ```
     """
     from meerschaum.config._edit import edit_config
-    if action is None:
-        action = []
-    if len(action) == 0:
-        action.append('meerschaum')
-    return edit_config(keys=action, **kw)
+    from meerschaum.config._read_config import get_possible_keys
+    from meerschaum.actions import actions
+    from meerschaum.utils.prompt import choose
+
+    if not action:
+        action = [
+            choose(
+                "Choose a configuration file to edit:",
+                get_possible_keys(),
+                default='meerschaum',
+                noask=noask,
+            )
+        ]
+
+    edit_success, edit_msg = edit_config(keys=action, debug=debug, **kwargs)
+    if not edit_success:
+        return edit_success, edit_msg
+
+    return actions['reload'](debug=debug)
+
 
 def _complete_edit_config(action: Optional[List[str]] = None, **kw: Any) -> List[str]:
     from meerschaum.config._read_config import get_possible_keys
@@ -343,7 +363,6 @@ def _edit_plugins(
     from meerschaum.utils.warnings import warn
     from meerschaum.utils.prompt import prompt, yes_no
     from meerschaum.utils.misc import edit_file
-    from meerschaum.utils.packages import reload_meerschaum
     from meerschaum.actions import actions
 
     if not action:
@@ -376,7 +395,7 @@ def _edit_plugins(
             continue
 
         edit_file(plugin_file_path)
-        reload_meerschaum(debug=debug)
+        actions['reload'](debug=debug)
 
     return True, "Success"
 

meerschaum/actions/login.py

@@ -10,13 +10,13 @@ from __future__ import annotations
 from meerschaum.utils.typing import SuccessTuple, Optional, List, Any
 
 def login(
-        action: Optional[List[str]] = None,
-        connector_keys: Optional[List[str]] = None,
-        yes: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    connector_keys: Optional[List[str]] = None,
+    yes: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Log into a Meerschaum API instance.
     """
@@ -56,7 +56,7 @@ def login(
     for k in _keys:
         try:
             _connectors.append(parse_instance_keys(k))
-        except Exception as e:
+        except Exception:
             warn(f"Unable to build connector '{k}'. Is it registered?", stack=False)
 
     meerschaum_config = get_config('meerschaum')

meerschaum/actions/register.py

@@ -512,14 +512,20 @@ def _register_tokens(
             "To which user should this token be registered? Enter the number.",
             usernames,
         )
-        user_id = instance_connector.get_user_id(
-            User(username, instance=mrsm_instance),
-            debug=debug,
-        )
-        if user_id is None:
-            return False, f"Cannot load ID for user '{username}'."
+    else:
+        username = getattr(instance_connector, 'username')
+
+    if not username:
+        return False, "Cannot register a token without a user."
+
+    user_id = instance_connector.get_user_id(
+        User(username, instance=mrsm_instance),
+        debug=debug,
+    )
+    if user_id is None:
+        return False, f"Cannot load ID for user '{username}'."
 
-        user = User(username, user_id=user_id, instance=mrsm_instance)
+    user = User(username, user_id=user_id, instance=mrsm_instance)
 
     token = Token(
         label=name,

meerschaum/actions/reload.py

@@ -9,13 +9,30 @@ Reload the running Meerschaum instance.
 from __future__ import annotations
 from meerschaum.utils.typing import Any, SuccessTuple, List, Optional
 
+
 def reload(
-        action: Optional[List[str]] = None,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    debug: bool = False,
+    _stop_daemons: bool = True,
+    **kw: Any
+) -> SuccessTuple:
     """
     Reload the running Meerschaum instance.
     """
     from meerschaum.utils.packages import reload_meerschaum
-    return reload_meerschaum(debug=debug)
+    from meerschaum.actions import actions
+
+    if _stop_daemons:
+        from meerschaum._internal.cli.workers import get_existing_cli_worker_indices
+        indices = get_existing_cli_worker_indices()
+        cli_action = 'restart' if indices else 'stop'
+
+        stop_daemon_success, stop_daemon_msg = actions[cli_action](['daemons'], debug=debug, **kw)
+        if not stop_daemon_success:
+            return stop_daemon_success, stop_daemon_msg
+
+    reload_success, reload_msg = reload_meerschaum(debug=debug)
+    if not reload_success:
+        return reload_success, reload_msg
+
+    return True, "Success"

meerschaum/actions/restart.py

@@ -7,6 +7,7 @@ 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,
@@ -18,6 +19,7 @@ def restart(
     from meerschaum.actions import choose_subaction
     attach_options = {
         'jobs': _restart_jobs,
+        'daemons': _restart_daemons,
     }
     return choose_subaction(action, attach_options, executor_keys=executor_keys, **kwargs)
 
@@ -111,3 +113,15 @@ def _restart_jobs(
             time.sleep(min_seconds)
 
     return check_success, check_msg
+
+
+def _restart_daemons(
+    action: Optional[List[str]] = None,
+    **kwargs
+) -> SuccessTuple:
+    """
+    Restart the CLI daemons.
+    """
+    from meerschaum.actions import actions
+    kwargs['force'] = True
+    return actions['start'](['daemons'], **kwargs)

meerschaum/actions/show.py

@@ -46,6 +46,7 @@ def show(
         'schedules'  : _show_schedules,
         'venvs'      : _show_venvs,
         'tokens'     : _show_tokens,
+        'daemons'    : _show_daemons,
     }
     return choose_subaction(action, show_options, **kw)
 
@@ -205,7 +206,7 @@ def _show_version(nopretty: bool = False, **kw : Any) -> SuccessTuple:
         msg = "Meerschaum v" + version
         _print = info
     _print(msg)
-    return (True, "Success")
+    return True, "Success"
 
 
 def _show_connectors(
@@ -563,6 +564,7 @@ def _complete_show_packages(
 
     return possibilities
 
+
 def _show_jobs(
     action: Optional[List[str]] = None,
     executor_keys: Optional[str] = None,
@@ -763,7 +765,7 @@ def _show_environment(
     """
     import os
     from meerschaum.utils.formatting import pprint
-    from meerschaum.config._environment import get_env_vars
+    from meerschaum.config.environment import get_env_vars
     pprint(
         {
             env_var: os.environ[env_var]
@@ -930,7 +932,7 @@ def _show_tokens(
     from meerschaum.utils.packages import import_rich
     from meerschaum.utils.formatting import UNICODE, get_console
     rich = import_rich()
-    rich_table, rich_json = mrsm.attempt_import('rich.table', 'rich.json')
+    rich_table, rich_json, rich_box = mrsm.attempt_import('rich.table', 'rich.json', 'rich.box')
 
     conn = parse_instance_keys(mrsm_instance)
 
@@ -994,7 +996,11 @@ def _show_tokens(
         else "[-]"
     )
 
-    table = rich_table.Table(title=f"Registered Tokens on instance '{conn}'")
+    table = rich_table.Table(
+        title=f"Registered Tokens on instance '{conn}'",
+        box=rich_box.ROUNDED,
+        title_style='bold',
+    )
     table.add_column("ID")
     table.add_column("Label")
     table.add_column("User")
@@ -1018,6 +1024,65 @@ def _show_tokens(
     return True, "Success"
 
 
+def _show_daemons() -> SuccessTuple:
+    """
+    Print information about the running CLI daemons.
+    """
+    from meerschaum._internal.cli.workers import get_existing_cli_workers
+    workers = get_existing_cli_workers()
+    if not workers:
+        return True, "No CLI daemons are running."
+
+    rich_table, rich_box, rich_text = mrsm.attempt_import('rich.table', 'rich.box', 'rich.text')
+    table = rich_table.Table(
+        rich_table.Column("Index", justify='center'),
+        rich_table.Column("Status"),
+        rich_table.Column("Locked", justify='center'),
+        rich_table.Column("Ready", justify='center'),
+        rich_table.Column("Actions"),
+        title='CLI Daemons',
+        box=rich_box.ROUNDED,
+        title_style='bold',
+    )
+
+    running_icon = mrsm.get_config('formatting', 'emoji', 'running')
+    paused_icon = mrsm.get_config('formatting', 'emoji', 'paused')
+    stopped_icon = mrsm.get_config('formatting', 'emoji', 'stopped')
+    locked_icon = mrsm.get_config('formatting', 'emoji', 'locked')
+    unlocked_icon = mrsm.get_config('formatting', 'emoji', 'unlocked')
+    status_styles = {
+        'running': 'green',
+        'stopped': 'red',
+        'paused': 'yellow',
+    }
+
+    for worker in workers:
+        status = worker.job.status
+        status_text = rich_text.Text(
+            status,
+            style=status_styles[status],
+        )
+        if not worker.is_ready():
+            ready_icon = stopped_icon
+        else:
+            ready_icon = (
+                running_icon
+                if status == 'running'
+                else paused_icon
+            )
+
+        table.add_row(
+            str(worker.ix),
+            status_text,
+            (locked_icon if worker.lock_path.exists() else unlocked_icon),
+            ready_icon,
+            str(worker.job.daemon.rotating_log.get_latest_subfile_index()),
+        )
+
+    mrsm.pprint(table)
+    return True, "Success"
+
+
 ### NOTE: This must be the final statement of the module.
 ###       Any subactions added below these lines will not
 ###       be added to the `help` docstring.