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

meerschaum/actions/bootstrap.py

@@ -221,18 +221,17 @@ def _bootstrap_pipes(
     return (successes > 0), msg
 
 def _bootstrap_connectors(
-        action : Optional[List[str]] = None,
-        connector_keys : Optional[List[str]] = None,
-        yes : bool = False,
-        force : bool = False,
-        noask : bool = False,
-        debug : bool = False,
-        return_keys : bool = False,
-        **kw : Any
-    ) -> Union[SuccessTuple, Tuple[str, str]]:
+    action: Optional[List[str]] = None,
+    connector_keys: Optional[List[str]] = None,
+    yes: bool = False,
+    force: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    return_keys: bool = False,
+    **kw: Any
+) -> Union[SuccessTuple, Tuple[str, str]]:
     """
     Prompt the user for the details necessary to create a Connector.
-
     """
     from meerschaum.connectors.parse import is_valid_connector_keys
     from meerschaum.connectors import connectors, get_connector, types, custom_types
@@ -386,10 +385,10 @@ def _bootstrap_connectors(
 
 
 def _bootstrap_plugins(
-        action: Optional[List[str]] = None,
-        debug: bool = False,
-        **kwargs: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Launch an interactive wizard to guide the user to creating a new plugin.
     """

meerschaum/actions/python.py

@@ -9,14 +9,14 @@ from __future__ import annotations
 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:
+    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:
     """
     Launch a virtual environment's Python interpreter with Meerschaum imported.
     You may pass flags to the Python binary by surrounding each flag with `[]`.
@@ -56,6 +56,9 @@ def python(
     if action is None:
         action = []
 
+    if noask:
+        nopretty = True
+
     joined_actions = (
         ["import meerschaum as mrsm"]
         if venv is None and not sub_args

meerschaum/actions/register.py

@@ -7,12 +7,13 @@ Register new Pipes. Requires the API to be running.
 """
 
 from __future__ import annotations
+import meerschaum as mrsm
 from meerschaum.utils.typing import SuccessTuple, Any, List, Optional, Dict
 
 def register(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> SuccessTuple:
     """
     Register new items (pipes, plugins, users).
 
@@ -23,22 +24,25 @@ def register(
         'pipes'     : _register_pipes,
         'plugins'   : _register_plugins,
         'users'     : _register_users,
+        'connectors': _register_connectors,
     }
     return choose_subaction(action, options, **kw)
 
 
 def _complete_register(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
     """
     Override the default Meerschaum `complete_` function.
     """
     if action is None:
         action = []
     options = {
-        'plugin' : _complete_register_plugins,
-        'plugins' : _complete_register_plugins,
+        'plugin': _complete_register_plugins,
+        'plugins': _complete_register_plugins,
+        'connector': _complete_register_connectors,
+        'connectors': _complete_register_connectors,
     }
 
     if len(action) > 0 and action[0] in options:
@@ -51,14 +55,14 @@ def _complete_register(
 
 
 def _register_pipes(
-        connector_keys: Optional[List[str]] = None,
-        metric_keys: Optional[List[str]] = None,
-        location_keys: Optional[List[str]] = None,
-        params: Optional[Dict[str, Any]] = None,
-        tags: Optional[List[str]] = None,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    connector_keys: Optional[List[str]] = None,
+    metric_keys: Optional[List[str]] = None,
+    location_keys: Optional[List[str]] = None,
+    params: Optional[Dict[str, Any]] = None,
+    tags: Optional[List[str]] = None,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Create and register Pipe objects.
 
@@ -147,15 +151,18 @@ def _register_pipes(
 
 
 def _register_plugins(
-        action: Optional[List[str]] = None,
-        repository: Optional[str] = None,
-        shell: bool = False,
-        debug: bool = False,
-        yes: bool = False,
-        noask: bool = False,
-        force: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    repository: Optional[str] = None,
+    shell: bool = False,
+    debug: bool = False,
+    yes: bool = False,
+    noask: bool = False,
+    force: bool = False,
+    **kw: Any
+) -> SuccessTuple:
+    """
+    Upload plugins to an API instance (repository).
+    """
     from meerschaum.utils.debug import dprint
     from meerschaum.plugins import reload_plugins, get_plugins_names
     from meerschaum.connectors.parse import parse_repo_keys
@@ -246,17 +253,19 @@ def _register_plugins(
     reload_plugins(debug=debug)
     return total_success > 0, msg
 
+
 def _complete_register_plugins(*args, **kw):
     from meerschaum.actions.uninstall import _complete_uninstall_plugins
     return _complete_uninstall_plugins(*args, **kw)
 
+
 def _register_users(
-        action: Optional[List[str]] = None,
-        mrsm_instance: Optional[str] = None,
-        shell: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    mrsm_instance: Optional[str] = None,
+    shell: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Register a new user to a Meerschaum instance.
     """
@@ -294,7 +303,7 @@ def _register_users(
         nonregistered_users.append(user)
 
     ### prompt for passwords and emails, then try to register
-    success = dict()
+    success = {}
     successfully_registered_users = set()
     for _user in nonregistered_users:
         try:
@@ -337,6 +346,95 @@ def _register_users(
     )
     return succeeded > 0, msg
 
+
+def _register_connectors(
+    action: Optional[List[str]] = None,
+    connector_keys: Optional[List[str]] = None,
+    params: Optional[Dict[str, Any]] = None,
+    **kwargs: Any
+) -> SuccessTuple:
+    """
+    Create new connectors programmatically with `--params`.
+    See `bootstrap connector`.
+
+    Examples:
+
+    mrsm register connector sql:tmp --params 'uri:sqlite:////tmp/tmp.db'
+
+    mrsm register connector -c sql:new --params '{"database": "/tmp/new.db"}'
+    """
+    from meerschaum.config import get_config, write_config
+    from meerschaum.utils.prompt import yes_no
+    from meerschaum.utils.warnings import warn
+    all_keys = (action or []) + (connector_keys or [])
+    if len(all_keys) != 1:
+        return (
+            False,
+            "Provide one pair of keys for the connector to be registered."
+        )
+
+    keys = all_keys[0]
+
+    if keys.count(':') != 1:
+        return False, "Connector keys must be in the format `type:label`."
+
+    type_, label = keys.split(':', maxsplit=1)
+    mrsm_config = get_config('meerschaum')
+    if 'connectors' not in mrsm_config:
+        mrsm_config['connectors'] = {}
+
+    if type_ not in mrsm_config['connectors']:
+        mrsm_config['connectors'] = {}
+
+    is_new = True
+    if label in mrsm_config['connectors'][type_]:
+        rich_table, rich_json, rich_box = mrsm.attempt_import(
+            'rich.table',
+            'rich.json',
+            'rich.box',
+        )
+        existing_params = mrsm_config['connectors'][type_][label]
+        if existing_params == params:
+            return True, "Connector exists, nothing to do."
+
+        table = rich_table.Table(box=rich_box.MINIMAL)
+        table.add_column('Existing Parameters')
+        table.add_column('New Parameters')
+        table.add_row(
+            rich_json.JSON.from_data(existing_params),
+            rich_json.JSON.from_data(params or {}),
+        )
+
+        mrsm.pprint(table)
+        warn(f"Connector '{keys}' already exists.", stack=False)
+        if not yes_no(
+            f"Do you want to overwrite connector '{keys}'?",
+            default='n',
+            **kwargs
+        ):
+            return False, "Nothing was changed."
+
+        is_new = False
+
+    mrsm_config['connectors'][type_][label] = params
+    if not write_config({'meerschaum': mrsm_config}):
+        return False, "Failed to update configuration."
+
+    msg = (
+        "Successfully "
+        + ("registered" if is_new else "updated")
+        + f" connector '{keys}'."
+    )
+    return True, msg
+
+
+def _complete_register_connectors(
+    action: Optional[List[str]] = None, **kw: Any
+) -> List[str]:
+    from meerschaum.actions.show import _complete_show_connectors
+    return _complete_show_connectors(action)
+
+
 ### 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

@@ -48,9 +48,9 @@ def show(
 
 
 def _complete_show(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
     """
     Override the default Meerschaum `complete_` function.
     """
@@ -91,7 +91,13 @@ def _show_actions(**kw: Any) -> SuccessTuple:
     from meerschaum.utils.misc import print_options
     from meerschaum._internal.shell.Shell import hidden_commands
     _actions = [ _a for _a in actions if _a not in hidden_commands ]
-    print_options(options=_actions, name='actions', actions=False, **kw)
+    print_options(
+        options=_actions,
+        name='actions',
+        actions=False,
+        sort_options=True,
+        **kw
+    )
     return True, "Success"
 
 
@@ -219,15 +225,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:
@@ -238,16 +253,16 @@ def _show_connectors(
 
 
 def _complete_show_connectors(
-        action: Optional[List[str]] = None, **kw: Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None, **kw: Any
+) -> List[str]:
     from meerschaum.utils.misc import get_connector_labels
     _text = action[0] if action else ""
     return get_connector_labels(search_term=_text, ignore_exact_match=True)
 
 
 def _show_arguments(
-        **kw: Any
-    ) -> SuccessTuple:
+    **kw: Any
+) -> SuccessTuple:
     """
     Show the parsed keyword arguments.
     """
@@ -257,16 +272,16 @@ def _show_arguments(
 
 
 def _show_data(
-        action: Optional[List[str]] = None,
-        gui: bool = False,
-        begin: Optional[datetime.datetime] = None,
-        end: Optional[datetime.datetime] = None,
-        params: Optional[Dict[str, Any]] = None,
-        chunksize: Optional[int] = -1,
-        nopretty: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    gui: bool = False,
+    begin: Optional[datetime.datetime] = None,
+    end: Optional[datetime.datetime] = None,
+    params: Optional[Dict[str, Any]] = None,
+    chunksize: Optional[int] = -1,
+    nopretty: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Show pipes data as Pandas DataFrames.
     
@@ -365,11 +380,11 @@ def _show_data(
 
 
 def _show_columns(
-        action: Optional[List[str]] = None,
-        debug: bool = False,
-        nopretty: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    debug: bool = False,
+    nopretty: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Show the registered and table columns for pipes.
     """
@@ -383,11 +398,11 @@ def _show_columns(
 
 
 def _show_rowcounts(
-        action: Optional[List[str]] = None,
-        workers: Optional[int] = None,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    workers: Optional[int] = None,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Show the rowcounts for pipes.
     
@@ -424,12 +439,12 @@ def _show_rowcounts(
     return True, "Success"
 
 def _show_plugins(
-        action: Optional[List[str]] = None,
-        repository: Optional[str] = None,
-        nopretty: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    repository: Optional[str] = None,
+    nopretty: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Show the installed plugins.
     """
@@ -466,10 +481,10 @@ def _show_plugins(
     return True, "Success"
 
 def _show_users(
-        mrsm_instance: Optional[str] = None,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    mrsm_instance: Optional[str] = None,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Show the registered users in a Meerschaum instance (default is the current instance).
     """
@@ -489,10 +504,10 @@ def _show_users(
     return True, "Success"
 
 def _show_packages(
-        action: Optional[List[str]] = None,
-        nopretty: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    nopretty: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Show the packages in dependency groups, or as a list with `--nopretty`.
     """
@@ -521,9 +536,9 @@ def _show_packages(
     return True, "Success"
 
 def _complete_show_packages(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> List[str]:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
     from meerschaum.utils.packages import packages
     if not action:
         return sorted(list(packages.keys()))
@@ -536,10 +551,10 @@ def _complete_show_packages(
     return possibilities
 
 def _show_jobs(
-        action: Optional[List[str]] = None,
-        nopretty: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    nopretty: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Show the currently running and stopped jobs.
     """
@@ -563,10 +578,10 @@ def _show_jobs(
 
 
 def _show_logs(
-        action: Optional[List[str]] = None,
-        nopretty: bool = False,
-        **kw
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    nopretty: bool = False,
+    **kw
+) -> SuccessTuple:
     """
     Show the logs for jobs.
     
@@ -598,13 +613,15 @@ def _show_logs(
     now_follow_str = now.strftime(follow_timestamp_format)
 
     def build_buffer_spaces(daemons) -> Dict[str, str]:
-        max_len_id = max(len(d.daemon_id) for d in daemons) if daemons else 0
+        max_len_id = (
+            max(len(d.daemon_id) for d in daemons) + 1
+        ) if daemons else 0
         buffer_len = max(
             get_config('jobs', 'logs', 'min_buffer_len'),
-            max_len_id 
+            max_len_id
         )
         return {
-            d.daemon_id: ''.join([' ' for i in range(buffer_len - len(d.daemon_id))])
+            d.daemon_id: ''.join([' '] * (buffer_len - len(d.daemon_id)))
             for d in daemons
         }
 
@@ -754,9 +771,9 @@ def _show_logs(
 
 
 def _show_environment(
-        nopretty: bool = False,
-        **kw
-    ) -> SuccessTuple:
+    nopretty: bool = False,
+    **kw
+) -> SuccessTuple:
     """
     Show all of the current environment variables with begin with `'MRSM_'`.
     """
@@ -774,12 +791,12 @@ def _show_environment(
 
 
 def _show_tags(
-        action: Optional[List[str]] = None,
-        tags: Optional[List[str]] = None,
-        workers: Optional[int] = None,
-        nopretty: bool = False,
-        **kwargs
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    tags: Optional[List[str]] = None,
+    workers: Optional[int] = None,
+    nopretty: bool = False,
+    **kwargs
+) -> SuccessTuple:
     """
     Show the existing tags and their associated pipes.
     """
@@ -854,10 +871,10 @@ def _show_tags(
 
 
 def _show_schedules(
-        action: Optional[List[str]] = None,
-        nopretty: bool = False,
-        **kwargs: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    nopretty: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Print the upcoming timestamps according to the given schedule.
 
@@ -905,8 +922,8 @@ def _show_schedules(
         
 
 def _show_venvs(
-        **kwargs: Any    
-    ):
+    **kwargs: Any    
+):
     """
     Print the available virtual environments in the current MRSM_ROOT_DIR.
     """

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

@@ -21,9 +21,9 @@ def stop(action: Optional[List[str]] = None, **kw) -> SuccessTuple:
 
 
 def _complete_stop(
-        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,14 +49,14 @@ def _complete_stop(
 
 
 def _stop_jobs(
-        action: Optional[List[str]] = None,
-        timeout_seconds: Optional[int] = None,
-        noask: bool = False,
-        force: bool = False,
-        yes: bool = False,
-        nopretty: bool = False,
-        **kw
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    timeout_seconds: Optional[int] = None,
+    noask: bool = False,
+    force: bool = False,
+    yes: bool = False,
+    nopretty: bool = False,
+    **kw
+) -> SuccessTuple:
     """
     Stop running jobs that were started with `-d` or `start job`.