meerschaum 2.4.0.dev0__tar.gz → 2.4.0.dev1__tar.gz

{meerschaum-2.4.0.dev0/meerschaum.egg-info → meerschaum-2.4.0.dev1}/PKG-INFO

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

{meerschaum-2.4.0.dev0 → meerschaum-2.4.0.dev1}/meerschaum/actions/copy.py

@@ -115,11 +115,11 @@ def _copy_pipes(
         ):
             _new_pipe.sync(
                 p.get_data(
-                    debug = debug,
-                    as_iterator = True,
+                    debug=debug,
+                    as_iterator=True,
                     **kw
                 ),
-                debug = debug,
+                debug=debug,
                 **kw
             )
 

{meerschaum-2.4.0.dev0 → meerschaum-2.4.0.dev1}/meerschaum/config/_version.py

@@ -2,4 +2,4 @@
 Specify the Meerschaum release version.
 """
 
-__version__ = "2.4.0.dev0"
+__version__ = "2.4.0.dev1"

{meerschaum-2.4.0.dev0 → meerschaum-2.4.0.dev1}/meerschaum/core/Pipe/__init__.py

@@ -135,6 +135,7 @@ class Pipe:
     from ._deduplicate import deduplicate
     from ._bootstrap import bootstrap
     from ._dtypes import enforce_dtypes, infer_dtypes
+    from ._copy import copy_to
 
     def __init__(
         self,

{meerschaum-2.4.0.dev0 → meerschaum-2.4.0.dev1}/meerschaum/core/Pipe/_clear.py

@@ -7,25 +7,28 @@ Clear pipe data within a bounded or unbounded interval.
 """
 
 from __future__ import annotations
+
+from datetime import datetime
 from meerschaum.utils.typing import SuccessTuple, Any, Optional, Dict
 
+
 def clear(
-        self,
-        begin: Optional[datetime.datetime] = None,
-        end: Optional[datetime.datetime] = None,
-        params: Optional[Dict[str, Any]] = None,
-        debug: bool = False,
-        **kwargs: Any
-    ) -> SuccessTuple:
+    self,
+    begin: Optional[datetime] = None,
+    end: Optional[datetime] = None,
+    params: Optional[Dict[str, Any]] = None,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Call the Pipe's instance connector's `clear_pipe` method.
 
     Parameters
     ----------
-    begin: Optional[datetime.datetime], default None:
+    begin: Optional[datetime], default None:
         If provided, only remove rows newer than this datetime value.
 
-    end: Optional[datetime.datetime], default None:
+    end: Optional[datetime], default None:
         If provided, only remove rows older than this datetime column (not including end).
 
     params: Optional[Dict[str, Any]], default None
@@ -41,11 +44,11 @@ def clear(
     Examples
     --------
     >>> pipe = mrsm.Pipe('test', 'test', columns={'datetime': 'dt'}, instance='sql:local')
-    >>> pipe.sync({'dt': [datetime.datetime(2020, 1, 1, 0, 0)]})
-    >>> pipe.sync({'dt': [datetime.datetime(2021, 1, 1, 0, 0)]})
-    >>> pipe.sync({'dt': [datetime.datetime(2022, 1, 1, 0, 0)]})
+    >>> pipe.sync({'dt': [datetime(2020, 1, 1, 0, 0)]})
+    >>> pipe.sync({'dt': [datetime(2021, 1, 1, 0, 0)]})
+    >>> pipe.sync({'dt': [datetime(2022, 1, 1, 0, 0)]})
     >>> 
-    >>> pipe.clear(begin=datetime.datetime(2021, 1, 1, 0, 0))
+    >>> pipe.clear(begin=datetime(2021, 1, 1, 0, 0))
     >>> pipe.get_data()
               dt
     0 2020-01-01

meerschaum-2.4.0.dev1/meerschaum/core/Pipe/_copy.py

@@ -0,0 +1,106 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define methods for copying pipes.
+"""
+
+from datetime import datetime, timedelta
+
+import meerschaum as mrsm
+from meerschaum.utils.typing import SuccessTuple, Any, Optional, Dict, Union
+
+
+def copy_to(
+    self,
+    instance_keys: str,
+    sync: bool = True,
+    begin: Union[datetime, int, None] = None,
+    end: Union[datetime, int, None] = None,
+    params: Optional[Dict[str, Any]] = None,
+    chunk_interval: Union[timedelta, int, None] = None,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
+    """
+    Copy a pipe to another instance.
+
+    Parameters
+    ----------
+    instance_keys: str
+        The instance to which to copy this pipe.
+
+    sync: bool, default True
+        If `True`, sync the source pipe's documents 
+
+    begin: Union[datetime, int, None], default None
+        Beginning datetime value to pass to `Pipe.get_data()`.
+
+    end: Union[datetime, int, None], default None
+        End datetime value to pass to `Pipe.get_data()`.
+
+    params: Optional[Dict[str, Any]], default None
+        Parameters filter to pass to `Pipe.get_data()`.
+
+    chunk_interval: Union[timedelta, int, None], default None
+        The size of chunks to retrieve from `Pipe.get_data()` for syncing.
+
+    kwargs: Any
+        Additional flags to pass to `Pipe.get_data()` and `Pipe.sync()`, e.g. `workers`.
+
+    Returns
+    -------
+    A SuccessTuple indicating success.
+    """
+    if str(instance_keys) == self.instance_keys:
+        return False, f"Cannot copy {self} to instance '{instance_keys}'."
+
+    new_pipe = mrsm.Pipe(
+        self.connector_keys,
+        self.metric_key,
+        self.location_key,
+        parameters=self.parameters.copy(),
+        instance=instance_keys,
+    )
+
+    new_pipe_is_registered = new_pipe.get_id() is not None
+
+    metadata_method = new_pipe.edit if new_pipe_is_registered else new_pipe.register
+    metadata_success, metadata_msg = metadata_method(debug=debug)
+    if not metadata_success:
+        return metadata_success, metadata_msg
+
+    if not self.exists(debug=debug):
+        return True, f"{self} does not exist; nothing to sync."
+
+    original_as_iterator = kwargs.get('as_iterator', None)
+    kwargs['as_iterator'] = True
+
+    chunk_generator = self.get_data(
+        begin=begin,
+        end=end,
+        params=params,
+        chunk_interval=chunk_interval,
+        debug=debug,
+        **kwargs
+    )
+
+    if original_as_iterator is None:
+        _ = kwargs.pop('as_iterator', None)
+    else:
+        kwargs['as_iterator'] = original_as_iterator
+
+    sync_success, sync_msg = new_pipe.sync(
+        chunk_generator,
+        begin=begin,
+        end=end,
+        params=params,
+        debug=debug,
+        **kwargs
+    )
+    msg = (
+        f"Successfully synced {new_pipe}:\n{sync_msg}"
+        if sync_success
+        else f"Failed to sync {new_pipe}:\n{sync_msg}"
+    )
+    return sync_success, msg

{meerschaum-2.4.0.dev0 → meerschaum-2.4.0.dev1}/meerschaum/core/Pipe/_verify.py

@@ -12,17 +12,17 @@ from meerschaum.utils.warnings import warn, info
 from meerschaum.utils.debug import dprint
 
 def verify(
-        self,
-        begin: Union[datetime, int, None] = None,
-        end: Union[datetime, int, None] = None,
-        params: Optional[Dict[str, Any]] = None,
-        chunk_interval: Union[timedelta, int, None] = None,
-        bounded: Optional[bool] = None,
-        deduplicate: bool = False,
-        workers: Optional[int] = None,
-        debug: bool = False,
-        **kwargs: Any
-    ) -> SuccessTuple:
+    self,
+    begin: Union[datetime, int, None] = None,
+    end: Union[datetime, int, None] = None,
+    params: Optional[Dict[str, Any]] = None,
+    chunk_interval: Union[timedelta, int, None] = None,
+    bounded: Optional[bool] = None,
+    deduplicate: bool = False,
+    workers: Optional[int] = None,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Verify the contents of the pipe by resyncing its interval.
 

{meerschaum-2.4.0.dev0 → meerschaum-2.4.0.dev1/meerschaum.egg-info}/PKG-INFO

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

{meerschaum-2.4.0.dev0 → meerschaum-2.4.0.dev1}/meerschaum.egg-info/SOURCES.txt

@@ -205,6 +205,7 @@ meerschaum/core/Pipe/__init__.py
 meerschaum/core/Pipe/_attributes.py
 meerschaum/core/Pipe/_bootstrap.py
 meerschaum/core/Pipe/_clear.py
+meerschaum/core/Pipe/_copy.py
 meerschaum/core/Pipe/_data.py
 meerschaum/core/Pipe/_deduplicate.py
 meerschaum/core/Pipe/_delete.py