meerschaum 2.4.0.dev0__py3-none-any.whl → 2.4.0.dev1__py3-none-any.whl

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/config/_version.py

@@ -2,4 +2,4 @@
 Specify the Meerschaum release version.
 """
 
-__version__ = "2.4.0.dev0"
+__version__ = "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/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/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/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.dist-info → meerschaum-2.4.0.dev1.dist-info}/METADATA

@@ -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.dist-info → meerschaum-2.4.0.dev1.dist-info}/RECORD

@@ -26,7 +26,7 @@ meerschaum/actions/api.py,sha256=nRHGeMTy0njI9Qec_606GwSS0AnoxiGJodOS8uWpjfU,125
 meerschaum/actions/attach.py,sha256=UV19d9W_2WYcrf7BRz7k3mriDoX1V4rA4AKvbLdor0o,3106
 meerschaum/actions/bootstrap.py,sha256=c6US_SklR_ipr1Ax_2S6zP5pVZivr7v9OLTPxsMCiI4,14828
 meerschaum/actions/clear.py,sha256=OoFZE0bK5m8s3GLNZcixuVT0DMj1izXVxGCATcmUGbI,4851
-meerschaum/actions/copy.py,sha256=hLRc81oVBjnV22lpeSDb-HsDX2on9K2u6C1H8qJITNQ,6844
+meerschaum/actions/copy.py,sha256=NwTwj3IMdK1TFRuJXCxsbIEFNVeoNGoMkvE6H1ZQZzo,6838
 meerschaum/actions/deduplicate.py,sha256=puYyxeFYEUy1Sd2IOcZB2e6MrNxAZl2bTLmNzFDkCiw,1167
 meerschaum/actions/delete.py,sha256=OidLnYT4E3OEHGHOeHOHbL3FFJonE7iR_3sPCj0azK0,18974
 meerschaum/actions/drop.py,sha256=Hd5h4rrWd7qL2rTqglsTonUsEoH7qQlsfqNFSHGeqr0,2453
@@ -142,7 +142,7 @@ meerschaum/config/_preprocess.py,sha256=-AEA8m_--KivZwTQ1sWN6LTn5sio_fUr2XZ51BO6
 meerschaum/config/_read_config.py,sha256=WFZKIXZMDe_ca0ES7ivgM_mnwShvFxLdoeisT_X5-h0,14720
 meerschaum/config/_shell.py,sha256=46_m49Txc5q1rGfCgO49ca48BODx45DQJi8D0zz1R18,4245
 meerschaum/config/_sync.py,sha256=oK2ZujO2T1he08BXCFyiniBUevNGWSQKXLcS_jRv_7Y,4155
-meerschaum/config/_version.py,sha256=ko0j1wwF4ngSOgFGF9dJ_nxwMUj8EwEgLFGA5rFwpgM,76
+meerschaum/config/_version.py,sha256=iWXhzo8W_BkmGIL_HSHnU4ESCCaOIuBZGwu1MFLKjfQ,76
 meerschaum/config/paths.py,sha256=JjibeGN3YAdSNceRwsd42aNmeUrIgM6ndzC8qZAmNI0,621
 meerschaum/config/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 meerschaum/config/stack/__init__.py,sha256=bUXiccj-dvpuPCGs-hclR8E5lrgrpg5Tmjte3BJVX4s,10488
@@ -190,10 +190,11 @@ meerschaum/connectors/valkey/_pipes.py,sha256=-QnjGs6Xb7U9ZyjRyJ1PRUPfxoCOSAS7Zd
 meerschaum/connectors/valkey/_plugins.py,sha256=ZqiEW4XZCOpw4G8DUK2IKY6Qrph4mYfTjgXWimgakYY,6267
 meerschaum/connectors/valkey/_users.py,sha256=AS1vLarrkDA9yPK644GWwRiQiTZVa9x3nlLpyntq40g,7730
 meerschaum/core/__init__.py,sha256=tjASW10n9uLV6bYhcwP4rggh-ESXSJzgxpSBbVsuISs,251
-meerschaum/core/Pipe/__init__.py,sha256=mU8FHqHPTdSRBwEoJyNs-qNRb5PYVyXRVNTEQaEYexU,16671
+meerschaum/core/Pipe/__init__.py,sha256=g1Geblo4NwNYumM9sSPBMAxiGZnhuh-nQ5OSwQ06Dvg,16702
 meerschaum/core/Pipe/_attributes.py,sha256=8nHMCZnQexAcG1ONXNqTldEowD7gstd34lDUcBktPeA,13144
 meerschaum/core/Pipe/_bootstrap.py,sha256=evyi07kkzAVMj66HfZkbYdcWk_oHUDsl6f13EnSPMYs,7723
-meerschaum/core/Pipe/_clear.py,sha256=hQVPztHiadzLB0c4_yFg6EETnf9MtFdJDCpO41Giuco,2261
+meerschaum/core/Pipe/_clear.py,sha256=yFAYQnDmL3m6DzyAutgnBDXSOL9gjIrLvlQXd86YFV0,2193
+meerschaum/core/Pipe/_copy.py,sha256=PcOeNUb0B4-HehTAAnBpjyT4uLLTR6VQOarY0SFA9wk,2912
 meerschaum/core/Pipe/_data.py,sha256=Ese54Qointav0M-bmIx5NrJIbIrFCb2hQvPEAfxRBAk,20922
 meerschaum/core/Pipe/_deduplicate.py,sha256=E3oXu6-0vZhzacv0GHri9yHd7XrSlIStZ--KE2EqeVM,10274
 meerschaum/core/Pipe/_delete.py,sha256=1geNp9BgrocXP1gt76dMbnlJWKYFMuSNqPFA4K4-hXE,2118
@@ -204,7 +205,7 @@ meerschaum/core/Pipe/_fetch.py,sha256=LtYqZSN2kwc5Tl2gQ5kSmGN7Ombv86k1zDNTP3SUF1
 meerschaum/core/Pipe/_register.py,sha256=Sd5xaAW8H7uLTIoommcKb-6kHPRuHJLWNSbPnt2UbvA,2240
 meerschaum/core/Pipe/_show.py,sha256=nG50y8eBT9TVuKkRgAKtNDNIxysJvMNxfu__lkL1F9k,1352
 meerschaum/core/Pipe/_sync.py,sha256=ha0bk3FEw3foaWIpzYYxzAeFjXoOubVL-avfowKJImE,32132
-meerschaum/core/Pipe/_verify.py,sha256=KSnthUzImRLjt9fxyBaLvArqDuOLRpKBfk0tnseJClc,14262
+meerschaum/core/Pipe/_verify.py,sha256=GDCFRWWoaqXXfLQaTlS9_J7OqjuqA_JqXvUWZUOEclk,14218
 meerschaum/core/Plugin/__init__.py,sha256=UXg64EvJPgI1PCxkY_KM02-ZmBm4FZpLPIQR_uSJJDc,137
 meerschaum/core/User/_User.py,sha256=JZ9Y1tsjZe-cgD24m9YfZ6ZwSOKn_sHc4rbQ7KblBz8,6592
 meerschaum/core/User/__init__.py,sha256=lJ7beIZTG9sO4dAi3367fFBl17dXYEWHKi7HoaPlDyk,193
@@ -249,11 +250,11 @@ meerschaum/utils/packages/_packages.py,sha256=I1tXtYbMlITIVmoJhYQhWtCcmOwvK7iHdb
 meerschaum/utils/packages/lazy_loader.py,sha256=VHnph3VozH29R4JnSSBfwtA5WKZYZQFT_GeQSShCnuc,2540
 meerschaum/utils/venv/_Venv.py,sha256=sBnlmxHdAh2bx8btfVoD79-H9-cYsv5lP02IIXkyECs,3553
 meerschaum/utils/venv/__init__.py,sha256=bLAWnllKDuE_z6bLk7gLh4mI3Sp1j5hsboTqPKOQq84,24361
-meerschaum-2.4.0.dev0.dist-info/LICENSE,sha256=jG2zQEdRNt88EgHUWPpXVWmOrOduUQRx7MnYV9YIPaw,11359
-meerschaum-2.4.0.dev0.dist-info/METADATA,sha256=CTCFiuL1p4KHbzwgA7EGgqlE2taefHVcoxbwlb1fMSc,24106
-meerschaum-2.4.0.dev0.dist-info/NOTICE,sha256=OTA9Fcthjf5BRvWDDIcBC_xfLpeDV-RPZh3M-HQBRtQ,114
-meerschaum-2.4.0.dev0.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-meerschaum-2.4.0.dev0.dist-info/entry_points.txt,sha256=5YBVzibw-0rNA_1VjB16z5GABsOGf-CDhW4yqH8C7Gc,88
-meerschaum-2.4.0.dev0.dist-info/top_level.txt,sha256=bNoSiDj0El6buocix-FRoAtJOeq1qOF5rRm2u9i7Q6A,11
-meerschaum-2.4.0.dev0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-meerschaum-2.4.0.dev0.dist-info/RECORD,,
+meerschaum-2.4.0.dev1.dist-info/LICENSE,sha256=jG2zQEdRNt88EgHUWPpXVWmOrOduUQRx7MnYV9YIPaw,11359
+meerschaum-2.4.0.dev1.dist-info/METADATA,sha256=7D3rckc0osdt2IQDj2ChMSJDuQeihJMwF3qgROoETSI,24106
+meerschaum-2.4.0.dev1.dist-info/NOTICE,sha256=OTA9Fcthjf5BRvWDDIcBC_xfLpeDV-RPZh3M-HQBRtQ,114
+meerschaum-2.4.0.dev1.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
+meerschaum-2.4.0.dev1.dist-info/entry_points.txt,sha256=5YBVzibw-0rNA_1VjB16z5GABsOGf-CDhW4yqH8C7Gc,88
+meerschaum-2.4.0.dev1.dist-info/top_level.txt,sha256=bNoSiDj0El6buocix-FRoAtJOeq1qOF5rRm2u9i7Q6A,11
+meerschaum-2.4.0.dev1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+meerschaum-2.4.0.dev1.dist-info/RECORD,,