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

meerschaum/utils/jobs/__init__.py

@@ -0,0 +1,245 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+
+"""
+Higher-level utilities for managing `meerschaum.utils.daemon.Daemon`.
+"""
+
+import pathlib
+
+import meerschaum as mrsm
+from meerschaum.utils.jobs._Job import Job, StopMonitoringLogs
+from meerschaum.utils.typing import Dict, Optional, List, Callable, Any
+
+__all__ = (
+    'Job',
+    'get_jobs',
+    'get_filtered_jobs',
+    'get_restart_jobs',
+    'get_running_jobs',
+    'get_stopped_jobs',
+    'get_paused_jobs',
+    'get_restart_jobs',
+    'check_restart_jobs',
+    'start_check_jobs_thread',
+    'stop_check_jobs_thread',
+)
+
+
+def get_jobs(
+    executor_keys: Optional[str] = None,
+    debug: bool = False,
+) -> Dict[str, Job]:
+    """
+    Return a dictionary of the existing jobs.
+
+    Parameters
+    ----------
+    executor_keys: Optional[str], default None
+        If provided, return remote jobs on the given API instance.
+        Otherwise return local jobs.
+
+    Returns
+    -------
+    A dictionary mapping job names to jobs.
+    """
+    from meerschaum.connectors.parse import parse_connector_keys
+    if executor_keys == 'local':
+        executor_keys = None
+
+    if executor_keys is not None:
+        try:
+            _ = parse_connector_keys(executor_keys, construct=False)
+            conn = mrsm.get_connector(executor_keys)
+            return conn.get_jobs(debug=debug)
+        except Exception:
+            return {}
+
+    from meerschaum.utils.daemon import get_daemons
+    daemons = get_daemons()
+    return {
+        daemon.daemon_id: Job(name=daemon.daemon_id)
+        for daemon in daemons
+    }
+
+
+def get_filtered_jobs(
+    executor_keys: Optional[str] = None,
+    filter_list: Optional[List[str]] = None,
+    warn: bool = False,
+    debug: bool = False,
+) -> Dict[str, Job]:
+    """
+    Return a list of jobs filtered by the user.
+    """
+    from meerschaum.utils.warnings import warn as _warn
+    jobs = get_jobs(executor_keys, debug=debug)
+
+    if not filter_list:
+        return {
+            name: job
+            for name, job in jobs.items()
+            if not job.hidden
+        }
+
+    jobs_to_return = {}
+    for name in filter_list:
+        job = jobs.get(name, None)
+        if job is None:
+            if warn:
+                _warn(
+                    f"Job '{name}' does not exist.",
+                    stack=False,
+                )
+            continue
+        jobs_to_return[name] = job
+
+    return jobs_to_return
+
+
+def get_restart_jobs(
+    executor_keys: Optional[str] = None,
+    jobs: Optional[Dict[str, Job]] = None,
+    debug: bool = False,
+) -> Dict[str, Job]:
+    """
+    Return jobs which were created with `--restart` or `--loop`.
+    """
+    if jobs is None:
+        jobs = get_jobs(executor_keys, debug=debug)
+
+    return {
+        name: job
+        for name, job in jobs.items()
+        if job.restart
+    }
+
+
+def get_running_jobs(
+    executor_keys: Optional[str] = None,
+    jobs: Optional[Dict[str, Job]] = None,
+    debug: bool = False,
+) -> Dict[str, Job]:
+    """
+    Return a dictionary of running jobs.
+    """
+    if jobs is None:
+        jobs = get_jobs(executor_keys, debug=debug)
+
+    return {
+        name: job
+        for name, job in jobs.items()
+        if job.status == 'running'
+    }
+
+
+def get_paused_jobs(
+    executor_keys: Optional[str] = None,
+    jobs: Optional[Dict[str, Job]] = None,
+    debug: bool = False,
+) -> Dict[str, Job]:
+    """
+    Return a dictionary of paused jobs.
+    """
+    if jobs is None:
+        jobs = get_jobs(executor_keys, debug=debug)
+
+    return {
+        name: job
+        for name, job in jobs.items()
+        if job.status == 'paused'
+    }
+
+
+def get_stopped_jobs(
+    executor_keys: Optional[str] = None,
+    jobs: Optional[Dict[str, Job]] = None,
+    debug: bool = False,
+) -> Dict[str, Job]:
+    """
+    Return a dictionary of stopped jobs.
+    """
+    if jobs is None:
+        jobs = get_jobs(executor_keys, debug=debug)
+
+    return {
+        name: job
+        for name, job in jobs.items()
+        if job.status == 'stopped'
+    }
+
+
+def check_restart_jobs(
+    executor_keys: Optional[str] = None,
+    silent: bool = False,
+) -> None:
+    """
+    Restart any stopped jobs which were created with `--restart`.
+
+    Parameters
+    ----------
+    executor_keys: Optional[str], default None
+        If provided, check jobs on the given remote API instance.
+        Otherwise check local jobs.
+
+    silent: bool, default False
+        If `True`, do not print the restart success message.
+    """
+    jobs = get_jobs(executor_keys)
+    for name, job in jobs.items():
+        success, msg = job.check_restart()
+        if not silent:
+            mrsm.pprint((success, msg))
+
+
+def _check_restart_jobs_against_lock(*args, **kwargs):
+    from meerschaum.config.paths import CHECK_JOBS_LOCK_PATH
+    fasteners = mrsm.attempt_import('fasteners')
+    lock = fasteners.InterProcessLock(CHECK_JOBS_LOCK_PATH)
+    with lock:
+        check_restart_jobs(*args, **kwargs)
+
+
+_check_loop_stop_thread = None
+def start_check_jobs_thread():
+    """
+    Start a thread to regularly monitor jobs.
+    """
+    import atexit
+    from functools import partial
+    from meerschaum.utils.threading import RepeatTimer
+    from meerschaum.config.static import STATIC_CONFIG
+
+    global _check_loop_stop_thread
+    sleep_seconds = STATIC_CONFIG['jobs']['check_restart_seconds']
+
+    _check_loop_stop_thread = RepeatTimer(
+        sleep_seconds,
+        partial(
+            _check_restart_jobs_against_lock,
+            silent=True,
+        )
+    )
+    _check_loop_stop_thread.daemon = False
+    atexit.register(stop_check_jobs_thread)
+
+    _check_loop_stop_thread.start()
+
+
+def stop_check_jobs_thread():
+    """
+    Stop the job monitoring thread.
+    """
+    from meerschaum.config.paths import CHECK_JOBS_LOCK_PATH
+    from meerschaum.utils.warnings import warn
+    if _check_loop_stop_thread is None:
+        return
+
+    _check_loop_stop_thread.cancel()
+
+    try:
+        if CHECK_JOBS_LOCK_PATH.exists():
+            CHECK_JOBS_LOCK_PATH.unlink()
+    except Exception as e:
+        warn(f"Failed to remove check jobs lock file:\n{e}")

meerschaum/utils/misc.py

@@ -875,7 +875,7 @@ def dict_from_od(od: collections.OrderedDict) -> Dict[Any, Any]:
             _d[k] = dict_from_od(v)
     return _d
 
-def remove_ansi(s : str) -> str:
+def remove_ansi(s: str) -> str:
     """
     Remove ANSI escape characters from a string.
 
@@ -899,10 +899,10 @@ def remove_ansi(s : str) -> str:
 
 
 def get_connector_labels(
-        *types: str,
-        search_term: str = '',
-        ignore_exact_match = True,
-    ) -> List[str]:
+    *types: str,
+    search_term: str = '',
+    ignore_exact_match = True,
+) -> List[str]:
     """
     Read connector labels from the configuration dictionary.
 
@@ -1063,7 +1063,7 @@ def async_wrap(func):
             loop = asyncio.get_event_loop()
         pfunc = partial(func, *args, **kwargs)
         return await loop.run_in_executor(executor, pfunc)
-    return run 
+    return run
 
 
 def debug_trace(browser: bool = True):
@@ -1077,17 +1077,17 @@ def debug_trace(browser: bool = True):
 
 
 def items_str(
-        items: List[Any],
-        quotes: bool = True,
-        quote_str: str = "'",
-        commas: bool = True,
-        comma_str: str = ',',
-        and_: bool = True,
-        and_str: str = 'and',
-        oxford_comma: bool = True,
-        spaces: bool = True,
-        space_str = ' ',
-    ) -> str:
+    items: List[Any],
+    quotes: bool = True,
+    quote_str: str = "'",
+    commas: bool = True,
+    comma_str: str = ',',
+    and_: bool = True,
+    and_str: str = 'and',
+    oxford_comma: bool = True,
+    spaces: bool = True,
+    space_str = ' ',
+) -> str:
     """
     Return a formatted string if list items separated by commas.
 
@@ -1522,6 +1522,7 @@ def safely_extract_tar(tarf: 'file', output_dir: Union[str, 'pathlib.Path']) ->
 
     return safe_extract(tarf, output_dir)
 
+
 ##################
 # Legacy imports #
 ##################

meerschaum/utils/packages/_packages.py

@@ -48,7 +48,7 @@ packages: Dict[str, Dict[str, str]] = {
         'prompt_toolkit'             : 'prompt-toolkit>=3.0.39',
         'more_itertools'             : 'more-itertools>=8.7.0',
         'daemon'                     : 'python-daemon>=0.2.3',
-        'fasteners'                  : 'fasteners>=0.18.0',
+        'fasteners'                  : 'fasteners>=0.19.0',
         'psutil'                     : 'psutil>=5.8.0',
         'watchfiles'                 : 'watchfiles>=0.21.0',
         'dill'                       : 'dill>=0.3.3',
@@ -58,7 +58,7 @@ packages: Dict[str, Dict[str, str]] = {
     },
     'drivers': {
         'cryptography'               : 'cryptography>=38.0.1',
-        'psycopg'                    : 'psycopg[binary]>=3.1.18',
+        'psycopg'                    : 'psycopg[binary]>=3.2.1',
         'pymysql'                    : 'PyMySQL>=0.9.0',
         'aiomysql'                   : 'aiomysql>=0.0.21',
         'sqlalchemy_cockroachdb'     : 'sqlalchemy-cockroachdb>=2.0.0',

meerschaum/utils/prompt.py

@@ -66,6 +66,7 @@ def prompt(
     from meerschaum.config import get_config
     from meerschaum.config.static import _static_config
     from meerschaum.utils.misc import filter_keywords
+    from meerschaum.utils.daemon import running_in_daemon
     noask = check_noask(noask)
     if not noask:
         prompt_toolkit = attempt_import('prompt_toolkit')
@@ -102,14 +103,21 @@ def prompt(
         question += '\n' + other_lines
     question += ' '
 
-    answer = (
-        prompt_toolkit.prompt(
-            prompt_toolkit.formatted_text.ANSI(question),
-            wrap_lines = wrap_lines,
-            default = default_editable or '',
-            **filter_keywords(prompt_toolkit.prompt, **kw)
-        ) if not noask else ''
-    )
+    if not running_in_daemon():
+        answer = (
+            prompt_toolkit.prompt(
+                prompt_toolkit.formatted_text.ANSI(question),
+                wrap_lines = wrap_lines,
+                default = default_editable or '',
+                **filter_keywords(prompt_toolkit.prompt, **kw)
+            ) if not noask else ''
+        )
+    else:
+        print(question, end='', flush=True)
+        try:
+            answer = input()
+        except EOFError:
+            answer = ''
     if noask:
         print(question)
     if answer == '' and default is not None:

{meerschaum-2.2.7.dist-info → meerschaum-2.3.0.dev3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meerschaum
-Version: 2.2.7
+Version: 2.3.0.dev3
 Summary: Sync Time-Series Pipes with Meerschaum
 Home-page: https://meerschaum.io
 Author: Bennett Meares
@@ -51,7 +51,7 @@ Requires-Dist: databases >=0.4.0 ; extra == 'api'
 Requires-Dist: aiosqlite >=0.16.0 ; extra == 'api'
 Requires-Dist: asyncpg >=0.21.0 ; extra == 'api'
 Requires-Dist: cryptography >=38.0.1 ; extra == 'api'
-Requires-Dist: psycopg[binary] >=3.1.18 ; extra == 'api'
+Requires-Dist: psycopg[binary] >=3.2.1 ; extra == 'api'
 Requires-Dist: PyMySQL >=0.9.0 ; extra == 'api'
 Requires-Dist: aiomysql >=0.0.21 ; extra == 'api'
 Requires-Dist: sqlalchemy-cockroachdb >=2.0.0 ; extra == 'api'
@@ -74,7 +74,7 @@ Requires-Dist: packaging >=21.3.0 ; extra == 'api'
 Requires-Dist: prompt-toolkit >=3.0.39 ; extra == 'api'
 Requires-Dist: more-itertools >=8.7.0 ; extra == 'api'
 Requires-Dist: python-daemon >=0.2.3 ; extra == 'api'
-Requires-Dist: fasteners >=0.18.0 ; extra == 'api'
+Requires-Dist: fasteners >=0.19.0 ; extra == 'api'
 Requires-Dist: psutil >=5.8.0 ; extra == 'api'
 Requires-Dist: watchfiles >=0.21.0 ; extra == 'api'
 Requires-Dist: dill >=0.3.3 ; extra == 'api'
@@ -124,7 +124,7 @@ Requires-Dist: packaging >=21.3.0 ; extra == 'core'
 Requires-Dist: prompt-toolkit >=3.0.39 ; extra == 'core'
 Requires-Dist: more-itertools >=8.7.0 ; extra == 'core'
 Requires-Dist: python-daemon >=0.2.3 ; extra == 'core'
-Requires-Dist: fasteners >=0.18.0 ; extra == 'core'
+Requires-Dist: fasteners >=0.19.0 ; extra == 'core'
 Requires-Dist: psutil >=5.8.0 ; extra == 'core'
 Requires-Dist: watchfiles >=0.21.0 ; extra == 'core'
 Requires-Dist: dill >=0.3.3 ; extra == 'core'
@@ -161,7 +161,7 @@ Requires-Dist: mkdocs-redirects >=1.0.4 ; extra == 'docs'
 Requires-Dist: jinja2 ==3.0.3 ; extra == 'docs'
 Provides-Extra: drivers
 Requires-Dist: cryptography >=38.0.1 ; extra == 'drivers'
-Requires-Dist: psycopg[binary] >=3.1.18 ; extra == 'drivers'
+Requires-Dist: psycopg[binary] >=3.2.1 ; extra == 'drivers'
 Requires-Dist: PyMySQL >=0.9.0 ; extra == 'drivers'
 Requires-Dist: aiomysql >=0.0.21 ; extra == 'drivers'
 Requires-Dist: sqlalchemy-cockroachdb >=2.0.0 ; extra == 'drivers'
@@ -211,7 +211,7 @@ Requires-Dist: packaging >=21.3.0 ; extra == 'full'
 Requires-Dist: prompt-toolkit >=3.0.39 ; extra == 'full'
 Requires-Dist: more-itertools >=8.7.0 ; extra == 'full'
 Requires-Dist: python-daemon >=0.2.3 ; extra == 'full'
-Requires-Dist: fasteners >=0.18.0 ; extra == 'full'
+Requires-Dist: fasteners >=0.19.0 ; extra == 'full'
 Requires-Dist: psutil >=5.8.0 ; extra == 'full'
 Requires-Dist: watchfiles >=0.21.0 ; extra == 'full'
 Requires-Dist: dill >=0.3.3 ; extra == 'full'
@@ -219,7 +219,7 @@ Requires-Dist: virtualenv >=20.1.0 ; extra == 'full'
 Requires-Dist: APScheduler >=4.0.0a5 ; extra == 'full'
 Requires-Dist: uv >=0.2.11 ; extra == 'full'
 Requires-Dist: cryptography >=38.0.1 ; extra == 'full'
-Requires-Dist: psycopg[binary] >=3.1.18 ; extra == 'full'
+Requires-Dist: psycopg[binary] >=3.2.1 ; extra == 'full'
 Requires-Dist: PyMySQL >=0.9.0 ; extra == 'full'
 Requires-Dist: aiomysql >=0.0.21 ; extra == 'full'
 Requires-Dist: sqlalchemy-cockroachdb >=2.0.0 ; extra == 'full'
@@ -273,7 +273,7 @@ Requires-Dist: databases >=0.4.0 ; extra == 'sql'
 Requires-Dist: aiosqlite >=0.16.0 ; extra == 'sql'
 Requires-Dist: asyncpg >=0.21.0 ; extra == 'sql'
 Requires-Dist: cryptography >=38.0.1 ; extra == 'sql'
-Requires-Dist: psycopg[binary] >=3.1.18 ; extra == 'sql'
+Requires-Dist: psycopg[binary] >=3.2.1 ; extra == 'sql'
 Requires-Dist: PyMySQL >=0.9.0 ; extra == 'sql'
 Requires-Dist: aiomysql >=0.0.21 ; extra == 'sql'
 Requires-Dist: sqlalchemy-cockroachdb >=2.0.0 ; extra == 'sql'
@@ -296,7 +296,7 @@ Requires-Dist: packaging >=21.3.0 ; extra == 'sql'
 Requires-Dist: prompt-toolkit >=3.0.39 ; extra == 'sql'
 Requires-Dist: more-itertools >=8.7.0 ; extra == 'sql'
 Requires-Dist: python-daemon >=0.2.3 ; extra == 'sql'
-Requires-Dist: fasteners >=0.18.0 ; extra == 'sql'
+Requires-Dist: fasteners >=0.19.0 ; extra == 'sql'
 Requires-Dist: psutil >=5.8.0 ; extra == 'sql'
 Requires-Dist: watchfiles >=0.21.0 ; extra == 'sql'
 Requires-Dist: dill >=0.3.3 ; extra == 'sql'