shvcli 0.2.1__tar.gz → 0.4.0__tar.gz

{shvcli-0.2.1/shvcli.egg-info → shvcli-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shvcli
-Version: 0.2.1
+Version: 0.4.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.6.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/>`__
 
 
@@ -123,6 +118,8 @@ switched in runtime. The following options are available:
 
 * **vimode**: If Vi input mode should be used for command line input. The
   default is ``false``.
+* **autoget**: Automatically call getter methods and print received values when
+  listing nodes and methods (``ls`` and ``dir`` methods special handling).
 * **autoprobe**: Completion process benefits from probing of the SHV nodes with
   ``ls`` and ``dir``, and to provide easier usage this can happen automatically
   in background. This is what this option controls. It is ``true`` by default

{shvcli-0.2.1 → shvcli-0.4.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/>`__
 
 
@@ -73,6 +73,8 @@ switched in runtime. The following options are available:
 
 * **vimode**: If Vi input mode should be used for command line input. The
   default is ``false``.
+* **autoget**: Automatically call getter methods and print received values when
+  listing nodes and methods (``ls`` and ``dir`` methods special handling).
 * **autoprobe**: Completion process benefits from probing of the SHV nodes with
   ``ls`` and ``dir``, and to provide easier usage this can happen automatically
   in background. This is what this option controls. It is ``true`` by default

shvcli-0.4.0/pyproject.toml

@@ -0,0 +1,101 @@
+[project]
+name = "shvcli"
+version = "0.4.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.6.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", "TRIO", "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.4.0/shvcli/__init__.py

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

{shvcli-0.2.1 → shvcli-0.4.0}/shvcli/__main__.py

@@ -1,4 +1,5 @@
 """Implementation of command line application."""
+
 import argparse
 import asyncio
 import logging
@@ -18,11 +19,22 @@ def parse_args() -> argparse.Namespace:
         action="store_true",
         help="Enable logging that provides communication debug info.",
     )
+    parser.add_argument(
+        "-s",
+        "--scan",
+        action="store_true",
+        help="Perform scan as a first action right after connect.",
+    )
+    parser.add_argument(
+        "--scan-depth",
+        type=int,
+        default=3,
+        help="Depth of the scan performed if --scan is used.",
+    )
     parser.add_argument(
         "URL",
         nargs="?",
-        default="tcp://test@localhost?password=test",
-        help="SHV RPC URL specifying connection to the broker.",
+        help="SHV RPC URL specifying connection to the broker or host from configuration.",
     )
     return parser.parse_args()
 
@@ -32,8 +44,11 @@ def main() -> None:
     logging.basicConfig(format="[%(asctime)s] [%(levelname)s] - %(message)s")
     args = parse_args()
     config = CliConfig()
-    config.url = args.URL
+    if args.URL is not None:
+        config.url = args.URL
     config.debug = config.debug or args.debug
+    config.initial_scan = args.scan
+    config.initial_scan_depth = args.scan_depth
     asyncio.run(run(config))
 
 

shvcli-0.4.0/shvcli/__version__.py

@@ -0,0 +1,25 @@
+"""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"
+    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.2.1 → shvcli-0.4.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

{shvcli-0.2.1 → shvcli-0.4.0}/shvcli/builtin_impl.py

@@ -1,9 +1,10 @@
 """Implementations of our builtin methods."""
+
 import collections.abc
+import inspect
 import itertools
 
 from prompt_toolkit.completion import Completion
-from prompt_toolkit.shortcuts import ProgressBar, ProgressBarCounter
 from shv import RpcSubscription
 
 from .builtin import METHODS, Argument, XMethod, builtin, xbuiltin
@@ -12,6 +13,7 @@ from .complet_tools import comp_from, comp_path
 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
 
 
@@ -35,11 +37,14 @@ def argument_set_comp(
     """Completion for !set method."""
     opt, val = items.interpret_param_set()
     if val is not None:
-        if opt in config.opts_bool:
+        if config.OPTS.get(opt or "") is config.Type.BOOL:
             yield from comp_from(val, {"true", "false"})
     else:
-        yield from comp_from(items.param_raw, config.opts_bool)
-        yield from comp_from(items.param_raw, (f"no{v}" for v in config.opts_bool))
+        yield from comp_from(items.param_raw, config.OPTS.keys())
+        yield from comp_from(
+            items.param_raw,
+            (f"no{v}" for v, t in config.OPTS.items() if t is config.Type.BOOL),
+        )
 
 
 argument_signal = Argument("[PATH:SIGNAL]", argument_signal_comp, autoprobe=True)
@@ -58,8 +63,8 @@ async def _help(_: SHVClient, __: CliConfig, ___: CliItems) -> None:
             call = f"{name}[X]"
         else:
             call = name + "".join(f"|{n}" for n in m.aliases)
-        print_row(call + (f" {m.argument.description}" if m.argument else ""), 2)
-        print_block(m.description, 4)
+        print_row(f"{call} {m.argument.description if m.argument else ''}")
+        print_block(inspect.cleandoc(m.description), 4)
 
 
 @builtin(aliases={"sub"}, argument=argument_signal)
@@ -91,7 +96,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(node, name)]),
+                    iter([
+                        ("", "├─" if hasnext else "└─"),
+                        ls_node_format(name, parent_node=node),
+                    ]),
                 )
             )
             print_node(node[name], [*cols, hasnext])
@@ -114,22 +122,7 @@ async def scan(
 
     Scan uses 'ls' and 'dir' to fetch info about all nodes.
     """
-    depth = depth or 3
-    path = items.interpret_param_path(config)
-    depth += path.count("/")  # Extend depth to the depth in path
-    pths = [path]
-    with ProgressBar() as pb:
-        pbcnt: ProgressBarCounter = pb()
-        pbcnt.total = 1
-        while pths:
-            pth = pths.pop()
-            pbcnt.label = pth
-            node = await shvclient.probe(pth)
-            if node is not None and (pth.count("/") + 1 if pth else 0) < depth:
-                assert node.nodes is not None
-                pths.extend(f"{pth}{'/' if pth else ''}{name}" for name in node.nodes)
-                pbcnt.total += len(node.nodes)
-            pbcnt.item_completed()
+    await scan_nodes(shvclient, items.interpret_param_path(config), depth or 3)
 
 
 @builtin("set", aliases={"s"}, argument=argument_set)
@@ -137,17 +130,29 @@ async def _set(_: SHVClient, config: CliConfig, items: CliItems) -> None:
     """Set configuration options in runtime."""
     opt, val = items.interpret_param_set()
     if not opt:
-        for n in config.opts_bool:
-            print(f"{n}: {str(getattr(config, n)).lower()}")
+        w = max(len(n) for n in config.OPTS.keys())
+        for n, t in config.OPTS.items():
+            row = [("", (" " * (w - len(n))) + n + "  ")]
+            match t:
+                case config.Type.BOOL:
+                    v = getattr(config, n)
+                    assert isinstance(v, bool)
+                    row.append(("ansigreen" if v else "ansired", str(v).lower()))
+                case config.Type.INT:
+                    row.append(("", str(getattr(config, n))))
+                case _:
+                    raise NotImplementedError(f"Unimplemented {t!r}")
+            print_row(row)
         return
-    no = opt.startswith("no")
-    if no:
+
+    # 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_bool:
+    if opt not in config.OPTS.keys():
         print(f"Invalid option: {opt}")
         return
     if val is None:
-        value = not getattr(config, opt)
+        value = not no
     else:
         m = {"true": True, "t": True, "false": False, "f": False}
         if val not in m:

{shvcli-0.2.1 → shvcli-0.4.0}/shvcli/cli.py

@@ -1,4 +1,5 @@
 """Command line interface."""
+
 import asyncio
 import json
 import pathlib
@@ -8,16 +9,16 @@ 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.cpon import Cpon
+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
 from .config import CliConfig
 from .lsdir import dir_method, ls_method
 from .parse import parse_line
+from .scan import scan_nodes
 from .tools import print_cpon
 from .valid import CliValidator
 
@@ -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())
@@ -76,6 +77,8 @@ async def run(config: CliConfig) -> None:
         if cachepath.exists():
             with cachepath.open("r") as f:
                 shvclient.tree = Node.load(json.load(f))
+    if config.initial_scan:
+        await scan_nodes(shvclient, "", config.initial_scan_depth)
 
     clitask = asyncio.create_task(_app(config, shvclient))
     await shvclient.client.wait_disconnect()

{shvcli-0.2.1 → shvcli-0.4.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,
@@ -20,7 +20,7 @@ from shv.cpon import Cpon
 from . import VERSION
 
 
-class Node(collections.abc.Mapping):
+class Node(collections.abc.Mapping[str, "Node"]):
     """Abstraction on the tree node."""
 
     def __init__(self) -> None:
@@ -31,7 +31,7 @@ class Node(collections.abc.Mapping):
         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 +43,7 @@ class Node(collections.abc.Mapping):
         """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 +68,7 @@ class Node(collections.abc.Mapping):
         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,7 +79,7 @@ class Node(collections.abc.Mapping):
             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()},
@@ -90,15 +90,18 @@ class Node(collections.abc.Mapping):
         }
 
     @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.Sequence):
+            res.methods = set(data["methods"])
+        if isinstance(data["signals"], collections.abc.Sequence):
+            res.signals = set(data["signals"])
+        res.nodes_probed = bool(data["nodes_probed"])
+        res.methods_probed = bool(data["methods_probed"])
         return res
 
 
@@ -108,11 +111,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()
@@ -150,19 +153,27 @@ 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 for d in res if RpcMethodFlags.NOT_CALLABLE not in d.flags
+        }
+        node.signals = {d.name for d in res if RpcMethodFlags.NOT_CALLABLE 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:
@@ -190,7 +201,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.2.1 → shvcli-0.4.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,7 +59,7 @@ 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] == "!"
                 and (bmethod := builtin.get_builtin(items.method[1:])) is not None

{shvcli-0.2.1 → shvcli-0.4.0}/shvcli/complet_tools.py

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