meerschaum 2.2.5.dev0__py3-none-any.whl → 2.2.5.dev3__py3-none-any.whl

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

@@ -219,15 +219,24 @@ def _show_connectors(
     from meerschaum.config import get_config
     from meerschaum.utils.formatting import make_header
     from meerschaum.utils.formatting import pprint
+
+    conn_type = action[0].split(':')[0] if action else None
+
     if not nopretty:
-        print(make_header("\nConfigured connectors:"))
-    pprint(get_config('meerschaum', 'connectors'), nopretty=nopretty)
-    if not nopretty:
+        print(make_header(
+            f"""\nConfigured {"'" + (conn_type + "' ") if conn_type else ''}Connectors:"""
+        ))
+
+    keys = ['meerschaum', 'connectors']
+    if conn_type:
+        keys.append(conn_type)
+    pprint(get_config(*keys), nopretty=nopretty)
+    if not nopretty and not conn_type:
         print(make_header("\nActive connectors:"))
         pprint(connectors, nopretty=nopretty)
 
     from meerschaum.connectors.parse import parse_instance_keys
-    if action:
+    if action and ':' in action[0]:
         attr, keys = parse_instance_keys(action[0], construct=False, as_tuple=True, debug=debug)
         if attr:
             if not nopretty:

meerschaum/actions/stack.py

@@ -7,7 +7,7 @@ Functions for running the Docker Compose stack
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import SuccessTuple, Any, List, Optional
+from meerschaum.utils.typing import SuccessTuple, Any, List, Optional, Union
 
 def stack(
         action: Optional[List[str]] = None,
@@ -19,7 +19,7 @@ def stack(
         debug: bool = False,
         _capture_output: bool = False,
         **kw: Any
-    ) -> SuccessTuple:
+    ) -> Union[SuccessTuple, 'subprocess.Popen']:
     """
     Control the Meerschaum stack with Docker Compose.
     Usage: `stack {command}`
@@ -147,18 +147,18 @@ def stack(
             ['docker', 'compose'] if has_builtin_compose
             else ['docker-compose']
         ) + cmd_list,
-        cwd = STACK_COMPOSE_PATH.parent,
-        stdout = stdout,
-        stderr = stderr,
-        env = stack_env_dict,
+        cwd=STACK_COMPOSE_PATH.parent,
+        stdout=stdout,
+        stderr=stderr,
+        env=stack_env_dict,
     ) if (has_builtin_compose or has_binary_compose) else run_python_package(
         'compose',
-        args = cmd_list,
-        cwd = STACK_COMPOSE_PATH.parent,
-        venv = _compose_venv,
-        capture_output = _capture_output,
-        as_proc = True,
-        env = stack_env_dict,
+        args=cmd_list,
+        cwd=STACK_COMPOSE_PATH.parent,
+        venv=_compose_venv,
+        capture_output=_capture_output,
+        as_proc=True,
+        env=stack_env_dict,
     )
     try:
         rc = proc.wait() if proc is not None else 1

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.
     

meerschaum/api/__init__.py

@@ -237,4 +237,3 @@ for module_name, functions_list in _api_plugins.items():
                 + f"when executing function '{function.__name__}' with exception:\n{e}",
                 stack=False,
             )
-

meerschaum/api/dash/__init__.py

@@ -50,7 +50,6 @@ stylesheets = [
     '/static/css/bootstrap.min.css',
     '/static/css/dbc_dark.css',
     '/static/css/dash.css',
-    #  '/static/js/node_modules/xterm/css/xterm.css',
 ]
 scripts = ['/static/js/node_modules/xterm/lib/xterm.js']
 dash_app = enrich.DashProxy(

meerschaum/api/dash/callbacks/custom.py

@@ -21,7 +21,7 @@ def init_dash_plugins():
         for _function in _functions:
             try:
                 _function(dash_app)
-            except Exception as e:
+            except Exception:
                 warn(
                     f"Failed to load function '{_function.__name__}' "
                     + f"from plugin '{_module_name}':\n"

meerschaum/api/dash/plugins.py

@@ -7,7 +7,7 @@ Functions for interacting with plugins via the web interface.
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import List, Tuple, SuccessTuple
+from meerschaum.utils.typing import List, Tuple, SuccessTuple, Optional, WebState, Dict, Any
 from meerschaum.utils.packages import import_dcc, import_html
 from meerschaum.api import get_api_connector, endpoints, CHECK_UPDATE
 html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
@@ -17,10 +17,10 @@ from meerschaum.api.dash import dash_app, debug, active_sessions
 
 
 def get_plugins_cards(
-        state: Optional[WebState] = None,
-        search_term: Optional[str] = None,
-        session_data: Optional[Dict[str, Any]] = None,
-    ) -> Tuple[List[dbc.Card], List[SuccessTuple]]:
+    state: Optional[WebState] = None,
+    search_term: Optional[str] = None,
+    session_data: Optional[Dict[str, Any]] = None,
+) -> Tuple[List[dbc.Card], List[SuccessTuple]]:
     """
     Return the cards and alerts for plugins.
     """
@@ -96,4 +96,3 @@ def is_plugin_owner(plugin_name: str, session_data: Dict['str', Any]) -> bool:
         _username is not None
         and _username == _plugin_username
     )
-

meerschaum/config/__init__.py

@@ -12,7 +12,7 @@ from __future__ import annotations
 import os, shutil, sys, pathlib, copy
 from meerschaum.utils.typing import Any, Dict, Optional, Union
 from meerschaum.utils.threading import RLock
-from meerschaum.utils.warnings import warn
+from meerschaum.utils.warnings import warn, error
 
 from meerschaum.config._version import __version__
 from meerschaum.config._edit import edit_config, write_config
@@ -239,17 +239,28 @@ def get_config(
     return c
 
 
-def get_plugin_config(*keys : str, **kw : Any) -> Optional[Any]:
+def get_plugin_config(
+        *keys: str,
+        warn: bool = False,
+        **kw: Any
+    ) -> Optional[Any]:
     """
     This may only be called from within a Meerschaum plugin.
     See `meerschaum.config.get_config` for arguments.
     """
-    from meerschaum.utils.warnings import warn, error
     from meerschaum.plugins import _get_parent_plugin
     parent_plugin_name = _get_parent_plugin(2)
     if parent_plugin_name is None:
-        error(f"You may only call `get_plugin_config()` from within a Meerschaum plugin.")
-    return get_config(*(['plugins', parent_plugin_name] + list(keys)), **kw)
+        error(
+            "You may only call `get_plugin_config()` "
+            "from within a Meerschaum plugin."
+        )
+
+    return get_config(
+        *(['plugins', parent_plugin_name] + list(keys)),
+        warn=warn,
+        **kw
+    )
 
 
 def write_plugin_config(
@@ -259,7 +270,6 @@ def write_plugin_config(
     """
     Write a plugin's configuration dictionary.
     """
-    from meerschaum.utils.warnings import warn, error
     from meerschaum.plugins import _get_parent_plugin
     parent_plugin_name = _get_parent_plugin(2)
     if parent_plugin_name is None:

meerschaum/config/_version.py

@@ -2,4 +2,4 @@
 Specify the Meerschaum release version.
 """
 
-__version__ = "2.2.5.dev0"
+__version__ = "2.2.5.dev3"

meerschaum/core/Pipe/_fetch.py

@@ -12,6 +12,7 @@ import meerschaum as mrsm
 from meerschaum.utils.typing import Optional, Any, Union, SuccessTuple, Iterator
 from meerschaum.config import get_config
 from meerschaum.utils.warnings import warn
+from meerschaum.utils.misc import filter_keywords
 
 def fetch(
         self,
@@ -75,25 +76,28 @@ def fetch(
     with mrsm.Venv(get_connector_plugin(self.connector)):
         df = self.connector.fetch(
             self,
-            begin = _determine_begin(
-                self,
-                begin,
-                check_existing = check_existing,
-                debug = debug,
-            ),
-            end = end,
-            chunk_hook = _chunk_hook,
-            debug = debug,
-            **kw
+            **filter_keywords(
+                self.connector.fetch,
+                begin=_determine_begin(
+                    self,
+                    begin,
+                    check_existing=check_existing,
+                    debug=debug,
+                ),
+                end=end,
+                chunk_hook=_chunk_hook,
+                debug=debug,
+                **kw
+            )
         )
     return df
 
 
 def get_backtrack_interval(
-        self,
-        check_existing: bool = True,
-        debug: bool = False,
-    ) -> Union[timedelta, int]:
+    self,
+    check_existing: bool = True,
+    debug: bool = False,
+) -> Union[timedelta, int]:
     """
     Get the chunk interval to use for this pipe.
 
@@ -127,17 +131,17 @@ def get_backtrack_interval(
 
 
 def _determine_begin(
-        pipe: mrsm.Pipe,
-        begin: Union[datetime, int, str] = '',
-        check_existing: bool = True,
-        debug: bool = False,
-    ) -> Union[datetime, int, None]:
+    pipe: mrsm.Pipe,
+    begin: Union[datetime, int, str, None] = '',
+    check_existing: bool = True,
+    debug: bool = False,
+) -> Union[datetime, int, None]:
     """
     Apply the backtrack interval if `--begin` is not provided.
 
     Parameters
     ----------
-    begin: Union[datetime, int, str], default ''
+    begin: Union[datetime, int, str, None], default ''
         The provided begin timestamp.
 
     check_existing: bool, default True
@@ -160,4 +164,4 @@ def _determine_begin(
         return sync_time - backtrack_interval
     except Exception as e:
         warn(f"Unable to substract backtrack interval {backtrack_interval} from {sync_time}.")
-        return sync_time
+    return sync_time