shvcli 0.6.1__tar.gz → 0.6.2__tar.gz

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: shvcli
-Version: 0.6.1
+Version: 0.6.2
 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.1
+Requires-Dist: pyshv>=0.8.0
 Requires-Dist: prompt_toolkit
 Requires-Dist: pygments
 Requires-Dist: pyxdg
@@ -172,10 +172,7 @@ environment you are running in.
 
 **subscribe|sub**: Add new subscribe. Shortcut to the call of
 ``.app/broker/currentClient:subscribe`` that accepts arguments in more convenient
-way (you need to use Map if you call that method directly). The argument has
-same format such as method calls in this tool, that means ``PATH:METHOD`` where
-``METHOD`` can be left out to match all methods. Pattern subscribes are not
-supporter, yet.
+way. The argument can be multiple RPC RIs (``PATH:METHOD:SIGNAL`` patterns).
 
 **unsubscribe|usub**: Unsubscribe existing subscription. It is reverse operation
 to the **subscribe** and same remarks apply here as well. It is a shortcut to
@@ -197,11 +194,11 @@ cache.
 thus use it sparely.
 
 **set|s**: allows modification of configuration option in runtime.  The names
-are the same as in ``config`` section. The boolean options (the only ones
-available right now) are set if no argument is provided, or cleared if name is
-prefixed with ``no`` (and thus to disable ``raw`` you use ``noraw``). You can
-also provide argument ``true`` or ``false``. Without any configuration option it
-simply prints the current configuration.
+are the same as in ``config`` section. The boolean options  are set if no
+argument is provided, or cleared if name is prefixed with ``no`` (and thus to
+disable ``raw`` you use ``noraw``). You can also add ``=true`` or ``=false``.
+The equal sign is also used with integer and floating point options. Without any
+configuration option it simply prints the current configuration.
 
 
 Special methods ``ls`` and ``dir``

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

@@ -127,10 +127,7 @@ environment you are running in.
 
 **subscribe|sub**: Add new subscribe. Shortcut to the call of
 ``.app/broker/currentClient:subscribe`` that accepts arguments in more convenient
-way (you need to use Map if you call that method directly). The argument has
-same format such as method calls in this tool, that means ``PATH:METHOD`` where
-``METHOD`` can be left out to match all methods. Pattern subscribes are not
-supporter, yet.
+way. The argument can be multiple RPC RIs (``PATH:METHOD:SIGNAL`` patterns).
 
 **unsubscribe|usub**: Unsubscribe existing subscription. It is reverse operation
 to the **subscribe** and same remarks apply here as well. It is a shortcut to
@@ -152,11 +149,11 @@ cache.
 thus use it sparely.
 
 **set|s**: allows modification of configuration option in runtime.  The names
-are the same as in ``config`` section. The boolean options (the only ones
-available right now) are set if no argument is provided, or cleared if name is
-prefixed with ``no`` (and thus to disable ``raw`` you use ``noraw``). You can
-also provide argument ``true`` or ``false``. Without any configuration option it
-simply prints the current configuration.
+are the same as in ``config`` section. The boolean options  are set if no
+argument is provided, or cleared if name is prefixed with ``no`` (and thus to
+disable ``raw`` you use ``noraw``). You can also add ``=true`` or ``=false``.
+The equal sign is also used with integer and floating point options. Without any
+configuration option it simply prints the current configuration.
 
 
 Special methods ``ls`` and ``dir``

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

@@ -1,6 +1,6 @@
 [project]
 name = "shvcli"
-version = "0.6.1"
+version = "0.6.2"
 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.1",
+  "pyshv >= 0.8.0",
   "prompt_toolkit",
   "pygments",
   "pyxdg",
@@ -77,8 +77,6 @@ ignore = [
   "PLR0916",
   # This seems like a wrong rule
   "PLW1641",
-  # Deprecated
-  "ANN101", "ANN102",
 ]
 preview = true
 [tool.ruff.lint.per-file-ignores]

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

@@ -33,19 +33,27 @@ def argument_signal_comp(
 
 
 def argument_set_comp(
-    _: SHVClient, config: CliConfig, items: CliItems
+    client: SHVClient, config: CliConfig, items: CliItems
 ) -> collections.abc.Iterable[Completion]:
     """Completion for !set method."""
-    opt, val = items.interpret_param_set()
-    if val is not None:
-        if config.OPTS.get(opt or "") is config.Type.BOOL:
+    item = items.param_raw.split()[-1] if items.param_raw else ""
+    if "=" in item:
+        opt, _, val = item.partition("=")
+        if config.OPTS.get(opt) == config.Type.BOOL:
             yield from comp_from(val, {"true", "false"})
     else:
-        yield from comp_from(items.param_raw, config.OPTS.keys())
         yield from comp_from(
-            items.param_raw,
+            item,
+            (v for v, t in config.OPTS.items() if t is config.Type.BOOL),
+        )
+        yield from comp_from(
+            item,
             (f"no{v}" for v, t in config.OPTS.items() if t is config.Type.BOOL),
         )
+        yield from comp_from(
+            item,
+            (f"{v}=" for v, t in config.OPTS.items() if t is not config.Type.BOOL),
+        )
 
 
 argument_signal = Argument("[PATH:SIGNAL]", argument_signal_comp, autoprobe=True)
@@ -54,7 +62,7 @@ argument_set = Argument("[OPTION [VALUE]]", argument_set_comp)
 
 
 @builtin("help", {"h"}, hidden=True)
-def _help(_: SHVClient, __: CliConfig, ___: CliItems) -> None:
+def _help(client: SHVClient, config: CliConfig, items: CliItems) -> None:
     """Print help for all builtin methods."""
     print_row("Available internal methods (all prefixed with '!'):")
     for name, m in METHODS.items():
@@ -83,7 +91,9 @@ async def unsubscribe(shvclient: SHVClient, config: CliConfig, items: CliItems)
 
 
 @builtin(aliases={"subs", "test"})
-async def subscriptions(shvclient: SHVClient, _: CliConfig, __: CliItems) -> None:
+async def subscriptions(
+    shvclient: SHVClient, config: CliConfig, items: CliItems
+) -> None:
     """List current subscriptions."""
     subs = await shvclient.call(".broker/currentClient", "subscriptions")
     if isinstance(subs, dict):
@@ -118,7 +128,7 @@ def tree(shvclient: SHVClient, config: CliConfig, items: CliItems) -> None:
 
 
 @builtin(argument=argument_path)
-async def cd(_: SHVClient, __: CliConfig, ___: CliItems) -> None:
+async def cd(client: SHVClient, config: CliConfig, itemst: CliItems) -> None:
     """Change to given path even if it is invalid."""
 
 
@@ -134,10 +144,9 @@ async def scan(
 
 
 @builtin("set", aliases={"s"}, argument=argument_set)
-def _set(_: SHVClient, config: CliConfig, items: CliItems) -> None:
+def _set(client: SHVClient, config: CliConfig, items: CliItems) -> None:
     """Set configuration options in runtime."""
-    opt, val = items.interpret_param_set()
-    if not opt:
+    if not items.param_raw.strip():
         w = max(len(n) for n in config.OPTS.keys())
         for n, t in config.OPTS.items():
             row = [("", (" " * (w - len(n))) + n + "  ")]
@@ -146,25 +155,39 @@ def _set(_: SHVClient, config: CliConfig, items: CliItems) -> None:
                     v = getattr(config, n)
                     assert isinstance(v, bool)
                     row.append(("ansigreen" if v else "ansired", str(v).lower()))
-                case config.Type.INT:
+                case config.Type.INT | config.Type.FLOAT:
                     row.append(("", str(getattr(config, n))))
                 case _:
                     raise NotImplementedError(f"Unimplemented {t!r}")
             print_row(row)
         return
 
-    # TODO from here we need add support for integers when we need it.
-    if no := opt.startswith("no"):
-        opt = opt[2:]
-    if opt not in config.OPTS.keys():
-        print(f"Invalid option: {opt}")
-        return
-    if val is None:
-        value = not no
-    else:
-        m = {"true": True, "t": True, "false": False, "f": False}
-        if val not in m:
-            print(f"Invalid value, expected 'true' or 'false': {val}")
+    for opt in items.param_raw.split():
+        if "=" in opt:
+            opt, _, val = opt.partition("=")  # noqa: PLW2901
+            if opt not in config.OPTS.keys():
+                print(f"Invalid option: {opt}")
+                return
+            value: bool | int | float
+            match config.OPTS[opt]:
+                case config.Type.BOOL:
+                    bools = {"true": True, "t": True, "false": False, "f": False}
+                    if val not in bools:
+                        print(f"Invalid value, expected 'true' or 'false': {val}")
+                        return
+                    value = bools[val]
+                case config.Type.INT:
+                    value = int(val, 0)
+                case config.Type.FLOAT:
+                    value = float(val)
+                case _:
+                    raise NotImplementedError(f"Unimplemented {t!r}")
+            setattr(config, opt, value)
+            continue
+
+        if no := opt.startswith("no"):
+            opt = opt[2:]  # noqa: PLW2901
+        if opt not in config.OPTS.keys():
+            print(f"Invalid option: {opt}")
             return
-        value = m[val]
-    setattr(config, opt, value)
+        setattr(config, opt, not no)

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

@@ -1,6 +1,7 @@
 """Command line interface."""
 
 import asyncio
+import contextlib
 import json
 import pathlib
 import re
@@ -30,13 +31,10 @@ async def _app(config: CliConfig, shvclient: SHVClient) -> None:
         with histfile.open("w") as _:
             pass
 
-    completer = CliCompleter(shvclient, config)
-    validator = CliValidator(shvclient, config)
-
     session: PromptSession = PromptSession(
         history=FileHistory(str(histfile)),
-        completer=completer,
-        validator=validator,
+        completer=CliCompleter(shvclient, config),
+        validator=CliValidator(shvclient, config),
     )
     while True:
         try:
@@ -52,7 +50,6 @@ async def _app(config: CliConfig, shvclient: SHVClient) -> None:
                         [prompt_path, ("", "> ")], vi_mode=config.vimode
                     )
             except EOFError:
-                await shvclient.disconnect()
                 return
             await handle_line(shvclient, config, result)
         except KeyboardInterrupt:
@@ -82,15 +79,20 @@ async def run(config: CliConfig, subscriptions: list[str]) -> None:
     if config.initial_scan:
         await scan_nodes(shvclient, "", config.initial_scan_depth)
 
-    clitask = asyncio.create_task(_app(config, shvclient))
-    await shvclient.client.wait_disconnect()
-    if not clitask.done():
+    app_task = asyncio.create_task(_app(config, shvclient))
+    disconnect_task = asyncio.create_task(shvclient.client.wait_disconnect())
+    tasks: set[asyncio.Task] = {app_task, disconnect_task}
+    await asyncio.wait(tasks, return_when=asyncio.FIRST_COMPLETED)
+
+    if not app_task.done():
+        app_task.cancel()
+    if disconnect_task.done():
         print("Disconnected.")
-        clitask.cancel()
-    try:
-        await clitask
-    except asyncio.CancelledError:
-        pass
+    else:
+        await shvclient.disconnect()
+        await disconnect_task
+    with contextlib.suppress(asyncio.CancelledError):
+        await app_task
 
     if config.cache:
         cachepath.parent.mkdir(exist_ok=True)

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

@@ -13,8 +13,8 @@ from shv import (
     RpcMethodFlags,
     RpcMethodNotFoundError,
     SHVType,
-    SimpleClient,
 )
+from shv import SHVClient as _SHVClient
 
 from . import VERSION
 from .tools import print_cpon
@@ -67,7 +67,7 @@ class Node(collections.abc.Mapping[str, "Node"]):
         if pnode is not None:
             pnode.nodes.pop(path.name)
 
-    def get_path(self, path: str | PurePosixPath) -> None | Node:
+    def get_path(self, path: str | PurePosixPath) -> Node | None:
         """Get node on given path."""
         if isinstance(path, str):
             path = PurePosixPath(path)
@@ -101,7 +101,7 @@ class Node(collections.abc.Mapping[str, "Node"]):
         return res
 
 
-class SHVClient(SimpleClient):
+class SHVClient(_SHVClient):
     """Our client caching SHV Tree and reporting received signals."""
 
     APP_NAME = "shvcli"

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

@@ -62,14 +62,6 @@ class CliItems:
             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.
-
-        :return: First word and rest of the string.
-        """
-        s = self.param_raw.split(" ", maxsplit=1)
-        return s[0] if s else None, s[1] if len(s) > 1 else None
-
 
 def parse_line(line: str) -> CliItems:
     """Parse CLI line."""

shvcli-0.6.2/shvcli/plugins.py

@@ -0,0 +1,18 @@
+"""Utility to manage plugins."""
+
+import importlib
+import importlib.metadata
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def load_plugins() -> None:
+    """Import plugins.
+
+    Plugins get inserted automatically. We have to only ensure that we import
+    them.
+    """
+    for plugin in importlib.metadata.entry_points(group="shvcli.plugins"):
+        logger.debug("Loading plugin: %s", plugin.name)
+        importlib.__import__(plugin.value)

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: shvcli
-Version: 0.6.1
+Version: 0.6.2
 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.1
+Requires-Dist: pyshv>=0.8.0
 Requires-Dist: prompt_toolkit
 Requires-Dist: pygments
 Requires-Dist: pyxdg
@@ -172,10 +172,7 @@ environment you are running in.
 
 **subscribe|sub**: Add new subscribe. Shortcut to the call of
 ``.app/broker/currentClient:subscribe`` that accepts arguments in more convenient
-way (you need to use Map if you call that method directly). The argument has
-same format such as method calls in this tool, that means ``PATH:METHOD`` where
-``METHOD`` can be left out to match all methods. Pattern subscribes are not
-supporter, yet.
+way. The argument can be multiple RPC RIs (``PATH:METHOD:SIGNAL`` patterns).
 
 **unsubscribe|usub**: Unsubscribe existing subscription. It is reverse operation
 to the **subscribe** and same remarks apply here as well. It is a shortcut to
@@ -197,11 +194,11 @@ cache.
 thus use it sparely.
 
 **set|s**: allows modification of configuration option in runtime.  The names
-are the same as in ``config`` section. The boolean options (the only ones
-available right now) are set if no argument is provided, or cleared if name is
-prefixed with ``no`` (and thus to disable ``raw`` you use ``noraw``). You can
-also provide argument ``true`` or ``false``. Without any configuration option it
-simply prints the current configuration.
+are the same as in ``config`` section. The boolean options  are set if no
+argument is provided, or cleared if name is prefixed with ``no`` (and thus to
+disable ``raw`` you use ``noraw``). You can also add ``=true`` or ``=false``.
+The equal sign is also used with integer and floating point options. Without any
+configuration option it simply prints the current configuration.
 
 
 Special methods ``ls`` and ``dir``

{shvcli-0.6.1 → shvcli-0.6.2}/shvcli.egg-info/SOURCES.txt

@@ -13,11 +13,11 @@ shvcli/complet_tools.py
 shvcli/config.py
 shvcli/lsdir.py
 shvcli/parse.py
+shvcli/plugins.py
 shvcli/py.typed
 shvcli/scan.py
 shvcli/tools.py
 shvcli/valid.py
-shvcli/version
 shvcli.egg-info/PKG-INFO
 shvcli.egg-info/SOURCES.txt
 shvcli.egg-info/dependency_links.txt

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

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

shvcli-0.6.1/shvcli/version

@@ -1 +0,0 @@
-0.3.0