restore old code for execute_command (#33)

* restore old code

* update project info

* new syncops module

* rename execute as rexec in syncops

Author: cav71

Makefile

@@ -14,7 +14,7 @@ help: ## Display the list of available targets
 
 
 .PHONY: check
-check: check-fmt lint test ## Check code formatting and run tests
+check: check-fmt lint ## Check code formatting
 	@echo "🟢 pass"
 
 .PHONY: check-fmt

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "luxos"
-version = "0.1.0"
+version = "0.1.1"
 description = "The all encompassing LuxOS python library."
 readme = "README.md"
 license = { text = "MIT" }  # TODO I don't think this is a MIT??

src/luxos/asyncops.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import asyncio
+import contextlib
 import functools
 import json
 import logging
@@ -126,9 +127,9 @@ def validate_message(
     port: int,
     res: dict[str, Any],
     extrakey: str | None = None,
-    minfields: None | int = None,
-    maxfields: None | int = None,
-) -> dict[str, Any]:
+    minfields: None | int = 1,
+    maxfields: None | int = 1,
+) -> Any:
     # all miner message comes with a STATUS
     for key in ["STATUS", "id", *([extrakey] if extrakey else [])]:
         if key in res:
@@ -142,17 +143,17 @@ def validate_message(
 
     n = len(res[extrakey])
     msg = None
-    if minfields and (n < minfields):
+    if (minfields is not None) and (n < minfields):
         msg = f"found {n} fields for {extrakey} invalid: " f"{n} <= {minfields}"
-    elif maxfields and (n > maxfields):
+    elif (maxfields is not None) and (n > maxfields):
         msg = f"found {n} fields for {extrakey} invalid: " f"{n} >= {maxfields}"
     if msg is None:
         return res[extrakey]
     raise exceptions.MinerCommandMalformedMessageError(host, port, msg, res)
 
 
 @wrapped
-async def logon(host: str, port: int, timeout: float | None = 3) -> str:
+async def logon(host: str, port: int, timeout: float | None = None) -> str:
     timeout = TIMEOUT if timeout is None else timeout
     res = await roundtrip(host, port, {"command": "logon"}, timeout=timeout)
 
@@ -166,7 +167,7 @@ async def logon(host: str, port: int, timeout: float | None = 3) -> str:
         )
     sessions = validate_message(host, port, res, "SESSION", 1, 1)
 
-    session = sessions[0]  # type: ignore
+    session = sessions[0]
 
     if "SessionID" not in session:
         raise exceptions.MinerCommandSessionAlreadyActive(
@@ -177,56 +178,15 @@ async def logon(host: str, port: int, timeout: float | None = 3) -> str:
 
 @wrapped
 async def logoff(
-    host: str, port: int, sid: str, timeout: float | None = 3
+    host: str, port: int, sid: str, timeout: float | None = None
 ) -> dict[str, Any]:
     timeout = TIMEOUT if timeout is None else timeout
     return await roundtrip(
         host, port, {"command": "logoff", "parameter": sid}, timeout=timeout
     )
 
 
-@wrapped
-async def execute_command(
-    host: str,
-    port: int,
-    timeout_sec: float | None,
-    cmd: str,
-    parameters: list[str] | None = None,
-    verbose: bool = False,
-    asjson: bool | None = True,
-    add_address: bool = False,
-) -> tuple[tuple[str, int], dict[str, Any]] | dict[str, Any]:
-    timeout = TIMEOUT if timeout_sec is None else timeout_sec
-    parameters = parameters or []
-
-    sid = None
-    if api.logon_required(cmd):
-        sid = await logon(host, port)
-        parameters = [sid, *parameters]
-        log.debug("session id requested & obtained for %s:%i (%s)", host, port, sid)
-    else:
-        log.debug("no logon required for command '%s' on %s:%i", cmd, host, port)
-
-    try:
-        packet = {"command": cmd}
-        if parameters:
-            packet["parameter"] = ",".join(parameters)
-        log.debug(
-            "executing command '%s' on '%s:%i' with parameters: %s",
-            cmd,
-            host,
-            port,
-            packet.get("parameter", ""),
-        )
-        ret = await roundtrip(host, port, packet, timeout=timeout, asjson=asjson)
-        log.debug("received from %s:%s: %s", host, port, str(ret))
-        return ((host, port), ret) if add_address else ret
-    finally:
-        if sid:
-            await logoff(host, port, sid)
-
-
-def _rexec_parameters(
+def parameters_to_list(
     parameters: str | list[Any] | dict[str, Any] | None = None,
 ) -> list[str]:
     if isinstance(parameters, dict):
@@ -256,9 +216,7 @@ async def rexec(
     retry: int | None = None,
     retry_delay: float | None = None,
 ) -> dict[str, Any] | None:
-    from . import api
-
-    parameters = _rexec_parameters(parameters)
+    parameters = parameters_to_list(parameters)
 
     timeout = TIMEOUT if timeout is None else timeout
     retry = RETRIES if retry is None else retry
@@ -328,3 +286,14 @@ async def rexec(
         await logoff(host, port, sid)
     if isinstance(failure, Exception):
         raise failure
+
+
+@contextlib.asynccontextmanager
+async def with_atm(host, port, enabled: bool, timeout: float | None = None):
+    res = await rexec(host, port, "atm", timeout=timeout)
+    if not res:
+        raise exceptions.MinerConnectionError(host, port, "cannot check atm")
+    current = validate_message(host, port, res, "ATM")[0]["Enabled"]
+    await rexec(host, port, "atmset", {"enabled": enabled}, timeout=timeout)
+    yield current
+    await rexec(host, port, "atmset", {"enabled": current}, timeout=timeout)

src/luxos/cli/flags.py

@@ -204,6 +204,9 @@ def add_arguments_database(parser: LuxosParserBase):
 
     group = parser.add_argument_group("database", "Database related options")
     group.add_argument("--db", dest="engine", help="sqlalchemy uri or filename")
+    group.add_argument(
+        "--db-create", action="store_true", help="create the db structures"
+    )
 
     def callback(args: argparse.Namespace):
         from sqlalchemy import create_engine

src/luxos/exceptions.py

@@ -32,3 +32,19 @@ class MinerCommandSessionAlreadyActive(MinerConnectionError):
 
 class MinerCommandMalformedMessageError(MinerConnectionError):
     pass
+
+
+class LuxosLaunchError(MinerConnectionError):
+    def __init__(self, tback: str, host: str, port: int, *args, **kwargs):
+        self.tback = tback
+        super().__init__(host, port, *args, **kwargs)
+
+    def __str__(self):
+        from .text import indent
+
+        msg = indent(str(self.tback), "| ")
+        return f"{self.address}: \n{msg}"
+
+
+class LuxosLaunchTimeoutError(LuxosLaunchError, asyncio.TimeoutError):
+    pass

src/luxos/ips.py

@@ -129,6 +129,27 @@ def iter_ip_ranges(
             cur += 1
 
 
+def ip_ranges(
+    txt: str, rsep: str = "-", gsep: str = ":"
+) -> list[tuple[str, int | None]]:
+    """return a list of ips given a text expression.
+
+    Eg.
+        >>> for ip in ip_ranges("127.0.0.1"):
+        ...     print(ip)
+        127.0.0.1
+
+        >>> for ip in ip_ranges("127.0.0.1-127.0.0.3"):
+        ...     print(ip)
+        127.0.0.1
+        127.0.0.2
+        127.0.0.3
+
+    NOTE: use the `:` (gsep) to separate ips groups, and `-` (rsep) to define a range.
+    """
+    return list(iter_ip_ranges(txt, rsep=rsep, gsep=gsep))
+
+
 def load_ips_from_csv(path: Path | str, port: int = 4028) -> list[tuple[str, int]]:
     """loads ip addresses from a csv file
 

src/luxos/scripts/luxos.py

@@ -11,19 +11,11 @@
 from pathlib import Path
 
 from ..cli import v1 as cli
+from ..syncops import execute_command
 
 log = logging.getLogger(__name__)
 
 
-def execute_command(host: str, port: int, timeout_sec: int, cmd: str, parameters: list, verbose: bool):
-    from ..asyncops import rexec
-    def adapter(awaitable):
-        with contextlib.suppress(asyncio.TimeoutError):
-            loop = asyncio.get_event_loop()
-            return loop.run_until_complete(awaitable)
-    return adapter(rexec(host, port, timeout=timeout_sec, cmd=cmd, parameters=parameters))
-
-
 def add_arguments(parser: cli.LuxosParserBase) -> None:
 
     def add_miners_arguments(group):