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

meerschaum/plugins/bootstrap.py

@@ -0,0 +1,333 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+
+"""
+Define the bootstrapping wizard for creating plugins.
+"""
+
+import re
+import pathlib
+import meerschaum as mrsm
+from meerschaum.utils.typing import Any, SuccessTuple, Dict, List
+from meerschaum.utils.warnings import warn, info
+from meerschaum.utils.prompt import prompt, choose, yes_no
+from meerschaum.utils.formatting._shell import clear_screen
+
+FEATURE_CHOICES: Dict[str, str] = {
+    'fetch'    : 'Fetch data\n     (e.g. extracting from a remote API)\n',
+    'connector': 'Custom connector\n     (e.g. manage credentials)\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',
+}
+
+IMPORTS_LINES: Dict[str, str] = {
+    'stdlib': (
+        "from datetime import datetime, timedelta, timezone\n"
+    ),
+    'default': (
+        "import meerschaum as mrsm\n"
+        "from meerschaum.config import get_plugin_config, write_plugin_config\n"
+    ),
+    'connector': (
+        "from meerschaum.connectors import Connector, make_connector\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: Dict[str, str] = {
+    'header': (
+        "#! /usr/bin/env python3\n"
+        "# -*- coding: utf-8 -*-\n\n"
+        "\"\"\"\n"
+        "Implement the plugin '{plugin_name}'.\n\n"
+        "See the Writing Plugins guide for more information:\n"
+        "https://meerschaum.io/reference/plugins/writing-plugins/\n"
+        "\"\"\"\n\n"
+    ),
+    'default': (
+        "__version__ = '0.0.1'\n"
+        "\n# Add any dependencies to `required` (similar to `requirements.txt`).\n"
+        "required: list[str] = []\n\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': {dt_col_name},\n"
+        "        }}\n"
+        "    }}\n\n\n"
+    ),
+    'fetch': (
+        "def fetch(\n"
+        "    pipe: mrsm.Pipe,\n"
+        "    begin: datetime | None = None,\n"
+        "    end: datetime | None = None,\n"
+        "    **kwargs\n"
+        "):\n"
+        "    \"\"\"Return or yield dataframes.\"\"\"\n"
+        "    docs = []\n"
+        "    # populate docs with dictionaries (rows).\n"
+        "    return docs\n\n\n"
+    ),
+    'connector': (
+        "@make_connector\n"
+        "class {plugin_name_capitalized}Connector(Connector):\n"
+        "    \"\"\"Implement '{plugin_name_lower}' connectors.\"\"\"\n\n"
+        "    REQUIRED_ATTRIBUTES: list[str] = []\n"
+        "    \n"
+        "    def fetch(\n"
+        "        self,\n"
+        "        pipe: mrsm.Pipe,\n"
+        "        begin: datetime | None = None,\n"
+        "        end: datetime | None = None,\n"
+        "        **kwargs\n"
+        "    ):\n"
+        "        \"\"\"Return or yield dataframes.\"\"\"\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('/{plugin_name}')\n"
+        "    def get_my_endpoint(curr_user=fastapi.Depends(manager)):\n"
+        "        return {{'message': \"Hello from plugin '{plugin_name}'!\"}}\n\n\n"
+    ),
+    'web': (
+        "@dash_plugin\n"
+        "def init_dash(dash_app):\n"
+        "    \"\"\"Initialize the Plotly Dash application.\"\"\"\n\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"
+    ),
+}
+
+def bootstrap_plugin(
+        plugin_name: str,
+        debug: bool = False,
+        **kwargs: Any
+    ) -> SuccessTuple:
+    """
+    Prompt the user for features and create a plugin file.
+    """
+    from meerschaum.utils.misc import edit_file
+    plugins_dir_path = _get_plugins_dir_path()
+    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"
+    )
+
+    plugin = mrsm.Plugin(plugin_name)
+    if plugin.is_installed():
+        uninstall_success, uninstall_msg = _ask_to_uninstall(plugin)
+        if not uninstall_success:
+            return uninstall_success, uninstall_msg
+        clear_screen(debug=debug)
+
+    features: List[str] = choose(
+        "Which of the following features would you like to add to your plugin?",
+        list(FEATURE_CHOICES.items()),
+        default = 'fetch',
+        multiple = True,
+        as_indices = True,
+        **kwargs
+    )
+
+    clear_screen(debug=debug)
+
+    action_name = ''
+    if 'action' in features:
+        action_name = _get_action_name()
+        clear_screen(debug=debug)
+    action_spaces = action_name.replace('_', ' ')
+
+    dt_col_name = None
+    if 'fetch' in features:
+        dt_col_name = _get_quoted_dt_col_name()
+        clear_screen(debug=debug)
+
+    plugin_labels = {
+        'plugin_name': plugin_name,
+        'plugin_name_capitalized': re.split(
+            r'[-_]', plugin_name.lower()
+        )[0].capitalize(),
+        'plugin_name_lower': plugin_name.lower(),
+        'action_name': action_name,
+        'action_spaces': action_spaces,
+        'dt_col_name': dt_col_name,
+    }
+
+    body_text = ""
+    body_text += FEATURE_LINES['header'].format(**plugin_labels)
+    body_text += IMPORTS_LINES['stdlib'].format(**plugin_labels)
+    body_text += IMPORTS_LINES['default'].format(**plugin_labels)
+    if 'connector' in features:
+        body_text += IMPORTS_LINES['connector'].format(**plugin_labels)
+    if 'action' in features:
+        body_text += IMPORTS_LINES['action'].format(**plugin_labels)
+    if 'api' in features and 'web' in features:
+        body_text += IMPORTS_LINES['api+web'].format(**plugin_labels)
+    elif 'api' in features:
+        body_text += IMPORTS_LINES['api'].format(**plugin_labels)
+    elif 'web' in features:
+        body_text += IMPORTS_LINES['web'].format(**plugin_labels)
+
+    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'].format(**plugin_labels)
+        body_text += FEATURE_LINES['fetch'].format(**plugin_labels)
+
+    if 'connector' in features:
+        body_text += FEATURE_LINES['connector'].format(**plugin_labels)
+
+    if 'action' in features:
+        body_text += FEATURE_LINES['action'].format(**plugin_labels)
+
+    if 'api' in features:
+        body_text += FEATURE_LINES['api'].format(**plugin_labels)
+
+    if 'web' in features:
+        body_text += FEATURE_LINES['web'].format(**plugin_labels)
+
+    try:
+        plugin_path = plugins_dir_path / (plugin_name + '.py')
+        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
+
+    clear_screen(debug=debug)
+    mrsm.pprint((True, f"Successfully created file '{plugin_path}'."))
+    try:
+        _ = prompt(
+            f"Press [Enter] to edit plugin '{plugin_name}',"
+            + " [CTRL+C] to skip.",
+            icon = False,
+        )
+    except (KeyboardInterrupt, Exception):
+        return True, "Success"
+
+    edit_file(plugin_path, debug=debug)
+    return True, "Success"
+
+
+def _get_plugins_dir_path() -> pathlib.Path:
+    from meerschaum.config.paths import PLUGINS_DIR_PATHS
+    
+    if not PLUGINS_DIR_PATHS:
+        raise EnvironmentError("No plugin dir path could be found.")
+
+    if len(PLUGINS_DIR_PATHS) == 1:
+        return PLUGINS_DIR_PATHS[0]
+
+    return 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(),
+        )
+    )
+ 
+
+def _ask_to_uninstall(plugin: mrsm.Plugin, **kwargs: Any) -> SuccessTuple:
+    from meerschaum._internal.entry import entry
+    warn(f"Plugin '{plugin}' 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}' already exists."
+
+    return entry(['uninstall', 'plugin', plugin.name, '-f'])
+
+
+def _get_action_name() -> str:
+    while True:
+        try:
+            action_name = prompt(
+                "What is name of your action?\n    "
+                + "(separate subactions with spaces, e.g. `sing song`):"
+            ).replace(' ', '_')
+        except KeyboardInterrupt:
+            return False, "Aborted plugin creation."
+
+        if action_name:
+            break
+        warn("Please enter an action.", stack=False)
+    return action_name
+
+
+def _get_quoted_dt_col_name() -> str:
+    try:
+        dt_col_name = prompt(
+            "Enter the datetime column name ([CTRL+C] to skip):"
+        )
+    except (Exception, KeyboardInterrupt):
+        dt_col_name = None
+
+    if dt_col_name is None:
+        dt_col_name = 'None'
+    elif '"' in dt_col_name or "'" in dt_col_name:
+        dt_col_name = f"\"\"\"{dt_col_name}\"\"\""
+    else:
+        dt_col_name = f"\"{dt_col_name}\""
+
+    return dt_col_name

meerschaum/utils/daemon/Daemon.py

@@ -185,7 +185,7 @@ class Daemon:
                     result = self.target(*self.target_args, **self.target_kw)
                     self.properties['result'] = result
                 except Exception as e:
-                    warn(e, stacklevel=3)
+                    warn(f"Exception in daemon target function: {e}", stacklevel=3)
                     result = e
                 finally:
                     self._log_refresh_timer.cancel()
@@ -203,9 +203,20 @@ class Daemon:
             daemon_error = traceback.format_exc()
             with open(DAEMON_ERROR_LOG_PATH, 'a+', encoding='utf-8') as f:
                 f.write(daemon_error)
+            warn(f"Encountered an error while running the daemon '{self}':\n{daemon_error}")
+        finally:
+            self._cleanup_on_exit()
 
-        if daemon_error:
-            warn(f"Encountered an error while starting the daemon '{self}':\n{daemon_error}")
+    def _cleanup_on_exit(self):
+        """Perform cleanup operations when the daemon exits."""
+        try:
+            self._log_refresh_timer.cancel()
+            self.rotating_log.close()
+            if self.pid is None and self.pid_path.exists():
+                self.pid_path.unlink()
+            self._capture_process_timestamp('ended')
+        except Exception as e:
+            warn(f"Error during daemon cleanup: {e}")
 
 
     def _capture_process_timestamp(

meerschaum/utils/daemon/FileDescriptorInterceptor.py

@@ -65,24 +65,31 @@ class FileDescriptorInterceptor:
             except BlockingIOError:
                 continue
             except OSError as e:
-                continue
+                from meerschaum.utils.warnings import warn
+                warn(f"OSError in FileDescriptorInterceptor: {e}")
+                break
 
-            first_char_is_newline = data[0] == b'\n'
-            last_char_is_newline = data[-1] == b'\n'
+            try:
+                first_char_is_newline = data[0] == b'\n'
+                last_char_is_newline = data[-1] == b'\n'
 
-            injected_str = self.injection_hook()
-            injected_bytes = injected_str.encode('utf-8')
+                injected_str = self.injection_hook()
+                injected_bytes = injected_str.encode('utf-8')
 
-            if is_first_read:
-                data = b'\n' + data
-                is_first_read = False
+                if is_first_read:
+                    data = b'\n' + data
+                    is_first_read = False
 
-            modified_data = (
-                (data[:-1].replace(b'\n', b'\n' + injected_bytes) + b'\n')
-                if last_char_is_newline
-                else data.replace(b'\n', b'\n' + injected_bytes)
-            )
-            os.write(self.new_file_descriptor, modified_data)
+                modified_data = (
+                    (data[:-1].replace(b'\n', b'\n' + injected_bytes) + b'\n')
+                    if last_char_is_newline
+                    else data.replace(b'\n', b'\n' + injected_bytes)
+                )
+                os.write(self.new_file_descriptor, modified_data)
+            except Exception as e:
+                from meerschaum.utils.warnings import warn
+                warn(f"Error in FileDescriptorInterceptor data processing: {e}")
+                break
 
 
     def stop_interception(self):

meerschaum/utils/daemon/RotatingFile.py

@@ -355,26 +355,29 @@ class RotatingFile(io.IOBase):
         As such, if data is larger than max_file_size, then the corresponding subfile
         may exceed this limit.
         """
-        self.file_path.parent.mkdir(exist_ok=True, parents=True)
-        if isinstance(data, bytes):
-            data = data.decode('utf-8')
-
-        prefix_str = self.get_timestamp_prefix_str() if self.write_timestamps else ""
-        suffix_str = "\n" if self.write_timestamps else ""
-        self.refresh_files(
-            potential_new_len = len(prefix_str + data + suffix_str),
-            start_interception = self.write_timestamps,
-        )
         try:
-            if prefix_str:
-                self._current_file_obj.write(prefix_str)
-            self._current_file_obj.write(data)
-            if suffix_str:
-                self._current_file_obj.write(suffix_str)
+            self.file_path.parent.mkdir(exist_ok=True, parents=True)
+            if isinstance(data, bytes):
+                data = data.decode('utf-8')
+
+            prefix_str = self.get_timestamp_prefix_str() if self.write_timestamps else ""
+            suffix_str = "\n" if self.write_timestamps else ""
+            self.refresh_files(
+                potential_new_len = len(prefix_str + data + suffix_str),
+                start_interception = self.write_timestamps,
+            )
+            try:
+                if prefix_str:
+                    self._current_file_obj.write(prefix_str)
+                self._current_file_obj.write(data)
+                if suffix_str:
+                    self._current_file_obj.write(suffix_str)
+            except Exception as e:
+                warn(f"Failed to write to subfile:\n{traceback.format_exc()}")
+            self.flush()
+            self.delete(unused_only=True)
         except Exception as e:
-            warn(f"Failed to write to subfile:\n{traceback.format_exc()}")
-        self.flush()
-        self.delete(unused_only=True)
+            warn(f"Unexpected error in RotatingFile.write: {e}")
 
 
     def delete(self, unused_only: bool = False) -> None:

meerschaum/utils/formatting/__init__.py

@@ -10,7 +10,7 @@ from __future__ import annotations
 import platform
 import os
 import sys
-from meerschaum.utils.typing import Optional, Union, Any
+from meerschaum.utils.typing import Optional, Union, Any, Dict
 from meerschaum.utils.formatting._shell import make_header
 from meerschaum.utils.formatting._pprint import pprint
 from meerschaum.utils.formatting._pipes import (
@@ -298,6 +298,7 @@ def print_options(
         header: Optional[str] = None,
         num_cols: Optional[int] = None,
         adjust_cols: bool = True,
+        sort_options: bool = False,
         **kw
     ) -> None:
     """
@@ -339,6 +340,8 @@ def print_options(
     _options = []
     for o in options:
         _options.append(str(o))
+    if sort_options:
+        _options = sorted(_options)
     _header = f"Available {name}" if header is None else header
 
     if num_cols is None:
@@ -349,7 +352,7 @@ def print_options(
             print()
             print(make_header(_header))
         ### print actions
-        for option in sorted(_options):
+        for option in _options:
             if not nopretty:
                 print("  - ", end="")
             print(option)
@@ -385,7 +388,7 @@ def print_options(
 
     if _header is not None:
         table = Table(
-            title = '\n' + _header,
+            title = ('\n' + _header) if header else header,
             box = box.SIMPLE,
             show_header = False,
             show_footer = False,
@@ -397,13 +400,22 @@ def print_options(
     for i in range(num_cols):
         table.add_column()
 
-    chunks = iterate_chunks(
-        [Text.from_ansi(highlight_pipes(o)) for o in sorted(_options)],
-        num_cols,
-        fillvalue=''
-    )
-    for c in chunks:
-        table.add_row(*c)
+    if len(_options) < 12:
+        # If fewer than 12 items, use a single column
+        for option in _options:
+            table.add_row(Text.from_ansi(highlight_pipes(option)))
+    else:
+        # Otherwise, use multiple columns as before
+        num_rows = (len(_options) + num_cols - 1) // num_cols
+        for i in range(num_rows):
+            row = []
+            for j in range(num_cols):
+                index = i + j * num_rows
+                if index < len(_options):
+                    row.append(Text.from_ansi(highlight_pipes(_options[index])))
+                else:
+                    row.append('')
+            table.add_row(*row)
 
     get_console().print(table)
     return None

meerschaum/utils/packages/_packages.py

@@ -42,6 +42,7 @@ packages: Dict[str, Dict[str, str]] = {
         'requests'                   : 'requests>=2.23.0',
         'binaryornot'                : 'binaryornot>=0.4.4',
         'pyvim'                      : 'pyvim>=3.0.2',
+        'ptpython'                   : 'ptpython>=3.0.27',
         'aiofiles'                   : 'aiofiles>=0.6.0',
         'packaging'                  : 'packaging>=21.3.0',
         'prompt_toolkit'             : 'prompt-toolkit>=3.0.39',
@@ -74,7 +75,6 @@ packages: Dict[str, Dict[str, str]] = {
         'litecli'                    : 'litecli>=1.5.0',
         'mssqlcli'                   : 'mssql-cli>=1.0.0',
         'gadwall'                    : 'gadwall>=0.2.0',
-        'ptpython'                   : 'ptpython>=3.0.27',
     },
     'stack': {
         'compose'                    : 'docker-compose>=1.29.2',