shvcli 0.7.0__tar.gz → 0.8.0__tar.gz

{shvcli-0.7.0/shvcli.egg-info → shvcli-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shvcli
-Version: 0.7.0
+Version: 0.8.0
 Summary: Silicon Heaven CLI access application
 Author: Elektroline a.s.
 License: MIT License
@@ -27,7 +27,6 @@ License: MIT License
         
 Project-URL: repository, https://gitlab.com/silicon-heaven/shvcli
 Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Classifier: Environment :: Console
 Classifier: Intended Audience :: End Users/Desktop
@@ -37,7 +36,7 @@ Classifier: Topic :: Terminals
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pyshv>=0.9.0
+Requires-Dist: pyshv>=0.10.0
 Requires-Dist: prompt_toolkit
 Requires-Dist: pygments
 Requires-Dist: pyxdg
@@ -151,6 +150,8 @@ following options are available without any plugins:
   is used only in case when method doesn't support delayed responses.
 * **autoget_timeout**: Timeout in seconds for call that is part of autoget
   functionality.
+* **history_count**: Integer number used for number of records requested at time
+  for ``!history`` builtin.
 
 Example configuration file:
 
@@ -213,6 +214,10 @@ parameter must be path to the local file where data will be stored.
 **verify**: provides a way to verify RPC File node against local file. The
 parameter must be path to the local file used for the verification.
 
+**history**: is helper to list recorded history of signals by ``.history`` API.
+The listing is incremental in ``history_count`` configured number of records and
+in the order from the newest ones.
+
 
 Special methods ``ls`` and ``dir``
 ----------------------------------
@@ -225,6 +230,17 @@ Their parameter is also handled in a special way. It is considered to be
 additional path suffix unless it is a valid CPON. This is allowed to match the
 common shells.
 
+You can see ``raw`` option to disable this behavior.
+
+
+OAuth2 login
+------------
+
+SHVCLI supports non-standard login method OAuth2. This is not defined by SHV
+standard. The non-standard URL query ``oauth2=y`` is accepted to perform the
+OAuth2 login. The login is facilitated by web browser. SHVCLI will start server
+on ``tcp://localhost:37719/`` to be able to receive token.
+
 
 Plugins
 -------

{shvcli-0.7.0 → shvcli-0.8.0}/README.rst

@@ -105,6 +105,8 @@ following options are available without any plugins:
   is used only in case when method doesn't support delayed responses.
 * **autoget_timeout**: Timeout in seconds for call that is part of autoget
   functionality.
+* **history_count**: Integer number used for number of records requested at time
+  for ``!history`` builtin.
 
 Example configuration file:
 
@@ -167,6 +169,10 @@ parameter must be path to the local file where data will be stored.
 **verify**: provides a way to verify RPC File node against local file. The
 parameter must be path to the local file used for the verification.
 
+**history**: is helper to list recorded history of signals by ``.history`` API.
+The listing is incremental in ``history_count`` configured number of records and
+in the order from the newest ones.
+
 
 Special methods ``ls`` and ``dir``
 ----------------------------------
@@ -179,6 +185,17 @@ Their parameter is also handled in a special way. It is considered to be
 additional path suffix unless it is a valid CPON. This is allowed to match the
 common shells.
 
+You can see ``raw`` option to disable this behavior.
+
+
+OAuth2 login
+------------
+
+SHVCLI supports non-standard login method OAuth2. This is not defined by SHV
+standard. The non-standard URL query ``oauth2=y`` is accepted to perform the
+OAuth2 login. The login is facilitated by web browser. SHVCLI will start server
+on ``tcp://localhost:37719/`` to be able to receive token.
+
 
 Plugins
 -------

{shvcli-0.7.0 → shvcli-0.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shvcli"
-version = "0.7.0"
+version = "0.8.0"
 description = "Silicon Heaven CLI access application"
 readme = "README.rst"
 license = {file = "LICENSE"}
@@ -9,7 +9,6 @@ authors = [
 ]
 classifiers = [
   "Development Status :: 4 - Beta",
-  "Programming Language :: Python :: 3",
   "Operating System :: OS Independent",
   "Environment :: Console",
   "Intended Audience :: End Users/Desktop",
@@ -19,7 +18,7 @@ classifiers = [
 ]
 requires-python = ">=3.11"
 dependencies = [
-  "pyshv >= 0.9.0",
+  "pyshv >= 0.10.0",
   "prompt_toolkit",
   "pygments",
   "pyxdg",
@@ -39,6 +38,8 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools.packages.find]
 [tool.setuptools.package-data]
 "*" = ["py.typed"]
+[tool.setuptools.cmdclass]
+build_py = "shvcli.__setuptools__.BuildPy"
 
 [tool.coverage.run]
 branch = true

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/__main__.py

@@ -5,7 +5,6 @@ import asyncio
 from .afterconn import Afterconn
 from .args import args_apply, args_parse
 from .cli import run
-from .client import Client
 from .config import load_config
 from .plugins import load_plugins
 from .state import State
@@ -22,7 +21,7 @@ def main() -> None:
     state.cache_load(Url(state).cache_path())
 
     async def async_main() -> None:
-        client = await Client.connect(Url(state).url, state=state)
+        client = await Url(state).connect()
         await Afterconn(state).run(client)
         await run(client)
         if client.client.connected:

shvcli-0.8.0/shvcli/__setuptools__.py

@@ -0,0 +1,18 @@
+"""Setuptools hook used to replace __version__.py file."""
+
+import pathlib
+
+from setuptools.command.build_py import build_py as _build_py
+
+
+class BuildPy(_build_py):
+    """Custom package build step."""
+
+    def run(self) -> None:  # noqa: D102
+        package = pathlib.Path(__file__).parent.name
+        buildlib = pathlib.Path(self.build_lib) / package
+        buildlib.mkdir(parents=True, exist_ok=True)
+        version = self.distribution.metadata.version
+        (buildlib / "__version__.py").write_text(f'VERSION = "{version}"\n')
+        super().run()
+        (buildlib / "__setuptools__.py").unlink()

shvcli-0.8.0/shvcli/__version__.py

@@ -0,0 +1,24 @@
+"""The loader of the version for source file only installation.
+
+It looks for pyproject.toml file in upper directory and loads version from
+there.
+
+This file is overwritten during distribution build to contain only constant
+VERSION. Please see __setuptools__.py for details.
+"""
+
+import pathlib
+import tomllib
+
+
+def _get_version() -> str:
+    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.7.0 → shvcli-0.8.0}/shvcli/builtins/__init__.py

@@ -8,6 +8,7 @@ from .broker import BuiltinSubscribe, BuiltinSubscriptions, BuiltinUnsubscribe
 from .cd import BuiltinCD
 from .file import BuiltinDownload, BuiltinUpload, BuiltinVerify
 from .help import BuiltinHelp
+from .history import BuiltinHistory
 from .scan import BuiltinScan
 from .set import BuiltinSet
 from .tree import BuiltinTree
@@ -16,6 +17,7 @@ __all__ = [
     "BuiltinCD",
     "BuiltinDownload",
     "BuiltinHelp",
+    "BuiltinHistory",
     "BuiltinScan",
     "BuiltinSet",
     "BuiltinSubscribe",

shvcli-0.8.0/shvcli/builtins/history.py

@@ -0,0 +1,146 @@
+"""The getLog builtin."""
+
+from __future__ import annotations
+
+import collections.abc
+import contextlib
+import datetime
+import itertools
+
+import shv
+import shv.path
+import shv.rpcdef
+from prompt_toolkit import Application
+from prompt_toolkit.key_binding import KeyBindings
+from prompt_toolkit.key_binding.key_processor import KeyPressEvent
+from prompt_toolkit.layout import FormattedTextControl, Layout, Window
+from prompt_toolkit.patch_stdout import patch_stdout
+
+from ..builtin import Builtin, Builtins
+from ..client import Client
+from ..cliitems import CliItems
+from ..option import IntOption
+from ..state import State
+from ..tools.print import print_cpon, print_ftext
+
+_kb = KeyBindings()
+
+
+@_kb.add("<any>")
+def _(event: KeyPressEvent) -> None:
+    event.app.exit(result=event.key_sequence[0].key in {"c-m", "y"})
+
+
+class BuiltinHistory(Builtin):
+    """The implementation of ``history`` builtin that fetches logs."""
+
+    def __init__(self, builtins: Builtins, state: State) -> None:
+        super().__init__(builtins, state)
+        builtins["history"] = self
+
+    @property
+    def description(self) -> tuple[str, str]:  # noqa: D102
+        return "[SINCE]", "Get the node's history."
+
+    @staticmethod
+    async def _locate_getlog(
+        path: shv.path.SHVPath, client: Client
+    ) -> shv.path.SHVPath | None:
+        for pth in itertools.chain(reversed(path.parents), iter((path,))):
+            hpth = pth / ".history" / (path.relative_to(pth))
+            with contextlib.suppress(shv.rpcdef.RpcMethodNotFoundError):
+                if await client.dir_exists(hpth, "getLog"):
+                    return hpth
+        return None
+
+    async def run(self, items: CliItems, client: Client) -> None:  # noqa: D102
+        if items.param:
+            since = datetime.datetime.fromisoformat(items.param)
+            since = since.replace(tzinfo=datetime.UTC)
+        else:
+            since = datetime.datetime.now()
+        until = datetime.datetime.fromtimestamp(0)
+        count = HistoryCount(self.state)
+
+        # First we need to locate the appropriate .history
+        history_path = await self._locate_getlog(items.path, client)
+        if history_path is None:
+            print(f"There are no logs for path: {items.path}")
+            return
+
+        app: Application[bool] = Application(
+            Layout(Window(FormattedTextControl("Fetch more logs? (Y/n)"))),
+            key_bindings=_kb,
+        )
+
+        cont = True
+        while cont:
+            logs = await client.call(
+                history_path, "getLog", {1: since, 2: until, 3: int(count)}
+            )
+            if not shv.is_shvlist(logs) or not logs:
+                break  # No more logs
+
+            refmap: dict[int, str] = {}
+            for i, log in enumerate(logs):
+                if shv.is_shvimap(log):
+                    timestamp = log.get(1, None)
+                    loc = None
+                    if isinstance(ref := log.get(2), int):
+                        loc = refmap.pop(i - ref - 1, None)
+                        if loc is not None:
+                            refmap[i] = loc
+                    else:
+                        spath = log.get(3, "")
+                        method = log.get(5, "get")
+                        signal = log.get(4, "chng")
+                        if all(isinstance(s, str) for s in (spath, method, signal)):
+                            loc = f"{spath}:{method}:{signal}"
+                            refmap[i] = loc
+                    if isinstance(timestamp, datetime.datetime) and loc is not None:
+                        print_ftext(
+                            (
+                                (
+                                    "ansibrightblack",
+                                    timestamp.replace(tzinfo=None).isoformat(
+                                        timespec="milliseconds"
+                                    )
+                                    + "Z",
+                                ),
+                                ("", " "),
+                                ("ansiblue", loc),
+                            ),
+                            end="  ",
+                        )
+                        print_cpon(log[6], short=True)
+                        since = timestamp
+                        cont = True
+                        continue
+                print_cpon(log, short=True)
+                cont = False
+
+            if cont:
+                with patch_stdout():
+                    cont = await app.run_async()
+                    app.output.cursor_up(1)
+                    app.output.write("\r")
+                    app.output.erase_end_of_line()
+                    app.output.flush()
+
+
+class HistoryCount(IntOption):
+    """Number of items fetched at one ``!history`` builtin invocation."""
+
+    def __init__(self, state: State) -> None:
+        super().__init__(state)
+        self._value = 20
+
+    @classmethod
+    def aliases(cls) -> collections.abc.Sequence[str]:  # noqa: D102
+        return ("history_count",)
+
+    def __int__(self) -> int:
+        return self._value
+
+    def rset(self, value: int) -> None:  # noqa: D102
+        self._value = value

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/cli.py

@@ -14,7 +14,7 @@ from prompt_toolkit.key_binding.key_processor import KeyPressEvent
 from prompt_toolkit.patch_stdout import patch_stdout
 from prompt_toolkit.shortcuts import CompleteStyle, ProgressBar, ProgressBarCounter
 from prompt_toolkit.shortcuts.progress_bar import formatters
-from shv import RpcError
+from shv.rpcdef import RpcError
 
 from .builtin import Builtins
 from .client import Client

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/client.py

@@ -4,15 +4,11 @@ from __future__ import annotations
 
 import typing
 
-from shv import (
-    RpcDir,
-    RpcError,
-    RpcMessage,
-    RpcMethodNotFoundError,
-    SHVClient,
-    SHVPath,
-    SHVType,
-)
+from shv import SHVType
+from shv.path import SHVPath
+from shv.rpcapi.client import SHVClient
+from shv.rpcdef import RpcDir, RpcError, RpcMethodNotFoundError
+from shv.rpcmessage import RpcMessage
 
 from . import VERSION
 from .options import CallQueryTimeout, CallRetryTimeout

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/cliitems.py

@@ -3,8 +3,9 @@
 import contextlib
 import string
 
-from shv import SHVPath, SHVType
+from shv import SHVType
 from shv.cpon import Cpon
+from shv.path import SHVPath
 from shv.rpctypes import RpcType, RpcTypeParseError, rpctype_parse
 
 
@@ -29,7 +30,9 @@ class CliItems:
         path = "" if ":" not in ri and "/" not in ri else ri.partition(":")[0]
         if any(c in path for c in string.whitespace):
             raise ValueError("Path can't have white character in it.")
-        return self.path_prefix / path
+        if path == "/":
+            return SHVPath("")
+        return self.path_prefix / path.rstrip("/")
 
     @property
     def method(self) -> str:

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/file.py

@@ -7,15 +7,18 @@ import io
 import pathlib
 
 import shv
+import shv.path
+import shv.rpcdef.file
 from prompt_toolkit.shortcuts import ProgressBar, ProgressBarCounter
+from shv.rpcdef.file import RpcFile
 
 from .client import Client
 
 
 async def copy_file(
     client: Client,
-    src: pathlib.Path | shv.SHVPath,
-    dest: pathlib.Path | shv.SHVPath,
+    src: pathlib.Path | shv.path.SHVPath,
+    dest: pathlib.Path | shv.path.SHVPath,
     label: str = "",
 ) -> None:
     """Copy file with support for local and SHV RPC files.
@@ -23,17 +26,17 @@ async def copy_file(
     :raises RpcError: For RPC errors.
     :raises FileNotFoundError: In case remote or local file is not located.
     """
-    srcfile: shv.RpcFile | io.IOBase | None = None
-    destfile: shv.RpcFile | io.IOBase | None = None
+    srcfile: RpcFile | io.IOBase | None = None
+    destfile: RpcFile | io.IOBase | None = None
 
     try:
-        if isinstance(src, shv.SHVPath):
-            srcfile = shv.RpcFile(client, str(src), flags=shv.RpcFile.Flag(0))
+        if isinstance(src, shv.path.SHVPath):
+            srcfile = RpcFile(client, str(src), flags=RpcFile.Flag(0))
             if not await srcfile.readable():
                 raise FileNotFoundError(f"No such readable SHV RPC file: {src}")
             srcsiz = await srcfile.size()
-        if isinstance(dest, shv.SHVPath):
-            destfile = shv.RpcFile(client, str(dest), flags=shv.RpcFile.Flag(0))
+        if isinstance(dest, shv.path.SHVPath):
+            destfile = RpcFile(client, str(dest), flags=RpcFile.Flag(0))
             if not await destfile.writable():
                 raise FileNotFoundError(f"No such writable SHV RPC file: {dest}")
 
@@ -44,7 +47,7 @@ async def copy_file(
             destfile = dest.open("wb")
 
         assert srcfile is not None and destfile is not None
-        if isinstance(destfile, shv.RpcFile):
+        if isinstance(destfile, RpcFile):
             await destfile.truncate(0)
 
         with ProgressBar() as pb:

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/lsdir.py

@@ -5,7 +5,8 @@ import contextlib
 import itertools
 import string
 
-from shv import Cpon, RpcDir, RpcError
+from shv.cpon import Cpon
+from shv.rpcdef import RpcDir, RpcError
 
 from .client import Client, Node
 from .cliitems import CliItems

shvcli-0.8.0/shvcli/oauth.py

@@ -0,0 +1,75 @@
+"""Utility to receive token from OAuth2 provider."""
+
+import http.server
+import json
+import socketserver
+import urllib.parse
+import urllib.request
+import webbrowser
+
+
+def oauth_login_token(
+    tp: str, client_id: str, authorize_url: str, token_url: str, scopes: list[str]
+) -> str:
+    """Use OAuth2 to get login token.
+
+    This is blocking call and thus :func:`asyncio.run_in_executor` should be
+    used if called from asyncio.
+    """
+    redirect_uri = "http://localhost:37719/"
+
+    auth_code = None
+
+    class _HTTPHandler(http.server.BaseHTTPRequestHandler):
+        def do_GET(self) -> None:  # noqa: N802
+            nonlocal auth_code
+            parsed_path = urllib.parse.urlparse(self.path)
+            if parsed_path.path == "/":
+                params = urllib.parse.parse_qs(parsed_path.query)
+                auth_code = params.get("code", [None])[0]
+                self.send_response(200)
+                self.send_header("Content-Type", "text/html")
+                self.end_headers()
+                self.wfile.write(b"""
+                    <html><body>
+                      <p>Authorization complete. You may close this window.</p>
+                      <script>window.close();</script>
+                    </body></html>
+                """)
+            else:
+                self.send_error(404)
+
+        def log_message(self, fmt: str, *args: str) -> None:
+            pass  # suppress default logging
+
+    socketserver.TCPServer.allow_reuse_address = True
+    with socketserver.TCPServer(("", 37719), _HTTPHandler) as httpd:
+        webbrowser.open(
+            authorize_url
+            + "?"
+            + urllib.parse.urlencode({
+                "client_id": client_id,
+                "response_type": "code",
+                "redirect_uri": redirect_uri,
+                "scope": " ".join(scopes),
+            })
+        )
+        print("Waiting for authorization...")
+        while auth_code is None:
+            httpd.handle_request()
+
+    data = {
+        "client_id": client_id,
+        "grant_type": "authorization_code",
+        "code": auth_code,
+        "redirect_uri": redirect_uri,
+        "scope": " ".join(scopes),
+    }
+    req = urllib.request.Request(  # noqa: S310
+        token_url, data=urllib.parse.urlencode(data).encode("UTF-8"), method="POST"
+    )
+    req.add_header("Content-Type", "application/x-www-form-urlencoded")
+    with urllib.request.urlopen(req) as resp:  # noqa: S310
+        res = json.loads(resp.read())["access_token"]
+    assert isinstance(res, str)
+    return f"{tp}:{res}"

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/options.py

@@ -78,7 +78,7 @@ class DebugOption(BoolOption):
         logging.root.setLevel(logging.DEBUG if value else logging.WARNING)
 
     def __bool__(self) -> bool:
-        return logging.root.level >= logging.DEBUG
+        return logging.root.level <= logging.DEBUG
 
 
 class CallDuration(BoolOption):

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/state.py

@@ -10,6 +10,8 @@ import pathlib
 import typing
 
 import shv
+import shv.chainpack
+import shv.path
 
 
 class StateVarMeta(abc.ABCMeta):
@@ -67,7 +69,7 @@ class State(dict[type[StateVar], StateVar]):
 
     def __init__(self) -> None:
         super().__init__()
-        self.path: shv.SHVPath = shv.SHVPath()
+        self.path = shv.path.SHVPath()
         """Current path we are working relative to."""
 
         for cls in StateVar.variables:
@@ -79,7 +81,7 @@ class State(dict[type[StateVar], StateVar]):
         with contextlib.suppress(FileNotFoundError):
             with cachefile.open("rb") as f:
                 try:
-                    data = shv.ChainPack.unpack(f.read())
+                    data = shv.chainpack.ChainPack.unpack(f.read())
                 except (ValueError, EOFError):
                     return
             if shv.is_shvmap(data):
@@ -93,4 +95,4 @@ class State(dict[type[StateVar], StateVar]):
             var.cache_dump(data)
         cachefile.parent.mkdir(parents=True, exist_ok=True)
         with cachefile.open("wb") as f:
-            f.write(shv.ChainPack.pack(data))
+            f.write(shv.chainpack.ChainPack.pack(data))

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/tools/complet.py

@@ -3,7 +3,7 @@
 import collections.abc
 import itertools
 
-import shv
+import shv.path
 from prompt_toolkit.completion import Completion
 
 from ..tree import Tree
@@ -21,7 +21,7 @@ def comp_from(
 
 
 def comp_path(
-    path: str, path_prefix: shv.SHVPath, tree: Tree, tail: str = ":"
+    path: str, path_prefix: shv.path.SHVPath, tree: Tree, tail: str = ":"
 ) -> collections.abc.Iterable[Completion]:
     """Perform completion for the given current path."""
     pth, _, word = path.rpartition("/")
@@ -36,7 +36,7 @@ def comp_path(
 
 
 def comp_signal_ri(
-    ri: str, path_prefix: shv.SHVPath, tree: Tree
+    ri: str, path_prefix: shv.path.SHVPath, tree: Tree
 ) -> collections.abc.Iterable[Completion]:
     """Completion for RPC RI."""
     match ri.count(":"):

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/tools/print.py

@@ -8,6 +8,7 @@ import typing
 
 import more_itertools
 import shv
+import shv.cpon
 from prompt_toolkit import print_formatted_text
 from prompt_toolkit.document import Document
 from prompt_toolkit.formatted_text import FormattedText
@@ -18,9 +19,11 @@ from pygments.lexers.data import JsonLexer
 def print_ftext(
     fstrs: collections.abc.Iterable[tuple[str, str]]
     | collections.abc.Iterator[tuple[str, str]],
+    *args: typing.Any,  # noqa: ANN401
+    **kwargs: typing.Any,  # noqa: ANN401
 ) -> None:
     """Call :meth:`print_formatted_text` with :class:`FormattedText`."""
-    print_formatted_text(FormattedText(fstrs))
+    print_formatted_text(FormattedText(fstrs), *args, **kwargs)
 
 
 def print_flist(
@@ -125,12 +128,14 @@ def _wrap_cpon(cpon: str) -> collections.abc.Iterator[str]:
 def print_cpon(data: shv.SHVType, prefix: str = "", short: bool = False) -> None:
     """Print given data in CPON format."""
     if short:
-        cpon = "\n".join(_wrap_cpon(prefix + shv.Cpon.pack(data)))[len(prefix) :]
+        cpon = "\n".join(_wrap_cpon(prefix + shv.cpon.Cpon.pack(data)))[len(prefix) :]
         print_ftext(itertools.chain(iter((("", prefix),)), cpon_ftext(cpon)))
     else:
         print_ftext(
             itertools.chain(
                 iter((("", prefix),)),
-                cpon_ftext(shv.Cpon.pack(data, shv.CponWriter.Options(indent=b" "))),
+                cpon_ftext(
+                    shv.cpon.Cpon.pack(data, shv.cpon.CponWriter.Options(indent=b" "))
+                ),
             )
         )

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/tree.py

@@ -7,6 +7,8 @@ import contextlib
 import typing
 
 import shv
+import shv.path
+import shv.rpcdef
 
 from .state import State, StateVar
 
@@ -20,9 +22,9 @@ class Node(collections.abc.Mapping[str, "Node"]):
 
         self.nodes: dict[str, Node] = {}
         """The child nodes of this node."""
-        self.methods: dict[str, shv.RpcDir | None] = {
-            "ls": shv.RpcDir.stdls(),
-            "dir": shv.RpcDir.stddir(),
+        self.methods: dict[str, shv.rpcdef.RpcDir | None] = {
+            "ls": shv.rpcdef.RpcDir.stdls(),
+            "dir": shv.rpcdef.RpcDir.stddir(),
         }
         """The methods discovered to be associated with this method."""
         self.nodes_probed = False
@@ -42,10 +44,10 @@ class Node(collections.abc.Mapping[str, "Node"]):
         """Get number of child nodes."""
         return len(self.nodes)
 
-    def valid_path(self, path: shv.SHVPath | str) -> Node:
+    def valid_path(self, path: shv.path.SHVPath | str) -> Node:
         """Add valid path relative to this node."""
         if isinstance(path, str):
-            path = shv.SHVPath(path)
+            path = shv.path.SHVPath(path)
         node = self
         for n in path.parts:
             if n not in node:
@@ -53,10 +55,10 @@ class Node(collections.abc.Mapping[str, "Node"]):
             node = node[n]
         return node
 
-    def invalid_path(self, path: shv.SHVPath | str) -> None:
+    def invalid_path(self, path: shv.path.SHVPath | str) -> None:
         """Invalidate path as not existent."""
         if isinstance(path, str):
-            path = shv.SHVPath(path)
+            path = shv.path.SHVPath(path)
         pnode = None
         node = self
         for n in path.parts:
@@ -67,7 +69,7 @@ class Node(collections.abc.Mapping[str, "Node"]):
         if pnode is not None:
             pnode.nodes.pop(path.name)
 
-    def get_node(self, path: shv.SHVPath) -> Node | None:
+    def get_node(self, path: shv.path.SHVPath) -> Node | None:
         """Get node on given path."""
         node = self
         for n in path.parts:
@@ -76,7 +78,9 @@ class Node(collections.abc.Mapping[str, "Node"]):
             node = node[n]
         return node
 
-    def get_method(self, path: shv.SHVPath, method: str) -> shv.RpcDir | None:
+    def get_method(
+        self, path: shv.path.SHVPath, method: str
+    ) -> shv.rpcdef.RpcDir | None:
         """Get method from given path."""
         if (node := self.get_node(path)) is not None:
             return node.methods.get(method, None)
@@ -104,8 +108,8 @@ class Node(collections.abc.Mapping[str, "Node"]):
         if shv.is_shvmap(data["methods"]):
             for n, v in data["methods"].items():
                 desc = None
-                with contextlib.suppress(shv.RpcInvalidParamError, ValueError):
-                    desc = shv.RpcDir.from_shv(v)
+                with contextlib.suppress(shv.rpcdef.RpcInvalidParamError, ValueError):
+                    desc = shv.rpcdef.RpcDir.from_shv(v)
                 self.methods[n] = desc
         self.nodes_probed = bool(data["nodes_probed"])
         self.methods_probed = bool(data["methods_probed"])

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli/url.py

@@ -3,7 +3,9 @@
 from __future__ import annotations
 
 import argparse
+import asyncio
 import contextlib
+import dataclasses
 import os
 import pathlib
 import re
@@ -12,13 +14,39 @@ import subprocess
 import typing
 
 import shv
+import shv.rpcapi
+import shv.rpclogin
+import shv.rpctransport
+import shv.rpcurl
 import xdg.BaseDirectory
 
 from .args import ArgsParseFuncGenT, register_argparser
+from .client import Client
 from .config import Config, ConfigError, register_config
+from .oauth import oauth_login_token
 from .state import State, StateVar
 
 
+class RpcUrlEx(shv.rpcurl.RpcUrl):
+    """Extended :class:`shv.rpcurl.RpcUrl`.
+
+    This defines additional attributes custom for the SHVCLI.
+    """
+
+    oauth2: bool = False
+    """If OAuth2 login method should be used or not."""
+
+    def _parse_query(self, pqs: dict[str, list[str]]) -> None:
+        super()._parse_query(pqs)
+        if opts := pqs.pop("oauth2", []):
+            if opts[0] in {"true", "t", "y"}:
+                self.oauth2 = True
+            elif opts[0] in {"false", "f", "n"}:
+                self.oauth2 = False
+            else:
+                raise ValueError(f"Invalid for verify: {opts[0]}")
+
+
 class Url(StateVar):
     """The SHV RPC URL deduction and store."""
 
@@ -28,8 +56,9 @@ class Url(StateVar):
         """The mapping of hosts aliases to the full URLs."""
         self.hosts_shell: dict[str, str] = {}
         """The mapping of aliases to the shell expanded URLs."""
-        self.url: shv.RpcUrl = shv.RpcUrl("localhost")
+        self.url: RpcUrlEx = RpcUrlEx("localhost")
         """SHV RPC URL currectly set as the one to be used."""
+        self._state = state
 
     def set(self, value: str) -> None:
         """Set given value as URL by interpreting it in various ways.
@@ -55,27 +84,72 @@ class Url(StateVar):
                 check=True,
             ).stdout.decode()
         value = self.hosts.get(value, value)
-        self.url = shv.RpcUrl.parse(value)
+        self.url = RpcUrlEx.parse(value)
         # TODO this modifies it even if unix is explicitly specified
-        if self.url.protocol is shv.RpcProtocol.UNIX:
+        if self.url.protocol is shv.rpcurl.RpcProtocol.UNIX:
             with contextlib.suppress(FileNotFoundError):
                 st = os.stat(self.url.location)
                 if stat.S_ISCHR(st.st_mode):
-                    self.url.protocol = shv.RpcProtocol.TTY
+                    self.url.protocol = shv.rpcurl.RpcProtocol.TTY
 
     def cache_path(self) -> pathlib.Path:
         """Cache path based on the current URL."""
         return pathlib.Path(xdg.BaseDirectory.save_cache_path("shvcli")) / re.sub(
             r"[^\w_. -]",
             "_",
-            shv.RpcUrl(
+            RpcUrlEx(
                 location=self.url.location,
                 port=self.url.port,
                 protocol=self.url.protocol,
-                login=shv.RpcLogin(username=self.url.login.username),
+                login=shv.rpclogin.RpcLogin(username=self.url.login.username),
             ).to_url(),
         )
 
+    async def connect(self) -> Client:
+        """Create new client based on this URL."""
+        url = self.url
+        if self.url.oauth2:
+            base = shv.rpcapi.SHVBase(
+                await shv.rpctransport.connect_rpc_client(self.url)
+            )
+            workflows = await base.call("", "workflows")
+            await base.disconnect()
+            if shv.is_shvlist(workflows):
+                oauths = [
+                    v
+                    for v in workflows
+                    if shv.is_shvmap(v)
+                    and isinstance(tp := v.get("type"), str)
+                    and tp.startswith("oauth2")
+                ]
+                if len(oauths) >= 1:
+                    oauth = oauths[0]
+                    tp = oauth.get("type")
+                    client_id = oauth.get("clientId")
+                    authorize_url = oauth.get("authorizeUrl")
+                    token_url = oauth.get("tokenUrl")
+                    scopes = oauth.get("scopes")
+                    assert shv.is_shvlist(scopes)
+                    token = await asyncio.get_running_loop().run_in_executor(
+                        None,
+                        lambda: oauth_login_token(
+                            str(tp),
+                            str(client_id),
+                            str(authorize_url),
+                            str(token_url),
+                            list(str(v) for v in scopes),
+                        ),
+                    )
+                    url = dataclasses.replace(
+                        url,
+                        login=dataclasses.replace(
+                            url.login,
+                            token=token,
+                            login_type=shv.rpclogin.RpcLoginType.TOKEN,
+                        ),
+                    )
+        return await Client.connect(url, state=self._state)
+
 
 @register_config
 def _config(config: Config, state: State) -> None:

{shvcli-0.7.0 → shvcli-0.8.0/shvcli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shvcli
-Version: 0.7.0
+Version: 0.8.0
 Summary: Silicon Heaven CLI access application
 Author: Elektroline a.s.
 License: MIT License
@@ -27,7 +27,6 @@ License: MIT License
         
 Project-URL: repository, https://gitlab.com/silicon-heaven/shvcli
 Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Classifier: Environment :: Console
 Classifier: Intended Audience :: End Users/Desktop
@@ -37,7 +36,7 @@ Classifier: Topic :: Terminals
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pyshv>=0.9.0
+Requires-Dist: pyshv>=0.10.0
 Requires-Dist: prompt_toolkit
 Requires-Dist: pygments
 Requires-Dist: pyxdg
@@ -151,6 +150,8 @@ following options are available without any plugins:
   is used only in case when method doesn't support delayed responses.
 * **autoget_timeout**: Timeout in seconds for call that is part of autoget
   functionality.
+* **history_count**: Integer number used for number of records requested at time
+  for ``!history`` builtin.
 
 Example configuration file:
 
@@ -213,6 +214,10 @@ parameter must be path to the local file where data will be stored.
 **verify**: provides a way to verify RPC File node against local file. The
 parameter must be path to the local file used for the verification.
 
+**history**: is helper to list recorded history of signals by ``.history`` API.
+The listing is incremental in ``history_count`` configured number of records and
+in the order from the newest ones.
+
 
 Special methods ``ls`` and ``dir``
 ----------------------------------
@@ -225,6 +230,17 @@ Their parameter is also handled in a special way. It is considered to be
 additional path suffix unless it is a valid CPON. This is allowed to match the
 common shells.
 
+You can see ``raw`` option to disable this behavior.
+
+
+OAuth2 login
+------------
+
+SHVCLI supports non-standard login method OAuth2. This is not defined by SHV
+standard. The non-standard URL query ``oauth2=y`` is accepted to perform the
+OAuth2 login. The login is facilitated by web browser. SHVCLI will start server
+on ``tcp://localhost:37719/`` to be able to receive token.
+
 
 Plugins
 -------

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.rst
 pyproject.toml
 shvcli/__init__.py
 shvcli/__main__.py
+shvcli/__setuptools__.py
 shvcli/__version__.py
 shvcli/afterconn.py
 shvcli/args.py
@@ -14,6 +15,7 @@ shvcli/complet.py
 shvcli/config.py
 shvcli/file.py
 shvcli/lsdir.py
+shvcli/oauth.py
 shvcli/option.py
 shvcli/options.py
 shvcli/plugins.py
@@ -34,6 +36,7 @@ shvcli/builtins/broker.py
 shvcli/builtins/cd.py
 shvcli/builtins/file.py
 shvcli/builtins/help.py
+shvcli/builtins/history.py
 shvcli/builtins/scan.py
 shvcli/builtins/set.py
 shvcli/builtins/tree.py

{shvcli-0.7.0 → shvcli-0.8.0}/shvcli.egg-info/requires.txt

@@ -1,4 +1,4 @@
-pyshv>=0.9.0
+pyshv>=0.10.0
 prompt_toolkit
 pygments
 pyxdg

shvcli-0.7.0/shvcli/__version__.py

@@ -1,26 +0,0 @@
-"""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()