meerschaum 2.2.4__py3-none-any.whl → 2.2.5.dev2__py3-none-any.whl

meerschaum/_internal/arguments/_parse_arguments.py

@@ -80,8 +80,9 @@ def parse_arguments(sysargs: List[str]) -> Dict[str, Any]:
 
     ### rebuild sysargs without sub_arguments
     filtered_sysargs = [
-        word for i, word in enumerate(sysargs)
-            if i not in sub_arg_indices
+        word
+        for i, word in enumerate(sysargs)
+        if i not in sub_arg_indices
     ]
 
     try:
@@ -99,7 +100,6 @@ def parse_arguments(sysargs: List[str]) -> Dict[str, Any]:
         except Exception as _e:
             args_dict['text'] = ' '.join(sysargs)
         args_dict[STATIC_CONFIG['system']['arguments']['failure_key']] = e
-        unknown = []
 
     false_flags = [arg for arg, val in args_dict.items() if val is False]
     for arg in false_flags:
@@ -126,17 +126,26 @@ def parse_arguments(sysargs: List[str]) -> Dict[str, Any]:
 
     ### remove None (but not False) args
     none_args = []
+    none_args_keep = []
     for a, v in args_dict.items():
         if v is None:
             none_args.append(a)
+        elif v == 'None':
+            none_args_keep.append(a)
     for a in none_args:
         del args_dict[a]
+    for a in none_args_keep:
+        args_dict[a] = None
 
     ### location_key '[None]' or 'None' -> None
     if 'location_keys' in args_dict:
         args_dict['location_keys'] = [
-            None if lk in ('[None]', 'None')
-            else lk for lk in args_dict['location_keys'] 
+            (
+                None
+                if lk in ('[None]', 'None')
+                else lk
+            )
+            for lk in args_dict['location_keys']
         ]
 
     return parse_synonyms(args_dict)
@@ -145,7 +154,7 @@ def parse_arguments(sysargs: List[str]) -> Dict[str, Any]:
 def parse_line(line: str) -> Dict[str, Any]:
     """
     Parse a line of text into standard Meerschaum arguments.
-    
+
     Parameters
     ----------
     line: str
@@ -165,12 +174,12 @@ def parse_line(line: str) -> Dict[str, Any]:
     try:
         return parse_arguments(shlex.split(line))
     except Exception as e:
-        return {'action': [], 'text': line,}
+        return {'action': [], 'text': line}
 
 
 def parse_synonyms(
-        args_dict: Dict[str, Any]
-    ) -> Dict[str, Any]:
+    args_dict: Dict[str, Any]
+) -> Dict[str, Any]:
     """Check for synonyms (e.g. `async` = `True` -> `unblock` = `True`)"""
     if args_dict.get('async', None):
         args_dict['unblock'] = True
@@ -194,8 +203,8 @@ def parse_synonyms(
 
 
 def parse_dict_to_sysargs(
-        args_dict : Dict[str, Any]
-    ) -> List[str]:
+    args_dict: Dict[str, Any]
+) -> List[str]:
     """Revert an arguments dictionary back to a command line list."""
     from meerschaum._internal.arguments._parser import get_arguments_triggers
     sysargs = []
@@ -230,9 +239,9 @@ def parse_dict_to_sysargs(
 
 
 def remove_leading_action(
-        action: List[str],
-        _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
-    ) -> List[str]:
+    action: List[str],
+    _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
+) -> List[str]:
     """
     Remove the leading strings in the `action` list.
 

meerschaum/_internal/arguments/_parser.py

@@ -37,12 +37,15 @@ class ArgumentParser(argparse.ArgumentParser):
         return result
 
 
-def parse_datetime(dt_str: str) -> datetime:
+def parse_datetime(dt_str: str) -> Union[datetime, int, str]:
     """Parse a string into a datetime."""
     from meerschaum.utils.misc import is_int
     if is_int(dt_str):
         return int(dt_str)
 
+    if dt_str in ('None', '[None]'):
+        return 'None'
+
     from meerschaum.utils.packages import attempt_import
     dateutil_parser = attempt_import('dateutil.parser')
 

meerschaum/_internal/entry.py

@@ -47,9 +47,6 @@ def entry(sysargs: Optional[List[str]] = None) -> SuccessTuple:
                 )
             )
 
-    #  if args.get('schedule', None):
-        #  from meerschaum.utils.schedule import schedule_function
-        #  return schedule_function(entry_with_args, **args)
     return entry_with_args(**args)
 
 
@@ -122,11 +119,12 @@ def entry_with_args(
 def _do_action_wrapper(action_function, plugin_name, **kw):
     from meerschaum.plugins import Plugin
     from meerschaum.utils.venv import Venv, active_venvs, deactivate_venv
+    from meerschaum.utils.misc import filter_keywords
     plugin = Plugin(plugin_name) if plugin_name else None
     with Venv(plugin, debug=kw.get('debug', False)):
         action_name = ' '.join(action_function.__name__.split('_') + kw.get('action', []))
         try:
-            result = action_function(**kw)
+            result = action_function(**filter_keywords(action_function, **kw))
         except Exception as e:
             if kw.get('debug', False):
                 import traceback

meerschaum/_internal/shell/Shell.py

@@ -182,7 +182,6 @@ def _check_complete_keys(line: str) -> Optional[List[str]]:
             is_trigger = True
         elif line.endswith(' '):
             ### return empty list so we don't try to parse an incomplete line.
-            #  print('ABORT')
             return []
 
     from meerschaum.utils.misc import get_connector_labels
@@ -196,8 +195,6 @@ def _check_complete_keys(line: str) -> Optional[List[str]]:
             if line.rstrip(' ').endswith(trigger):
                 return get_connector_labels()
 
-            #  args = parse_line(line.rstrip(' '))
-            #  search_term = args[var] if var != 'connector_keys' else args[var][0]
             return get_connector_labels(search_term=last_word.rstrip(' '))
 
     return None

meerschaum/actions/__init__.py

@@ -40,7 +40,11 @@ def get_subactions(
     for name, f in inspect.getmembers(action_module):
         if not inspect.isfunction(f):
             continue
-        if action_function.__name__ + '_' in name and not name.lstrip('_').startswith('complete'):
+
+        ### Detect subactions which may contain an underscore prefix.
+        if (
+            name.lstrip('_').startswith(action_function.__name__.lstrip('_') + '_')
+        ):
             _name = name.replace(action_function.__name__, '')
             _name = _name.lstrip('_')
             subactions[_name] = f

meerschaum/actions/backup.py

@@ -0,0 +1,43 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+
+"""
+Backup the stack database.
+"""
+
+from __future__ import annotations
+from meerschaum.utils.typing import SuccessTuple, Any, List, Optional, Union
+
+def backup(
+        action: Optional[List[str]] = None,
+        **kwargs: Any
+    ) -> SuccessTuple:
+    """
+    Backup the stack database.
+    """
+    from meerschaum.actions import choose_subaction
+    options = {
+        'database'        : _backup_database,
+    }
+    return choose_subaction(action, options, **kwargs)
+
+
+def _backup_database(
+        action: Optional[List[str]] = None,
+    ) -> SuccessTuple:
+    """
+    Backup the stack's database to a sql file.
+    """
+    from meerschaum.actions import get_action
+    from meerschaum.config.paths import BACKUP_RESOURCES_PATH
+    do_stack = get_action('stack')
+    cmd_list = ['exec', 'db', 'pg']
+    stack_success, stack_msg = do_stack(['exec'])
+    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.
+from meerschaum.utils.misc import choices_docstring as _choices_docstring
+backup.__doc__ += _choices_docstring('backup')

meerschaum/actions/bootstrap.py

@@ -25,6 +25,7 @@ def bootstrap(
     options = {
         'pipes'      : _bootstrap_pipes,
         'connectors' : _bootstrap_connectors,
+        'plugins'    : _bootstrap_plugins,
     }
     return choose_subaction(action, options, **kw)
 
@@ -102,12 +103,14 @@ def _bootstrap_pipes(
         )
         try:
             ck = choose(
-                f"Where are the data coming from?\n\n" +
-                f"    Please type the keys of a connector from below,\n" +
-                f"    or enter '{new_label}' to register a new connector.\n\n" +
-                f" {get_config('formatting', 'emoji', 'connector')} Connector:\n",
+                (
+                    "Where are the data coming from?\n\n" +
+                    f"    Please type the keys of a connector or enter '{new_label}'\n" +
+                    "    to register a new connector.\n\n" +
+                    f" {get_config('formatting', 'emoji', 'connector')} Connector:"
+                ),
                 get_connector_labels() + [new_label],
-                numeric = False
+                numeric = False,
             )
         except KeyboardInterrupt:
             return abort_tuple
@@ -257,8 +260,8 @@ def _bootstrap_connectors(
         _type = choose(
             (
                 'Please choose a connector type.\n'
-                + 'For more information on connectors, '
-                + 'please visit https://meerschaum.io/reference/connectors'
+                + '    See https://meerschaum.io/reference/connectors '
+                + 'for documentation on connectors.\n'
             ),
             sorted(list(connectors)),
             default = 'sql'
@@ -382,6 +385,28 @@ def _bootstrap_connectors(
     return True, "Success"
 
 
+def _bootstrap_plugins(
+        action: Optional[List[str]] = None,
+        debug: bool = False,
+        **kwargs: Any
+    ) -> SuccessTuple:
+    """
+    Launch an interactive wizard to guide the user to creating a new plugin.
+    """
+    from meerschaum.utils.prompt import prompt
+    from meerschaum.plugins.bootstrap import bootstrap_plugin
+
+    if not action:
+        action = [prompt("Enter the name of your new plugin:")]
+
+    for plugin_name in action:
+        bootstrap_success, bootstrap_msg = bootstrap_plugin(plugin_name)
+        if not bootstrap_success:
+            return bootstrap_success, bootstrap_msg
+
+    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.

meerschaum/actions/delete.py

@@ -29,6 +29,7 @@ def delete(
         'users'      : _delete_users,
         'connectors' : _delete_connectors,
         'jobs'       : _delete_jobs,
+        'venvs'      : _delete_venvs,
     }
     return choose_subaction(action, options, **kw)
 
@@ -486,6 +487,67 @@ def _delete_jobs(
     )
 
 
+def _delete_venvs(
+        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.
+    """
+    import os
+    import shutil
+    import pathlib
+    from meerschaum.config.paths import VIRTENV_RESOURCES_PATH
+    from meerschaum.utils.venv import venv_exists
+    from meerschaum.utils.prompt import yes_no
+    from meerschaum.utils.misc import print_options
+    from meerschaum.utils.warnings import warn
+
+    venvs_to_skip = ['mrsm']
+    venvs = [
+        _venv
+        for _venv in action or os.listdir(VIRTENV_RESOURCES_PATH)
+        if venv_exists(_venv)
+        and _venv not in venvs_to_skip
+    ]
+
+    if not venvs:
+        msg = "No venvs to delete."
+        if action:
+            return False, msg
+        return True, msg
+
+    print_options(
+        venvs,
+        header = 'Venvs to Delete:',
+        **kwargs
+    )
+    confirm_delete = yes_no(
+        (
+            "Remove the above venv" + ('s' if len(venvs) != 1 else '') + "?\n    "
+            + "Run `mrsm upgrade packages` and `mrsm install required` to reinstall dependencies.\n"
+        ),
+        yes = yes,
+        default = 'n',
+        force = force,
+    )
+    if not confirm_delete:
+        return True, "Nothing was deleted."
+
+    for venv in venvs:
+        venv_path = pathlib.Path(VIRTENV_RESOURCES_PATH / venv)
+        try:
+            shutil.rmtree(venv_path)
+        except Exception as e:
+            error_msg = f"Failed to remove '{venv_path}':\n{e}"
+            return False, error_msg
+
+    msg = f"Removed {len(venvs)} venv" + ('s' if len(venvs) != 1 else '') + '.'
+    return True, msg
+
 
 ### NOTE: This must be the final statement of the module.
 ###       Any subactions added below these lines will not

meerschaum/actions/edit.py

@@ -7,6 +7,7 @@ Functions for editing elements belong here.
 """
 
 from __future__ import annotations
+import meerschaum as mrsm 
 from meerschaum.utils.typing import List, Any, SuccessTuple, Optional, Dict
 
 def edit(
@@ -22,19 +23,22 @@ def edit(
         'pipes'     : _edit_pipes,
         'definition': _edit_definition,
         'users'     : _edit_users,
+        'plugins'   : _edit_plugins,
     }
     return choose_subaction(action, options, **kw)
 
 
 def _complete_edit(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
     """
     Override the default Meerschaum `complete_` function.
     """
     options = {
         'config': _complete_edit_config,
+        'plugin': _complete_edit_plugins,
+        'plugins': _complete_edit_plugins,
     }
 
     if action is None:
@@ -78,7 +82,7 @@ def _edit_config(action : Optional[List[str]] = None, **kw : Any) -> SuccessTupl
         action.append('meerschaum')
     return edit_config(keys=action, **kw)
 
-def _complete_edit_config(action: Optional[List[str]] = None, **kw : Any) -> List[str]:
+def _complete_edit_config(action: Optional[List[str]] = None, **kw: Any) -> List[str]:
     from meerschaum.config._read_config import get_possible_keys
     keys = get_possible_keys()
     if not action:
@@ -172,9 +176,9 @@ def _edit_pipes(
 
 
 def _edit_definition(
-        action: Optional[List[str]] = None,
-        **kw
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    **kw
+) -> SuccessTuple:
     """
     Edit pipes' definitions.
     Alias for `edit pipes definition`.
@@ -183,13 +187,13 @@ def _edit_definition(
 
 
 def _edit_users(
-        action: Optional[List[str]] = None,
-        mrsm_instance: Optional[str] = None,
-        yes: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    mrsm_instance: Optional[str] = None,
+    yes: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Edit users' registration information.
     """
@@ -262,7 +266,7 @@ def _edit_users(
     if not action:
         return False, "No users to edit."
 
-    success = dict()
+    success = {}
     for username in action:
         try:
             user = build_user(username)
@@ -289,6 +293,85 @@ def _edit_users(
     info(msg)
     return True, msg
 
+
+def _edit_plugins(
+    action: Optional[List[str]] = None,
+    debug: bool = False,
+    **kwargs: Any
+):
+    """
+    Edit a plugin's source code.
+    """
+    import pathlib
+    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:
+        return False, "Specify which plugin to edit."
+
+    for plugin_name in action:
+        plugin = mrsm.Plugin(plugin_name)
+
+        if not plugin.is_installed():
+            warn(f"Plugin '{plugin_name}' is not installed.", stack=False)
+
+            if not yes_no(
+                f"Would you like to create a new plugin '{plugin_name}'?",
+                **kwargs
+            ):
+                return False, f"Plugin '{plugin_name}' does not exist."
+
+            actions['bootstrap'](
+                ['plugins', plugin_name],
+                debug = debug,
+                **kwargs
+            )
+            continue
+
+        plugin_file_path = pathlib.Path(plugin.__file__).resolve()
+
+        try:
+            _ = prompt(f"Press [Enter] to open '{plugin_file_path}':", icon=False)
+        except (KeyboardInterrupt, Exception):
+            continue
+
+        edit_file(plugin_file_path)
+        reload_meerschaum(debug=debug)
+
+    return True, "Success"
+
+
+def _complete_edit_plugins(
+    action: Optional[List[str]] = None,
+    line: Optional[str] = None,
+    **kw: Any
+) -> List[str]:
+    from meerschaum.plugins import get_plugins_names
+    plugins_names = get_plugins_names(try_import=False)
+    if not action:
+        return plugins_names
+
+    last_word = action[-1]
+    if last_word in plugins_names and (line or '')[-1] == ' ':
+        return [
+            plugin_name
+            for plugin_name in plugins_names
+            if plugin_name not in action
+        ]
+
+    possibilities = []
+    for plugin_name in plugins_names:
+        if (
+            plugin_name.startswith(last_word)
+            and plugin_name not in action
+        ):
+            possibilities.append(plugin_name)
+    return possibilities
+
+
 ### NOTE: This must be the final statement of the module.
 ###       Any subactions added below these lines will not
 ###       be added to the `help` docstring.

meerschaum/actions/python.py

@@ -11,6 +11,9 @@ from meerschaum.utils.typing import SuccessTuple, Any, List, Optional
 def python(
         action: Optional[List[str]] = None,
         sub_args: Optional[List[str]] = None,
+        nopretty: bool = False,
+        noask: bool = False,
+        venv: Optional[str] = None,
         debug: bool = False,
         **kw: Any
     ) -> SuccessTuple:
@@ -24,6 +27,21 @@ def python(
     Examples:
         mrsm python
         mrsm python [-m pip -V]
+
+    Flags:
+        `--nopretty`
+        Open a plain Pyhthon REPL rather than ptpython.
+
+        `--noask`
+        Run the supplied Python code and do not open a REPL.
+
+        `--venv`
+        Run the Python interpreter from a virtual environment.
+        Will not have Meercshaum imported.
+
+        `--sub-args` (or flags surrounded by `[]`)
+        Rather than run Python code, execute the interpreter with the given sub-flags
+        (e.g. `mrsm python [-V]`)
     """
     import sys, subprocess, os
     from meerschaum.utils.debug import dprint
@@ -33,11 +51,16 @@ def python(
     from meerschaum.config import __version__ as _version
     from meerschaum.config.paths import VIRTENV_RESOURCES_PATH, PYTHON_RESOURCES_PATH
     from meerschaum.utils.packages import run_python_package, attempt_import
+    from meerschaum.utils.process import run_process
 
     if action is None:
         action = []
 
-    joined_actions = ["import meerschaum as mrsm"]
+    joined_actions = (
+        ["import meerschaum as mrsm"]
+        if venv is None and not sub_args
+        else []
+    )
     line = ""
     for i, a in enumerate(action):
         if a == '':
@@ -68,6 +91,11 @@ def python(
         '"""); '
         + 'pts.print_formatted_text(ansi); '
     )
+    if nopretty or venv is not None or sub_args:
+        print_command = ""
+
+    if sub_args:
+        nopretty = True
 
     command = print_command
     for a in joined_actions:
@@ -89,7 +117,21 @@ def python(
             'ptpython',
             sub_args or ['--dark-bg', '-i', init_script_path.as_posix()],
             foreground = True,
-            venv = None,
+            venv = venv,
+        ) if not nopretty else run_process(
+            (
+                [venv_executable(venv)] + (
+                    sub_args or
+                    (
+                        (
+                            ['-i']
+                            if not noask
+                            else []
+                        ) + [init_script_path.as_posix()]
+                    )
+                )
+            ),
+            foreground = True,
         )
     except KeyboardInterrupt:
         return_code = 1

meerschaum/actions/show.py

@@ -42,6 +42,7 @@ def show(
         'logs'       : _show_logs,
         'tags'       : _show_tags,
         'schedules'  : _show_schedules,
+        'venvs'      : _show_venvs,
     }
     return choose_subaction(action, show_options, **kw)
 
@@ -903,6 +904,31 @@ def _show_schedules(
     return True, "Success"
         
 
+def _show_venvs(
+        **kwargs: Any    
+    ):
+    """
+    Print the available virtual environments in the current MRSM_ROOT_DIR.
+    """
+    import os
+    import pathlib
+    from meerschaum.config.paths import VIRTENV_RESOURCES_PATH
+    from meerschaum.utils.venv import venv_exists
+    from meerschaum.utils.misc import print_options
+
+    venvs = [
+        _venv
+        for _venv in os.listdir(VIRTENV_RESOURCES_PATH)
+        if venv_exists(_venv)
+    ]
+    print_options(
+        venvs,
+        name = 'Venvs:',
+        **kwargs
+    )
+
+    return True, "Success"
+
 
 ### NOTE: This must be the final statement of the module.
 ###       Any subactions added below these lines will not