powercli 0.3.4__tar.gz → 0.3.6__tar.gz

{powercli-0.3.4/src/powercli.egg-info → powercli-0.3.6}/PKG-INFO

@@ -1,26 +1,28 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: powercli
-Version: 0.3.4
+Version: 0.3.6
 Summary: High-level CLI interaction
 Author-email: Quinten Roets <qdr2104@columbia.edu>
-License: MIT
+License-Expression: MIT
 Project-URL: Source Code, https://github.com/quintenroets/cli
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: rich<14,>=13.7.1
+Requires-Dist: pexpect<5,>=4.9.0
+Requires-Dist: rich<15,>=14.0.1
 Provides-Extra: dev
 Requires-Dist: hypothesis<7,>=6.97.1; extra == "dev"
-Requires-Dist: package-dev-tools<1,>=0.5.11; extra == "dev"
+Requires-Dist: package-dev-tools<1,>=0.7.1; extra == "dev"
 Requires-Dist: package-dev-utils<1,>=0.1.6; extra == "dev"
 Requires-Dist: superpathlib<3,>=2.0.2; extra == "dev"
+Dynamic: license-file
 
 # PowerCLI
 [![PyPI version](https://badge.fury.io/py/powercli.svg)](https://badge.fury.io/py/powercli)
 ![PyPI downloads](https://img.shields.io/pypi/dm/powercli)
 ![Python version](https://img.shields.io/badge/python-3.10+-brightgreen)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS%20%7c%20windows-brightgreen)
-![Coverage](https://img.shields.io/badge/coverage-82%25-brightgreen)
+![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 
 High-level CLI:
 * Run commands

{powercli-0.3.4 → powercli-0.3.6}/README.md

@@ -3,7 +3,7 @@
 ![PyPI downloads](https://img.shields.io/pypi/dm/powercli)
 ![Python version](https://img.shields.io/badge/python-3.10+-brightgreen)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS%20%7c%20windows-brightgreen)
-![Coverage](https://img.shields.io/badge/coverage-82%25-brightgreen)
+![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 
 High-level CLI:
 * Run commands

{powercli-0.3.4 → powercli-0.3.6}/pyproject.toml

@@ -1,19 +1,20 @@
 [project]
 name = "powercli"
-version = "0.3.4"
+version = "0.3.6"
 description = "High-level CLI interaction"
 authors = [{name = "Quinten Roets", email = "qdr2104@columbia.edu"}]
-license = {text = "MIT"}
+license = "MIT"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-    "rich >=13.7.1, <14",
+    "pexpect >=4.9.0, <5",
+    "rich >=14.0.1, <15",
 ]
 
 [project.optional-dependencies]
 dev = [
     "hypothesis >=6.97.1, <7",
-    "package-dev-tools >=0.5.11, <1",
+    "package-dev-tools >=0.7.1, <1",
     "package-dev-utils >=0.1.6, <1",
     "superpathlib >=2.0.2, <3",
 ]
@@ -33,7 +34,7 @@ command_line = "-m pytest tests"
 
 [tool.coverage.report]
 precision = 4
-fail_under = 75
+fail_under = 100
 
 [tool.mypy]
 strict = true

{powercli-0.3.4 → powercli-0.3.6}/src/cli/__init__.py

@@ -3,7 +3,6 @@ from .commands import (
     capture_output_lines,
     capture_return_code,
     completes_successfully,
-    install,
     launch,
     launch_commands,
     open_urls,

{powercli-0.3.4 → powercli-0.3.6}/src/cli/commands/__init__.py

@@ -1,4 +1,3 @@
-from .install import install
 from .open_ import open_urls
 from .run import (
     capture_output,

{powercli-0.3.4 → powercli-0.3.6}/src/cli/commands/commands.py

@@ -1,19 +1,20 @@
 import os
 import shlex
-import types
 import typing
-from collections.abc import Iterable, Iterator
+from collections.abc import Iterable, Iterator, Sequence
 from dataclasses import dataclass
 from functools import cached_property
 from pathlib import Path
-from typing import Protocol
+from typing import Protocol, cast
 
 
 class StringLike(Protocol):
     def __str__(self) -> str: ...
 
 
-CommandItem = StringLike | dict[str, StringLike] | set[StringLike] | list[StringLike]
+CommandItem = (
+    StringLike | dict[str, StringLike] | Sequence[StringLike] | Iterator[StringLike]
+)
 
 
 @dataclass
@@ -42,7 +43,7 @@ class CommandPreparer:
         commands: tuple[str, ...]
         if self.should_use_root(command):
             if not command.startswith(self.root_keyword):
-                command = f"{self.root_keyword } {command}"
+                command = f"{self.root_keyword} {command}"
             if self.askpass_is_available:
                 command = command.replace(self.root_keyword, f"{self.root_keyword} -A")
         if self.use_console:
@@ -75,7 +76,7 @@ class CommandPreparer:
         if os.name == "posix":
             should_use_root = self.use_root or self.root_keyword in first_command_part
         else:
-            should_use_root = False
+            should_use_root = False  # pragma: nocover
         return should_use_root
 
     def generate_command_parts(self) -> Iterator[str]:
@@ -111,12 +112,12 @@ class CommandPreparer:
 
     @classmethod
     def extract_items(cls, item: CommandItem) -> Iterator[StringLike]:
-        collection_types = list, tuple, types.GeneratorType
+        collection_types = list, tuple, Iterator
         is_collection = any(
             isinstance(item, collection) for collection in collection_types
         )
         if is_collection:
-            yield from typing.cast(Iterable[StringLike], item)
+            yield from typing.cast("Iterable[StringLike]", item)
         elif isinstance(item, dict):
             for key, value in item.items():
                 yield f"--{key}"
@@ -126,4 +127,4 @@ class CommandPreparer:
             for part in item:
                 yield f"--{part}"
         elif hasattr(item, "__str__"):
-            yield item
+            yield cast("str", item)

{powercli-0.3.4 → powercli-0.3.6}/src/cli/commands/open_.py

@@ -7,6 +7,6 @@ from .run import launch
 def open_urls(*urls: StringLike) -> None:
     for url in urls:
         if os.name == "nt":
-            os.startfile(url)  # type: ignore[attr-defined] # noqa: S606
+            os.startfile(url)  # type: ignore[attr-defined] # noqa: S606 # pragma: nocover
         else:
             launch("xdg-open", url)

{powercli-0.3.4 → powercli-0.3.6}/src/cli/commands/runner.py

@@ -59,7 +59,7 @@ class Runner(Generic[T1]):
         import tempfile
 
         with tempfile.TemporaryFile() as untyped_log_file:
-            log_file = typing.cast(io.TextIOWrapper, untyped_log_file)
+            log_file = typing.cast("io.TextIOWrapper", untyped_log_file)
             self.run_in_tty(log_file)
             log_file.seek(0)
             return log_file.read()
@@ -72,7 +72,7 @@ class Runner(Generic[T1]):
         if self.capture_output is not None:
             child.expect(pexpect.EOF)
         else:
-            child.interact()
+            child.interact()  # pragma: nocover
 
     def capture_output(self) -> str:
         return self.run(capture_output=True).stdout.strip()
@@ -135,9 +135,10 @@ class Runner(Generic[T1]):
         try:
             return runner(*args, **kwargs)
         except subprocess.CalledProcessError as exception:
-            verbose = self.verbose_errors
-            verbose_exception = CalledProcessError(exception.stderr or exception)
-            raise verbose_exception from exception if verbose else exception
+            if self.verbose_errors:
+                verbose_exception = CalledProcessError(exception.stderr or exception)
+                raise verbose_exception from exception
+            raise
 
     def prepare_console_command(self) -> None:
         self.console = True

{powercli-0.3.4 → powercli-0.3.6}/src/cli/output/message.py

@@ -40,7 +40,7 @@ class Message:
         return self._message
 
     @message.setter
-    def message(self, message: str) -> None:
+    def message(self, message: str | None) -> None:
         if message is not None:
             self.show(message)
 

{powercli-0.3.4 → powercli-0.3.6}/src/cli/output/progress.py

@@ -5,9 +5,9 @@ from functools import cached_property
 from typing import TYPE_CHECKING, TypeVar
 
 if TYPE_CHECKING:
-    from collections.abc import Iterable, Iterator
+    from collections.abc import Iterable, Iterator  # pragma: nocover
 
-    from rich.progress import Progress
+    from rich.progress import Progress  # pragma: nocover
 
 
 T = TypeVar("T")

{powercli-0.3.4 → powercli-0.3.6}/src/cli/output/rich.py

@@ -7,7 +7,7 @@ import rich
 
 T = TypeVar("T")
 if TYPE_CHECKING:
-    from rich.console import Console
+    from rich.console import Console  # pragma: nocover
 
 
 class ObjectProxy(Generic[T]):

{powercli-0.3.4 → powercli-0.3.6}/src/cli/output/status.py

@@ -6,11 +6,10 @@ from typing import TYPE_CHECKING, Any
 from .rich import console
 
 if TYPE_CHECKING:
-    from rich.console import Status
+    from rich.console import Status  # pragma: nocover
 
 
 def status(*args: Any, **kwargs: Any) -> Status | contextlib.nullcontext[None]:
-    console.clear_live()
     use_status = not is_running_in_notebook()
     return console.status(*args, **kwargs) if use_status else contextlib.nullcontext()
 
@@ -21,5 +20,5 @@ def is_running_in_notebook() -> bool:
     except NameError:
         in_notebook = False
     else:
-        in_notebook = True
+        in_notebook = True  # pragma: nocover
     return in_notebook

{powercli-0.3.4 → powercli-0.3.6/src/powercli.egg-info}/PKG-INFO

@@ -1,26 +1,28 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: powercli
-Version: 0.3.4
+Version: 0.3.6
 Summary: High-level CLI interaction
 Author-email: Quinten Roets <qdr2104@columbia.edu>
-License: MIT
+License-Expression: MIT
 Project-URL: Source Code, https://github.com/quintenroets/cli
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: rich<14,>=13.7.1
+Requires-Dist: pexpect<5,>=4.9.0
+Requires-Dist: rich<15,>=14.0.1
 Provides-Extra: dev
 Requires-Dist: hypothesis<7,>=6.97.1; extra == "dev"
-Requires-Dist: package-dev-tools<1,>=0.5.11; extra == "dev"
+Requires-Dist: package-dev-tools<1,>=0.7.1; extra == "dev"
 Requires-Dist: package-dev-utils<1,>=0.1.6; extra == "dev"
 Requires-Dist: superpathlib<3,>=2.0.2; extra == "dev"
+Dynamic: license-file
 
 # PowerCLI
 [![PyPI version](https://badge.fury.io/py/powercli.svg)](https://badge.fury.io/py/powercli)
 ![PyPI downloads](https://img.shields.io/pypi/dm/powercli)
 ![Python version](https://img.shields.io/badge/python-3.10+-brightgreen)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS%20%7c%20windows-brightgreen)
-![Coverage](https://img.shields.io/badge/coverage-82%25-brightgreen)
+![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 
 High-level CLI:
 * Run commands

{powercli-0.3.4 → powercli-0.3.6}/src/powercli.egg-info/SOURCES.txt

@@ -8,7 +8,6 @@ src/cli/cli/__init__.py
 src/cli/cli/entry_point.py
 src/cli/commands/__init__.py
 src/cli/commands/commands.py
-src/cli/commands/install.py
 src/cli/commands/open_.py
 src/cli/commands/run.py
 src/cli/commands/runner.py
@@ -27,6 +26,9 @@ src/powercli.egg-info/entry_points.txt
 src/powercli.egg-info/requires.txt
 src/powercli.egg-info/top_level.txt
 tests/test_cli_entry_point.py
+tests/test_input.py
 tests/test_message.py
+tests/test_output.py
 tests/test_progress.py
+tests/test_run.py
 tests/test_runner.py

{powercli-0.3.4 → powercli-0.3.6}/src/powercli.egg-info/requires.txt

@@ -1,7 +1,8 @@
-rich<14,>=13.7.1
+pexpect<5,>=4.9.0
+rich<15,>=14.0.1
 
 [dev]
 hypothesis<7,>=6.97.1
-package-dev-tools<1,>=0.5.11
+package-dev-tools<1,>=0.7.1
 package-dev-utils<1,>=0.1.6
 superpathlib<3,>=2.0.2

powercli-0.3.6/tests/test_cli_entry_point.py

@@ -0,0 +1,16 @@
+import contextlib
+from unittest.mock import MagicMock, patch
+
+from package_dev_utils.tests.args import cli_args
+
+from cli import cli
+
+
+@patch("subprocess.run")
+@patch("subprocess.Popen")
+@cli_args("ls")
+def test_entry_point(mocked_popen: MagicMock, mocked_run: MagicMock) -> None:
+    with contextlib.suppress(FileNotFoundError):
+        cli.entry_point()
+    mocked_popen.assert_called_once()
+    mocked_run.assert_called_once()

powercli-0.3.6/tests/test_input.py

@@ -0,0 +1,25 @@
+from unittest.mock import MagicMock, patch
+
+from rich.prompt import Confirm, Prompt
+
+import cli
+
+word = "hello"
+
+
+@patch("builtins.input")
+def test_ask(mocked_input: MagicMock) -> None:
+    cli.ask(word)
+    mocked_input.assert_called_once()
+
+
+@patch.object(Prompt, "ask")
+def test_prompt(mocked_ask: MagicMock) -> None:
+    cli.prompt(word)
+    mocked_ask.assert_called_once()
+
+
+@patch.object(Confirm, "ask")
+def test_confirm(mocked_confirm: MagicMock) -> None:
+    cli.confirm(word)
+    mocked_confirm.assert_called_once()

powercli-0.3.6/tests/test_output.py

@@ -0,0 +1,30 @@
+from collections.abc import Iterator
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+from cli.output.message import Message
+
+from .test_progress import ITERATIONS
+
+
+@pytest.fixture
+def message() -> Iterator[Message]:
+    message = Message("hello")
+    with message:
+        yield message
+
+
+def test_message(message: Message) -> None:
+    for i in range(ITERATIONS):
+        message.message = str(i)
+
+
+@patch("os.get_terminal_size")
+def test_create_header(mocked_terminal_size: MagicMock, message: Message) -> None:
+    mocked_terminal_size.columns = 100
+    message.create_header()
+
+
+def test_extract_message(message: Message) -> None:
+    assert message.message

{powercli-0.3.4 → powercli-0.3.6}/tests/test_progress.py

@@ -6,7 +6,7 @@ import pytest
 import cli
 
 SLEEP_INTERVAL = 0.01
-ITERATIONS = 200
+ITERATIONS = 50
 
 
 # Best to inspect these tests manually

powercli-0.3.6/tests/test_run.py

@@ -0,0 +1,93 @@
+import subprocess
+from unittest.mock import MagicMock, patch
+
+import pytest
+from hypothesis import given
+from superpathlib import Path
+
+import cli
+from cli.commands.commands import CommandPreparer
+from cli.output.console import set_title
+
+from .test_runner import linux_only_test, text_strategy
+
+
+@linux_only_test
+def test_exception_handling() -> None:
+    with pytest.raises(cli.CalledProcessError):
+        cli.run("exit 1", shell=True)  # noqa: S604
+
+
+@linux_only_test
+def test_non_verbose_exception_handling() -> None:
+    with pytest.raises(subprocess.CalledProcessError):
+        cli.run("exit 1", shell=True, verbose_errors=False)  # noqa: S604
+
+
+def test_command_not_found_exception_handling() -> None:
+    with pytest.raises(FileNotFoundError):
+        cli.run("non_existing_command")
+
+
+def test_command_and_argument_combination() -> None:
+    cli.run("ls -l", "-a")
+
+
+def test_cwd() -> None:
+    with Path.tempdir() as folder:
+        extracted_folder_name = cli.capture_output("pwd", cwd=folder).split("/")[-1]
+    assert extracted_folder_name == folder.name
+
+
+@given(value=text_strategy())
+@linux_only_test
+def test_extra_subprocess_kwarg(value: str) -> None:
+    env = {"name": value}
+    assert cli.capture_output("echo", "$name", shell=True, env=env) == value  # noqa: S604
+
+
+def test_set_parsing() -> None:
+    commands = "python", {"version"}
+    cli.run(*commands)
+
+
+def test_iterator_parsing() -> None:
+    commands = ("python", iter(["--version"]))
+    cli.run(*commands)
+
+
+def test_dict_parsing() -> None:
+    commands = "git", {"work-tree": "."}, "status"
+    cli.run(*commands)
+
+
+@patch("subprocess.run")
+def test_title(mocked_popen: MagicMock) -> None:
+    cli.run("ls", title="ls", console=True)
+    mocked_popen.assert_called_once()
+
+
+def test_set_title() -> None:
+    set_title(title="ls")
+
+
+def test_sudo() -> None:
+    cli.run("sudo ls")
+
+
+def test_root() -> None:
+    cli.run("ls", root=True)
+
+
+@patch.object(CommandPreparer, "askpass_is_available", new=True)
+def test_root_with_askpass_enabled() -> None:
+    cli.run("ls", root=True)
+
+
+def test_root_in_shell() -> None:
+    cli.run("ls", root=True, shell=True)  # noqa: S604
+
+
+@patch.object(CommandPreparer, "askpass_is_available", new=True)
+def test_root_in_shell_with_askpass_enabled() -> None:
+    cli.run("ls", root=True, shell=True)  # noqa: S604

{powercli-0.3.4 → powercli-0.3.6}/tests/test_runner.py

@@ -1,12 +1,13 @@
 import os
 import string
+from unittest.mock import patch
 
 import pytest
 from hypothesis import given, settings, strategies
 from hypothesis.strategies import SearchStrategy
-from superpathlib import Path
 
 import cli
+from cli.commands.runner import Runner
 
 linux_only_test = pytest.mark.skipif(
     os.name != "posix",
@@ -28,7 +29,7 @@ def test_capture_output_lines(message: str) -> None:
     assert cli.capture_output_lines("printf", "%s", message) == message.splitlines()
 
 
-@settings(deadline=1000)
+@settings(deadline=3000)
 @given(message=text_strategy())
 def test_pipe_output_and_capture(message: str) -> None:
     commands = (
@@ -51,34 +52,30 @@ def test_completes_successfully(return_code: int) -> None:
     assert cli.completes_successfully("exit", return_code, shell=True) == success  # noqa: S604
 
 
-@linux_only_test
-def test_exception_handling() -> None:
-    with pytest.raises(cli.CalledProcessError):
-        cli.run("exit 1", shell=True)  # noqa: S604
+def test_run_commands() -> None:
+    commands = ("ls", "pwd")
+    cli.run_commands(*commands)
 
 
-def test_command_not_found_exception_handling() -> None:
-    with pytest.raises(FileNotFoundError):
-        cli.run("non_existing_command")
+def test_launch() -> None:
+    cli.launch("ls")
 
 
-def test_command_and_argument_combination() -> None:
-    cli.run("ls -l", "-a")
+def test_launch_commands() -> None:
+    cli.launch_commands("ls")
 
 
-def test_run_commands() -> None:
-    commands = ("ls", "pwd")
-    cli.run_commands(*commands)
+def test_run_commands_in_shell() -> None:
+    cli.run_commands_in_shell("ls")
 
 
-def test_cwd() -> None:
-    with Path.tempdir() as folder:
-        extracted_folder_name = cli.capture_output("pwd", cwd=folder).split("/")[-1]
-    assert extracted_folder_name == folder.name
+def test_open() -> None:
+    open_function = "os.startfile" if os.name == "nt" else "subprocess.Popen"
+    with patch(open_function) as mocked_open:
+        cli.open_urls("pwd")
+        mocked_open.assert_called_once()
 
 
-@given(value=text_strategy())
-@linux_only_test
-def test_extra_subprocess_kwarg(value: str) -> None:
-    env = {"name": value}
-    assert cli.capture_output("echo", "$name", shell=True, env=env) == value  # noqa: S604
+def test_tty() -> None:
+    if os.name != "nt":  # not supported on Windows
+        Runner(items=["ls"]).capture_tty_output()

powercli-0.3.4/src/cli/commands/install.py

@@ -1,31 +0,0 @@
-import platform
-import shlex
-import warnings
-from collections.abc import Iterator
-
-from .run import completes_successfully, run
-
-
-def install(*packages: str, install_command: str | None = None) -> None:
-    is_linux = platform.system() == "Linux"
-    if is_linux:
-        _install(*packages, install_command=install_command)
-    else:
-        message = "Required packages can only be installed on Linux"
-        warnings.warn(message, stacklevel=2)
-
-
-def _install(*packages: str, install_command: str | None = None) -> None:
-    if install_command is None:
-        install_command = next(extract_package_manager_command(), None)
-    assert install_command is not None
-    for package in packages:
-        args = shlex.split(package)
-        run(install_command, *args, root=True, check=False)
-
-
-def extract_package_manager_command() -> Iterator[str]:
-    commands = {"apt": "apt install -y", "pacman": "pacman -S --noconfirm"}
-    for package_manager, command in commands.items():
-        if completes_successfully("which", package_manager):
-            yield command

powercli-0.3.4/tests/test_cli_entry_point.py

@@ -1,11 +0,0 @@
-import contextlib
-
-from package_dev_utils.tests.args import cli_args
-
-from cli import cli
-
-
-@cli_args("ls")
-def test_entry_point() -> None:
-    with contextlib.suppress(FileNotFoundError):
-        cli.entry_point()