shvcli 0.6.0__tar.gz → 0.6.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shvcli
-Version: 0.6.0
+Version: 0.6.1
 Summary: Silicon Heaven CLI access application
 Author: Elektroline a.s.
 License: MIT License
@@ -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.6.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.6.0 → shvcli-0.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shvcli"
-version = "0.6.0"
+version = "0.6.1"
 description = "Silicon Heaven CLI access application"
 readme = "README.rst"
 license = {file = "LICENSE"}

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

@@ -117,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.6.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.6.0 → shvcli-0.6.1}/shvcli/lsdir.py

@@ -85,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(
@@ -113,8 +116,13 @@ async def dir_method(shvclient: SHVClient, config: CliConfig, items: CliItems) -
             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(

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

@@ -59,7 +59,7 @@ class CliItems:
             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}")
+            res.append(f"{self.path}{'/' if self.path else ''}{path}:{method}:{signal}")
         return res
 
     def interpret_param_set(self) -> tuple[str | None, str | None]:

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

@@ -141,7 +141,7 @@ def print_cpon(data: shv.SHVType, prefix: str = "", short: bool = False) -> None
         cpon = "\n".join(_wrap_cpon(prefix + shv.Cpon.pack(data)))[len(prefix) :]
         print_ftext(itertools.chain(iter((("", prefix),)), cpon_ftext(cpon)))
     else:
-        print_row(
+        print_ftext(
             itertools.chain(
                 iter((("", prefix),)),
                 cpon_ftext(shv.Cpon.pack(data, shv.CponWriter.Options(indent=b" "))),

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shvcli
-Version: 0.6.0
+Version: 0.6.1
 Summary: Silicon Heaven CLI access application
 Author: Elektroline a.s.
 License: MIT License
@@ -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: