meerschaum 2.2.6__tar.gz → 2.3.0__tar.gz

{meerschaum-2.2.6/meerschaum.egg-info → meerschaum-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meerschaum
-Version: 2.2.6
+Version: 2.3.0
 Summary: Sync Time-Series Pipes with Meerschaum
 Home-page: https://meerschaum.io
 Author: Bennett Meares
@@ -59,17 +59,18 @@ Requires-Dist: aiofiles>=0.6.0; extra == "core"
 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: psutil>=5.8.0; extra == "core"
-Requires-Dist: watchfiles>=0.21.0; extra == "core"
-Requires-Dist: dill>=0.3.3; extra == "core"
+Requires-Dist: fasteners>=0.19.0; extra == "core"
 Requires-Dist: virtualenv>=20.1.0; extra == "core"
 Requires-Dist: APScheduler>=4.0.0a5; extra == "core"
 Requires-Dist: uv>=0.2.11; extra == "core"
+Provides-Extra: jobs
+Requires-Dist: dill>=0.3.3; extra == "jobs"
+Requires-Dist: python-daemon>=0.2.3; extra == "jobs"
+Requires-Dist: watchfiles>=0.21.0; extra == "jobs"
+Requires-Dist: psutil>=5.8.0; extra == "jobs"
 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"
@@ -131,7 +132,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"
@@ -153,11 +154,7 @@ Requires-Dist: aiofiles>=0.6.0; extra == "sql"
 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: psutil>=5.8.0; extra == "sql"
-Requires-Dist: watchfiles>=0.21.0; extra == "sql"
-Requires-Dist: dill>=0.3.3; extra == "sql"
+Requires-Dist: fasteners>=0.19.0; extra == "sql"
 Requires-Dist: virtualenv>=20.1.0; extra == "sql"
 Requires-Dist: APScheduler>=4.0.0a5; extra == "sql"
 Requires-Dist: uv>=0.2.11; extra == "sql"
@@ -190,7 +187,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"
@@ -212,11 +209,7 @@ Requires-Dist: aiofiles>=0.6.0; extra == "api"
 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: psutil>=5.8.0; extra == "api"
-Requires-Dist: watchfiles>=0.21.0; extra == "api"
-Requires-Dist: dill>=0.3.3; extra == "api"
+Requires-Dist: fasteners>=0.19.0; extra == "api"
 Requires-Dist: virtualenv>=20.1.0; extra == "api"
 Requires-Dist: APScheduler>=4.0.0a5; extra == "api"
 Requires-Dist: uv>=0.2.11; extra == "api"
@@ -236,6 +229,10 @@ Requires-Dist: dash-extensions>=1.0.4; extra == "api"
 Requires-Dist: dash-daq>=0.5.0; extra == "api"
 Requires-Dist: terminado>=0.12.1; extra == "api"
 Requires-Dist: tornado>=6.1.0; extra == "api"
+Requires-Dist: dill>=0.3.3; extra == "api"
+Requires-Dist: python-daemon>=0.2.3; extra == "api"
+Requires-Dist: watchfiles>=0.21.0; extra == "api"
+Requires-Dist: psutil>=5.8.0; extra == "api"
 Provides-Extra: full
 Requires-Dist: pprintpp>=0.4.0; extra == "full"
 Requires-Dist: asciitree>=0.3.3; extra == "full"
@@ -261,16 +258,16 @@ Requires-Dist: aiofiles>=0.6.0; extra == "full"
 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: psutil>=5.8.0; extra == "full"
-Requires-Dist: watchfiles>=0.21.0; extra == "full"
-Requires-Dist: dill>=0.3.3; extra == "full"
+Requires-Dist: fasteners>=0.19.0; extra == "full"
 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: dill>=0.3.3; extra == "full"
+Requires-Dist: python-daemon>=0.2.3; extra == "full"
+Requires-Dist: watchfiles>=0.21.0; extra == "full"
+Requires-Dist: psutil>=5.8.0; 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"

{meerschaum-2.2.6 → meerschaum-2.3.0}/meerschaum/__init__.py

@@ -20,15 +20,17 @@ limitations under the License.
 
 import atexit
 from meerschaum.utils.typing import SuccessTuple
+from meerschaum.utils.packages import attempt_import
 from meerschaum.core.Pipe import Pipe
 from meerschaum.plugins import Plugin
 from meerschaum.utils.venv import Venv
+from meerschaum.jobs import Job, make_executor
 from meerschaum.connectors import get_connector, Connector, make_connector
 from meerschaum.utils import get_pipes
 from meerschaum.utils.formatting import pprint
 from meerschaum._internal.docs import index as __doc__
 from meerschaum.config import __version__, get_config
-from meerschaum.utils.packages import attempt_import
+from meerschaum._internal.entry import entry
 from meerschaum.__main__ import _close_pools
 
 atexit.register(_close_pools)
@@ -42,14 +44,17 @@ __all__ = (
     "Plugin",
     "Venv",
     "Plugin",
+    "Job",
     "pprint",
     "attempt_import",
     "actions",
     "config",
     "connectors",
+    "jobs",
     "plugins",
     "utils",
     "SuccessTuple",
     "Connector",
     "make_connector",
+    "entry",
 )

{meerschaum-2.2.6 → meerschaum-2.3.0}/meerschaum/__main__.py

@@ -19,9 +19,15 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
-import sys, os, copy
+import sys
+import os
+import copy
 
-def main(sysargs: list = None) -> None:
+from meerschaum.utils.typing import List, Optional
+from meerschaum.utils.formatting import print_tuple as _print_tuple
+
+
+def main(sysargs: Optional[List[str]] = None) -> None:
     """Main CLI entry point."""
     if sysargs is None:
         sysargs = copy.deepcopy(sys.argv[1:])
@@ -39,11 +45,6 @@ def main(sysargs: list = None) -> None:
         parse_version(sysargs)
         return _exit(old_cwd=old_cwd)
 
-    if ('-d' in sysargs or '--daemon' in sysargs) and ('stack' not in sysargs):
-        from meerschaum.utils.daemon import daemon_entry
-        daemon_entry(sysargs)
-        return _exit(old_cwd=old_cwd)
-
     from meerschaum._internal.entry import entry, get_shell
 
     ### Try to launch a shell if --shell is provided.
@@ -57,8 +58,7 @@ def main(sysargs: list = None) -> None:
     return_tuple = entry(sysargs)
     rc = 0
     if isinstance(return_tuple, tuple) and '--nopretty' not in sysargs:
-        from meerschaum.utils.formatting import print_tuple
-        print_tuple(return_tuple, upper_padding=1)
+        _print_tuple(return_tuple, upper_padding=1)
         rc = 0 if (return_tuple[0] is True) else 1
 
     return _exit(rc, old_cwd=old_cwd)

{meerschaum-2.2.6 → meerschaum-2.3.0}/meerschaum/_internal/arguments/__init__.py

@@ -8,7 +8,7 @@ This package includes argument parsing utilities.
 
 from meerschaum._internal.arguments._parse_arguments import (
     parse_arguments, parse_line, remove_leading_action,
-    parse_dict_to_sysargs,
+    parse_dict_to_sysargs, split_chained_sysargs, split_pipeline_sysargs,
 )
 from meerschaum._internal.arguments._parser import parser
 from meerschaum.plugins import add_plugin_argument

{meerschaum-2.2.6 → meerschaum-2.3.0}/meerschaum/_internal/arguments/_parse_arguments.py

@@ -10,7 +10,7 @@ This module contains functions for parsing arguments
 from __future__ import annotations
 import json
 from datetime import timedelta
-from meerschaum.utils.typing import List, Dict, Any, Optional, Callable, SuccessTuple
+from meerschaum.utils.typing import List, Dict, Any, Optional, Callable, SuccessTuple, Tuple
 from meerschaum.utils.threading import RLock
 
 _locks = {
@@ -18,6 +18,59 @@ _locks = {
 }
 _loaded_plugins_args: bool = False
 
+def split_pipeline_sysargs(sysargs: List[str]) -> Tuple[List[str], List[str]]:
+    """
+    Split `sysargs` into the main pipeline and the flags following the pipeline separator (`:`).
+    """
+    from meerschaum.config.static import STATIC_CONFIG
+    pipeline_key = STATIC_CONFIG['system']['arguments']['pipeline_key']
+    if pipeline_key not in sysargs:
+        return sysargs, []
+
+    ### Find the index of the last occurrence of `:`.
+    pipeline_ix = len(sysargs) - 1 - sysargs[::-1].index(pipeline_key)
+    sysargs_after_pipeline_key = sysargs[pipeline_ix+1:]
+    sysargs = [arg for arg in sysargs[:pipeline_ix] if arg != pipeline_key]
+    return sysargs, sysargs_after_pipeline_key
+
+
+def split_chained_sysargs(sysargs: List[str]) -> List[List[str]]:
+    """
+    Split a `sysargs` list containing "and" keys (`+`)
+    into a list of individual `sysargs`.
+    """
+    from meerschaum.config.static import STATIC_CONFIG
+    and_key = STATIC_CONFIG['system']['arguments']['and_key']
+
+    if not sysargs or and_key not in sysargs:
+        return [sysargs]
+
+    ### Coalesce and consecutive joiners into one.
+    coalesce_args = []
+    previous_arg = None
+    for arg in [_arg for _arg in sysargs]:
+        if arg == and_key and previous_arg == and_key:
+            continue
+        coalesce_args.append(arg)
+        previous_arg = arg
+
+    ### Remove any joiners from the ends.
+    if coalesce_args[0] == and_key:
+        coalesce_args = coalesce_args[1:]
+    if coalesce_args[-1] == and_key:
+        coalesce_args = coalesce_args[:-1]
+
+    chained_sysargs = []
+    current_sysargs = []
+    for arg in coalesce_args:
+        if arg != and_key:
+            current_sysargs.append(arg)
+        else:
+            chained_sysargs.append(current_sysargs)
+            current_sysargs = []
+    chained_sysargs.append(current_sysargs)
+    return chained_sysargs
+
 
 def parse_arguments(sysargs: List[str]) -> Dict[str, Any]:
     """
@@ -206,9 +259,14 @@ def parse_dict_to_sysargs(
     args_dict: Dict[str, Any]
 ) -> List[str]:
     """Revert an arguments dictionary back to a command line list."""
+    import shlex
     from meerschaum._internal.arguments._parser import get_arguments_triggers
-    sysargs = []
-    sysargs += args_dict.get('action', [])
+    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum.utils.warnings import warn
+
+    action = args_dict.get('action', None)
+    sysargs: List[str] = []
+    sysargs.extend(action or [])
     allow_none_args = {'location_keys'}
 
     triggers = get_arguments_triggers()
@@ -216,6 +274,7 @@ def parse_dict_to_sysargs(
     for a, t in triggers.items():
         if a == 'action' or a not in args_dict:
             continue
+
         ### Add boolean flags
         if isinstance(args_dict[a], bool):
             if args_dict[a] is True:
@@ -288,9 +347,6 @@ def remove_leading_action(
     for a in action:
         _action.append(a.replace('_', UNDERSCORE_STANDIN))
 
-    ### e.g. 'show_pipes_baz'
-    action_str = '_'.join(_action)
-
     ### e.g. 'show_pipes'
     action_name = action_function.__name__.lstrip('_')
 
@@ -300,6 +356,16 @@ def remove_leading_action(
     ### Strip away any leading prefices.
     action_name = action_name[main_action_index:]
 
+    subaction_parts = action_name.replace(main_action_name, '').lstrip('_').split('_')
+    subaction_name = subaction_parts[0] if subaction_parts else None
+
+    ### e.g. 'pipe' -> 'pipes'
+    if subaction_name and subaction_name.endswith('s') and not action[1].endswith('s'):
+        _action[1] += 's'
+
+    ### e.g. 'show_pipes_baz'
+    action_str = '_'.join(_action)
+
     if not action_str.replace(UNDERSCORE_STANDIN, '_').startswith(action_name):
         warn(f"Unable to parse '{action_str}' for action '{action_name}'.")
         return action

{meerschaum-2.2.6 → meerschaum-2.3.0}/meerschaum/_internal/arguments/_parser.py

@@ -62,7 +62,24 @@ def parse_datetime(dt_str: str) -> Union[datetime, int, str]:
     return dt
 
 
-def parse_help(sysargs : Union[List[str], Dict[str, Any]]) -> None:
+def parse_executor_keys(executor_keys_str: str) -> Union[str, None]:
+    """
+    Ensure that only API keys are provided for executor_keys.
+    """
+    if executor_keys_str in ('local', 'systemd'):
+        return executor_keys_str
+
+    if executor_keys_str.lower() == 'none':
+        return 'local'
+
+    if not executor_keys_str.startswith('api:'):
+        from meerschaum.utils.warnings import error
+        error(f"Invalid exectutor keys '{executor_keys_str}'.", stack=False)
+
+    return executor_keys_str
+
+
+def parse_help(sysargs: Union[List[str], Dict[str, Any]]) -> None:
     """Parse the `--help` flag to determine which help message to print."""
     from meerschaum._internal.arguments._parse_arguments import parse_arguments, parse_line
     from meerschaum.actions import actions, get_subactions
@@ -135,6 +152,7 @@ _seen_plugin_args = {}
 
 groups = {}
 groups['actions'] = parser.add_argument_group(title='Actions options')
+groups['jobs'] = parser.add_argument_group(title='Jobs options')
 groups['pipes'] = parser.add_argument_group(title='Pipes options')
 groups['sync'] = parser.add_argument_group(title='Sync options')
 groups['api'] = parser.add_argument_group(title='API options')
@@ -166,18 +184,25 @@ groups['actions'].add_argument(
     help="Automatically choose the defaults answers to questions. Does not result in data loss.",
 )
 groups['actions'].add_argument(
-    '-d', '--daemon', action='store_true',
-    help = "Run an action as a background daemon."
+    '-A', '--sub-args', nargs=argparse.REMAINDER,
+    help = (
+        "Provide a list of arguments for subprocesses. " +
+        "You can also type sub-arguments in [] instead." +
+        " E.g. `stack -A='--version'`, `ls [-lh]`, `echo -A these are sub-arguments`"
+    )
 )
-groups['actions'].add_argument(
-    '--rm', action='store_true', help="Delete a job once it has finished executing."
+
+### Jobs options
+groups['jobs'].add_argument(
+    '-d', '--daemon', action='store_true',
+    help = "Run an action as a background daemon to create a job."
 )
-groups['actions'].add_argument(
+groups['jobs'].add_argument(
     '--name', '--job-name', type=parse_name, help=(
         "Assign a name to a job. If no name is provided, a random name will be assigned."
     ),
 )
-groups['actions'].add_argument(
+groups['jobs'].add_argument(
     '-s', '--schedule', '--cron', type=str,
     help = (
         "Continue executing the action according to a schedule (e.g. 'every 1 seconds'). \n"
@@ -185,15 +210,20 @@ groups['actions'].add_argument(
         + "https://red-engine.readthedocs.io/en/stable/condition_syntax/index.html"
     )
 )
-groups['actions'].add_argument(
-    '-A', '--sub-args', nargs=argparse.REMAINDER,
-    help = (
-        "Provide a list of arguments for subprocesses. " +
-        "You can also type sub-arguments in [] instead." +
-        " E.g. `stack -A='--version'`, `ls [-lh]`, `echo -A these are sub-arguments`"
-    )
+groups['jobs'].add_argument(
+    '--restart', action='store_true',
+    help=("Restart a job if not stopped manually."),
+)
+groups['jobs'].add_argument(
+    '-e', '--executor-keys', type=parse_executor_keys,
+    help=(
+        "Execute jobs locally or remotely. "
+        "Supported values are 'local', 'systemd', and 'api:{label}'."
+    ),
+)
+groups['jobs'].add_argument(
+    '--rm', action='store_true', help="Delete a job once it has finished executing."
 )
-
 ### Pipes options
 groups['pipes'].add_argument(
     '-c', '-C', '--connector-keys', nargs='+',