qbraid-core 0.1.0.dev1__tar.gz → 0.1.0.dev3__tar.gz

{qbraid-core-0.1.0.dev1 → qbraid-core-0.1.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-core
-Version: 0.1.0.dev1
+Version: 0.1.0.dev3
 Summary: Python library with core abstractions for software development in the qBraid ecosystem.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -25,6 +25,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
+Requires-Dist: urllib3
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: isort; extra == "dev"

{qbraid-core-0.1.0.dev1 → qbraid-core-0.1.0.dev3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-core"
-version = "0.1.0.dev1"
+version = "0.1.0.dev3"
 authors = [
     {name = "qBraid Development Team", email = "contact@qbraid.com"},
 ]
@@ -26,7 +26,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-dependencies = ["requests"]
+dependencies = ["requests", "urllib3"]
 
 [project.urls]
 Homepage = "https://www.qbraid.com/"

{qbraid-core-0.1.0.dev1 → qbraid-core-0.1.0.dev3}/qbraid_core/__init__.py

@@ -40,6 +40,7 @@ Exceptions
    RequestsApiError
 
 """
+from ._warnings import _check_version, _disable_urllib3
 from .client import QbraidClient
 from .exceptions import (
     AuthError,
@@ -104,3 +105,7 @@ def client(*args, **kwargs):
         A service client instance.
     """
     return _get_default_session().client(*args, **kwargs)
+
+
+_disable_urllib3()
+_check_version("qbraid-core")

{qbraid-core-0.1.0.dev1 → qbraid-core-0.1.0.dev3}/qbraid_core/_version.py

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

qbraid-core-0.1.0.dev3/qbraid_core/_warnings.py

@@ -0,0 +1,45 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module for emitting and disabling warnings at top level.
+
+"""
+import warnings
+
+import urllib3
+
+from .exceptions import QbraidException
+from .system import get_latest_package_version, get_local_package_version
+
+
+def _warn_new_version(local: str, latest: str) -> bool:
+    """Returns True if you should warn user about updated package version,
+    False otherwise."""
+    installed_major, installed_minor = map(int, local.split(".")[:2])
+    latest_major, latest_minor = map(int, latest.split(".")[:2])
+
+    return (installed_major, installed_minor) < (latest_major, latest_minor)
+
+
+def _check_version(package: str) -> None:
+    """Emits UserWarning if updated package version exists."""
+    try:
+        latest_version = get_latest_package_version(package)
+        local_version = get_local_package_version(package)
+
+        if _warn_new_version(local_version, latest_version):
+            warnings.warn(
+                f"You are using {package} version {local_version}, however, version "
+                f"{latest_version} is available. To avoid compatibility issues, consider "
+                "upgrading.",
+                UserWarning,
+            )
+    except QbraidException:
+        pass
+
+
+# coverage: ignore
+def _disable_urllib3() -> None:
+    """Disables urllib3 InsecureRequestWarning warning."""
+    urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)

{qbraid-core-0.1.0.dev1 → qbraid-core-0.1.0.dev3}/qbraid_core/services/quantum/proxy.py

@@ -22,7 +22,7 @@ SUPPORTED_QJOB_LIBS = ["braket"]
 
 def _check_proxy(
     proxy_spec: Tuple[str, ...], slug_path: Optional[Path] = None
-) -> Tuple[bool, bool]:
+) -> Tuple[bool, bool, Path]:
     """
     Checks if the specified proxy file exists and contains the string 'qbraid'.
 
@@ -32,9 +32,13 @@ def _check_proxy(
         slug_path (optional, Path): The base path to prepend to the 'pyenv' directory.
 
     Returns:
-        A tuple of two booleans: The first indicates whether the specified proxy file exists;
-        the second, if the file exists, is True if it contains 'qbraid', False otherwise.
+        A tuple of two booleans and sitepackages path: The first bool indicates whether the
+        specified proxy file exists; the second bool, if the file exists, is True if it contains
+        'qbraid', False otherwise. The sitepackages path gives the location of the site-packages
+        directory where the proxy file is located.
     """
+    site_packages_path = None
+
     try:
         if slug_path is None:
             site_packages: str = get_active_site_packages_path()
@@ -43,26 +47,26 @@ def _check_proxy(
             site_packages_path = get_venv_site_packages_path(slug_path / "pyenv")
     except QbraidException as err:
         logger.debug(err)
-        return False, False
+        return False, False, site_packages_path
 
     target_file_path = site_packages_path.joinpath(*proxy_spec)
 
     if not target_file_path.exists():
-        return False, False
+        return False, False, site_packages_path
 
     try:
         with target_file_path.open("r", encoding="utf-8") as file:
             for line in file:
                 if "qbraid" in line:
                     return True, True, site_packages_path
-        return True, False
+        return True, False, site_packages_path
     except Exception as err:  # pylint: disable=broad-exception-caught
         logger.debug("Unexpected error checking qBraid proxy: %s", err)
 
-    return True, False
+    return True, False, site_packages_path
 
 
-def quantum_lib_proxy_state(device_lib: str) -> Dict[str, Union[str, bool]]:
+def quantum_lib_proxy_state(device_lib: str, **kwargs) -> Dict[str, Union[str, bool]]:
     """Checks if qBraid Quantum Jobs are supported and if so, checks whether they are enabled.
     Returns dictionary providing information about the state of qBraid Quantum Jobs support
     and configuration for the given quantum device library.
@@ -91,11 +95,12 @@ def quantum_lib_proxy_state(device_lib: str) -> Dict[str, Union[str, bool]]:
     if device_lib == "braket":
         proxy_lib = "botocore"
         proxy_spec = (proxy_lib, "httpsession.py")
-        supported, enabled = _check_proxy(proxy_spec)
+        supported, enabled, path = _check_proxy(proxy_spec, **kwargs)
 
     # add more device libraries here as needed
 
     state["proxy_lib"] = proxy_lib
     state["supported"] = supported
     state["enabled"] = enabled
+    state["path"] = str(path)
     return state

{qbraid-core-0.1.0.dev1 → qbraid-core-0.1.0.dev3}/qbraid_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-core
-Version: 0.1.0.dev1
+Version: 0.1.0.dev3
 Summary: Python library with core abstractions for software development in the qBraid ecosystem.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -25,6 +25,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
+Requires-Dist: urllib3
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: isort; extra == "dev"

{qbraid-core-0.1.0.dev1 → qbraid-core-0.1.0.dev3}/qbraid_core.egg-info/SOURCES.txt

@@ -28,6 +28,7 @@ docs/api/qbraid_core.services.rst
 docs/api/qbraid_core.system.rst
 qbraid_core/__init__.py
 qbraid_core/_version.py
+qbraid_core/_warnings.py
 qbraid_core/client.py
 qbraid_core/exceptions.py
 qbraid_core/registry.py
@@ -63,6 +64,7 @@ tests/test_client.py
 tests/test_environments.py
 tests/test_session.py
 tests/test_system.py
+tests/test_warnings.py
 tests/fixtures/__init__.py
 tests/fixtures/environments.py
 tools/verify_headers.py

{qbraid-core-0.1.0.dev1 → qbraid-core-0.1.0.dev3}/qbraid_core.egg-info/requires.txt

@@ -1,4 +1,5 @@
 requests
+urllib3
 
 [dev]
 black

qbraid-core-0.1.0.dev3/tests/test_warnings.py

@@ -0,0 +1,31 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Unit tests related to qBraid core functionality and system configurations.
+
+"""
+import pytest
+
+from qbraid_core._warnings import _warn_new_version
+
+check_version_data = [
+    # local, API, warn
+    ("0.1.0", "0.1.1", False),
+    ("1.0.7", "1.0.8", False),
+    ("1.3.2", "2.0.6", True),
+    ("0.1.0", "0.3.0", True),
+    ("0.2.4.dev1", "0.2.4", False),
+    ("0.1.0", "0.1.0.dev0", False),
+    ("0.1.6.dev2", "0.1.6.dev5", False),
+    ("0.1.6.dev5", "0.1.6.dev2", False),
+    ("0.2.0", "0.1.4", False),
+]
+
+
+@pytest.mark.parametrize("test_data", check_version_data)
+def test_check_version(test_data):
+    """Test function that compares local/api package versions to determine if
+    update is needed."""
+    local, api, warn_bool = test_data
+    assert warn_bool == _warn_new_version(local, api)

{qbraid-core-0.1.0.dev1 → qbraid-core-0.1.0.dev3}/tools/verify_headers.py

@@ -19,13 +19,27 @@ header = """# Copyright (c) 2024, qBraid Development Team
 # All rights reserved.
 """
 
+header_gpl = """# Copyright (C) 2024 qBraid
+#
+# This file is part of the qBraid-SDK
+#
+# The qBraid-SDK is free software released under the GNU General Public License v3
+# or later. You can redistribute and/or modify it under the terms of the GPL v3.
+# See the LICENSE file in the project root or <https://www.gnu.org/licenses/gpl-3.0.html>.
+#
+# THERE IS NO WARRANTY for the qBraid-SDK, as per Section 15 of the GPL v3.
+"""
+
+header_2023 = header.replace("2024", "2023")
+header_gpl_2023 = header_gpl.replace("2024", "2023")
+
 skip_files = ["qbraid_core/_version.py"]
 
 failed_headers = []
 fixed_headers = []
 
 
-def should_skip(file_path, content):
+def should_skip(file_path: str, content: str) -> bool:
     if file_path in skip_files:
         return True
 
@@ -45,11 +59,17 @@ def should_skip(file_path, content):
     return False
 
 
-def replace_or_add_header(file_path, fix=False):
+def replace_or_add_header(file_path: str, fix: bool = False) -> None:
     with open(file_path, "r", encoding="ISO-8859-1") as f:
         content = f.read()
 
-    if content.startswith(header) or should_skip(file_path, content):
+    if (
+        content.startswith(header)
+        or content.startswith(header_2023)
+        or content.startswith(header_gpl)
+        or content.startswith(header_gpl_2023)
+        or should_skip(file_path, content)
+    ):
         return
 
     if not fix:
@@ -76,7 +96,7 @@ def replace_or_add_header(file_path, fix=False):
     fixed_headers.append(file_path)
 
 
-def process_files_in_directory(directory, fix=False):
+def process_files_in_directory(directory: str, fix: bool = False) -> int:
     count = 0
     for root, _, files in os.walk(directory):
         for file in files:
@@ -87,9 +107,29 @@ def process_files_in_directory(directory, fix=False):
     return count
 
 
+def display_help() -> None:
+    help_message = """
+    Usage: python verify_headers.py SRC [OPTIONS] ...
+
+    This script checks for copyright headers at the specified path.
+    If no flags are passed, it will indicate which files would be
+    modified without actually making any changes.
+    
+    Options:
+    --help      Display this help message and exit.
+    --fix       Adds/modifies file headers as necessary.
+    """
+    print(help_message)
+    sys.exit(0)
+
+
 if __name__ == "__main__":
-    if len(sys.argv) < 2:
-        print("Please provide at least one directory as a command-line argument.")
+    if "--help" in sys.argv:
+        display_help()
+
+    # Check if at least two arguments are provided and the first argument is not a flag
+    if len(sys.argv) < 2 or sys.argv[1].startswith("--"):
+        print("Usage: python verify_headers.py SRC [OPTIONS] ...")
         sys.exit(1)
 
     script_directory = os.path.dirname(os.path.abspath(__file__))
@@ -97,16 +137,19 @@ if __name__ == "__main__":
     skip_files = [os.path.join(project_directory, file_path) for file_path in skip_files]
 
     fix = "--fix" in sys.argv
-    directories = [arg for arg in sys.argv[1:] if arg != "--fix"]
+    files_and_dirs = [arg for arg in sys.argv[1:] if arg != "--fix"]
 
     checked = 0
-    for directory in directories:
-        full_directory_path = os.path.join(project_directory, directory)
-        if os.path.isdir(full_directory_path):
-            checked += process_files_in_directory(full_directory_path, fix)
+    for item in files_and_dirs:
+        full_path = os.path.join(project_directory, item)
+        if os.path.isdir(full_path):
+            checked += process_files_in_directory(full_path, fix)
+        elif os.path.isfile(full_path) and full_path.endswith(".py"):
+            replace_or_add_header(full_path, fix)
+            checked += 1
         else:
-            failed_headers.append(full_directory_path)
-            print(f"Directory not found: {full_directory_path}")
+            failed_headers.append(full_path)
+            print(f"Directory not found: {full_path}")
 
     if not fix:
         if failed_headers: