shvcli 0.3.0__tar.gz → 0.5.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shvcli
-Version: 0.3.0
+Version: 0.5.0
 Summary: Silicon Heaven CLI access application
 Author: Elektroline a.s.
 License: MIT License
@@ -25,7 +25,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
         
-Project-URL: repository, https://gitlab.com/elektroline-predator/shvcli
+Project-URL: repository, https://gitlab.com/silicon-heaven/shvcli
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
@@ -38,27 +38,22 @@ Classifier: Topic :: Terminals
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pyshv>=0.5.0
+Requires-Dist: pyshv>=0.7.0
 Requires-Dist: prompt_toolkit
+Requires-Dist: pygments
 Requires-Dist: pyxdg
-Provides-Extra: lint
-Requires-Dist: black; extra == "lint"
-Requires-Dist: isort; extra == "lint"
-Requires-Dist: mypy; extra == "lint"
-Requires-Dist: pydocstyle; extra == "lint"
-Requires-Dist: pylint; extra == "lint"
 
 =====================================
 Silicon Heaven CLI access application
 =====================================
-.. image:: https://gitlab.com/elektroline-predator/shvcli/-/raw/master/logo.svg
+.. image:: https://gitlab.com/silicon-heaven/shvcli/-/raw/master/logo.svg
    :align: right
    :height: 128px
 
 This provides an easy to use CLI interfase to access the SHV network.
 
-* `📃 Sources <https://gitlab.com/elektroline-predator/shvcli>`__
-* `⁉️ Issue tracker <https://gitlab.com/elektroline-predator/shvcli/-/issues>`__
+* `📃 Sources <https://gitlab.com/silicon-heaven/shvcli>`__
+* `⁉️ Issue tracker <https://gitlab.com/silicon-heaven/shvcli/-/issues>`__
 * `📕 Silicon Heaven protocol documentation <https://silicon-heaven.github.io/shv-doc/>`__
 
 

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

@@ -1,14 +1,14 @@
 =====================================
 Silicon Heaven CLI access application
 =====================================
-.. image:: https://gitlab.com/elektroline-predator/shvcli/-/raw/master/logo.svg
+.. image:: https://gitlab.com/silicon-heaven/shvcli/-/raw/master/logo.svg
    :align: right
    :height: 128px
 
 This provides an easy to use CLI interfase to access the SHV network.
 
-* `📃 Sources <https://gitlab.com/elektroline-predator/shvcli>`__
-* `⁉️ Issue tracker <https://gitlab.com/elektroline-predator/shvcli/-/issues>`__
+* `📃 Sources <https://gitlab.com/silicon-heaven/shvcli>`__
+* `⁉️ Issue tracker <https://gitlab.com/silicon-heaven/shvcli/-/issues>`__
 * `📕 Silicon Heaven protocol documentation <https://silicon-heaven.github.io/shv-doc/>`__
 
 

shvcli-0.5.0/pyproject.toml

@@ -0,0 +1,101 @@
+[project]
+name = "shvcli"
+version = "0.5.0"
+description = "Silicon Heaven CLI access application"
+readme = "README.rst"
+license = {file = "LICENSE"}
+authors = [
+  { name="Elektroline a.s." },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+  "Environment :: Console",
+  "Intended Audience :: End Users/Desktop",
+  "Topic :: Home Automation",
+  "Topic :: System :: Shells",
+  "Topic :: Terminals",
+]
+requires-python = ">=3.11"
+dependencies = [
+  "pyshv >= 0.7.0",
+  "prompt_toolkit",
+  "pygments",
+  "pyxdg",
+]
+
+[project.urls]
+repository = "https://gitlab.com/silicon-heaven/shvcli"
+
+[project.scripts]
+shvcli = "shvcli.__main__:main"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+[tool.setuptools.package-data]
+"*" = ["py.typed"]
+
+[tool.coverage.run]
+branch = true
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if typing.TYPE_CHECKING:"
+]
+
+[tool.ruff]
+target-version = "py311"
+[tool.ruff.lint]
+select = [
+  "F", "E", "W", "I", "N", "D", "UP", "YTT", "ANN", "ASYNC", "ASYNC1", "S", "BLE",
+  "B", "A", "COM", "PL", "RUF"
+]
+ignore = [
+  # Magic methods have defined behavior so what is there to document. __init__
+  # should be documented in class docstring.
+  "D105", "D107",
+  # These have conflicting rules.
+  "D203", "D213",
+  # Ignore too long lines (format tackles that)
+  "E501",
+  # It is nice that assert should not be used for input checking but it can be
+  # also used for internal consistency checking.
+  "S101", "B011",
+  # subprocess can be insecurely used but not is insecure by design
+  "S404", "S603", "S607",
+  # Catching Exception is valid and safe in some cases and thus should be allowed
+  "BLE001",
+  # Conflict with formatter
+  "COM812",
+  # Remove too-many limit for more complex code.
+  "PLR0904", "PLR0911", "PLR0912", "PLR0913", "PLR0917", "PLR2004", "PLR1702",
+  "PLR0916",
+  # This seems like a wrong rule
+  "PLW1641",
+  # Deprecated
+  "ANN101", "ANN102",
+]
+preview = true
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+  "D100", "D101", "D102", "D103", "D104", "S101", "S106", "ANN001", "ANN002",
+  "ANN003", "ANN201", "ANN202", "ANN204", "ANN205", "PLR6301",
+]
+"docs/conf.py" = ["D100", "D103", "A001", "ANN201", "ANN001"]
+[tool.ruff.format]
+docstring-code-format = true
+preview = true
+
+[tool.mypy]
+python_version = "3.11"
+ignore_missing_imports = true
+disallow_untyped_defs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+warn_unreachable = true

shvcli-0.5.0/shvcli/__init__.py

@@ -0,0 +1,5 @@
+"""Silicon Heaven Command Line Interface."""
+
+from .__version__ import VERSION
+
+__all__ = ["VERSION"]

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

@@ -1,4 +1,5 @@
 """Implementation of command line application."""
+
 import argparse
 import asyncio
 import logging

shvcli-0.5.0/shvcli/__version__.py

@@ -0,0 +1,26 @@
+"""The smarter loader of the version.
+
+It identifies if this package is installed and returns version from egg info or
+it looks for pyproject.toml file in upper directory.
+"""
+
+import importlib.metadata
+import pathlib
+import tomllib
+
+
+def _get_version() -> str:
+    for dist_name in importlib.metadata.packages_distributions().get(__package__, []):
+        dist = importlib.metadata.distribution(dist_name)
+        if str(dist.locate_file(f"{__package__}/__version__.py")) == __file__:
+            return dist.version
+    pyproject = pathlib.Path(__file__).parent.parent / "pyproject.toml"
+    if pyproject.exists():
+        with pyproject.open("rb") as f:
+            res = tomllib.load(f)["project"]["version"]
+            if isinstance(res, str):
+                return res
+    return "unknown"
+
+
+VERSION = _get_version()

{shvcli-0.3.0 → shvcli-0.5.0}/shvcli/builtin.py

@@ -1,4 +1,5 @@
 """Builtin methods glue code so they can be defined separatelly."""
+
 import collections.abc
 import dataclasses
 import typing
@@ -9,7 +10,9 @@ from .client import SHVClient
 from .config import CliConfig
 from .parse import CliItems
 
-_T_METHOD = typing.Callable[[SHVClient, CliConfig, CliItems], typing.Awaitable[None]]
+_T_METHOD = typing.Callable[
+    [SHVClient, CliConfig, CliItems], typing.Awaitable[None] | None
+]
 _T_XMETHOD = typing.Callable[
     [SHVClient, CliConfig, CliItems, int | None], typing.Awaitable[None]
 ]
@@ -114,7 +117,10 @@ async def call_builtin(
         return
 
     if isinstance(m, Method):
-        return await m.func(shvclient, config, items)
+        res = m.func(shvclient, config, items)
+        if isinstance(res, collections.abc.Awaitable):
+            await res
+        return
 
     typing.assert_type(m, XMethod)
     strnum = items.method[len(m.name) + 1 :]

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

@@ -1,10 +1,10 @@
 """Implementations of our builtin methods."""
+
 import collections.abc
 import inspect
 import itertools
 
 from prompt_toolkit.completion import Completion
-from shv import RpcSubscription
 
 from .builtin import METHODS, Argument, XMethod, builtin, xbuiltin
 from .client import Node, SHVClient
@@ -21,11 +21,13 @@ def argument_signal_comp(
 ) -> collections.abc.Iterable[Completion]:
     """Completion for subscribe argument."""
     if ":" in items.param_raw:
-        path, method = items.interpret_param_method(config)
-        assert method is not None
+        path, method, signal = items.interpret_param_ri(config).split(":")
         node = shvclient.tree.get_path(path)
         if node is not None:
-            yield from comp_from(method, node.signals)
+            if items.param_raw.count(":") == 1:
+                yield from comp_from(method, node.methods)
+            elif method in node.methods:
+                yield from comp_from(signal, node.methods[method])
     else:
         yield from comp_path(shvclient, config, items)
 
@@ -52,7 +54,7 @@ argument_set = Argument("[OPTION [VALUE]]", argument_set_comp)
 
 
 @builtin("help", {"h"}, hidden=True)
-async def _help(_: SHVClient, __: CliConfig, ___: CliItems) -> None:
+def _help(_: SHVClient, __: CliConfig, ___: CliItems) -> None:
     """Print help for all builtin methods."""
     print_row("Available internal methods (all prefixed with '!'):")
     for name, m in METHODS.items():
@@ -69,15 +71,13 @@ async 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."""
-    path, method = items.interpret_param_method(config)
-    await shvclient.subscribe(RpcSubscription(path, method or ""))
+    await shvclient.subscribe(items.interpret_param_ri(config))
 
 
 @builtin(aliases={"usub"}, argument=argument_signal)
 async def unsubscribe(shvclient: SHVClient, config: CliConfig, items: CliItems) -> None:
     """Unsubscribe existing subscription."""
-    path, method = items.interpret_param_method(config)
-    await shvclient.unsubscribe(RpcSubscription(path, method or ""))
+    await shvclient.unsubscribe(items.interpret_param_ri(config))
 
 
 @builtin(aliases={"subs", "test"})
@@ -87,7 +87,7 @@ async def subscriptions(shvclient: SHVClient, _: CliConfig, __: CliItems) -> Non
 
 
 @builtin(aliases={"t"}, argument=argument_path)
-async def tree(shvclient: SHVClient, config: CliConfig, items: CliItems) -> None:
+def tree(shvclient: SHVClient, config: CliConfig, items: CliItems) -> None:
     """Print tree of nodes discovered in this session."""
 
     def print_node(node: Node, cols: list[bool]) -> None:
@@ -95,12 +95,10 @@ async def tree(shvclient: SHVClient, config: CliConfig, items: CliItems) -> None
             print_ftext(
                 itertools.chain(
                     (("", "│ " if c else "  ") for c in cols),
-                    iter(
-                        [
-                            ("", "├─" if hasnext else "└─"),
-                            ls_node_format(name, parent_node=node),
-                        ]
-                    ),
+                    iter([
+                        ("", "├─" if hasnext else "└─"),
+                        ls_node_format(name, parent_node=node),
+                    ]),
                 )
             )
             print_node(node[name], [*cols, hasnext])
@@ -127,7 +125,7 @@ async def scan(
 
 
 @builtin("set", aliases={"s"}, argument=argument_set)
-async def _set(_: SHVClient, config: CliConfig, items: CliItems) -> None:
+def _set(_: SHVClient, config: CliConfig, items: CliItems) -> None:
     """Set configuration options in runtime."""
     opt, val = items.interpret_param_set()
     if not opt:

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

@@ -1,4 +1,5 @@
 """Command line interface."""
+
 import asyncio
 import json
 import pathlib
@@ -8,9 +9,9 @@ import xdg.BaseDirectory
 from prompt_toolkit import PromptSession
 from prompt_toolkit.history import FileHistory
 from prompt_toolkit.patch_stdout import patch_stdout
-from shv import RpcError, RpcUrl
+from shv import RpcError, RpcLogin, RpcUrl
 
-from . import builtin_impl as _
+from . import builtin_impl as _  # noqa F401
 from .builtin import call_builtin
 from .client import Node, SHVClient
 from .complet import CliCompleter
@@ -51,7 +52,7 @@ async def _app(config: CliConfig, shvclient: SHVClient) -> None:
                         [prompt_path, ("", "> ")], vi_mode=config.vimode
                     )
             except EOFError:
-                shvclient.client.disconnect()
+                await shvclient.disconnect()
                 return
             await handle_line(shvclient, config, result)
         except KeyboardInterrupt:
@@ -68,7 +69,7 @@ async def run(config: CliConfig) -> None:
             location=config.url.location,
             port=config.url.port,
             protocol=config.url.protocol,
-            username=config.url.username,
+            login=RpcLogin(username=config.url.login.username),
         )
         cpath = xdg.BaseDirectory.save_cache_path("shvcli")
         fname = re.sub(r"[^\w_. -]", "_", cacheurl.to_url())

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

@@ -1,4 +1,5 @@
 """SHV client for shvcli."""
+
 from __future__ import annotations
 
 import collections.abc
@@ -6,7 +7,6 @@ import typing
 from pathlib import PurePosixPath
 
 from shv import (
-    RpcClient,
     RpcError,
     RpcMessage,
     RpcMethodDesc,
@@ -26,12 +26,11 @@ class Node(collections.abc.Mapping[str, "Node"]):
     def __init__(self) -> None:
         """Initialize the node."""
         self.nodes: dict[str, Node] = {}
-        self.methods: set[str] = {"ls", "dir"}
-        self.signals: set[str] = set()
+        self.methods: dict[str, set[str]] = {"ls": {"lsmod"}, "dir": set()}
         self.nodes_probed = False
         self.methods_probed = False
 
-    def __getitem__(self, key: str) -> "Node":
+    def __getitem__(self, key: str) -> Node:
         """Get node from nodes."""
         return self.nodes[key]
 
@@ -43,7 +42,7 @@ class Node(collections.abc.Mapping[str, "Node"]):
         """Get number of child nodes."""
         return len(self.nodes)
 
-    def valid_path(self, path: str | PurePosixPath) -> "Node":
+    def valid_path(self, path: str | PurePosixPath) -> Node:
         """Add valid path relative to this node."""
         if isinstance(path, str):
             path = PurePosixPath(path)
@@ -68,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) -> typing.Union[None, "Node"]:
+    def get_path(self, path: str | PurePosixPath) -> None | Node:
         """Get node on given path."""
         if isinstance(path, str):
             path = PurePosixPath(path)
@@ -79,26 +78,26 @@ class Node(collections.abc.Mapping[str, "Node"]):
             node = node[n]
         return node
 
-    def dump(self) -> typing.Any:
+    def dump(self) -> dict[str, object]:
         """Dump the data to basic types."""
         return {
             "nodes": {n: v.dump() for n, v in self.nodes.items()},
-            "methods": list(self.methods),
-            "signals": list(self.signals),
+            "methods": {n: list(v) for n, v in self.methods.items()},
             "nodes_probed": self.nodes_probed,
             "methods_probed": self.methods_probed,
         }
 
     @classmethod
-    def load(cls, data: typing.Any) -> Node:
+    def load(cls, data: collections.abc.Mapping[str, object]) -> Node:
         """Load node tree from dump."""
         assert isinstance(data, collections.abc.Mapping)
         res = cls()
-        res.nodes = {n: cls.load(v) for n, v in data["nodes"].items()}
-        res.methods = set(data["methods"])
-        res.signals = set(data["signals"])
-        res.nodes_probed = data["nodes_probed"]
-        res.methods_probed = data["methods_probed"]
+        if isinstance(data["nodes"], collections.abc.Mapping):
+            res.nodes = {n: cls.load(v) for n, v in data["nodes"].items()}
+        if isinstance(data["methods"], collections.abc.Mapping):
+            res.methods = {str(n): set(v) for n, v in data["methods"].items()}
+        res.nodes_probed = bool(data["nodes_probed"])
+        res.methods_probed = bool(data["methods_probed"])
         return res
 
 
@@ -108,11 +107,11 @@ class SHVClient(SimpleClient):
     APP_NAME = "shvcli"
     APP_VERSION = VERSION
 
-    def __init__(self, client: RpcClient) -> None:
+    def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None:  # noqa ANN401
         """Initialize client and set create reference to tree."""
         self.tree = Node()
         self.tree.valid_path(".app")
-        super().__init__(client)
+        super().__init__(*args, **kwargs)
 
     async def _loop(self) -> None:
         await super()._loop()
@@ -121,10 +120,10 @@ class SHVClient(SimpleClient):
     async def _message(self, msg: RpcMessage) -> None:
         await super()._message(msg)
         if msg.is_signal:
-            method = msg.method
-            assert method is not None
-            self.tree.valid_path(msg.path or "").signals.add(method)
-            print(f"{msg.path}:{method}: {Cpon.pack(msg.param)}")
+            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)}")
 
     async def ls(self, path: str) -> list[str]:
         """List same as in ValueClient but with result being preserved in tree."""
@@ -150,25 +149,34 @@ class SHVClient(SimpleClient):
             self.tree.invalid_path(path)
             raise exc
         node = self.tree.valid_path(path)
-        node.methods = {d.name for d in res if RpcMethodFlags.SIGNAL not in d.flags}
-        node.signals = {d.name for d in res if RpcMethodFlags.SIGNAL in d.flags}
+        node.methods = {
+            d.name: set(d.signals)
+            for d in res
+            if RpcMethodFlags.NOT_CALLABLE not in d.flags
+        }
         node.methods_probed = True
         return res
 
-    async def call(self, path: str, method: str, param: SHVType = None) -> SHVType:
+    async def call(
+        self,
+        path: str,
+        method: str,
+        *args: typing.Any,  # noqa ANN401
+        **kwargs: typing.Any,  # noqa ANN401
+    ) -> SHVType:
         """Perform call same as ValueClient.
 
         This uses every call to get insite into existence of method and node and records
         that in the tree.
         """
         try:
-            res = await super().call(path, method, param)
+            res = await super().call(path, method, *args, **kwargs)
         except RpcMethodNotFoundError as exc:
             raise exc
         except RpcError as exc:
-            self.tree.valid_path(path).methods.add(method)
+            self.tree.valid_path(path).methods.setdefault(method, set())
             raise exc
-        self.tree.valid_path(path).methods.add(method)
+        self.tree.valid_path(path).methods.setdefault(method, set())
         return res
 
     async def probe(self, path: str) -> Node | None:
@@ -190,7 +198,7 @@ class SHVClient(SimpleClient):
     async def path_is_valid(self, path: str) -> bool:
         """Check if given path is valid by using ls command."""
         path = path.strip("/")
-        if path == "":
+        if not path:
             return True  # top level is always valid
         if "/" in path:
             pth, name = path.rsplit("/", maxsplit=1)

{shvcli-0.3.0 → shvcli-0.5.0}/shvcli/complet.py

@@ -1,4 +1,5 @@
 """Completion for CLI."""
+
 import collections.abc
 import typing
 
@@ -28,7 +29,7 @@ class CliCompleter(Completer):
 
         # Parameters
         if CliFlags.COMPLETE_CALL in items.flags:
-            if items.method in ("ls", "dir") and not self.config.raw:
+            if items.method in {"ls", "dir"} and not self.config.raw:
                 yield from comp_path(self.shvclient, self.config, items)
             elif bmethod := builtin.get_builtin(items.method[1:]):
                 if bmethod.argument:
@@ -58,9 +59,10 @@ class CliCompleter(Completer):
         items = parse_line(document.text)
         if self.config.autoprobe and (
             CliFlags.COMPLETE_CALL not in items.flags
-            or items.method in ("ls", "dir")
+            or items.method in {"ls", "dir"}
             or (
-                items.method[0] == "!"
+                items.method
+                and items.method[0] == "!"
                 and (bmethod := builtin.get_builtin(items.method[1:])) is not None
                 and bmethod.argument
                 and bmethod.argument.autoprobe

{shvcli-0.3.0 → shvcli-0.5.0}/shvcli/complet_tools.py

@@ -1,4 +1,5 @@
 """Tool for completion algorithms."""
+
 import collections.abc
 import pathlib
 

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

@@ -1,4 +1,5 @@
 """Configuration state of the CLI."""
+
 import collections.abc
 import configparser
 import enum
@@ -100,7 +101,7 @@ class CliConfig:
                 self.__rurl = self.__url
             elif isinstance(self.__url, str):
                 self.__rurl = RpcUrl.parse(
-                    subprocess.run(
+                    subprocess.run(  # noqa S602
                         f"printf '%s' \"{self.__url}\"",
                         shell=True,
                         stdout=subprocess.PIPE,
@@ -128,7 +129,7 @@ class CliConfig:
         return logging.root.level <= logging.DEBUG
 
     @debug.setter
-    def debug(self, value: bool) -> None:
+    def debug(self, value: bool) -> None:  # noqa PLR6301
         logging.root.setLevel(logging.DEBUG if value else logging.WARNING)
 
     def shvpath(

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

@@ -1,4 +1,5 @@
 """Special handling of ls and dir methods."""
+
 import itertools
 import pathlib
 import string
@@ -32,14 +33,17 @@ def ls_node_format(
 def dir_method_format(method: RpcMethodDesc) -> tuple[str, str]:
     """Print format for single method info."""
     methstyle = ""
-    if RpcMethodFlags.SIGNAL in method.flags:
-        methstyle = "ansipurple"
+    if method.name in {"ls", "dir"}:
+        methstyle = "ansibrightblack"
     elif RpcMethodFlags.SETTER in method.flags:
         methstyle = "ansiyellow"
     elif RpcMethodFlags.GETTER in method.flags:
-        methstyle = "ansigreen"
-    elif method.name in ("ls", "dir"):
-        methstyle = "ansibrightblack"
+        if method.signals:
+            methstyle = "ansimagenta"
+        else:
+            methstyle = "ansigreen"
+    elif method.signals or RpcMethodFlags.NOT_CALLABLE in method.flags:
+        methstyle = "ansipurple"
     name = method.name
     return (
         methstyle,
@@ -74,7 +78,7 @@ async def ls_method(shvclient: SHVClient, config: CliConfig, items: CliItems) ->
                     else:
                         print_row(
                             itertools.chain(
-                                iter(n + [("", "  ")]), cpon_ftext(Cpon.pack(resp))
+                                iter([*n, ("", "  ")]), cpon_ftext(Cpon.pack(resp))
                             )
                         )
                         continue
@@ -99,7 +103,7 @@ async def dir_method(shvclient: SHVClient, config: CliConfig, items: CliItems) -
                 else:
                     print_row(
                         itertools.chain(
-                            iter(n + [("", "  ")]), cpon_ftext(Cpon.pack(resp))
+                            iter([*n, ("", "  ")]), cpon_ftext(Cpon.pack(resp))
                         )
                     )
                     continue

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

@@ -1,4 +1,5 @@
 """Implementation of CLI parser."""
+
 import dataclasses
 import enum
 
@@ -28,7 +29,7 @@ class CliItems:
     param_raw: str = ""
     """Raw parameter passed from CLI."""
 
-    flags: CliFlags = CliFlags(0)
+    flags: CliFlags = dataclasses.field(default_factory=lambda: CliFlags(0))
     """Flags signaling the presence of some important dividers."""
 
     @property
@@ -38,16 +39,6 @@ class CliItems:
             return None
         return Cpon.unpack(self.param_raw)
 
-    @property
-    def param_method(self) -> tuple[str, str | None]:
-        """Interpret parameter as path and method."""
-        if ":" in self.param_raw:
-            path, method = self.param_raw.split(":", maxsplit=1)
-            return path, method
-        if "/" in self.param_raw:
-            return self.param_raw, None
-        return "", self.param_raw
-
     def interpret_param_path(self, config: CliConfig) -> str:
         """Interpret parameter as path specification.
 
@@ -55,16 +46,18 @@ class CliItems:
         """
         return config.shvpath([self.path, self.param_raw])
 
-    def interpret_param_method(self, config: CliConfig) -> tuple[str, str | None]:
-        """Interpret parameter as method specification.
+    def interpret_param_ri(self, config: CliConfig, expand: bool = True) -> str:
+        """Interpret parameter as RI.
 
-        Compared to :meth:`param_method` this provides a full combination of
-        path and method not just parsed :prop:`param_raw`.
+        The path in RI is combined with pat in the configuration.
 
-        :return: pair of SHV path and method name that is from parameter.
+        :return: SHV RPC RI.
         """
-        param_path, method = self.param_method
-        return config.shvpath([self.path, param_path]), method
+        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}"
 
     def interpret_param_set(self) -> tuple[str | None, str | None]:
         """Interpret parameter as 'set' method specification.
@@ -84,9 +77,8 @@ def parse_line(line: str) -> CliItems:
     if ":" in line:
         res.flags |= CliFlags.HAS_COLON
         res.path, res.method = line.split(":", maxsplit=1)
+    elif "/" in line:
+        res.path = line
     else:
-        if "/" in line:
-            res.path = line
-        else:
-            res.method = line
+        res.method = line
     return res

{shvcli-0.3.0 → shvcli-0.5.0}/shvcli/scan.py

@@ -3,6 +3,7 @@
 Implementated sepratelly so we can use it not only from builtin methods but also
 directly when configured.
 """
+
 from prompt_toolkit.shortcuts import ProgressBar, ProgressBarCounter
 
 from .client import SHVClient

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

@@ -1,4 +1,5 @@
 """Various tools used in the code."""
+
 import collections.abc
 import os
 import textwrap
@@ -39,7 +40,7 @@ def intersperse(what: T, iterin: typing.Iterable[T]) -> typing.Iterator[T]:
 
 def print_ftext(
     fstrs: collections.abc.Iterable[tuple[str, str]]
-    | collections.abc.Iterator[tuple[str, str]]
+    | collections.abc.Iterator[tuple[str, str]],
 ) -> None:
     """Call :meth:`print_formatted_text` with :class:`FormattedText`."""
     print_formatted_text(FormattedText(fstrs))
@@ -47,7 +48,7 @@ def print_ftext(
 
 def print_flist(
     fstrs: collections.abc.Iterable[tuple[str, str]]
-    | collections.abc.Iterator[tuple[str, str]]
+    | collections.abc.Iterator[tuple[str, str]],
 ) -> None:
     """Print with :meth:`print_ftext` but interperse spaces."""
     cols = os.get_terminal_size().columns
@@ -70,7 +71,7 @@ def print_row(
     ftext: collections.abc.Iterable[tuple[str, str]]
     | collections.abc.Iterator[tuple[str, str]]
     | tuple[str, str]
-    | str
+    | str,
 ) -> None:
     """Print one line with hyphens when needed."""
     if isinstance(ftext, str):

{shvcli-0.3.0 → shvcli-0.5.0}/shvcli/valid.py

@@ -1,4 +1,5 @@
 """Validator for CLI."""
+
 from prompt_toolkit.document import Document
 from prompt_toolkit.validation import ValidationError, Validator
 
@@ -22,7 +23,7 @@ class CliValidator(Validator):
 
         # Parameters
         if CliFlags.COMPLETE_CALL in items.flags:
-            if items.method in ("ls", "dir") and not self.config.raw:
+            if items.method in {"ls", "dir"} and not self.config.raw:
                 return
             if builtin.get_builtin(items.method[1:]):
                 # TODO we can add validation to the builtins as well
@@ -30,7 +31,7 @@ class CliValidator(Validator):
             # Any other command should have CPON as argument and thus validate
             # it as such.
             try:
-                items.param
+                _ = items.param
             except (ValueError, EOFError) as exc:
                 raise ValidationError(message=f"Invalid CPON: {exc}") from exc
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shvcli
-Version: 0.3.0
+Version: 0.5.0
 Summary: Silicon Heaven CLI access application
 Author: Elektroline a.s.
 License: MIT License
@@ -25,7 +25,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
         
-Project-URL: repository, https://gitlab.com/elektroline-predator/shvcli
+Project-URL: repository, https://gitlab.com/silicon-heaven/shvcli
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
@@ -38,27 +38,22 @@ Classifier: Topic :: Terminals
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pyshv>=0.5.0
+Requires-Dist: pyshv>=0.7.0
 Requires-Dist: prompt_toolkit
+Requires-Dist: pygments
 Requires-Dist: pyxdg
-Provides-Extra: lint
-Requires-Dist: black; extra == "lint"
-Requires-Dist: isort; extra == "lint"
-Requires-Dist: mypy; extra == "lint"
-Requires-Dist: pydocstyle; extra == "lint"
-Requires-Dist: pylint; extra == "lint"
 
 =====================================
 Silicon Heaven CLI access application
 =====================================
-.. image:: https://gitlab.com/elektroline-predator/shvcli/-/raw/master/logo.svg
+.. image:: https://gitlab.com/silicon-heaven/shvcli/-/raw/master/logo.svg
    :align: right
    :height: 128px
 
 This provides an easy to use CLI interfase to access the SHV network.
 
-* `📃 Sources <https://gitlab.com/elektroline-predator/shvcli>`__
-* `⁉️ Issue tracker <https://gitlab.com/elektroline-predator/shvcli/-/issues>`__
+* `📃 Sources <https://gitlab.com/silicon-heaven/shvcli>`__
+* `⁉️ Issue tracker <https://gitlab.com/silicon-heaven/shvcli/-/issues>`__
 * `📕 Silicon Heaven protocol documentation <https://silicon-heaven.github.io/shv-doc/>`__
 
 

{shvcli-0.3.0 → shvcli-0.5.0}/shvcli.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.rst
 pyproject.toml
 shvcli/__init__.py
 shvcli/__main__.py
+shvcli/__version__.py
 shvcli/builtin.py
 shvcli/builtin_impl.py
 shvcli/cli.py

shvcli-0.5.0/shvcli.egg-info/requires.txt

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

{shvcli-0.3.0 → shvcli-0.5.0}/shvcli.egg-info/top_level.txt

@@ -1 +1,2 @@
+dist
 shvcli

shvcli-0.3.0/pyproject.toml

@@ -1,89 +0,0 @@
-[project]
-name = "shvcli"
-description = "Silicon Heaven CLI access application"
-readme = "README.rst"
-license = {file = "LICENSE"}
-dynamic = ["version"]
-authors = [
-  { name="Elektroline a.s." },
-]
-classifiers = [
-  "Development Status :: 4 - Beta",
-  "License :: OSI Approved :: MIT License",
-  "Programming Language :: Python :: 3",
-  "Operating System :: OS Independent",
-  "Environment :: Console",
-  "Intended Audience :: End Users/Desktop",
-  "Topic :: Home Automation",
-  "Topic :: System :: Shells",
-  "Topic :: Terminals",
-]
-requires-python = ">=3.11"
-dependencies = [
-  "pyshv >= 0.5.0",
-  "prompt_toolkit",
-  "pyxdg",
-]
-
-[project.urls]
-repository = "https://gitlab.com/elektroline-predator/shvcli"
-
-[project.optional-dependencies]
-lint = [
-  "black",
-  "isort",
-  "mypy",
-  "pydocstyle",
-  "pylint",
-]
-
-[project.scripts]
-shvcli = "shvcli.__main__:main"
-
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools.dynamic]
-version = {file = "shvcli/version"}
-[tool.setuptools.package-data]
-"*" = ["version", "py.typed"]
-
-[tool.coverage.run]
-branch = true
-[tool.coverage.report]
-exclude_lines = [
-    "pragma: no cover",
-    "if typing.TYPE_CHECKING:"
-]
-
-[tool.isort]
-profile = 'black'
-
-[tool.pylint.main]
-recursive = "y"
-fail-under = 9.5
-[tool.pylint.format]
-disable = [
-  # Exception can be safely caught because there is BaseException for unsafe
-  # ones (such as SystemExit) and there are reasons to catch all exceptions.
-  "W0718",
-  # Prevent usage of module name in documentation (seems unreasonable)
-  "C0104",
-  # We have pydocstyle for the following ones
-  "C0103", "C0114", "C0115", "C0116",
-]
-# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html
-max-line-length = 88
-
-[tool.mypy]
-python_version = "3.11"
-ignore_missing_imports = true
-disallow_untyped_defs = true
-warn_redundant_casts = true
-warn_unused_ignores = true
-warn_return_any = true
-warn_unreachable = true
-
-[tool.pydocstyle]
-convention = "pep257"

shvcli-0.3.0/shvcli/__init__.py

@@ -1,5 +0,0 @@
-"""Silicon Heaven Command Line Interface."""
-
-VERSION = (
-    (__import__("pathlib").Path(__file__).parent / "version").read_text("utf-8").strip()
-)

shvcli-0.3.0/shvcli.egg-info/requires.txt

@@ -1,10 +0,0 @@
-pyshv>=0.5.0
-prompt_toolkit
-pyxdg
-
-[lint]
-black
-isort
-mypy
-pydocstyle
-pylint