meerschaum 2.2.5.dev3__py3-none-any.whl → 2.2.7__py3-none-any.whl

meerschaum/utils/misc.py

@@ -6,6 +6,7 @@ Miscellaneous functions go here
 """
 
 from __future__ import annotations
+import sys
 from datetime import timedelta, datetime, timezone
 from meerschaum.utils.typing import (
     Union,
@@ -22,8 +23,11 @@ from meerschaum.utils.typing import (
     Hashable,
     Generator,
     Iterator,
+    TYPE_CHECKING,
 )
 import meerschaum as mrsm
+if TYPE_CHECKING:
+    import collections
 
 __pdoc__: Dict[str, bool] = {
     'to_pandas_dtype': False,
@@ -208,6 +212,7 @@ def parse_config_substitution(
 
     return leading_key[len(leading_key):][len():-1].split(delimeter)
 
+
 def edit_file(
         path: Union[pathlib.Path, str],
         default_editor: str = 'pyvim',
@@ -233,7 +238,6 @@ def edit_file(
     Returns
     -------
     A bool indicating the file was successfully edited.
-
     """
     import os
     from subprocess import call
@@ -254,7 +258,7 @@ def edit_file(
 
 
 def is_pipe_registered(
-        pipe: 'meerschaum.Pipe',
+        pipe: mrsm.Pipe,
         pipes: PipesDict,
         debug: bool = False
     ) -> bool:
@@ -726,25 +730,53 @@ def replace_password(d: Dict[str, Any], replace_with: str = '*') -> Dict[str, An
     return _d
 
 
+def filter_arguments(
+    func: Callable[[Any], Any],
+    *args: Any,
+    **kwargs: Any
+) -> Tuple[Tuple[Any], Dict[str, Any]]:
+    """
+    Filter out unsupported positional and keyword arguments.
+
+    Parameters
+    ----------
+    func: Callable[[Any], Any]
+        The function to inspect.
+
+    *args: Any
+        Positional arguments to filter and pass to `func`.
+
+    **kwargs
+        Keyword arguments to filter and pass to `func`.
+
+    Returns
+    -------
+    The `args` and `kwargs` accepted by `func`.
+    """
+    args = filter_positionals(func, *args)
+    kwargs = filter_keywords(func, **kwargs)
+    return args, kwargs
+
+
 def filter_keywords(
-        func: Callable[[Any], Any],
-        **kw: Any
-    ) -> Dict[str, Any]:
+    func: Callable[[Any], Any],
+    **kw: Any
+) -> Dict[str, Any]:
     """
-    Filter out unsupported keywords.
+    Filter out unsupported keyword arguments.
 
     Parameters
     ----------
     func: Callable[[Any], Any]
         The function to inspect.
-        
+
     **kw: Any
         The arguments to be filtered and passed into `func`.
 
     Returns
     -------
     A dictionary of keyword arguments accepted by `func`.
-    
+
     Examples
     --------
     ```python
@@ -766,6 +798,69 @@ def filter_keywords(
     return {k: v for k, v in kw.items() if k in func_params}
 
 
+def filter_positionals(
+    func: Callable[[Any], Any],
+    *args: Any
+) -> Tuple[Any]:
+    """
+    Filter out unsupported positional arguments.
+
+    Parameters
+    ----------
+    func: Callable[[Any], Any]
+        The function to inspect.
+
+    *args: Any
+        The arguments to be filtered and passed into `func`.
+        NOTE: If the function signature expects more arguments than provided,
+        the missing slots will be filled with `None`.
+
+    Returns
+    -------
+    A tuple of positional arguments accepted by `func`.
+
+    Examples
+    --------
+    ```python
+    >>> def foo(a, b):
+    ...     return a * b
+    >>> filter_positionals(foo, 2, 4, 6)
+    (2, 4)
+    >>> foo(*filter_positionals(foo, 2, 4, 6))
+    8
+    ```
+
+    """
+    import inspect
+    from meerschaum.utils.warnings import warn
+    func_params = inspect.signature(func).parameters
+    acceptable_args: List[Any] = []
+
+    def _warn_invalids(_num_invalid):
+        if _num_invalid > 0:
+            warn(
+                "Too few arguments were provided. "
+                + f"{_num_invalid} argument"
+                + ('s have ' if _num_invalid != 1 else " has ")
+                + " been filled with `None`.",
+            )
+
+    num_invalid: int = 0
+    for i, (param, val) in enumerate(func_params.items()):
+        if '=' in str(val) or '*' in str(val):
+            _warn_invalids(num_invalid)
+            return tuple(acceptable_args)
+
+        try:
+            acceptable_args.append(args[i])
+        except IndexError:
+            acceptable_args.append(None)
+            num_invalid += 1
+
+    _warn_invalids(num_invalid)
+    return tuple(acceptable_args)
+
+
 def dict_from_od(od: collections.OrderedDict) -> Dict[Any, Any]:
     """
     Convert an ordered dict to a dict.
@@ -974,10 +1069,11 @@ def async_wrap(func):
 def debug_trace(browser: bool = True):
     """
     Open a web-based debugger to trace the execution of the program.
+
+    This is an alias import for `meerschaum.utils.debug.debug_trace`.
     """
-    from meerschaum.utils.packages import attempt_import
-    heartrate = attempt_import('heartrate')
-    heartrate.trace(files=heartrate.files.all, browser=browser)
+    from meerschaum.utils.debug import trace
+    trace(browser=browser)
 
 
 def items_str(
@@ -1554,3 +1650,13 @@ def _get_subaction_names(*args, **kwargs) -> Any:
     """
     from meerschaum.actions import _get_subaction_names as real_function
     return real_function(*args, **kwargs)
+
+
+_current_module = sys.modules[__name__]
+__all__ = tuple(
+    name
+    for name, obj in globals().items()
+    if callable(obj)
+        and name not in __pdoc__
+        and getattr(obj, '__module__', None) == _current_module.__name__
+)

meerschaum/utils/packages/__init__.py

@@ -816,6 +816,7 @@ def pip_install(
     """
     from meerschaum.config._paths import VIRTENV_RESOURCES_PATH
     from meerschaum.config import get_config
+    from meerschaum.config.static import STATIC_CONFIG
     from meerschaum.utils.warnings import warn
     from meerschaum.utils.misc import is_android
     if args is None:
@@ -827,6 +828,11 @@ def pip_install(
     if check_wheel:
         have_wheel = venv_contains_package('wheel', venv=venv, debug=debug)
 
+    daemon_env_var = STATIC_CONFIG['environment']['daemon_id']
+    inside_daemon = daemon_env_var in os.environ
+    if inside_daemon:
+        silent = True
+
     _args = list(args)
     have_pip = venv_contains_package('pip', venv=None, debug=debug)
     try:
@@ -844,16 +850,16 @@ def pip_install(
     if have_pip and not have_uv_pip and _install_uv_pip and not is_android():
         if not pip_install(
             'uv',
-            venv = None,
-            debug = debug,
-            _install_uv_pip = False,
-            check_update = False,
-            check_pypi = False,
-            check_wheel = False,
-        ):
+            venv=None,
+            debug=debug,
+            _install_uv_pip=False,
+            check_update=False,
+            check_pypi=False,
+            check_wheel=False,
+        ) and not silent:
             warn(
                 f"Failed to install `uv` for virtual environment '{venv}'.",
-                color = False,
+                color=False,
             )
 
     use_uv_pip = (
@@ -909,13 +915,13 @@ def pip_install(
                     check_wheel = False,
                     debug = debug,
                     _install_uv_pip = False,
-                ):
+                ) and not silent:
                     warn(
                         (
                             "Failed to install `setuptools`, `wheel`, and `uv` for virtual "
                             + f"environment '{venv}'."
                         ),
-                        color = False,
+                        color=False,
                     )
 
         if requirements_file_path is not None:
@@ -975,7 +981,7 @@ def pip_install(
                 if not completely_uninstall_package(
                     _install_no_version,
                     venv=venv, debug=debug,
-                ):
+                ) and not silent:
                     warn(
                         f"Failed to clean up package '{_install_no_version}'.",
                     )
@@ -989,9 +995,9 @@ def pip_install(
         rc = run_python_package(
             ('pip' if not use_uv_pip else 'uv'),
             _args + _packages,
-            venv = None,
-            env = _get_pip_os_env(color=color),
-            debug = debug,
+            venv=None,
+            env=_get_pip_os_env(color=color),
+            debug=debug,
         )
         if debug:
             print(f"{rc=}")
@@ -1003,7 +1009,7 @@ def pip_install(
     )
     if not silent:
         print(msg)
-    if debug:
+    if debug and not silent:
         print('pip ' + ('un' if _uninstall else '') + 'install returned:', success)
     return success
 
@@ -1849,10 +1855,16 @@ def _get_pip_os_env(color: bool = True):
     Return the environment variables context in which `pip` should be run.
     See PEP 668 for why we are overriding the environment.
     """
-    import os
+    import os, sys, platform
+    python_bin_path = pathlib.Path(sys.executable)
     pip_os_env = os.environ.copy()
+    path_str = pip_os_env.get('PATH', '') or ''
+    path_sep = ':' if platform.system() != 'Windows' else ';'
     pip_os_env.update({
         'PIP_BREAK_SYSTEM_PACKAGES': 'true',
         ('FORCE_COLOR' if color else 'NO_COLOR'): '1',
     })
+    if str(python_bin_path) not in path_str:
+        pip_os_env['PATH'] = str(python_bin_path.parent) + path_sep + path_str
+
     return pip_os_env

meerschaum/utils/prompt.py

@@ -14,6 +14,7 @@ def prompt(
         question: str,
         icon: bool = True,
         default: Union[str, Tuple[str, str], None] = None,
+        default_editable: Optional[str] = None,
         detect_password: bool = True,
         is_password: bool = False,
         wrap_lines: bool = True,
@@ -37,6 +38,9 @@ def prompt(
     default: Union[str, Tuple[str, str], None], default None
         If the response is '', return the default value.
 
+    default_editable: Optional[str], default None
+        If provided, auto-type this user-editable string in the prompt.
+
     detect_password: bool, default True
         If `True`, set the input method to a censored password box if the word `password`
         appears in the question.
@@ -102,6 +106,7 @@ def prompt(
         prompt_toolkit.prompt(
             prompt_toolkit.formatted_text.ANSI(question),
             wrap_lines = wrap_lines,
+            default = default_editable or '',
             **filter_keywords(prompt_toolkit.prompt, **kw)
         ) if not noask else ''
     )

meerschaum/utils/schedule.py

@@ -7,10 +7,12 @@ Schedule processes and threads.
 """
 
 from __future__ import annotations
-import sys
+import signal
+import traceback
 from datetime import datetime, timezone, timedelta
 import meerschaum as mrsm
 from meerschaum.utils.typing import Callable, Any, Optional, List, Dict
+from meerschaum.utils.warnings import warn, error
 
 STARTING_KEYWORD: str = 'starting'
 INTERVAL_UNITS: List[str] = ['months', 'weeks', 'days', 'hours', 'minutes', 'seconds', 'years']
@@ -70,15 +72,15 @@ SCHEDULE_ALIASES: Dict[str, str] = {
 
 _scheduler = None
 def schedule_function(
-        function: Callable[[Any], Any],
-        schedule: str,
-        *args,
-        debug: bool = False,
-        **kw
-    ) -> None:
+    function: Callable[[Any], Any],
+    schedule: str,
+    *args,
+    debug: bool = False,
+    **kw
+) -> mrsm.SuccessTuple:
     """
     Block the process and execute the function intermittently according to the frequency.
-    https://rocketry.readthedocs.io/en/stable/condition_syntax/index.html
+    https://meerschaum.io/reference/background-jobs/#-schedules
 
     Parameters
     ----------
@@ -88,10 +90,13 @@ def schedule_function(
     schedule: str
         The frequency schedule at which `function` should be executed (e.g. `'daily'`).
 
+    Returns
+    -------
+    A `SuccessTuple` upon exit.
     """
     import asyncio
-    from meerschaum.utils.warnings import warn
     from meerschaum.utils.misc import filter_keywords, round_time
+
     global _scheduler
     kw['debug'] = debug
     kw = filter_keywords(function, **kw)
@@ -105,15 +110,16 @@ def schedule_function(
     except RuntimeError:
         loop = asyncio.new_event_loop()
 
+
     async def run_scheduler():
         async with _scheduler:
             job = await _scheduler.add_schedule(
                 function,
                 trigger,
-                args = args,
-                kwargs = kw,
-                max_running_jobs = 1, 
-                conflict_policy = apscheduler.ConflictPolicy.replace,
+                args=args,
+                kwargs=kw,
+                max_running_jobs=1,
+                conflict_policy=apscheduler.ConflictPolicy.replace,
             )
             try:
                 await _scheduler.run_until_stopped()
@@ -126,12 +132,13 @@ def schedule_function(
     except (KeyboardInterrupt, SystemExit) as e:
         loop.run_until_complete(_stop_scheduler())
 
+    return True, "Success"
+
 
 def parse_schedule(schedule: str, now: Optional[datetime] = None):
     """
     Parse a schedule string (e.g. 'daily') into a Trigger object.
     """
-    from meerschaum.utils.warnings import error
     from meerschaum.utils.misc import items_str, is_int
     (
         apscheduler_triggers_cron,
@@ -279,7 +286,6 @@ def parse_start_time(schedule: str, now: Optional[datetime] = None) -> datetime:
     datetime.datetime(2024, 5, 13, 0, 30, tzinfo=datetime.timezone.utc)
     """
     from meerschaum.utils.misc import round_time
-    from meerschaum.utils.warnings import error, warn
     dateutil_parser = mrsm.attempt_import('dateutil.parser')
     starting_parts = schedule.split(STARTING_KEYWORD)
     starting_str = ('now' if len(starting_parts) == 1 else starting_parts[-1]).strip()

meerschaum/utils/typing.py

@@ -14,6 +14,7 @@ try:
         Hashable,
         Generator,
         Iterator,
+        TYPE_CHECKING,
     )
 except Exception as e:
     import urllib.request, sys, pathlib, os

meerschaum/utils/venv/__init__.py

@@ -616,7 +616,11 @@ def venv_target_path(
             return site_packages_path
 
         if not inside_venv():
-            site_path = pathlib.Path(site.getusersitepackages())
+            user_site_packages = site.getusersitepackages()
+            if user_site_packages is None:
+                raise EnvironmentError("Could not determine user site packages.")
+
+            site_path = pathlib.Path(user_site_packages)
             if not site_path.exists():
 
                 ### Windows does not have `os.geteuid()`.

meerschaum/utils/warnings.py

@@ -3,7 +3,7 @@
 # vim:fenc=utf-8
 
 """
-Handle all things warnings and errors here
+Handle all things warnings and errors.
 """
 
 from __future__ import annotations
@@ -13,6 +13,13 @@ from meerschaum.utils.debug import dprint
 import sys
 import warnings
 
+__all__ = (
+    'warn',
+    'info',
+    'error',
+    'dprint',
+)
+
 warnings.filterwarnings(
     "always",
     category = UserWarning

meerschaum/utils/yaml.py

@@ -10,7 +10,7 @@ This is so switching between PyYAML and ruamel.yaml is smoother.
 
 from meerschaum.utils.misc import filter_keywords
 from meerschaum.utils.packages import attempt_import, all_packages, _import_module
-from meerschaum.utils.warnings import error, warn
+from meerschaum.utils.warnings import error
 from meerschaum.utils.threading import Lock
 
 _lib = None
@@ -49,7 +49,7 @@ class yaml:
     """
     global _yaml, _lib, _dumper
     if _import_name is None:
-        error(f"No YAML library declared.")
+        error("No YAML library declared.")
     with _locks['_lib']:
         try:
             _lib = _import_module(_import_name)

{meerschaum-2.2.5.dev3.dist-info → meerschaum-2.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meerschaum
-Version: 2.2.5.dev3
+Version: 2.2.7
 Summary: Sync Time-Series Pipes with Meerschaum
 Home-page: https://meerschaum.io
 Author: Bennett Meares