moat-kv 0.71.0__py3-none-any.whl → 0.71.7__py3-none-any.whl

build/lib/moat/kv/command/data.py

@@ -1,265 +0,0 @@
-# command line interface
-from __future__ import annotations
-
-import datetime
-import time
-
-import asyncclick as click
-from moat.util import MsgReader, NotGiven, P, PathLongener, attr_args, yprint
-
-from moat.kv.client import StreamedRequest
-from moat.kv.data import add_dates, data_get, node_attr
-
-
-@click.group(short_help="Manage data.", invoke_without_command=True)  # pylint: disable=undefined-variable
-@click.argument("path", type=P, nargs=1)
-@click.pass_context
-async def cli(ctx, path):
-    """
-    This subcommand accesses the actual user data stored in your MoaT-KV tree.
-    """
-    if ctx.invoked_subcommand is None:
-        await data_get(ctx.obj, path, recursive=False)
-    else:
-        ctx.obj.path = path
-
-
-@cli.command()
-@click.option(
-    "-d",
-    "--as-dict",
-    default=None,
-    help="Structure as dictionary. The argument is the key to use "
-    "for values. Default: return as list",
-)
-@click.option(
-    "-m",
-    "--maxdepth",
-    type=int,
-    default=None,
-    help="Limit recursion depth. Default: whole tree",
-)
-@click.option(
-    "-M",
-    "--mindepth",
-    type=int,
-    default=None,
-    help="Starting depth. Default: whole tree",
-)
-@click.option("-r", "--recursive", is_flag=True, help="Read a complete subtree")
-@click.option("-e", "--empty", is_flag=True, help="Include empty nodes")
-@click.option("-R", "--raw", is_flag=True, help="Print string values without quotes etc.")
-@click.option("-D", "--add-date", is_flag=True, help="Add *_date entries")
-@click.pass_obj
-async def get(obj, **k):
-    """
-    Read a MoaT-KV value.
-
-    If you read a sub-tree recursively, be aware that the whole subtree
-    will be read before anything is printed. Use the "watch --state" subcommand
-    for incremental output.
-    """
-
-    await data_get(obj, obj.path, **k)
-
-
-@cli.command("list")
-@click.option(
-    "-d",
-    "--as-dict",
-    default=None,
-    help="Structure as dictionary. The argument is the key to use "
-    "for values. Default: return as list",
-)
-@click.option(
-    "-m",
-    "--maxdepth",
-    type=int,
-    default=1,
-    help="Limit recursion depth. Default: 1 (single layer).",
-)
-@click.option(
-    "-M",
-    "--mindepth",
-    type=int,
-    default=1,
-    help="Starting depth. Default: 1 (single layer).",
-)
-@click.pass_obj
-async def list_(obj, **k):
-    """
-    List MoaT-KV values.
-
-    This is like "get" but with "--mindepth=1 --maxdepth=1 --recursive --empty"
-
-    If you read a sub-tree recursively, be aware that the whole subtree
-    will be read before anything is printed. Use the "watch --state" subcommand
-    for incremental output.
-    """
-
-    k["recursive"] = True
-    k["raw"] = True
-    k["empty"] = True
-    await data_get(obj, obj.path, **k)
-
-
-@cli.command("set", short_help="Add or update an entry")
-@attr_args
-@click.option("-l", "--last", nargs=2, help="Previous change entry (node serial)")
-@click.option("-n", "--new", is_flag=True, help="This is a new entry.")
-@click.pass_obj
-async def set_(obj, last, new, **kw):
-    """
-    Store a value at some MoaT-KV position.
-
-    If you update a value you can use "--last" to ensure that no other
-    change arrived between reading and writing the entry. (This is not
-    foolproof but reduces the window to a fraction of a second.)
-
-    When adding a new entry use "--new" to ensure that you don't
-    accidentally overwrite something.
-
-    MoaT-KV entries typically are mappings. Use a colon as the path if you
-    want to replace the top level.
-    """
-    if new:
-        if last:
-            raise click.UsageError("'new' and 'last' are mutually exclusive")
-        kw["chain"] = None
-    else:
-        if last:
-            kw["chain"] = {"node": last[0], "tick": int(last[1])}
-
-    res = await node_attr(obj, obj.path, **kw)
-
-    if obj.meta:
-        yprint(res, stream=obj.stdout)
-
-
-class nstr:
-    def __new__(cls, val):
-        if val is NotGiven:
-            return val
-        return str(val)
-
-
-@cli.command(short_help="Delete an entry / subtree")
-@click.option(
-    "-p",
-    "--prev",
-    type=nstr,
-    default=NotGiven,
-    help="Previous value. Deprecated; use 'last'",
-)
-@click.option("-l", "--last", nargs=2, help="Previous change entry (node serial)")
-@click.option("-r", "--recursive", is_flag=True, help="Delete a complete subtree")
-@click.option("--internal", is_flag=True, help="Affect the internal tree. DANGER.")
-@click.option("-e", "--eval", "eval_", is_flag=True, help="The previous value shall be evaluated.")
-@click.pass_obj
-async def delete(obj, prev, last, recursive, eval_, internal):
-    """
-    Delete an entry, or a whole subtree.
-
-    You really should use "--last" (preferred) or "--prev" (if you must) to
-    ensure that no other change arrived (but note that this doesn't work
-    when deleting a subtree).
-
-    Non-recursively deleting an entry with children works and does *not*
-    affect the child entries.
-
-    The root entry cannot be deleted.
-    """
-    args = {}
-    if eval_ and prev is NotGiven:
-        raise click.UsageError("You need to add a value that can be evaluated")
-    if recursive:
-        if prev is not NotGiven or last:
-            raise click.UsageError("You can't use a prev value when deleting recursively.")
-        if internal:
-            raise click.UsageError("'internal' and 'recursive' are mutually exclusive")
-    else:
-        if prev is not NotGiven:
-            if eval_:
-                prev = eval(prev)  # pylint: disable=eval-used
-            args["prev"] = prev
-        if last:
-            args["chain"] = {"node": last[0], "tick": int(last[1])}
-
-    res = await obj.client.delete(path=obj.path, nchain=obj.meta, recursive=recursive, **args)
-    if isinstance(res, StreamedRequest):
-        pl = PathLongener(obj.path)
-        async for r in res:
-            pl(r)
-            if obj.meta:
-                yprint(r, stream=obj.stdout)
-    else:
-        if obj.meta:
-            yprint(res, stream=obj.stdout)
-
-
-@cli.command()
-@click.option("-s", "--state", is_flag=True, help="Also get the current state.")
-@click.option("-o", "--only", is_flag=True, help="Value only, nothing fancy.")
-@click.option("-p", "--path-only", is_flag=True, help="Value only, nothing fancy.")
-@click.option("-D", "--add-date", is_flag=True, help="Add *_date entries")
-@click.option("-i", "--ignore", multiple=True, type=P, help="Skip this (sub)tree")
-@click.pass_obj
-async def monitor(obj, state, only, path_only, add_date, ignore):
-    """Monitor a MoaT-KV subtree"""
-
-    flushing = not state
-    seen = False
-
-    async with obj.client.watch(
-        obj.path,
-        nchain=obj.meta,
-        fetch=state,
-        max_depth=0 if only else -1,
-        long_path=False,
-    ) as res:
-        pl = PathLongener(() if path_only else obj.path)
-        async for r in res:
-            if add_date and "value" in r:
-                add_dates(r.value)
-            if any(p == r.path[: len(p)] for p in ignore):
-                continue
-            pl(r)
-            if r.get("state", "") == "uptodate":
-                if only and not seen:
-                    # value doesn't exist
-                    return
-                flushing = True
-                if only or path_only:
-                    continue
-            else:
-                del r["seq"]
-                if only or path_only:
-                    try:
-                        if path_only:
-                            print(f"{r.path} {r.value}", file=obj.stdout)
-                        else:
-                            print(r.value, file=obj.stdout)
-                        continue
-                    except AttributeError:
-                        # value has been deleted
-                        continue
-            if flushing:
-                r["time"] = time.time()
-                r["_time"] = datetime.datetime.now().isoformat(sep=" ", timespec="milliseconds")
-            yprint(r, stream=obj.stdout)
-            print("---", file=obj.stdout)
-            if flushing:
-                obj.stdout.flush()
-            seen = True
-
-
-@cli.command()
-@click.option("-i", "--infile", type=click.Path(), help="File to read (msgpack).")
-@click.pass_obj
-async def update(obj, infile):
-    """Send a list of updates to a MoaT-KV subtree"""
-    async with MsgReader(path=infile) as reader:
-        async for msg in reader:
-            if not hasattr(msg, "path"):
-                continue
-            await obj.client.set(obj.path + msg.path, value=msg.value)

build/lib/moat/kv/command/dump/__init__.py

@@ -1,143 +0,0 @@
-# command line interface
-from __future__ import annotations
-
-import datetime
-import sys
-from collections.abc import Mapping
-
-import asyncclick as click
-from moat.mqtt.codecs import MsgPackCodec
-from moat.util import (
-    MsgReader,
-    MsgWriter,
-    P,
-    Path,
-    PathLongener,
-    load_subgroup,
-    yload,
-    yprint,
-)
-
-from moat.kv.codec import unpacker
-
-
-@load_subgroup(short_help="Local data mangling", sub_pre="dump")
-async def cli():
-    """
-    Low-level tools that don't depend on a running MoaT-KV server.
-    """
-    pass
-
-
-@cli.command()
-@click.argument("node", nargs=1)
-@click.argument("file", type=click.Path(), nargs=1)
-async def init(node, file):
-    """Write an initial preload file.
-
-    Usage: moat kv dump init <node> <outfile>
-
-    Writes an initial MoaT-KV file that behaves as if it was generated by <node>.
-
-    Using this command, followed by "moat kv server -l <outfile> <node>", is
-    equivalent to running "moat kv server -i 'Initial data' <node>.
-    """
-    async with MsgWriter(path=file) as f:
-        await f(
-            dict(
-                chain=dict(node=node, tick=1, prev=None),
-                depth=0,
-                path=[],
-                tock=1,
-                value="Initial data",
-            ),
-        )
-
-
-@cli.command("msg")
-@click.argument("path", nargs=1)
-@click.pass_obj
-async def msg_(obj, path):
-    """
-    Monitor the server-to-sever message stream.
-
-    Use ':' for the main server's "update" stream.
-    Use '+NAME' to monitor a different stream instead.
-    Use '+' to monitor all streams.
-    Otherwise use the given name as-is; Mosquitto wildcard rules apply.
-
-    \b
-    Common streams (prefix with '+'):
-    * ping    all servers
-    * update  data changes
-    * del     nodes responsible for cleaning up deleted records
-    """
-    from moat.kv.backend import get_backend
-
-    class _Unpack:
-        def __init__(self):
-            self._part_cache = dict()
-
-    import moat.kv.server
-
-    _Unpack._unpack_multiple = moat.kv.server.Server._unpack_multiple
-    _unpacker = _Unpack()._unpack_multiple
-
-    path = P(path)
-    if len(path) == 0:
-        path = P(obj.cfg.server["root"]) | "update"
-    elif len(path) == 1 and path[0].startswith("+"):  # pylint: disable=no-member  # owch
-        p = path[0][1:]
-        path = P(obj.cfg.server["root"])
-        path |= p or "#"
-    be = obj.cfg.server.backend
-    kw = obj.cfg.server[be]
-
-    async with get_backend(be)(**kw) as conn:
-        async with conn.monitor(*path) as stream:
-            async for msg in stream:
-                v = vars(msg)
-                if isinstance(v.get("payload"), (bytearray, bytes)):
-                    t = msg.topic
-                    v = unpacker(v["payload"])
-                    v = _unpacker(v)
-                    if v is None:
-                        continue
-                    if not isinstance(v, Mapping):
-                        v = {"_data": v}
-                    v["_topic"] = Path.build(t)
-                else:
-                    v["_type"] = type(msg).__name__
-
-                v["_timestamp"] = datetime.datetime.now().isoformat(
-                    sep=" ",
-                    timespec="milliseconds",
-                )
-
-                yprint(v, stream=obj.stdout)
-                print("---", file=obj.stdout)
-
-
-@cli.command("post")
-@click.argument("path", nargs=1)
-@click.pass_obj
-async def post_(obj, path):
-    """
-    Send a msgpack-encoded message (or several) to a specific MQTT topic.
-
-    Messages are read from YAML.
-    Common streams:
-    * ping: sync: all servers (default)
-    * update: data changes
-    * del: sync: nodes responsible for cleaning up deleted records
-    """
-    from moat.kv.backend import get_backend
-
-    path = P(path)
-    be = obj.cfg.server.backend
-    kw = obj.cfg.server[be]
-
-    async with get_backend(be)(codec=MsgPackCodec, **kw) as conn:
-        for d in yload(sys.stdin, multi=True):
-            topic = d.pop("_topic", path)
-            await conn.send(*topic, payload=d)

build/lib/moat/kv/command/error.py

@@ -1,149 +0,0 @@
-# command line interface
-from __future__ import annotations
-
-import sys
-
-import asyncclick as click
-from moat.util import P, Path, yprint
-
-from moat.kv.data import add_dates
-from moat.kv.errors import ErrorRoot
-
-
-@click.group()  # pylint: disable=undefined-variable
-@click.pass_obj
-async def cli(obj):
-    """Manage error records in MoaT-KV."""
-    obj.err = await ErrorRoot.as_handler(obj.client)
-
-
-@cli.command()
-@click.option("-s", "--subsys", help="Subsystem to access")
-@click.argument("path", nargs=1)
-@click.pass_obj
-async def resolve(obj, path, subsys):
-    """
-    Mark an error as resolved.
-    """
-    path = P(path)
-    if subsys:
-        e = obj.err.get_error_record(subsys, path)
-    else:
-        e = obj.err.follow(path)
-    if e.resolved:
-        print("Already resolved.", file=sys.stderr)
-        return
-    await e.resolve()
-
-
-@cli.command()
-@click.option("-n", "--node", help="add details from this node")
-@click.option("-s", "--subsystem", "subsys", help="only show errors from this subsystem")
-@click.option("-r", "--resolved", is_flag=True, help="only resolved errors")
-@click.option("-v", "--verbose", count=True, help="add per-node details (-vv for traces)")
-@click.option("-a", "--all-errors", is_flag=True, help="add details from all nodes")
-@click.option("-d", "--as-dict", default=None, help="Dump a list of all open (or resolved) error.")
-@click.option("-p", "--path", default=":", help="only show errors below this subpath")
-@click.pass_obj
-async def dump(obj, as_dict, path, node, all_errors, verbose, resolved, subsys):
-    """Dump error entries."""
-    path = P(path)
-    path_ = obj.cfg["errors"].prefix
-    d = 2
-
-    async def one(r):
-        nonlocal y
-        val = r.value
-        if subsys and val.get("subsystem", "") != subsys:
-            return
-        if path and val.get("path", ())[: len(path)] != path:
-            return
-
-        if not all_errors and bool(val.get("resolved", False)) != resolved:
-            return
-
-        add_dates(val)
-        try:
-            rp = val.path
-            if as_dict:
-                del val.path
-            elif not isinstance(rp, Path):
-                rp = Path.build(rp)
-        except AttributeError:
-            rp = Path("incomplete") + r.path
-            if not as_dict:
-                val.path = rp
-        if rp[: len(path)] != path:
-            return
-        rp = rp[len(path) :]
-        if node is None:
-            val.syspath = r.path
-        else:
-            val.syspath = Path(node) + r.path
-
-        rn = {}
-
-        def disp(rr):
-            if node and rr.path[-1] != node:
-                return
-            val = rr.value
-            add_dates(val)
-            if verbose < 2:
-                rr.value.pop("trace", None)
-            rn[rr.path[-1]] = rr if obj.meta else rr.value
-
-        if verbose:
-            rs = await obj.client._request(
-                action="get_tree",
-                min_depth=1,
-                max_depth=1,
-                path=path_ + r.path[-2:],
-                iter=True,
-                nchain=3 if obj.meta else 0,
-            )
-            async for rr in rs:
-                disp(rr)
-
-        elif node:
-            rs = await obj.client.get(path_ + r.path[-2:] | node)
-            if "value" in rs:
-                disp(rs)
-
-        if rn:
-            val["nodes"] = rn
-
-        if as_dict is not None:
-            yy = y
-            if subsys is None:
-                yy = yy.setdefault(val.get("subsystem", "unknown"), {})
-            for p in rp:
-                yy = yy.setdefault(p, {})
-            yy[as_dict] = r if obj.meta else val
-        else:
-            yy = r if obj.meta else r.value
-
-            yprint([yy], stream=obj.stdout)
-            print("---", file=obj.stdout)
-
-    y = {}
-    res = None
-
-    if node is None and len(path) == 2 and isinstance(path[-1], int):  # single error?
-        r = await obj.client.get(path_ + path, nchain=3 if obj.meta else 0)
-        # Mangle a few variables so that the output is still OK
-        r.path = path
-        node = None
-
-        async def ait(r):
-            yield r
-
-        res = ait(r)
-        path = ()
-
-    if res is None:
-        res = obj.client.get_tree(path_, min_depth=d, max_depth=d, nchain=3 if obj.meta else 0)
-    async for r in res:
-        await one(r)
-
-    if as_dict is not None:
-        yprint(y, stream=obj.stdout)