qbraid-cli 0.8.0.dev3__tar.gz → 0.8.0.dev4__tar.gz

{qbraid-cli-0.8.0.dev3/qbraid_cli.egg-info → qbraid_cli-0.8.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.0.dev3
+Version: 0.8.0.dev4
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
 Requires-Dist: jupyter_client<9.0.0,>=7.0.0
-Requires-Dist: qbraid-core>=0.1.1
+Requires-Dist: qbraid-core>=0.1.2
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: dev
@@ -43,6 +43,8 @@ Requires-Dist: sphinx-rtd-theme<2.1,>=1.3; extra == "docs"
 Requires-Dist: docutils<0.21; extra == "docs"
 Requires-Dist: toml; extra == "docs"
 Requires-Dist: build; extra == "docs"
+Requires-Dist: m2r; extra == "docs"
+Requires-Dist: typer; extra == "docs"
 
 <img width="full" alt="qbraid_cli" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid-cli-banner.png">
 

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/docs/requirements.txt

@@ -1,7 +1,7 @@
 sphinx~=7.2.6
 sphinx-rtd-theme>=1.3,<2.1
 docutils<0.21
-typer-cli
+typer
 m2r
 build
 toml

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.8.0.dev3"
+version = "0.8.0.dev4"
 description = "Command Line Interface for interacting with all parts of the qBraid platform."
 readme = "README.md"
 authors = [{ name = "qBraid Development Team", email = "contact@qbraid.com" }]
@@ -30,7 +30,7 @@ dependencies = [
     "typer>=0.12.1",
     "rich>=10.11.0",
     "jupyter_client>=7.0.0,<9.0.0",
-    "qbraid-core>=0.1.1",
+    "qbraid-core>=0.1.2",
 ]
 requires-python = ">= 3.9"
 
@@ -44,7 +44,7 @@ Discord = "https://discord.gg/KugF6Cnncm"
 [project.optional-dependencies]
 jobs = ["amazon-braket-sdk>=1.48.1"]
 dev = ["black", "isort", "pylint", "pytest"]
-docs = ["sphinx~=7.2.6", "sphinx-rtd-theme>=1.3,<2.1", "docutils<0.21", "toml", "build"]
+docs = ["sphinx~=7.2.6", "sphinx-rtd-theme>=1.3,<2.1", "docutils<0.21", "toml", "build", "m2r", "typer"]
 
 [project.scripts]
 qbraid = "qbraid_cli.main:app"

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/qbraid_cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.dev1+g272a1c1'
-__version_tuple__ = version_tuple = (0, 1, 'dev1', 'g272a1c1')
+__version__ = version = '0.1.dev1+g9f219cc'
+__version_tuple__ = version_tuple = (0, 1, 'dev1', 'g9f219cc')

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/qbraid_cli/handlers.py

@@ -44,7 +44,11 @@ def handle_error(
     full_message = f"\n{error_prefix} {message}\n"
     if include_traceback:
         tb_string = traceback.format_exc()
-        full_message += f"\n{tb_string}"
+        # TODO: find out reason for weird traceback emitted from
+        # qbraid jobs enable/disable when library not installed.
+        # For now, if matches, just don't print it.
+        if tb_string.strip() != "NoneType: None":
+            full_message += f"\n{tb_string}"
     typer.echo(full_message, err=True)
     raise typer.Exit(code=1)
 

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/qbraid_cli/jobs/app.py

@@ -5,8 +5,6 @@
 Module defining commands in the 'qbraid jobs' namespace.
 
 """
-
-import sys
 from typing import Any, Callable, Dict, Tuple
 
 import typer
@@ -68,7 +66,8 @@ def jobs_state(
     )
 ) -> None:
     """Display the state of qBraid Quantum Jobs for the current environment."""
-    state_values: Dict[str, Tuple[bool, bool]] = run_progress_get_state(library)
+    result: Tuple[str, Dict[str, Tuple[bool, bool]]] = run_progress_get_state(library)
+    python_exe, state_values = result
     state_values = dict(sorted(state_values.items()))
 
     console = Console()
@@ -76,7 +75,7 @@ def jobs_state(
     max_lib_length = max((len(lib) for lib in state_values.keys()), default=len(header_1))
     padding = max_lib_length + 9
 
-    console.print(f"Executable: {sys.executable}")
+    console.print(f"Executable: {python_exe}")
     console.print(f"\n{header_1:<{padding}}{header_2}", style="bold")
 
     for lib, (installed, enabled) in state_values.items():

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/qbraid_cli/jobs/toggle_braket.py

@@ -9,17 +9,10 @@ Module supporting 'qbraid jobs enable/disable braket' and commands.
 import logging
 import os
 import subprocess
-import sys
 from pathlib import Path
 from typing import Optional, Tuple
 
 import typer
-from qbraid_core.system import (
-    QbraidSystemError,
-    get_active_site_packages_path,
-    get_latest_package_version,
-    get_local_package_version,
-)
 
 from qbraid_cli.exceptions import QbraidException
 from qbraid_cli.handlers import handle_error, handle_filesystem_operation, run_progress_task
@@ -28,33 +21,38 @@ logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
 
-def get_package_data(package: str) -> Tuple[str, str, str]:
+def get_package_data(package: str) -> Tuple[str, str, str, str]:
     """Retrieve package version and location data.
 
     Args:
         package (str): The name of the package to retrieve data for.
 
     Returns:
-        Tuple[str, str, str]: The installed and latest versions of the package, and the
-                              local site-packages path where it is / would be installed.
+        Tuple[str, str, str, str]: The installed and latest versions of the package, and the
+                                   local site-packages path where it is / would be installed.
 
     Raises:
         QbraidException: If package version or location data cannot be retrieved.
 
     """
+    # pylint: disable=import-outside-toplevel
+    from qbraid_core.system import (
+        QbraidSystemError,
+        get_active_python_path,
+        get_active_site_packages_path,
+        get_latest_package_version,
+        get_local_package_version,
+    )
 
     try:
-        installed_version = get_local_package_version(package)
+        python_pathlib = get_active_python_path()
+        site_packages_path = get_active_site_packages_path(python_path=python_pathlib)
+        installed_version = get_local_package_version(package, python_path=python_pathlib)
         latest_version = get_latest_package_version(package)
     except QbraidSystemError as err:
-        raise QbraidException("Failed to retrieve package version information") from err
-
-    try:
-        site_packages_path = get_active_site_packages_path()
-    except QbraidSystemError as err:
-        raise QbraidException("Failed to retrieve site-package location") from err
+        raise QbraidException("Failed to retrieve required system and/or package metadata") from err
 
-    return installed_version, latest_version, site_packages_path
+    return installed_version, latest_version, str(site_packages_path), str(python_pathlib)
 
 
 def confirm_updates(
@@ -117,8 +115,6 @@ def confirm_updates(
         typer.echo("\nqBraidSystemExit: Exiting.")
         raise typer.Exit()
 
-    typer.echo("")
-
 
 def aws_configure_dummy() -> None:
     """
@@ -156,23 +152,23 @@ def aws_configure_dummy() -> None:
 
 def enable_braket(auto_confirm: bool = False):
     """Enable qBraid quantum jobs for Amazon Braket."""
-    installed, latest, path = run_progress_task(
+    installed, latest, path, python_exe = run_progress_task(
         get_package_data, "boto3", description="Solving environment..."
     )
 
     if not auto_confirm:
         confirm_updates("enable", path, installed_version=installed, latest_version=latest)
+    typer.echo("")
 
     aws_configure_dummy()  # TODO: possibly add another confirmation for writing aws config files
+
     try:
-        subprocess.check_call([sys.executable, "-m", "pip", "install", "--upgrade", "boto3"])
+        subprocess.check_call([python_exe, "-m", "pip", "install", "--upgrade", "boto3"])
+        subprocess.check_call([python_exe, "-m", "pip", "uninstall", "botocore", "-y", "--quiet"])
         subprocess.check_call(
-            [sys.executable, "-m", "pip", "uninstall", "botocore", "-y", "--quiet"]
+            [python_exe, "-m", "pip", "install", "git+https://github.com/qBraid/botocore.git"]
         )
-        subprocess.check_call(
-            [sys.executable, "-m", "pip", "install", "git+https://github.com/qBraid/botocore.git"]
-        )
-    except subprocess.CalledProcessError:
+    except (subprocess.CalledProcessError, FileNotFoundError):
         handle_error(message="Failed to enable qBraid quantum jobs.")
 
     typer.secho("\nSuccessfully enabled qBraid quantum jobs.", fg=typer.colors.GREEN, bold=True)
@@ -182,18 +178,19 @@ def enable_braket(auto_confirm: bool = False):
 def disable_braket(auto_confirm: bool = False):
     """Disable qBraid quantum jobs for Amazon Braket."""
     package = "botocore"
-    installed, latest, path = run_progress_task(
+    installed, latest, path, python_exe = run_progress_task(
         get_package_data, package, description="Solving environment..."
     )
     package = f"{package}~={installed}" if installed < latest else package
 
     if not auto_confirm:
         confirm_updates("disable", path)
+    typer.echo("")
 
     try:
         subprocess.check_call(
             [
-                sys.executable,
+                python_exe,
                 "-m",
                 "pip",
                 "install",
@@ -202,7 +199,7 @@ def disable_braket(auto_confirm: bool = False):
             ],
             stderr=subprocess.DEVNULL,
         )
-    except subprocess.CalledProcessError:
+    except (subprocess.CalledProcessError, FileNotFoundError):
         handle_error(message="Failed to disable qBraid quantum jobs.")
 
     typer.secho("\nSuccessfully disabled qBraid quantum jobs.", fg=typer.colors.GREEN, bold=True)

qbraid_cli-0.8.dev4/qbraid_cli/jobs/validation.py

@@ -0,0 +1,93 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module for validating command arguments for qBraid Quantum Jobs.
+
+"""
+import sys
+from typing import Any, Callable, Dict, Optional, Tuple
+
+import typer
+from rich.console import Console
+
+from qbraid_cli.handlers import handle_error, run_progress_task, validate_item
+
+LEGACY_ARGS: Dict[str, str] = {
+    "amazon_braket": "braket",
+    "aws_braket": "braket",
+}
+
+
+def validate_library(value: str) -> str:
+    """Validate quantum jobs library."""
+    # pylint:disable-next=import-outside-toplevel
+    from qbraid_core.services.quantum.proxy import SUPPORTED_QJOB_LIBS
+
+    qjobs_libs = list(SUPPORTED_QJOB_LIBS.keys())
+
+    if value in LEGACY_ARGS:
+        old_value = value
+        value = LEGACY_ARGS[value]
+
+        console = Console()
+        console.print(
+            f"[red]DeprecationWarning:[/red] Argument '{old_value}' "
+            f"is deprecated. Use '{value}' instead.\n"
+        )
+
+    return validate_item(value, qjobs_libs, "Library")
+
+
+def get_state(library: Optional[str] = None) -> Tuple[str, Dict[str, Tuple[bool, bool]]]:
+    """Get the state of qBraid Quantum Jobs for the specified library."""
+    from qbraid_core.services.quantum import QuantumClient
+
+    jobs_state = QuantumClient.qbraid_jobs_state(device_lib=library)
+
+    python_exe: str = jobs_state.get("exe", sys.executable)
+    libs_state: Dict[str, Any] = jobs_state.get("libs", {})
+
+    state_values = {
+        lib: (state["supported"], state["enabled"]) for lib, state in libs_state.items()
+    }
+
+    return python_exe, state_values
+
+
+def run_progress_get_state(
+    library: Optional[str] = None,
+) -> Tuple[str, Dict[str, Tuple[bool, bool]]]:
+    """Run get state function with rich progress UI."""
+    return run_progress_task(
+        get_state,
+        library,
+        description="Collecting package metadata...",
+        error_message=f"Failed to collect {library} package metadata.",
+    )
+
+
+def handle_jobs_state(
+    library: str,
+    action: str,  # 'enable' or 'disable'
+    action_callback: Callable[[], None],
+) -> None:
+    """Handle the common logic for enabling or disabling qBraid Quantum Jobs."""
+    _, state_values = run_progress_get_state(library)
+    installed, enabled = state_values[library]
+
+    if not installed:
+        handle_error(
+            message=f"{library} not installed."
+        )  # TODO: Provide command to install library?
+    if (enabled and action == "enable") or (not enabled and action == "disable"):
+        action_color = "green" if enabled else "red"
+        console = Console()
+        console.print(
+            f"\nqBraid quantum jobs already [bold {action_color}]{action}d[/bold {action_color}] "
+            f"for [magenta]{library}[/magenta].\n\nCheck the state of all quantum jobs "
+            "libraries in this environment with: \n\n\t$ qbraid jobs state\n"
+        )
+        raise typer.Exit()
+
+    action_callback()  # Perform the specific enable/disable action

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4/qbraid_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.0.dev3
+Version: 0.8.0.dev4
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
 Requires-Dist: jupyter_client<9.0.0,>=7.0.0
-Requires-Dist: qbraid-core>=0.1.1
+Requires-Dist: qbraid-core>=0.1.2
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: dev
@@ -43,6 +43,8 @@ Requires-Dist: sphinx-rtd-theme<2.1,>=1.3; extra == "docs"
 Requires-Dist: docutils<0.21; extra == "docs"
 Requires-Dist: toml; extra == "docs"
 Requires-Dist: build; extra == "docs"
+Requires-Dist: m2r; extra == "docs"
+Requires-Dist: typer; extra == "docs"
 
 <img width="full" alt="qbraid_cli" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid-cli-banner.png">
 

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/qbraid_cli.egg-info/requires.txt

@@ -1,7 +1,7 @@
 typer>=0.12.1
 rich>=10.11.0
 jupyter_client<9.0.0,>=7.0.0
-qbraid-core>=0.1.1
+qbraid-core>=0.1.2
 
 [dev]
 black
@@ -15,6 +15,8 @@ sphinx-rtd-theme<2.1,>=1.3
 docutils<0.21
 toml
 build
+m2r
+typer
 
 [jobs]
 amazon-braket-sdk>=1.48.1

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/tests/test_jobs/test_app/test_jobs_disable.py

@@ -14,8 +14,10 @@ from qbraid_core.services.quantum.proxy import SUPPORTED_QJOB_LIBS
 
 from qbraid_cli.jobs.app import jobs_disable
 
+qjob_libs = list(SUPPORTED_QJOB_LIBS.keys())
 
-@pytest.mark.parametrize("library", SUPPORTED_QJOB_LIBS)
+
+@pytest.mark.parametrize("library", qjob_libs)
 def test_library_validation_on_disable(library):
     """Test library validation function during the jobs disable command."""
     with (
@@ -35,7 +37,7 @@ def test_error_for_unsupported_library_on_disable():
         jobs_disable(library="unsupported_library")
 
 
-@pytest.mark.parametrize("library", SUPPORTED_QJOB_LIBS)
+@pytest.mark.parametrize("library", qjob_libs)
 def test_handle_jobs_state_integration_on_disable(library):
     """Test the handle_jobs_state function during the jobs disable command."""
     with (

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/tests/test_jobs/test_app/test_jobs_enable.py

@@ -15,8 +15,10 @@ from qbraid_core.services.quantum.proxy import SUPPORTED_QJOB_LIBS
 
 from qbraid_cli.jobs.app import jobs_enable
 
+qjobs_libs = list(SUPPORTED_QJOB_LIBS.keys())
 
-@pytest.mark.parametrize("library", SUPPORTED_QJOB_LIBS)
+
+@pytest.mark.parametrize("library", qjobs_libs)
 def test_library_validation(library):
     """Test library validation function during the jobs enable command."""
     with (
@@ -31,7 +33,7 @@ def test_library_validation(library):
             mock_validate_library.assert_called_once_with(library)
 
 
-@pytest.mark.parametrize("library", SUPPORTED_QJOB_LIBS)
+@pytest.mark.parametrize("library", qjobs_libs)
 def test_enable_action_for_supported_library(library):
     """Test the enable action for supported libraries."""
     if importlib.util.find_spec(library) is None:
@@ -50,7 +52,7 @@ def test_raise_error_for_unsupported_library():
         jobs_enable(library="unsupported_library")
 
 
-@pytest.mark.parametrize("library", SUPPORTED_QJOB_LIBS)
+@pytest.mark.parametrize("library", qjobs_libs)
 def test_handle_jobs_state_integration(library):
     """Test the handle_jobs_state function during the jobs enable command."""
     with (

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/tests/test_jobs/test_toggle_braket/test_disable_braket.py

@@ -7,7 +7,6 @@ Unit tests for the disable_braket function in the toggle_braket module.
 """
 
 import subprocess
-import sys
 from unittest.mock import patch
 
 import pytest
@@ -24,7 +23,7 @@ def test_helper_functions_invoked_correctly():
     with (
         patch(
             "qbraid_cli.jobs.toggle_braket.get_package_data",
-            return_value=("1.0.0", "1.1.0", "/some/path"),
+            return_value=("1.0.0", "1.1.0", "/some/path", "/usr/bin/python"),
         ) as mock_get_package_data_disable,
         patch("qbraid_cli.jobs.toggle_braket.confirm_updates") as mock_confirm_updates,
     ):
@@ -44,7 +43,7 @@ def test_package_version_specification_for_reinstallation():
     with (
         patch(
             "qbraid_cli.jobs.toggle_braket.get_package_data",
-            return_value=("1.0.0", "1.1.0", "/some/path"),
+            return_value=("1.0.0", "1.1.0", "/some/path", "/usr/bin/python"),
         ),
         patch("qbraid_cli.jobs.toggle_braket.confirm_updates"),
         patch("subprocess.check_call") as mock_check_call,
@@ -53,7 +52,7 @@ def test_package_version_specification_for_reinstallation():
 
         mock_check_call.assert_called_with(
             [
-                sys.executable,
+                "/usr/bin/python",
                 "-m",
                 "pip",
                 "install",
@@ -72,7 +71,7 @@ def test_subprocess_execution_and_error_handling():
     with (
         patch(
             "qbraid_cli.jobs.toggle_braket.get_package_data",
-            return_value=("1.0.0", "1.0.0", "/some/path"),
+            return_value=("1.0.0", "1.0.0", "/some/path", "/usr/bin/python"),
         ),
         patch("qbraid_cli.jobs.toggle_braket.confirm_updates"),
         patch("subprocess.check_call", side_effect=subprocess.CalledProcessError(1, "cmd")),
@@ -87,7 +86,7 @@ def test_success_message_displayed():
     with (
         patch(
             "qbraid_cli.jobs.toggle_braket.get_package_data",
-            return_value=("1.0.0", "1.0.0", "/some/path"),
+            return_value=("1.0.0", "1.0.0", "/some/path", "/usr/bin/python"),
         ),
         patch("qbraid_cli.jobs.toggle_braket.confirm_updates"),
         patch("subprocess.check_call"),

{qbraid-cli-0.8.0.dev3 → qbraid_cli-0.8.dev4}/tests/test_jobs/test_toggle_braket/test_enable_braket.py

@@ -7,7 +7,6 @@ Unit tests for the enable_braket function in the toggle_braket module.
 """
 
 import subprocess
-import sys
 from unittest.mock import call, patch
 
 import pytest
@@ -21,7 +20,7 @@ def test_helper_function_invocations():
     with (
         patch(
             "qbraid_cli.jobs.toggle_braket.get_package_data",
-            return_value=("1.0.0", "1.2.0", "/some/path"),
+            return_value=("1.0.0", "1.2.0", "/some/path", "/usr/bin/python"),
         ) as mock_get_package_data,
         patch("qbraid_cli.jobs.toggle_braket.confirm_updates") as mock_confirm_updates,
         patch("qbraid_cli.jobs.toggle_braket.aws_configure_dummy") as mock_aws_configure_dummy,
@@ -36,10 +35,12 @@ def test_helper_function_invocations():
 
 def test_subprocess_calls():
     """Test the subprocess calls within `enable_braket`."""
+    mock_python_path = "/usr/bin/python"
+
     with (
         patch(
             "qbraid_cli.jobs.toggle_braket.get_package_data",
-            return_value=("1.0.0", "1.2.0", "/some/path"),
+            return_value=("1.0.0", "1.2.0", "/some/path", mock_python_path),
         ),
         patch("qbraid_cli.jobs.toggle_braket.confirm_updates"),
         patch("qbraid_cli.jobs.toggle_braket.aws_configure_dummy"),
@@ -49,11 +50,11 @@ def test_subprocess_calls():
 
         # Expected subprocess calls in order
         expected_calls = [
-            call([sys.executable, "-m", "pip", "install", "--upgrade", "boto3"]),
-            call([sys.executable, "-m", "pip", "uninstall", "botocore", "-y", "--quiet"]),
+            call([mock_python_path, "-m", "pip", "install", "--upgrade", "boto3"]),
+            call([mock_python_path, "-m", "pip", "uninstall", "botocore", "-y", "--quiet"]),
             call(
                 [
-                    sys.executable,
+                    mock_python_path,
                     "-m",
                     "pip",
                     "install",
@@ -69,7 +70,7 @@ def test_subprocess_error_handling():
     with (
         patch(
             "qbraid_cli.jobs.toggle_braket.get_package_data",
-            return_value=("1.0.0", "1.2.0", "/some/path"),
+            return_value=("1.0.0", "1.2.0", "/some/path", "/usr/bin/python"),
         ),
         patch("qbraid_cli.jobs.toggle_braket.confirm_updates"),
         patch("qbraid_cli.jobs.toggle_braket.aws_configure_dummy"),
@@ -87,7 +88,7 @@ def test_success_feedback():
     with (
         patch(
             "qbraid_cli.jobs.toggle_braket.get_package_data",
-            return_value=("1.0.0", "1.2.0", "/some/path"),
+            return_value=("1.0.0", "1.2.0", "/some/path", "/usr/bin/python"),
         ),
         patch("qbraid_cli.jobs.toggle_braket.confirm_updates"),
         patch("qbraid_cli.jobs.toggle_braket.aws_configure_dummy"),