meerschaum 2.2.5.dev0__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/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/bootstrap.py

@@ -103,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
@@ -258,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'
@@ -391,239 +393,16 @@ def _bootstrap_plugins(
     """
     Launch an interactive wizard to guide the user to creating a new plugin.
     """
-    import pathlib
-    import meerschaum as mrsm
-    from meerschaum.utils.warnings import info, warn
-    from meerschaum.utils.prompt import prompt, choose, yes_no
-    from meerschaum.utils.formatting._shell import clear_screen
-    from meerschaum.utils.misc import edit_file
-    from meerschaum.config.paths import PLUGINS_DIR_PATHS
-    from meerschaum._internal.entry import entry
+    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:")]
 
-    if len(PLUGINS_DIR_PATHS) > 1:
-        plugins_dir_path = pathlib.Path(
-            choose(
-                "In which directory do you want to write your plugin?",
-                [path.as_posix() for path in PLUGINS_DIR_PATHS],
-                numeric = True,
-                multiple = False,
-                default = PLUGINS_DIR_PATHS[0].as_posix(),
-            )
-        )
-    else:
-        plugins_dir_path = PLUGINS_DIR_PATHS[0]
-        
-    clear_screen(debug=debug)
-    info(
-        "Answer the questions below to pick out features.\n"
-        + "    See the Writing Plugins guide for documentation:\n"
-        + "    https://meerschaum.io/reference/plugins/writing-plugins/ for documentation.\n"
-    )
-
-    imports_lines = {
-        'default': (
-            "import meerschaum as mrsm\n"
-        ),
-        'action': (
-            "from meerschaum.actions import make_action\n"
-        ),
-        'api': (
-            "from meerschaum.plugins import api_plugin\n"
-        ),
-        'web': (
-            "from meerschaum.plugins import web_page, dash_plugin\n"
-        ),
-        'api+web': (
-            "from meerschaum.plugins import api_plugin, web_page, dash_plugin\n"
-        ),
-    }
-
-    ### TODO: Add feature for custom connectors.
-    feature_lines = {
-        'header': (
-            "# {plugin_name}.py\n\n"
-        ),
-        'default': (
-            "__version__ = '0.0.1'\n"
-            "\n# Add any depedencies to `required` (similar to `requirements.txt`).\n"
-            "required = []\n\n"
-        ),
-        'setup': (
-            "def setup(**kwargs) -> mrsm.SuccessTuple:\n"
-            "    \"\"\"Executed during installation and `mrsm setup plugin {plugin_name}`.\"\"\"\n"
-            "    return True, \"Success\"\n\n\n"
-        ),
-        'register': (
-            "def register(pipe: mrsm.Pipe):\n"
-            "    \"\"\"Return the default parameters for a new pipe.\"\"\"\n"
-            "    return {\n"
-            "        'columns': {\n"
-            "            'datetime': None,\n"
-            "        }\n"
-            "    }\n\n\n"
-        ),
-        'fetch': (
-            "def fetch(pipe: mrsm.Pipe, **kwargs):\n"
-            "    \"\"\"Return or yield dataframe-like objects.\"\"\"\n"
-            "    docs = []\n"
-            "    # populate docs with dictionaries (rows).\n"
-            "    return docs\n\n\n"
-        ),
-        'action': (
-            "@make_action\n"
-            "def {action_name}(**kwargs) -> mrsm.SuccessTuple:\n"
-            "    \"\"\"Run `mrsm {action_spaces}` to trigger.\"\"\"\n"
-            "    return True, \"Success\"\n\n\n"
-        ),
-        'api': (
-            "@api_plugin\n"
-            "def init_app(fastapi_app):\n"
-            "    \"\"\"Add new endpoints to the FastAPI app.\"\"\"\n\n"
-            "    import fastapi\n"
-            "    from meerschaum.api import manager\n\n"
-            "    @fastapi_app.get('/my/endpoint')\n"
-            "    def get_my_endpoint(curr_user=fastapi.Depends(manager)):\n"
-            "        return {'message': 'Hello, World!'}\n\n\n"
-        ),
-        'web': (
-            "@dash_plugin\n"
-            "def init_dash(dash_app):\n"
-            "    \"\"\"Initialize the Plotly Dash application.\"\"\"\n"
-            "    import dash.html as html\n"
-            "    import dash.dcc as dcc\n"
-            "    from dash import Input, Output, State, no_update\n"
-            "    import dash_bootstrap_components as dbc\n\n"
-            "    # Create a new page at the path `/dash/{plugin_name}`.\n"
-            "    @web_page('{plugin_name}', login_required=False)\n"
-            "    def page_layout():\n"
-            "        \"\"\"Return the layout objects for this page.\"\"\"\n"
-            "        return dbc.Container([\n"
-            "            dcc.Location(id='{plugin_name}-location'),\n"
-            "            html.Div(id='output-div'),\n"
-            "        ])\n\n"
-            "    @dash_app.callback(\n"
-            "        Output('output-div', 'children'),\n"
-            "        Input('{plugin_name}-location', 'pathname'),\n"
-            "    )\n"
-            "    def render_page_on_url_change(pathname: str):\n"
-            "        \"\"\"Reload page contents when the URL path changes.\"\"\"\n"
-            "        return html.H1(\"Hello from plugin '{plugin_name}'!\")\n\n\n"
-        ),
-    }
-
     for plugin_name in action:
-        plugin_path = plugins_dir_path / (plugin_name + '.py')
-        plugin = mrsm.Plugin(plugin_name)
-        if plugin.is_installed():
-            warn(f"Plugin '{plugin_name}' is already installed!", stack=False)
-            uninstall_plugin = yes_no(
-                f"Do you want to first uninstall '{plugin}'?",
-                default = 'n',
-                **kwargs
-            )
-            if not uninstall_plugin:
-                return False, f"Plugin '{plugin_name}' already exists."
-
-            uninstall_success, uninstall_msg = entry(['uninstall', 'plugin', plugin_name, '-f'])
-            if not uninstall_success:
-                return uninstall_success, uninstall_msg
-            clear_screen(debug=debug)
-
-        features = choose(
-            "Which of the following features would you like to add to your plugin?",
-            [
-                (
-                    'fetch',
-                    'Fetch data\n     (e.g. extracting from a remote API)\n'
-                ),
-                (
-                    'action',
-                    'New actions\n     (e.g. `mrsm sing song`)\n'
-                ),
-                (
-                    'api',
-                    'New API endpoints\n     (e.g. `POST /my/new/endpoint`)\n',
-                ),
-                (
-                    'web',
-                    'New web console page\n     (e.g. `/dash/my-web-app`)\n',
-                ),
-            ],
-            default = 'fetch',
-            multiple = True,
-            as_indices = True,
-            **kwargs
-        )
-
-        action_name = ''
-        if 'action' in features:
-            while True:
-                try:
-                    action_name = prompt(
-                        "What is name of your action?\n    "
-                        + "(separate subactions with spaces, e.g. `sing song`):"
-                    ).replace(' ', '_')
-                except KeyboardInterrupt as e:
-                    return False, "Aborted plugin creation."
-
-                if action_name:
-                    break
-                warn("Please enter an action.", stack=False)
-
-        action_spaces = action_name.replace('_', ' ')
-
-        plugin_labels = {
-            'plugin_name': plugin_name,
-            'action_name': action_name,
-            'action_spaces': action_spaces,
-        }
-
-        body_text = ""
-        body_text += feature_lines['header'].format(**plugin_labels)
-        body_text += imports_lines['default'].format(**plugin_labels)
-        if 'action' in features:
-            body_text += imports_lines['action']
-        if 'api' in features and 'web' in features:
-            body_text += imports_lines['api+web']
-        elif 'api' in features:
-            body_text += imports_lines['api']
-        elif 'web' in features:
-            body_text += imports_lines['web']
-
-        body_text += "\n"
-        body_text += feature_lines['default'].format(**plugin_labels)
-        body_text += feature_lines['setup'].format(**plugin_labels)
-
-        if 'fetch' in features:
-            body_text += feature_lines['register']
-            body_text += feature_lines['fetch']
-
-        if 'action' in features:
-            body_text += feature_lines['action'].format(**plugin_labels)
-
-        if 'api' in features:
-            body_text += feature_lines['api']
-
-        if 'web' in features:
-            body_text += feature_lines['web'].format(**plugin_labels)
-
-        try:
-            with open(plugin_path, 'w+', encoding='utf-8') as f:
-                f.write(body_text.rstrip())
-        except Exception as e:
-            error_msg = f"Failed to write file '{plugin_path}':\n{e}"
-            return False, error_msg
-
-        mrsm.pprint((True, f"Successfully created file '{plugin_path}'."))
-        try:
-            _ = prompt(f"Press [Enter] to edit plugin '{plugin_name}', [CTRL+C] to skip.")
-        except (KeyboardInterrupt, Exception):
-            continue
-
-        edit_file(plugin_path, debug=debug)
+        bootstrap_success, bootstrap_msg = bootstrap_plugin(plugin_name)
+        if not bootstrap_success:
+            return bootstrap_success, bootstrap_msg
 
     return True, "Success"
 

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/uninstall.py

@@ -25,9 +25,9 @@ def uninstall(
 
 
 def _complete_uninstall(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
     """
     Override the default Meerschaum `complete_` function.
     """
@@ -49,15 +49,16 @@ def _complete_uninstall(
     from meerschaum._internal.shell import default_action_completer
     return default_action_completer(action=(['uninstall'] + action), **kw)
 
+
 def _uninstall_plugins(
-        action: Optional[List[str]] = None,
-        repository: Optional[str] = None,
-        yes: bool = False,
-        force: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    repository: Optional[str] = None,
+    yes: bool = False,
+    force: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Remove installed plugins. Does not affect repository registrations.
     """
@@ -135,26 +136,20 @@ def _uninstall_plugins(
 
 
 def _complete_uninstall_plugins(action: Optional[List[str]] = None, **kw) -> List[str]:
-    from meerschaum.plugins import get_plugins_names
-    _plugin_names = get_plugins_names()
-    if not action:
-        return _plugin_names
-    possibilities = []
-    for name in _plugin_names:
-        if name.startswith(action[0]) and action[0] != name:
-            possibilities.append(name)
-    return possibilities
+    from meerschaum.actions.edit import _complete_edit_plugins
+    return _complete_edit_plugins(action=action, **kw)
+
 
 def _uninstall_packages(
-        action: Optional[List[str]] = None,
-        sub_args: Optional[List[str]] = None,
-        venv: Optional[str] = 'mrsm',
-        yes: bool = False,
-        force: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    sub_args: Optional[List[str]] = None,
+    venv: Optional[str] = 'mrsm',
+    yes: bool = False,
+    force: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Uninstall PyPI packages from the Meerschaum virtual environment.