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

meerschaum/core/Pipe/_sync.py

@@ -14,7 +14,9 @@ import threading
 import multiprocessing
 import functools
 from datetime import datetime, timedelta
+from typing import TYPE_CHECKING
 
+import meerschaum as mrsm
 from meerschaum.utils.typing import (
     Union,
     Optional,
@@ -26,13 +28,16 @@ from meerschaum.utils.typing import (
     List,
     Iterable,
     Generator,
-    Iterator,
 )
 from meerschaum.utils.warnings import warn, error
 
+if TYPE_CHECKING:
+    pd = mrsm.attempt_import('pandas')
+
 class InferFetch:
     MRSM_INFER_FETCH: bool = True
 
+
 def sync(
     self,
     df: Union[
@@ -125,7 +130,7 @@ def sync(
     from meerschaum.utils.formatting import get_console
     from meerschaum.utils.venv import Venv
     from meerschaum.connectors import get_connector_plugin
-    from meerschaum.utils.misc import df_is_chunk_generator, filter_keywords
+    from meerschaum.utils.misc import df_is_chunk_generator, filter_keywords, filter_arguments
     from meerschaum.utils.pool import get_pool
     from meerschaum.config import get_config
 
@@ -210,28 +215,28 @@ def sync(
             ):
                 with Venv(get_connector_plugin(self.instance_connector)):
                     p._exists = None
-                    return self.instance_connector.sync_pipe_inplace(
+                    _args, _kwargs = filter_arguments(
+                        p.instance_connector.sync_pipe_inplace,
                         p,
-                        **filter_keywords(
-                            p.instance_connector.sync_pipe_inplace,
-                            debug=debug,
-                            **kw
-                        )
+                        debug=debug,
+                        **kw
+                    )
+                    return self.instance_connector.sync_pipe_inplace(
+                        *_args,
+                        **_kwargs
                     )
-
 
             ### Activate and invoke `sync(pipe)` for plugin connectors with `sync` methods.
             try:
                 if getattr(p.connector, 'sync', None) is not None:
                     with Venv(get_connector_plugin(p.connector), debug=debug):
-                        return_tuple = p.connector.sync(
+                        _args, _kwargs = filter_arguments(
+                            p.connector.sync,
                             p,
-                            **filter_keywords(
-                                p.connector.sync,
-                                debug=debug,
-                                **kw
-                            )
+                            debug=debug,
+                            **kw
                         )
+                        return_tuple = p.connector.sync(*_args, **_kwargs)
                     p._exists = None
                     if not isinstance(return_tuple, tuple):
                         return_tuple = (

meerschaum/plugins/_Plugin.py

@@ -654,17 +654,18 @@ class Plugin:
             import ast, re
             ### NOTE: This technically would break 
             ### if `required` was the very first line of the file.
-            req_start_match = re.search(r'\nrequired(\s?)=', text)
+            req_start_match = re.search(r'required(:\s*)?.*=', text)
             if not req_start_match:
                 return []
             req_start = req_start_match.start()
+            equals_sign = req_start + text[req_start:].find('=')
 
             ### Dependencies may have brackets within the strings, so push back the index.
-            first_opening_brace = req_start + 1 + text[req_start:].find('[')
+            first_opening_brace = equals_sign + 1 + text[equals_sign:].find('[')
             if first_opening_brace == -1:
                 return []
 
-            next_closing_brace = req_start + 1 + text[req_start:].find(']')
+            next_closing_brace = equals_sign + 1 + text[equals_sign:].find(']')
             if next_closing_brace == -1:
                 return []
 
@@ -681,12 +682,11 @@ class Plugin:
 
             req_end = end_ix + 1
             req_text = (
-                text[req_start:req_end]
-                .lstrip()
-                .replace('required', '', 1)
+                text[(first_opening_brace-1):req_end]
                 .lstrip()
                 .replace('=', '', 1)
                 .lstrip()
+                .rstrip()
             )
             try:
                 required = ast.literal_eval(req_text)

meerschaum/plugins/__init__.py

@@ -27,7 +27,7 @@ _locks = {
     'PLUGINS_INTERNAL_LOCK_PATH': RLock(),
 }
 __all__ = (
-    "Plugin", "make_action", "api_plugin", "import_plugins",
+    "Plugin", "make_action", "api_plugin", "dash_plugin", "import_plugins",
     "reload_plugins", "get_plugins", "get_data_plugins", "add_plugin_argument",
     "pre_sync_hook", "post_sync_hook",
 )

meerschaum/utils/daemon/RotatingFile.py

@@ -32,14 +32,14 @@ class RotatingFile(io.IOBase):
     SEEK_BACK_ATTEMPTS: int = 5
 
     def __init__(
-            self,
-            file_path: pathlib.Path,
-            num_files_to_keep: Optional[int] = None,
-            max_file_size: Optional[int] = None,
-            redirect_streams: bool = False,
-            write_timestamps: bool = False,
-            timestamp_format: str = '%Y-%m-%d %H:%M',
-        ):
+        self,
+        file_path: pathlib.Path,
+        num_files_to_keep: Optional[int] = None,
+        max_file_size: Optional[int] = None,
+        redirect_streams: bool = False,
+        write_timestamps: bool = False,
+        timestamp_format: str = '%Y-%m-%d %H:%M',
+    ):
         """
         Create a file-like object which manages other files.
 
@@ -79,11 +79,7 @@ class RotatingFile(io.IOBase):
         self.redirect_streams = redirect_streams
         self.write_timestamps = write_timestamps
         self.timestamp_format = timestamp_format
-        self.subfile_regex_pattern = re.compile(
-            r'^'
-            + self.file_path.name
-            + r'(?:\.\d+)?$'
-        )
+        self.subfile_regex_pattern = re.compile(r'(.*)\.log(?:\.\d+)?$')
 
         ### When subfiles are opened, map from their index to the file objects.
         self.subfile_objects = {}
@@ -173,7 +169,7 @@ class RotatingFile(io.IOBase):
         latest_index = (
             self.get_index_from_subfile_name(existing_subfile_paths[-1].name)
             if existing_subfile_paths
-            else -1
+            else 0
         )
         return latest_index
 
@@ -222,9 +218,12 @@ class RotatingFile(io.IOBase):
             [
                 (file_name, self.get_index_from_subfile_name(file_name))
                 for file_name in os.listdir(self.file_path.parent)
-                if re.match(self.subfile_regex_pattern, file_name)
+                if (
+                    file_name.startswith(self.file_path.name)
+                    and re.match(self.subfile_regex_pattern, file_name)
+                )
             ],
-            key = lambda x: x[1],
+            key=lambda x: x[1],
         )
         return [
             (self.file_path.parent / file_name)

meerschaum/utils/dataframe.py

@@ -8,13 +8,21 @@ Utility functions for working with DataFrames.
 
 from __future__ import annotations
 from datetime import datetime
+
+import meerschaum as mrsm
 from meerschaum.utils.typing import (
     Optional, Dict, Any, List, Hashable, Generator,
-    Iterator, Iterable, Union, Tuple,
+    Iterator, Iterable, Union, TYPE_CHECKING,
 )
 
+if TYPE_CHECKING:
+    pd, dask = mrsm.attempt_import('pandas', 'dask')
+
 
-def add_missing_cols_to_df(df: 'pd.DataFrame', dtypes: Dict[str, Any]) -> pd.DataFrame:
+def add_missing_cols_to_df(
+    df: 'pd.DataFrame',
+    dtypes: Dict[str, Any],
+) -> 'pd.DataFrame':
     """
     Add columns from the dtypes dictionary as null columns to a new DataFrame.
 
@@ -723,7 +731,7 @@ def get_datetime_bound_from_df(
         df: Union['pd.DataFrame', dict, list],
         datetime_column: str,
         minimum: bool = True,
-    ) -> Union[int, 'datetime.datetime', None]:
+    ) -> Union[int, datetime, None]:
     """
     Return the minimum or maximum datetime (or integer) from a DataFrame.
 
@@ -818,7 +826,7 @@ def chunksize_to_npartitions(chunksize: Optional[int]) -> int:
 
 
 def df_from_literal(
-        pipe: Optional['meerschaum.Pipe'] = None,
+        pipe: Optional[mrsm.Pipe] = None,
         literal: str = None,
         debug: bool = False
     ) -> 'pd.DataFrame':

meerschaum/utils/debug.py

@@ -93,22 +93,16 @@ def _checkpoint(
     ) -> None:
     """If the `_progress` and `_task` objects are provided, increment the task by one step.
     If `_total` is provided, update the total instead.
-
-    Parameters
-    ----------
-    _progress: Optional['rich.progress.Progress'] :
-         (Default value = None)
-    _task: Optional[int] :
-         (Default value = None)
-    _total: Optional[int] :
-         (Default value = None)
-    **kw :
-        
-
-    Returns
-    -------
-
     """
     if _progress is not None and _task is not None:
         _kw = {'total': _total} if _total is not None else {'advance': 1}
         _progress.update(_task, **_kw)
+
+
+def trace(browser: bool = True):
+    """
+    Open a web-based debugger to trace the execution of the program.
+    """
+    from meerschaum.utils.packages import attempt_import
+    heartrate = attempt_import('heartrate')
+    heartrate.trace(files=heartrate.files.all, browser=browser)

meerschaum/utils/formatting/__init__.py

@@ -291,16 +291,16 @@ def print_tuple(
 
 
 def print_options(
-        options: Optional[Dict[str, Any]] = None,
-        nopretty: bool = False,
-        no_rich: bool = False,
-        name: str = 'options',
-        header: Optional[str] = None,
-        num_cols: Optional[int] = None,
-        adjust_cols: bool = True,
-        sort_options: bool = False,
-        **kw
-    ) -> None:
+    options: Optional[Dict[str, Any]] = None,
+    nopretty: bool = False,
+    no_rich: bool = False,
+    name: str = 'options',
+    header: Optional[str] = None,
+    num_cols: Optional[int] = None,
+    adjust_cols: bool = True,
+    sort_options: bool = False,
+    **kw
+) -> None:
     """
     Print items in an iterable as a fancy table.
 
@@ -342,7 +342,7 @@ def print_options(
         _options.append(str(o))
     if sort_options:
         _options = sorted(_options)
-    _header = f"Available {name}" if header is None else header
+    _header = f"\nAvailable {name}" if header is None else header
 
     if num_cols is None:
         num_cols = 8
@@ -388,7 +388,7 @@ def print_options(
 
     if _header is not None:
         table = Table(
-            title = ('\n' + _header) if header else header,
+            title = _header,
             box = box.SIMPLE,
             show_header = False,
             show_footer = False,
@@ -467,6 +467,7 @@ def fill_ansi(string: str, style: str = '') -> str:
 
     return rich_text_to_str(msg)
 
+
 def __getattr__(name: str) -> str:
     """
     Lazily load module-level variables.

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

@@ -1849,10 +1849,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/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,15 +3,23 @@
 # vim:fenc=utf-8
 
 """
-Handle all things warnings and errors here
+Handle all things warnings and errors.
 """
 
 from __future__ import annotations
 from meerschaum.utils.typing import Any, Union
+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.dev2.dist-info → meerschaum-2.2.6.dist-info}/METADATA

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