speedtest-ssh 2.8.0__tar.gz → 2.9.0__tar.gz

{speedtest_ssh-2.8.0/speedtest_ssh.egg-info → speedtest_ssh-2.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: speedtest_ssh
-Version: 2.8.0
+Version: 2.9.0
 Summary: A tool meant to check inter-device speeds via ssh
 License: GPL
 Project-URL: Homepage, https://github.com/zwimer/speedtest_ssh

{speedtest_ssh-2.8.0 → speedtest_ssh-2.9.0}/pyproject.toml

@@ -58,3 +58,10 @@ ignore = ["E731"]
 line-length = 120
 [tool.ruff.per-file-ignores]
 "__init__.py" = ["F401", "F403"]
+
+[tool.bandit]
+skips = ["B404", "B108"]
+
+[tool.vulture]
+ignore_names = ["cli"]
+paths = ["speedtest_ssh"]

speedtest_ssh-2.9.0/speedtest_ssh/_version.py

@@ -0,0 +1 @@
+__version__: str = "2.9.0"

{speedtest_ssh-2.8.0 → speedtest_ssh-2.9.0}/speedtest_ssh/data_transfer.py

@@ -22,6 +22,13 @@ if TYPE_CHECKING:
 __all__ = ("DataTransfer", "SFTP", "Rsync")
 
 
+_dict = string.ascii_uppercase + string.ascii_lowercase + string.digits
+
+
+def _rand_str(size: int) -> str:
+    return "".join(random.choice(_dict) for _ in range(size))  # nosec B311
+
+
 class ProgressBar(tqdm):
     """
     A small tqdm wrapper for paramiko's SFTP callbacks to use
@@ -43,7 +50,7 @@ class ProgressBar(tqdm):
 
 class DataTransfer:
     """
-    A context mananger used to send and receive data to and from the remote client
+    A context manager used to send and receive data to and from the remote client
     This class is a context manager; on exit will remove the remote file on deletion
     """
 
@@ -54,8 +61,7 @@ class DataTransfer:
         :param config: The Config object the DataTransfer instance should use
         """
         self._l = getLogger(self._LOG)
-        rand = lambda: random.choice(string.ascii_uppercase + string.ascii_lowercase + string.digits)
-        self._remote_f: str = f"/tmp/speedtest-ssh_{datetime.now()}_{''.join(rand() for _ in range(8))}.tmp"
+        self._remote_f: str = f"/tmp/speedtest-ssh_{datetime.now()}_{_rand_str(8)}.tmp"
         self._remote_f = self._remote_f.replace(":", "-").replace(" ", "_")
         # We promise that _remote_f components match: ^[a-zA-Z\d_.-]+$ (old rsync args suck)
         self._l.debug("Parsing ssh config and loading keys...")

{speedtest_ssh-2.8.0 → speedtest_ssh-2.9.0}/speedtest_ssh/speedtest_ssh.py

@@ -5,7 +5,6 @@ from pathlib import Path
 import argparse
 import math
 import time
-import sys
 import os
 
 from .config import Config
@@ -15,7 +14,8 @@ from ._version import __version__
 
 
 base_size = 2 * (1024**2)
-_password_env_name = "SPEEDTEST_SSH_PASSWORD"
+_password_env_name = "SPEEDTEST_SSH_PASSWORD"  # nosec B105
+_LOG_VERBOSITY: dict[int, int] = {0: WARNING, 1: INFO, 2: DEBUG}
 _LOG = "speedtest_ssh"
 
 
@@ -63,7 +63,7 @@ def _print_results(ping_delay: float | None, up_ns: int, down_ns: int, size: int
     print(f"{prefix}Upload Speed: {fmt(up_ns)}\nDownload Speed: {fmt(down_ns)}")
 
 
-def speedtest_ssh(num_seconds: int, ping: bool, mode: str, conf: Config) -> None:
+def speedtest_ssh(seconds: int, ping: bool, mode: str, conf: Config) -> None:
     """
     Run speedtest_ssh
     """
@@ -78,7 +78,7 @@ def speedtest_ssh(num_seconds: int, ping: bool, mode: str, conf: Config) -> None
             print("Testing...")
             nano_sec: int = 0
             size: int = base_size
-            remaining: int = int(1e9) * num_seconds
+            remaining: int = int(1e9) * seconds
             while int(1.5 * nano_sec) < remaining - 1:  # Try to get close to seconds
                 size *= 2 ** (0 if not nano_sec else max(1, int(math.log(remaining / nano_sec, 2))))
                 # ^ Faster than just *=2
@@ -89,51 +89,48 @@ def speedtest_ssh(num_seconds: int, ping: bool, mode: str, conf: Config) -> None
     _print_results(ping_delay, up_t, down_t, size)
 
 
-def main(argv: list[str]) -> None:
+def cli() -> None:
     """
-    speedtest_ssh from arguments
+    speedtest_ssh main
     """
-    base: str = os.path.basename(argv[0])
-    parser = argparse.ArgumentParser(prog=base)
-    parser.add_argument("--version", action="version", version=f"{base} {__version__}")
-    parser.add_argument("host", help="The host to speedtest the conection to")
-    parser.add_argument("--ping", action="store_true", help="Ping test the host as well")
-    parser.add_argument("--verbose", action="store_true", help="Be verbose")
-    parser.add_argument("--very-verbose", action="store_true", help="Be very verbose")
-    parser.add_argument("-u", "--user", help="The user used for ssh")
-    parser.add_argument(
-        "--password-env", action="store_true", help=f"Read password from {_password_env_name} environment variable"
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-V", "--version", action="version", version=f"{parser.prog} {__version__}")
+    remote = parser.add_argument_group("SSH Options")
+    remote.add_argument("host", help="The host to speedtest the conection to")
+    remote.add_argument("-u", "--user", help="The user used for ssh")
+    remote.add_argument("-p", "--port", type=int, help="The port used for ssh")
+    remote.add_argument(
+        "-E",
+        "--password-env",
+        action="store_true",
+        help=f"Read password from {_password_env_name} environment variable",
     )
-    parser.add_argument("-p", "--port", type=int, help="The port used for ssh")
     parser.add_argument(
-        "--num-seconds", type=int, default=20, help="An approximate number of seconds the speed tests should take"
+        "-v",
+        "--verbose",
+        action="count",
+        default=0,
+        help="Increase Log verbosity, pass more than once to increase verbosity",
     )
-    parser.add_argument(
+    modes = parser.add_argument_group("SpeedTest Options")
+    modes.add_argument("-P", "--ping", action="store_true", help="Ping test the host as well")
+    modes.add_argument(
+        "-s", "--seconds", type=int, default=20, help="An approximate number of seconds the speed tests should take"
+    )
+    modes.add_argument(
         "-m", "--mode", choices=["rsync", "sftp"], default="sftp", help="The speedtest method. Defaults to rsync"
     )
-    ns = vars(parser.parse_args(argv[1:]))
-    basicConfig(level=WARNING, format="%(message)s")
-    log = getLogger(_LOG)
-    if ns.pop("verbose"):
-        getLogger().setLevel(INFO)
-    if ns.pop("very_verbose"):
-        getLogger().setLevel(DEBUG)
-        log.debug("Very verbose logging enabled")
+    ns = vars(parser.parse_args())
+    # Configure logging
+    lvl = ns.pop("verbose")
+    lvl = _LOG_VERBOSITY[max(i for i in _LOG_VERBOSITY if i <= lvl)]
+    basicConfig(level=lvl, format="%(levelname)-8s %(message)s")
+    getLogger("main").debug("Log level set to %d", lvl)
+    # Call speedtest
     ns["password"] = None
     if ns.pop("password_env"):
         ns["password"] = os.environ.get(_password_env_name, None)
         if ns["password"] is None:
             raise RuntimeError(f"{_password_env_name} is not set")
     conf = Config(**{i.name: ns.pop(i.name) for i in fields(Config)})  # type: ignore
-    return speedtest_ssh(**ns, conf=conf)  # type: ignore
-
-
-def cli() -> None:
-    """
-    speedtest_ssh CLI
-    """
-    main(sys.argv)
-
-
-if __name__ == "__main__":
-    cli()
+    speedtest_ssh(**ns, conf=conf)  # type: ignore

{speedtest_ssh-2.8.0 → speedtest_ssh-2.9.0}/speedtest_ssh/util.py

@@ -43,7 +43,7 @@ def run_cmd(cmd: Path, *args: str | Path, **kwargs) -> subprocess.CompletedProce
     :return: Completed process
     """
     _log_cmd(cmd, args)
-    return subprocess.run((cmd, *args), **kwargs)
+    return subprocess.run((cmd, *args), **kwargs)  # nosec B603
 
 
 def tee_cmd(cmd: Path, *args: str | Path, level: int, **kwargs) -> tuple[subprocess.Popen, str]:
@@ -54,11 +54,11 @@ def tee_cmd(cmd: Path, *args: str | Path, level: int, **kwargs) -> tuple[subproc
     :param kwargs: Fowarded to subprocess.Popen aside from test and stdout
     :return: Completed process, stdout (do not read stdout from CompletedProcess)
     """
-    assert "text" not in kwargs
-    assert "stdout" not in kwargs
+    assert "text" not in kwargs  # nosec B101
+    assert "stdout" not in kwargs  # nosec B101
     log = getLogger(_LOG)
     _log_cmd(cmd, args)
-    p = subprocess.Popen((cmd, *args), text=True, stdout=subprocess.PIPE, **kwargs)
+    p = subprocess.Popen((cmd, *args), text=True, stdout=subprocess.PIPE, **kwargs)  # nosec B603
     stdout = ""
     for line in p.stdout:  # type: ignore
         log.log(level, line[:-1])

{speedtest_ssh-2.8.0 → speedtest_ssh-2.9.0/speedtest_ssh.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: speedtest_ssh
-Version: 2.8.0
+Version: 2.9.0
 Summary: A tool meant to check inter-device speeds via ssh
 License: GPL
 Project-URL: Homepage, https://github.com/zwimer/speedtest_ssh

speedtest_ssh-2.8.0/speedtest_ssh/_version.py

@@ -1 +0,0 @@
-__version__: str = "2.8.0"