qblox-instruments 1.4.2__py3-none-any.whl

qblox_instruments/__init__.py

@@ -0,0 +1,42 @@
+# SPDX-FileCopyrightText: © 2020 Qblox <https://qblox.com>
+# SPDX-License-Identifier: BSD-4-Clause
+
+from qblox_instruments.build import (
+    BuildInfo,
+    DeviceBuildInfo,
+    DeviceInfo,
+    get_build_info,
+    __version__,
+)
+from qblox_instruments.types import (
+    ClusterType,
+    InstrumentClass,
+    InstrumentType,
+    TypeHandle,
+)
+from qblox_instruments.cfg_man import ConfigurationManager, get_device_info
+from qblox_instruments.pnp import PlugAndPlay, resolve, AddressInfo, PortsInfo
+from qblox_instruments.native.definitions import (
+    SequencerStates,
+    SequencerStatus,
+    SequencerStatusFlags,
+    SequencerStatuses,
+    SystemStatus,
+    SystemStatusFlags,
+    SystemStatusSlotFlags,
+    SystemStatuses,
+)
+from qblox_instruments.qcodes_drivers import (
+    Cluster,
+    IOChannelQSM,
+    IOChannelQTM,
+    Module,
+    Quad,
+    Sequencer,
+    SpiRack,
+    TruthTable,
+)
+from qblox_instruments.ieee488_2 import (
+    DummyBinnedAcquisitionData,
+    DummyScopeAcquisitionData,
+)

qblox_instruments/_deprecation.py

@@ -0,0 +1,153 @@
+# SPDX-FileCopyrightText: © 2026 Qblox <https://qblox.com>
+# SPDX-License-Identifier: BSD-4-Clause
+
+
+import functools
+import inspect
+import warnings
+from collections.abc import Callable
+from functools import wraps
+from typing import Any, TypeVar
+
+F = TypeVar("F", bound=Callable[..., Any])
+
+
+def deprecate_positional_args_from(param_name: str) -> Callable[[F], F]:
+    """
+    Decorator to warn when arguments from `param_name` onwards are passed positionally.
+    Prepares users for a future version where a `*` will be inserted before `param_name`.
+    """
+
+    def decorator(func: F) -> F:
+        # Inspect the function to get a copy of its parameter names
+        sig = inspect.signature(func)
+        all_params = list(sig.parameters.keys())
+
+        # Find the index of the first parameter that should be kw-only
+        try:
+            cutoff_index = all_params.index(param_name)
+        except ValueError:
+            raise ValueError(f"Parameter '{param_name}' not found in {func.__name__}") from None
+
+        @wraps(func)
+        def wrapper(*args: Any, **kwargs: Any) -> Any:
+            if len(args) > cutoff_index:
+                # Find which should-be kw-only parameters were passed positionally
+                offending_params = all_params[cutoff_index : len(args)]
+                func_or_class_name = (
+                    func.__name__ if func.__name__ != "__init__" else args[0].__class__.__name__
+                )
+
+                warnings.warn(
+                    f"Passing {', '.join(offending_params)} positionally to {func_or_class_name}() "
+                    f"is deprecated and will raise an error in a future version. "
+                    f"Please use keyword arguments (e.g., {offending_params[0]}=...).",
+                    category=FutureWarning,
+                    stacklevel=2,
+                )
+
+            # Call the original function
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+def _find_stack_level() -> int:
+    """
+    Find the first place in the stack that is not inside qblox-scheduler.
+
+    Returns
+    -------
+    :
+        The stack level
+
+    """
+    frame = inspect.currentframe()
+    if frame is None:
+        return 1
+
+    stack = inspect.getouterframes(frame)
+    for i, frame_info in enumerate(stack):
+        if "qblox_scheduler" not in frame_info.filename:
+            return max(1, i - 1)
+    return 1
+
+
+def deprecated(
+    drop_version: str,
+    message_or_alias: str | Callable,
+) -> Callable:
+    """
+    A decorator for deprecating classes and methods.
+
+    Parameters
+    ----------
+    drop_version
+        A version of the package when the deprecated function or class will be dropped.
+    message_or_alias
+        Either an instruction about the usage of deprecated calls (string),
+        or the new drop-in replacement to the deprecated class or function (callable).
+
+    Returns
+    -------
+    :
+        The decorated function or class
+
+    """
+
+    def decorator(obj: Callable) -> Callable:
+        if callable(message_or_alias):
+            new_obj = message_or_alias
+            if isinstance(obj, type):
+                new_obj.__name__ = obj.__name__
+                new_obj.__qualname__ = obj.__qualname__
+            else:
+                new_obj.__name__ = obj.__name__
+                new_obj.__qualname__ = obj.__qualname__
+
+            @functools.wraps(obj)
+            def wrapper_func(*args, **kwargs):  # noqa: ANN202
+                warnings.warn(
+                    f"{obj.__name__} is deprecated and will be removed in "
+                    f"qblox-instruments>={drop_version}. Use {new_obj.__name__} instead.",
+                    category=FutureWarning,
+                    stacklevel=_find_stack_level(),
+                )
+                return new_obj(*args, **kwargs)
+
+            return wrapper_func
+        else:
+            msg = message_or_alias
+
+            if isinstance(obj, type):
+                original_init = obj.__init__
+
+                @functools.wraps(original_init)
+                def new_init(self, *args, **kwargs) -> None:
+                    warnings.warn(
+                        f"{obj.__name__} is deprecated and will be removed in "
+                        f"qblox-instruments>={drop_version}. {msg}",
+                        category=FutureWarning,
+                        stacklevel=_find_stack_level(),
+                    )
+                    original_init(self, *args, **kwargs)
+
+                obj.__init__ = new_init
+                return obj
+            else:
+
+                @functools.wraps(obj)
+                def wrapper_class(*args, **kwargs):  # noqa: ANN202
+                    warnings.warn(
+                        f"{obj.__name__} is deprecated and will be removed in "
+                        f"qblox-instruments>={drop_version}. {msg}",
+                        category=FutureWarning,
+                        stacklevel=_find_stack_level(),
+                    )
+                    return obj(*args, **kwargs)
+
+                return wrapper_class
+
+    return decorator