meerschaum 2.2.6__py3-none-any.whl → 2.2.7__py3-none-any.whl

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:])
@@ -41,7 +47,7 @@ def main(sysargs: list = None) -> None:
 
     if ('-d' in sysargs or '--daemon' in sysargs) and ('stack' not in sysargs):
         from meerschaum.utils.daemon import daemon_entry
-        daemon_entry(sysargs)
+        _print_tuple(daemon_entry(sysargs), upper_padding=1)
         return _exit(old_cwd=old_cwd)
 
     from meerschaum._internal.entry import entry, get_shell
@@ -57,8 +63,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/_internal/entry.py

@@ -8,20 +8,15 @@ The entry point for launching Meerschaum actions.
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import SuccessTuple, List, Optional, Dict
+from meerschaum.utils.typing import SuccessTuple, List, Optional, Dict, Callable, Any
 
 def entry(sysargs: Optional[List[str]] = None) -> SuccessTuple:
-    """Parse arguments and launch a Meerschaum action.
-    The `action` list removes the first element.
-    
-    Examples of action:
-        'show actions' -> ['actions']
-        'show' -> []
+    """
+    Parse arguments and launch a Meerschaum action.
 
     Returns
     -------
-    A `SuccessTuple` indicating success. If `schedule` is provided, this will never return.
-
+    A `SuccessTuple` indicating success.
     """
     from meerschaum._internal.arguments import parse_arguments
     from meerschaum.config.static import STATIC_CONFIG
@@ -51,9 +46,9 @@ def entry(sysargs: Optional[List[str]] = None) -> SuccessTuple:
 
 
 def entry_with_args(
-        _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
-        **kw
-    ) -> SuccessTuple:
+    _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
+    **kw
+) -> SuccessTuple:
     """Execute a Meerschaum action with keyword arguments.
     Use `_entry()` for parsing sysargs before executing.
     """
@@ -96,7 +91,12 @@ def entry_with_args(
 
     kw['action'] = remove_leading_action(kw['action'], _actions=_actions)
 
-    do_action = functools.partial(_do_action_wrapper, action_function, plugin_name, **kw)
+    do_action = functools.partial(
+        _do_action_wrapper,
+        action_function,
+        plugin_name,
+        **kw
+    )
     if kw.get('schedule', None) and not skip_schedule:
         from meerschaum.utils.schedule import schedule_function
         from meerschaum.utils.misc import interval_str

meerschaum/_internal/shell/Shell.py

@@ -95,8 +95,8 @@ def _insert_shell_actions(
         setattr(_shell_class, 'complete_' + a, completer)
 
 def _completer_wrapper(
-        target: Callable[[Any], List[str]]
-    ) -> Callable[['meerschaum._internal.shell.Shell', str, str, int, int], Any]:
+    target: Callable[[Any], List[str]]
+) -> Callable[['meerschaum._internal.shell.Shell', str, str, int, int], Any]:
     """
     Wrapper for `complete_` functions so they can instead use Meerschaum arguments.
     """
@@ -125,13 +125,13 @@ def _completer_wrapper(
 
 
 def default_action_completer(
-        text: Optional[str] = None,
-        line: Optional[str] = None,
-        begin_index: Optional[int] = None,
-        end_index: Optional[int] = None,
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> List[str]:
+    text: Optional[str] = None,
+    line: Optional[str] = None,
+    begin_index: Optional[int] = None,
+    end_index: Optional[int] = None,
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> List[str]:
     """
     Search for subactions by default. This may be overridden by each action.
     """
@@ -206,13 +206,11 @@ def get_shell_intro(with_color: bool = True) -> str:
     """
     from meerschaum.utils.formatting import CHARSET, ANSI, colored
     intro = get_config('shell', CHARSET, 'intro', patch=patch)
-    intro += '\n' + ''.join(
-        [' '
-            for i in range(
-                string_width(intro) - len('v' + version)
-            )
-        ]
-    ) + 'v' + version
+    intro += (
+        '\n'
+        + (' ' * (string_width(intro) - len('v' + version)))
+        + f'v{version}'
+    )
 
     if not with_color or not ANSI:
         return intro
@@ -225,10 +223,10 @@ def get_shell_intro(with_color: bool = True) -> str:
 
 class Shell(cmd.Cmd):
     def __init__(
-            self,
-            actions: Optional[Dict[str, Any]] = None,
-            sysargs: Optional[List[str]] = None
-        ):
+        self,
+        actions: Optional[Dict[str, Any]] = None,
+        sysargs: Optional[List[str]] = None
+    ):
         """
         Customize the CLI from configuration
         """
@@ -297,19 +295,25 @@ class Shell(cmd.Cmd):
         except Exception as e:
             pass
 
+        ### Finally, spawn the version update thread.
+        from meerschaum._internal.shell.updates import run_version_check_thread
+        self._update_thread = run_version_check_thread(debug=shell_attrs.get('debug', False))
+
+
     def load_config(self, instance: Optional[str] = None):
         """
         Set attributes from the shell configuration.
         """
         from meerschaum.utils.misc import remove_ansi
         from meerschaum.utils.formatting import CHARSET, ANSI, colored
-        
+        from meerschaum._internal.shell.updates import get_update_message
+
         if shell_attrs.get('intro', None) != '':
             self.intro = (
                 get_shell_intro(with_color=False)
                 if shell_attrs.get('intro', None) != ''
                 else ""
-            )
+            ) + get_update_message()
 
         shell_attrs['intro'] = self.intro
         shell_attrs['_prompt'] = get_config('shell', CHARSET, 'prompt', patch=patch)

meerschaum/_internal/shell/updates.py

@@ -0,0 +1,175 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+
+"""
+If configured, check `api:mrsm` for announcement messages.
+"""
+
+import json
+from datetime import datetime, timezone, timedelta
+
+import meerschaum as mrsm
+from meerschaum.utils.typing import Union, SuccessTuple, Optional
+from meerschaum.config import get_config
+from meerschaum.utils.formatting import CHARSET, ANSI, colored
+from meerschaum.utils.misc import string_width, remove_ansi
+from meerschaum.config.paths import (
+    UPDATES_LOCK_PATH,
+    UPDATES_CACHE_PATH,
+)
+from meerschaum.utils.threading import Thread
+
+
+def cache_remote_version(debug: bool = False) -> SuccessTuple:
+    """
+    Fetch and cache the latest version if available.
+    """
+    allow_update_check = get_config('shell', 'updates', 'check_remote')
+    if not allow_update_check:
+        return True, "Update checks are disabled."
+
+    refresh_minutes = get_config('shell', 'updates', 'refresh_minutes')
+    update_delta = timedelta(minutes=refresh_minutes)
+
+    if UPDATES_CACHE_PATH.exists():
+        try:
+            with open(UPDATES_CACHE_PATH, 'r', encoding='utf8') as f:
+                cache_dict = json.load(f)
+        except Exception:
+            cache_dict = {}
+    else:
+        cache_dict = {}
+
+    now = datetime.now(timezone.utc)
+    last_check_ts_str = cache_dict.get('last_check_ts')
+    last_check_ts = datetime.fromisoformat(last_check_ts_str) if last_check_ts_str else None
+
+    need_update = (
+        last_check_ts_str is None
+        or ((now - last_check_ts) >= update_delta)
+    )
+
+    if not need_update:
+        return True, "No updates are needed."
+
+    try:
+        conn = mrsm.get_connector('api:mrsm')
+        remote_version = conn.get_mrsm_version(debug=debug, timeout=3)
+    except Exception:
+        remote_version = None
+
+    if remote_version is None:
+        return False, "Could not determine remote version."
+
+    with open(UPDATES_CACHE_PATH, 'w+', encoding='utf-8') as f:
+        json.dump(
+            {
+                'last_check_ts': now.isoformat(),
+                'remote_version': remote_version,
+            },
+            f,
+        )
+
+    return True, "Updated remote version cache."
+
+
+def run_version_check_thread(debug: bool = False) -> Union[Thread, None]:
+    """
+    Run the version update check in a separate thread.
+    """
+    allow_update_check = get_config('shell', 'updates', 'check_remote')
+    if not allow_update_check:
+        return None
+
+    thread = Thread(
+        target=cache_remote_version,
+        daemon=True,
+        kwargs={'debug': debug},
+    )
+    thread.start()
+    return thread
+
+
+_remote_version: Optional[str] = None
+def get_remote_version_from_cache() -> Optional[str]:
+    """
+    Return the version string from the local cache file.
+    """
+    global _remote_version
+    try:
+        with open(UPDATES_CACHE_PATH, 'r', encoding='utf-8') as f:
+            cache_dict = json.load(f)
+    except Exception:
+        return None
+
+    _remote_version = cache_dict.get('remote_version')
+    return _remote_version
+
+
+_out_of_date: Optional[bool] = None
+def mrsm_out_of_date() -> bool:
+    """
+    Determine whether to print the upgrade message.
+    """
+    global _out_of_date
+    if _out_of_date is not None:
+        return _out_of_date
+
+    ### NOTE: Remote version is cached asynchronously.
+    if not UPDATES_CACHE_PATH.exists():
+        return False
+
+    remote_version_str = get_remote_version_from_cache()
+
+    packaging_version = mrsm.attempt_import('packaging.version')
+    current_version = packaging_version.parse(mrsm.__version__)
+    remote_version = packaging_version.parse(remote_version_str)
+
+    _out_of_date = remote_version > current_version
+    return _out_of_date
+
+
+def get_update_message() -> str:
+    """
+    Return the formatted message for when the current version is behind the latest release.
+    """
+    if not mrsm_out_of_date():
+        return ''
+
+    intro = get_config('shell', CHARSET, 'intro')
+    update_message = get_config('shell', CHARSET, 'update_message')
+    remote_version = get_remote_version_from_cache()
+    if not remote_version:
+        return ''
+
+    intro_width = string_width(intro)
+    msg_width = string_width(update_message)
+    update_left_padding = ' ' * ((intro_width - msg_width) // 2)
+
+    update_line = (
+        colored(
+            update_message,
+            *get_config('shell', 'ansi', 'update_message', 'color')
+        ) if ANSI
+        else update_message
+    )
+    update_instruction = (
+        colored("Run ", 'white')
+        + colored("upgrade mrsm", 'green')
+        + colored(" to install ", 'white')
+        + colored(f'v{remote_version}', 'yellow')
+        + '.'
+    )
+    update_instruction_clean = remove_ansi(update_instruction)
+    instruction_width = string_width(update_instruction_clean)
+    instruction_left_padding = ' ' * ((intro_width - instruction_width) // 2)
+
+    return (
+        '\n\n'
+        + update_left_padding
+        + update_line
+        + '\n'
+        + instruction_left_padding
+        + update_instruction
+    )

meerschaum/actions/register.py

@@ -203,14 +203,23 @@ def _register_plugins(
     successes = {}
 
     for name, plugin in plugins_to_register.items():
-        desc = None
         plugin.attributes = repo_connector.get_plugin_attributes(plugin, debug=debug)
         if plugin.attributes is None:
             plugin.attributes = {}
+
+        try:
+            description_text = plugin.attributes.get('description', '')
+            doc_text = plugin.module.__doc__.lstrip().rstrip()
+        except Exception:
+            description_text = ''
+            doc_text = ''
+
+        desc = description_text or doc_text or ''
+
         question = f"Would you like to add a description to plugin '{name}'?"
-        if plugin.attributes.get('description', None):
+        if desc:
             info(f"Found existing description for plugin '{plugin}':")
-            print(plugin.attributes['description'])
+            print(desc)
             question = (
                 "Would you like to overwrite this description?\n"
                 + "To edit the existing text, visit /dash/plugins for this repository."
@@ -220,9 +229,14 @@ def _register_plugins(
             default='n',
             yes=yes
         ):
-            info('Press (Esc + Enter) to submit the description, (CTRL + C) to cancel.')
+            info('Press (Esc + Enter) to submit, (CTRL + C) to cancel.')
             try:
-                desc = prompt('', multiline=True, icon=False)
+                desc = prompt(
+                    '',
+                    multiline=True,
+                    icon=False,
+                    default_editable=desc.lstrip().rstrip(),
+                )
             except KeyboardInterrupt:
                 desc = None
             if desc == '':

meerschaum/actions/sync.py

@@ -14,9 +14,9 @@ import meerschaum as mrsm
 from meerschaum.utils.typing import SuccessTuple, Any, List, Optional, Tuple, Union
 
 def sync(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> SuccessTuple:
     """
     Fetch and sync data for pipes.
 

meerschaum/actions/upgrade.py

@@ -10,9 +10,9 @@ from __future__ import annotations
 from meerschaum.utils.typing import SuccessTuple, Any, List, Optional, Union
 
 def upgrade(
-        action: Optional[List[str]] = None,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    **kw: Any
+) -> SuccessTuple:
     """
     Upgrade Meerschaum, plugins, or packages.
     
@@ -34,13 +34,13 @@ def upgrade(
 
 
 def _upgrade_meerschaum(
-        action: Optional[List[str]] = None,
-        yes: bool = False,
-        force: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    yes: bool = False,
+    force: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Upgrade the current Meerschaum instance.
     Optionally specify dependency groups.
@@ -109,26 +109,21 @@ class NoVenv:
     pass
 
 def _upgrade_packages(
-        action: Optional[List[str]] = None,
-        venv: Union[str, None, NoVenv] = NoVenv,
-        yes: bool = False,
-        force: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    venv: Union[str, None, NoVenv] = NoVenv,
+    yes: bool = False,
+    force: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Upgrade and install dependencies.
     If provided, upgrade only a dependency group, otherwise default to `full`.
     
     Examples:
-        ```
         upgrade packages
-        ```
-    
-        ```
-        upgrade packages docs
-        ```
+        upgrade packages full
     """
     from meerschaum.utils.packages import packages, pip_install, get_prerelease_dependencies
     from meerschaum.utils.warnings import info, warn
@@ -178,14 +173,15 @@ def _upgrade_packages(
         )
     return success, msg
 
+
 def _upgrade_plugins(
-        action: Optional[List[str]] = None,
-        yes: bool = False,
-        force: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    yes: bool = False,
+    force: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Upgrade all installed plugins to the latest versions.
     If no plugins are specified, attempt to upgrade all,
@@ -193,12 +189,8 @@ def _upgrade_plugins(
     
     Examples:
     
-    ```
     upgrade plugins
-    ```
-    ```
-    upgrade plugins testing
-    ```
+    upgrade plugins noaa
     """
     from meerschaum.actions import actions
     from meerschaum.plugins import get_plugins_names

meerschaum/api/routes/_pipes.py

@@ -44,14 +44,14 @@ pd = attempt_import('pandas')
 
 @app.post(pipes_endpoint + '/{connector_keys}/{metric_key}/{location_key}/register', tags=['Pipes'])
 def register_pipe(
-        connector_keys: str,
-        metric_key: str,
-        location_key: str,
-        parameters: dict,
-        curr_user = (
-            fastapi.Depends(manager) if not no_auth else None
-        ),
-    ):
+    connector_keys: str,
+    metric_key: str,
+    location_key: str,
+    parameters: dict,
+    curr_user = (
+        fastapi.Depends(manager) if not no_auth else None
+    ),
+):
     """
     Register a new pipe.
     """
@@ -376,18 +376,18 @@ def sync_pipe(
 
 @app.get(pipes_endpoint + '/{connector_keys}/{metric_key}/{location_key}/data', tags=['Pipes'])
 def get_pipe_data(
-        connector_keys: str,
-        metric_key: str,
-        location_key: str,
-        select_columns: Optional[str] = None,
-        omit_columns: Optional[str] = None,
-        begin: Union[str, int, None] = None,
-        end: Union[str, int, None] = None,
-        params: Optional[str] = None,
-        curr_user = (
-            fastapi.Depends(manager) if not no_auth else None
-        ),
-    ) -> str:
+    connector_keys: str,
+    metric_key: str,
+    location_key: str,
+    select_columns: Optional[str] = None,
+    omit_columns: Optional[str] = None,
+    begin: Union[str, int, None] = None,
+    end: Union[str, int, None] = None,
+    params: Optional[str] = None,
+    curr_user = (
+        fastapi.Depends(manager) if not no_auth else None
+    ),
+) -> str:
     """
     Get a pipe's data, applying any filtering.
 

meerschaum/config/_formatting.py

@@ -36,6 +36,7 @@ default_formatting_config = {
         'paused'           : '🟡',
         'stopped'          : '🔴',
         'tag'              : '🔖',
+        'announcement'     : '📢',
     },
     'pipes'                : {
         'unicode'          : {

meerschaum/config/_paths.py

@@ -123,6 +123,10 @@ paths = {
     'PERMANENT_PATCH_DIR_PATH'       : ('{ROOT_DIR_PATH}', 'permanent_patch_config'),
     'INTERNAL_RESOURCES_PATH'        : ('{ROOT_DIR_PATH}', '.internal'),
 
+    'UPDATES_RESOURCES_PATH'         : ('{INTERNAL_RESOURCES_PATH}', 'updates'),
+    'UPDATES_CACHE_PATH'             : ('{UPDATES_RESOURCES_PATH}', 'cache.json'),
+    'UPDATES_LOCK_PATH'              : ('{UPDATES_RESOURCES_PATH}', '.updates.lock'),
+
     'STACK_RESOURCES_PATH'           : ('{ROOT_DIR_PATH}', 'stack'),
     'STACK_COMPOSE_FILENAME'         : 'docker-compose.yaml',
     'STACK_COMPOSE_PATH'             : ('{STACK_RESOURCES_PATH}', '{STACK_COMPOSE_FILENAME}'),