meerschaum 3.0.0rc3__tar.gz → 3.0.0rc6__tar.gz

{meerschaum-3.0.0rc3/meerschaum.egg-info → meerschaum-3.0.0rc6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meerschaum
-Version: 3.0.0rc3
+Version: 3.0.0rc6
 Summary: Sync Time-Series Pipes with Meerschaum
 Author-email: Bennett Meares <bennett.meares@gmail.com>
 Maintainer-email: Bennett Meares <bennett.meares@gmail.com>
@@ -192,6 +192,7 @@ Requires-Dist: python-multipart>=0.0.20; extra == "api"
 Requires-Dist: httpx>=0.28.1; extra == "api"
 Requires-Dist: httpcore>=1.0.9; extra == "api"
 Requires-Dist: valkey>=6.1.0; extra == "api"
+Requires-Dist: python-jose>=3.5.0; extra == "api"
 Requires-Dist: numpy>=2.3.1; extra == "api"
 Requires-Dist: pandas[parquet]>=2.3.1; extra == "api"
 Requires-Dist: pyarrow>=20.0.0; extra == "api"
@@ -337,6 +338,7 @@ Requires-Dist: python-multipart>=0.0.20; extra == "full"
 Requires-Dist: httpx>=0.28.1; extra == "full"
 Requires-Dist: httpcore>=1.0.9; extra == "full"
 Requires-Dist: valkey>=6.1.0; extra == "full"
+Requires-Dist: python-jose>=3.5.0; extra == "full"
 Dynamic: license-file
 Dynamic: provides-extra
 

{meerschaum-3.0.0rc3 → meerschaum-3.0.0rc6}/meerschaum/_internal/arguments/_parser.py

@@ -377,7 +377,7 @@ groups['sync'].add_argument(
 groups['sync'].add_argument(
     '--cache', action='store_true',
     help=(
-        "When syncing or viewing a pipe's data, sync to a local database for later analysis."
+        "Sync pipes' metadata to disk."
     )
 )
 
@@ -508,3 +508,7 @@ groups['misc'].add_argument(
         + "Default behavior is to only allow recognized actions."
     )
 )
+groups['misc'].add_argument(
+    '--no-daemon', action='store_true',
+    help="Do not use the Meerschaum CLI daemon to execute the action.",
+)

meerschaum-3.0.0rc6/meerschaum/_internal/cli/__init__.py

@@ -0,0 +1,6 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define internal utilities for interacting with the CLI daemons.
+"""

meerschaum-3.0.0rc6/meerschaum/_internal/cli/daemons.py

@@ -0,0 +1,103 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define the CLI daemons utilities.
+"""
+
+import os
+import threading
+import pathlib
+from typing import Optional, List
+
+import meerschaum as mrsm
+
+
+def get_cli_daemon(ix: Optional[int] = None):
+    """
+    Get the CLI daemon.
+    """
+    from meerschaum._internal.cli.workers import ActionWorker
+    ix = ix if ix is not None else get_available_cli_daemon_ix()
+    return ActionWorker(ix)
+
+
+def get_cli_lock_path(ix: int) -> pathlib.Path:
+    """
+    Return the path to a CLI daemon's lock file.
+    """
+    from meerschaum.config.paths import CLI_RESOURCES_PATH
+    return CLI_RESOURCES_PATH / f"ix-{ix}.lock"
+
+
+def get_cli_session_id() -> str:
+    """
+    Return the session ID to use for the current process and thread.
+    """
+    return f"{os.getpid()}.{threading.current_thread().ident}"
+
+
+def get_available_cli_daemon_ix() -> int:
+    """
+    Return the index for an available CLI daemon.
+    """
+    max_ix = mrsm.get_config('system', 'cli', 'max_daemons') - 1
+    ix = 0
+    while True:
+        lock_path = get_cli_lock_path(ix)
+        if not lock_path.exists():
+            return ix
+        
+        ix += 1
+        if ix > max_ix:
+            raise EnvironmentError("Too many CLI daemons are running.")
+
+
+def get_existing_cli_daemon_indices() -> List[int]:
+    """
+    Return a list of the existing CLI daemons.
+    """
+    from meerschaum.utils.daemon import get_daemon_ids
+    daemon_ids = [daemon_id for daemon_id in get_daemon_ids() if daemon_id.startswith('.cli.')]
+    indices = []
+
+    for daemon_id in daemon_ids:
+        try:
+            ix = int(daemon_id[len('.cli.'):])
+            indices.append(ix)
+        except Exception:
+            pass
+
+    return indices
+
+
+def get_existing_cli_daemons() -> 'List[ActionWorker]':
+    """
+    Return a list of the existing CLI daemons.
+    """
+    from meerschaum._internal.cli.workers import ActionWorker
+    indices = get_existing_cli_daemon_indices()
+    return [
+        ActionWorker(ix)
+        for ix in indices
+    ]
+
+
+def _get_cli_session_dir_path(session_id: str) -> pathlib.Path:
+    """
+    Return the path to the file handles for the CLI session.
+    """
+    from meerschaum.config.paths import CLI_RESOURCES_PATH
+    return CLI_RESOURCES_PATH / session_id
+
+
+def _get_cli_stream_path(
+    session_id: str,
+    action_id: str,
+    stream: str = 'stdout',
+) -> pathlib.Path:
+    """
+    Return the file path for the stdout / stderr file stream.
+    """
+    session_dir_path = _get_cli_session_dir_path(session_id)
+    return session_dir_path / f'{action_id}.{stream}'

meerschaum-3.0.0rc6/meerschaum/_internal/cli/entry.py

@@ -0,0 +1,184 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define the CLI daemon entrypoint.
+"""
+
+import os
+import time
+import uuid
+import shlex
+import shutil
+import traceback
+import signal
+from typing import Optional, Dict, List, Any, Union
+
+import meerschaum as mrsm
+
+
+def entry_with_daemon(
+    sysargs: Optional[List[str]] = None,
+    _patch_args: Optional[Dict[str, Any]] = None,
+    _use_cli_daemon: bool = True,
+    _session_id: Optional[str] = None,
+) -> mrsm.SuccessTuple:
+    """
+    Parse arguments and launch a Meerschaum action.
+
+    Returns
+    -------
+    A `SuccessTuple` indicating success.
+    """
+    from meerschaum._internal.entry import entry_without_daemon
+    from meerschaum._internal.cli.workers import ActionWorker
+    from meerschaum._internal.cli.daemons import (
+        get_available_cli_daemon_ix,
+        get_cli_session_id,
+    )
+    daemon_is_ready = True
+
+    found_acceptable_prefix = False
+    found_unacceptable_prefix = False
+    allowed_prefixes = mrsm.get_config('system', 'cli', 'allowed_prefixes')
+    disallowed_prefixes = mrsm.get_config('system', 'cli', 'disallowed_prefixes')
+    refresh_seconds = mrsm.get_config('system', 'cli', 'refresh_seconds')
+    sysargs_str = sysargs if isinstance(sysargs, str) else shlex.join(sysargs or [])
+
+    for prefix in allowed_prefixes:
+        if sysargs_str.startswith(prefix) or prefix == '*':
+            found_acceptable_prefix = True
+            break
+
+    for prefix in disallowed_prefixes:
+        if sysargs_str.startswith(prefix) or prefix == '*':
+            found_unacceptable_prefix = True
+            break
+
+    if not found_acceptable_prefix or found_unacceptable_prefix:
+        daemon_is_ready = False
+
+    try:
+        daemon_ix = get_available_cli_daemon_ix() if daemon_is_ready else -1
+    except EnvironmentError as e:
+        from meerschaum.utils.warnings import warn
+        warn(e, stack=False)
+        daemon_ix = -1
+        daemon_is_ready = False
+
+    worker = ActionWorker(daemon_ix, refresh_seconds=refresh_seconds) if daemon_ix != -1 else None
+    if worker and worker.lock_path.exists():
+        daemon_is_ready = False
+
+    start_success, start_msg = (
+        worker.job.start()
+        if worker and daemon_is_ready
+        else (False, "Lock exists.")
+    )
+
+    if not start_success:
+        daemon_is_ready = False
+
+    if start_success and worker:
+        start = time.perf_counter()
+        while (time.perf_counter() - start) < 3:
+            if worker.is_ready():
+                break
+            time.sleep(refresh_seconds)
+
+    if not daemon_is_ready or worker is None:
+        return entry_without_daemon(sysargs, _patch_args=_patch_args)
+
+    session_id = _session_id or get_cli_session_id()
+    action_id = uuid.uuid4().hex
+
+    terminal_size = shutil.get_terminal_size()
+    env = {
+        **{
+            'LINES': str(terminal_size.lines),
+            'COLUMNS': str(terminal_size.columns),
+        },
+        **dict(os.environ),
+    }
+    
+    worker.write_input_data({
+        'session_id': session_id,
+        'action_id': action_id,
+        'sysargs': sysargs,
+        'patch_args': _patch_args,
+        'env': env,
+    })
+
+    accepted = False
+    exit_data = None
+    worker_data = None
+
+    while not accepted:
+        state = worker.read_output_data().get('state', None)
+        if state == 'accepted':
+            accepted = True
+            break
+
+        time.sleep(refresh_seconds)
+
+    try:
+        log = worker.job.daemon.rotating_log
+        worker.job.monitor_logs(
+            stop_on_exit=True,
+            callback_function=worker.monitor_callback,
+            _log=log,
+            _wait_if_stopped=False,
+        )
+        worker_data = worker.read_output_data()
+    except KeyboardInterrupt:
+        exit_data = {
+            'session_id': session_id,
+            'action_id': action_id,
+            'signal': signal.SIGINT,
+            'traceback': traceback.format_exc(),
+            'success': True,
+            'message': 'Exiting due to keyboard interrupt.',
+        }
+    except Exception as e:
+        exit_data = {
+            'session_id': session_id,
+            'action_id': action_id,
+            'signal': signal.SIGINT,
+            'traceback': traceback.format_exc(),
+            'success': False,
+            'message': f'Encountered exception: {e}',
+        }
+    except SystemExit:
+        exit_data = {
+            'session_id': session_id,
+            'action_id': action_id,
+            'signal': signal.SIGTERM,
+            'traceback': traceback.format_exc(),
+            'success': True,
+            'message': 'Exiting on SIGTERM.',
+        }
+    except BrokenPipeError:
+        return False, "Connection to daemon is broken."
+
+    if exit_data:
+        exit_success = bool(exit_data['success'])
+        exit_signal = exit_data['signal']
+        worker.send_signal(exit_signal)
+        try:
+            worker.job.monitor_logs(
+                stop_on_exit=True,
+                callback_function=worker.monitor_callback,
+                _wait_if_stopped=False,
+                _log=log,
+            )
+        except (KeyboardInterrupt, SystemExit):
+            worker.send_signal(signal.SIGTERM)
+        worker_data = worker.read_output_data()
+
+        if not exit_success:
+            print(exit_data['traceback'])
+
+    worker.write_input_data({'increment': True})
+    success = (worker_data or {}).get('success', False)
+    message = (worker_data or {}).get('message', "Failed to retrieve message from CLI worker.")
+    return success, message