shvcli 0.5.0__tar.gz → 0.6.1__tar.gz

{shvcli-0.5.0/shvcli.egg-info → shvcli-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shvcli
-Version: 0.5.0
+Version: 0.6.1
 Summary: Silicon Heaven CLI access application
 Author: Elektroline a.s.
 License: MIT License
@@ -38,7 +38,7 @@ Classifier: Topic :: Terminals
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pyshv>=0.7.0
+Requires-Dist: pyshv>=0.7.1
 Requires-Dist: prompt_toolkit
 Requires-Dist: pygments
 Requires-Dist: pyxdg
@@ -140,6 +140,12 @@ switched in runtime. The following options are available:
 * **cache**: Controls if cache is preserved between invocations. Cache is
   separated based on the connection URL and stored in files in
   ``$XDG_CACHE_HOME/shvcli``. The default is ``true``.
+* **call_attempts**: Number of attempts before method call is abandoned and
+  timeout is reported. This makes the total time multiple of **call_timeout**.
+* **call_timeout**: Timeout in seconds before call attempt is abandoned. Based
+  on the **call_attempts** call is attempted again or timeout is reported.
+* **autoget_timeout**: Timeout in seconds before call that is part of autoget
+  functionality.
 
 
 Example configuration file:

{shvcli-0.5.0 → shvcli-0.6.1}/README.rst

@@ -95,6 +95,12 @@ switched in runtime. The following options are available:
 * **cache**: Controls if cache is preserved between invocations. Cache is
   separated based on the connection URL and stored in files in
   ``$XDG_CACHE_HOME/shvcli``. The default is ``true``.
+* **call_attempts**: Number of attempts before method call is abandoned and
+  timeout is reported. This makes the total time multiple of **call_timeout**.
+* **call_timeout**: Timeout in seconds before call attempt is abandoned. Based
+  on the **call_attempts** call is attempted again or timeout is reported.
+* **autoget_timeout**: Timeout in seconds before call that is part of autoget
+  functionality.
 
 
 Example configuration file:

{shvcli-0.5.0 → shvcli-0.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shvcli"
-version = "0.5.0"
+version = "0.6.1"
 description = "Silicon Heaven CLI access application"
 readme = "README.rst"
 license = {file = "LICENSE"}
@@ -20,7 +20,7 @@ classifiers = [
 ]
 requires-python = ">=3.11"
 dependencies = [
-  "pyshv >= 0.7.0",
+  "pyshv >= 0.7.1",
   "prompt_toolkit",
   "pygments",
   "pyxdg",

{shvcli-0.5.0 → shvcli-0.6.1}/shvcli/__main__.py

@@ -21,6 +21,12 @@ def parse_args() -> argparse.Namespace:
     )
     parser.add_argument(
         "-s",
+        "--subscribe",
+        action="append",
+        default=[],
+        help="Automatic subscription right after connection.",
+    )
+    parser.add_argument(
         "--scan",
         action="store_true",
         help="Perform scan as a first action right after connect.",
@@ -49,7 +55,7 @@ def main() -> None:
     config.debug = config.debug or args.debug
     config.initial_scan = args.scan
     config.initial_scan_depth = args.scan_depth
-    asyncio.run(run(config))
+    asyncio.run(run(config, args.subscribe))
 
 
 if __name__ == "__main__":

{shvcli-0.5.0 → shvcli-0.6.1}/shvcli/builtin_impl.py

@@ -13,7 +13,7 @@ from .config import CliConfig
 from .lsdir import ls_node_format
 from .parse import CliItems
 from .scan import scan_nodes
-from .tools import lookahead, print_block, print_ftext, print_row
+from .tools import lookahead, print_block, print_flist, print_ftext, print_row
 
 
 def argument_signal_comp(
@@ -21,10 +21,10 @@ def argument_signal_comp(
 ) -> collections.abc.Iterable[Completion]:
     """Completion for subscribe argument."""
     if ":" in items.param_raw:
-        path, method, signal = items.interpret_param_ri(config).split(":")
+        path, method, signal = items.interpret_param_ri(config)[-1].split(":")
         node = shvclient.tree.get_path(path)
         if node is not None:
-            if items.param_raw.count(":") == 1:
+            if items.param_raw.rsplit(maxsplit=1)[-1].count(":") == 1:
                 yield from comp_from(method, node.methods)
             elif method in node.methods:
                 yield from comp_from(signal, node.methods[method])
@@ -71,19 +71,28 @@ def _help(_: SHVClient, __: CliConfig, ___: CliItems) -> None:
 @builtin(aliases={"sub"}, argument=argument_signal)
 async def subscribe(shvclient: SHVClient, config: CliConfig, items: CliItems) -> None:
     """Add new subscribe."""
-    await shvclient.subscribe(items.interpret_param_ri(config))
+    for ri in items.interpret_param_ri(config):
+        await shvclient.subscribe(ri)
 
 
 @builtin(aliases={"usub"}, argument=argument_signal)
 async def unsubscribe(shvclient: SHVClient, config: CliConfig, items: CliItems) -> None:
     """Unsubscribe existing subscription."""
-    await shvclient.unsubscribe(items.interpret_param_ri(config))
+    for ri in items.interpret_param_ri(config):
+        await shvclient.unsubscribe(ri)
 
 
 @builtin(aliases={"subs", "test"})
 async def subscriptions(shvclient: SHVClient, _: CliConfig, __: CliItems) -> None:
     """List current subscriptions."""
-    print(await shvclient.call(".app/broker/currentClient", "subscriptions"))
+    subs = await shvclient.call(".broker/currentClient", "subscriptions")
+    if isinstance(subs, dict):
+        print_flist(
+            ("", sub + (f"?{timeout}secs" if timeout is not None else ""))
+            for sub, timeout in subs.items()
+        )
+    else:
+        print(subs)
 
 
 @builtin(aliases={"t"}, argument=argument_path)

{shvcli-0.5.0 → shvcli-0.6.1}/shvcli/cli.py

@@ -59,10 +59,12 @@ async def _app(config: CliConfig, shvclient: SHVClient) -> None:
             continue
 
 
-async def run(config: CliConfig) -> None:
+async def run(config: CliConfig, subscriptions: list[str]) -> None:
     """Loop to run interactive CLI session."""
     shvclient = await SHVClient.connect(config.url)
     assert isinstance(shvclient, SHVClient)
+    for ri in subscriptions:
+        await shvclient.subscribe(ri)
 
     if config.cache:
         cacheurl = RpcUrl(
@@ -115,9 +117,15 @@ async def handle_line(shvclient: SHVClient, config: CliConfig, cmdline: str) ->
                 else:
                     print_cpon(
                         await shvclient.call(
-                            config.shvpath(items.path), items.method, param
+                            config.shvpath(items.path),
+                            items.method,
+                            param,
+                            call_attempts=config.call_attempts,
+                            call_timeout=config.call_timeout,
                         )
                     )
+        except TimeoutError:
+            print("Call timed out.")
         except RpcError as exc:
             print(f"{type(exc).__name__}: {exc.message}")
     else:

{shvcli-0.5.0 → shvcli-0.6.1}/shvcli/client.py

@@ -15,9 +15,9 @@ from shv import (
     SHVType,
     SimpleClient,
 )
-from shv.cpon import Cpon
 
 from . import VERSION
+from .tools import print_cpon
 
 
 class Node(collections.abc.Mapping[str, "Node"]):
@@ -123,7 +123,7 @@ class SHVClient(SimpleClient):
             self.tree.valid_path(msg.path or "").methods.setdefault(
                 msg.source, set()
             ).add(msg.signal_name)
-            print(f"{msg.path}:{msg.source}:{msg.signal_name}: {Cpon.pack(msg.param)}")
+            print_cpon(msg.param, f"{msg.path}:{msg.source}:{msg.signal_name}: ", True)
 
     async def ls(self, path: str) -> list[str]:
         """List same as in ValueClient but with result being preserved in tree."""

{shvcli-0.5.0 → shvcli-0.6.1}/shvcli/config.py

@@ -4,6 +4,7 @@ import collections.abc
 import configparser
 import enum
 import functools
+import itertools
 import logging
 import pathlib
 import subprocess
@@ -20,6 +21,7 @@ class CliConfig:
 
         BOOL = enum.auto()
         INT = enum.auto()
+        FLOAT = enum.auto()
 
     OPTS: collections.abc.Mapping[str, Type] = {
         "vimode": Type.BOOL,
@@ -27,12 +29,21 @@ class CliConfig:
         "autoprobe": Type.BOOL,
         "raw": Type.BOOL,
         "debug": Type.BOOL,
+        "call_attempts": Type.INT,
+        "call_timeout": Type.FLOAT,
+        "autoget_timeout": Type.FLOAT,
     }
-    """All options allowed to be set in runtime.
+    """Options allowed to be set in runtime and from configuration file.
+
     You can use :func:`setattr` and :func:`getattr`.
     """
 
-    def __init__(self) -> None:
+    COPTS: collections.abc.Mapping[str, Type] = {
+        "cache": Type.BOOL,
+    }
+    """Options allowed to be set only from configuration file."""
+
+    def __init__(self) -> None:  # noqa: PLR0915
         """Initialize the configuration to the default and load config files."""
         self.hosts: dict[str, RpcUrl] = {}
         """Hosts that can be used instead of URL."""
@@ -53,6 +64,13 @@ class CliConfig:
         """Interpret ls and dir method calls internally or not."""
         self.cache: bool = True
         """Preserve cache between executions. Not modifiable in runtime!"""
+        self.call_attempts: int = 1
+        """Number of call attempts before call is abandoned."""
+        self.call_timeout: float = 5.0
+        """Timeout in seconds before call is abandoned."""
+        self.autoget_timeout: float = 1.0
+        """Timeout in seconds for call that is part of autoget feature."""
+
         self.initial_scan: bool = False
         """Perform scan right after connection."""
         self.initial_scan_depth: int = 3
@@ -74,17 +92,19 @@ class CliConfig:
                     if self.hosts_shell and self.__url is None:
                         self.__url = self.hosts_shell[next(iter(self.hosts_shell))]
                 case "config":
-                    for n, t in self.OPTS.items():
+                    for n, t in itertools.chain(self.OPTS.items(), self.COPTS.items()):
                         value = getattr(self, n)
                         match t:
                             case self.Type.BOOL:
                                 value = sec.getboolean(n, fallback=value)
                             case self.Type.INT:
-                                value = sec.getinteger(n, fallback=value)
+                                value = sec.getint(n, fallback=value)
+                            case self.Type.FLOAT:
+                                value = sec.getfloat(n, fallback=value)
                             case _:
                                 raise NotImplementedError(f"Unhandled type: {t!r}")
                         setattr(self, n, value)
-                    if opts := set(sec.keys()) - set(self.OPTS.keys()):
+                    if opts := set(sec.keys()) - set(self.OPTS) - set(self.COPTS):
                         raise ValueError(
                             f"Invalid configuration option: {', '.join(opts)}"
                         )

{shvcli-0.5.0 → shvcli-0.6.1}/shvcli/lsdir.py

@@ -42,7 +42,7 @@ def dir_method_format(method: RpcMethodDesc) -> tuple[str, str]:
             methstyle = "ansimagenta"
         else:
             methstyle = "ansigreen"
-    elif method.signals or RpcMethodFlags.NOT_CALLABLE in method.flags:
+    elif method.signals:
         methstyle = "ansipurple"
     name = method.name
     return (
@@ -51,6 +51,20 @@ def dir_method_format(method: RpcMethodDesc) -> tuple[str, str]:
     )
 
 
+def dir_signal_format(method: RpcMethodDesc, signal: str) -> tuple[str, str]:
+    """Print format for signals."""
+    sigstyle = "ansipurple"
+    if method.name in {"ls", "dir"}:
+        sigstyle = "ansibrightblack"
+    elif RpcMethodFlags.GETTER in method.flags:
+        sigstyle = "ansimagenta"
+    label = f"{method.name}:{signal}"
+    return (
+        sigstyle,
+        f'"{label}"' if any(c in label for c in string.whitespace) else label,
+    )
+
+
 async def ls_method(shvclient: SHVClient, config: CliConfig, items: CliItems) -> None:
     """SHV ls method that is just smarter than regular call."""
     shvpath = items.interpret_param_path(config)
@@ -71,9 +85,12 @@ async def ls_method(shvclient: SHVClient, config: CliConfig, items: CliItems) ->
                 if "get" in nv.methods:
                     try:
                         resp = await shvclient.call(
-                            str(pathlib.PurePosixPath(shvpath) / nn), "get"
+                            str(pathlib.PurePosixPath(shvpath) / nn),
+                            "get",
+                            call_attempts=1,
+                            call_timeout=config.autoget_timeout,
                         )
-                    except RpcError:
+                    except (RpcError, TimeoutError):
                         pass
                     else:
                         print_row(
@@ -94,11 +111,18 @@ async def dir_method(shvclient: SHVClient, config: CliConfig, items: CliItems) -
     if config.autoget and any(_use_autoget(d) for d in dirr):
         w = max(len(d.name) for d in dirr)
         for d in dirr:
+            if RpcMethodFlags.NOT_CALLABLE in d.flags:
+                continue  # Ignore not callable
             n = [("", " " * (w - len(d.name))), dir_method_format(d)]
             if _use_autoget(d):
                 try:
-                    resp = await shvclient.call(shvpath, d.name)
-                except RpcError:
+                    resp = await shvclient.call(
+                        shvpath,
+                        d.name,
+                        call_attempts=1,
+                        call_timeout=config.autoget_timeout,
+                    )
+                except (RpcError, TimeoutError):
                     pass
                 else:
                     print_row(
@@ -110,6 +134,8 @@ async def dir_method(shvclient: SHVClient, config: CliConfig, items: CliItems) -
             print_row(n)
     else:
         print_flist(dir_method_format(d) for d in dirr)
+    if any(d.signals for d in dirr):
+        print_flist(dir_signal_format(d, s) for d in dirr for s in d.signals)
 
 
 def _use_autoget(method: RpcMethodDesc) -> bool:

{shvcli-0.5.0 → shvcli-0.6.1}/shvcli/parse.py

@@ -46,18 +46,21 @@ class CliItems:
         """
         return config.shvpath([self.path, self.param_raw])
 
-    def interpret_param_ri(self, config: CliConfig, expand: bool = True) -> str:
+    def interpret_param_ri(self, config: CliConfig, expand: bool = True) -> list[str]:
         """Interpret parameter as RI.
 
         The path in RI is combined with pat in the configuration.
 
         :return: SHV RPC RI.
         """
-        parts = self.param_raw.split(":")
-        path = parts[0] if parts[0] else "**"
-        method = parts[1] if len(parts) == 2 else "*"
-        signal = parts[2] if len(parts) == 3 else "*"
-        return f"{self.path}{"/" if path else ""}{path}:{method}:{signal}"
+        res = []
+        for item in self.param_raw.split():
+            parts = item.split(":")
+            path = parts[0] if parts[0] else "**"
+            method = parts[1] if len(parts) == 2 else "*"
+            signal = parts[2] if len(parts) == 3 else "*"
+            res.append(f"{self.path}{'/' if self.path else ''}{path}:{method}:{signal}")
+        return res
 
     def interpret_param_set(self) -> tuple[str | None, str | None]:
         """Interpret parameter as 'set' method specification.

{shvcli-0.5.0 → shvcli-0.6.1}/shvcli/tools.py

@@ -1,6 +1,7 @@
 """Various tools used in the code."""
 
 import collections.abc
+import itertools
 import os
 import textwrap
 import typing
@@ -118,16 +119,31 @@ def cpon_ftext(cpon: str) -> collections.abc.Iterator[tuple[str, str]]:
             yield "", "\n"
 
 
-def print_cpon(data: shv.SHVType, short: bool = False) -> None:
+def _wrap_cpon(cpon: str) -> collections.abc.Iterator[str]:
+    """Wrap CPON.
+
+    It is better to wrap CPON on division characters rather than white spaces
+    because those are part of the data.
+    """
+    cols = os.get_terminal_size().columns
+    while len(cpon) > cols:
+        i = max(cpon.rfind(sep, 0, cols) for sep in (",", "]", "}"))
+        if i == -1:
+            i = cols
+        yield cpon[: i + 1]
+        cpon = " " + cpon[i + 1 :]
+    yield cpon
+
+
+def print_cpon(data: shv.SHVType, prefix: str = "", short: bool = False) -> None:
     """Print given data in CPON format."""
-    simple = shv.Cpon.pack(data)
-    if len(simple) > os.get_terminal_size().columns:
-        if short:
-            print_row(cpon_ftext(simple))
-        else:
-            for line in shv.Cpon.pack(
-                data, shv.CponWriter.Options(indent=b" ")
-            ).splitlines():
-                print_row(cpon_ftext(line))
+    if short:
+        cpon = "\n".join(_wrap_cpon(prefix + shv.Cpon.pack(data)))[len(prefix) :]
+        print_ftext(itertools.chain(iter((("", prefix),)), cpon_ftext(cpon)))
     else:
-        print_ftext(cpon_ftext(simple))
+        print_ftext(
+            itertools.chain(
+                iter((("", prefix),)),
+                cpon_ftext(shv.Cpon.pack(data, shv.CponWriter.Options(indent=b" "))),
+            )
+        )

{shvcli-0.5.0 → shvcli-0.6.1/shvcli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shvcli
-Version: 0.5.0
+Version: 0.6.1
 Summary: Silicon Heaven CLI access application
 Author: Elektroline a.s.
 License: MIT License
@@ -38,7 +38,7 @@ Classifier: Topic :: Terminals
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pyshv>=0.7.0
+Requires-Dist: pyshv>=0.7.1
 Requires-Dist: prompt_toolkit
 Requires-Dist: pygments
 Requires-Dist: pyxdg
@@ -140,6 +140,12 @@ switched in runtime. The following options are available:
 * **cache**: Controls if cache is preserved between invocations. Cache is
   separated based on the connection URL and stored in files in
   ``$XDG_CACHE_HOME/shvcli``. The default is ``true``.
+* **call_attempts**: Number of attempts before method call is abandoned and
+  timeout is reported. This makes the total time multiple of **call_timeout**.
+* **call_timeout**: Timeout in seconds before call attempt is abandoned. Based
+  on the **call_attempts** call is attempted again or timeout is reported.
+* **autoget_timeout**: Timeout in seconds before call that is part of autoget
+  functionality.
 
 
 Example configuration file:

{shvcli-0.5.0 → shvcli-0.6.1}/shvcli.egg-info/requires.txt

@@ -1,4 +1,4 @@
-pyshv>=0.7.0
+pyshv>=0.7.1
 prompt_toolkit
 pygments
 pyxdg