qcodes.utils.deprecate

exception qcodes.utils.deprecate.QCoDeSDeprecationWarning[source]

Bases: RuntimeWarning

Fix for DeprecationWarning being suppressed by default.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

qcodes.utils.deprecate.assert_deprecated(message: str) Iterator[None][source]
qcodes.utils.deprecate.assert_not_deprecated() Iterator[None][source]
qcodes.utils.deprecate.deprecate(reason: Optional[str] = None, alternative: Optional[str] = None) Callable[[...], Any][source]

A utility function to decorate deprecated functions and classes.

Parameters
  • reason – The reason of deprecation.

  • alternative – The alternative function or class to put in use instead of the deprecated one.

qcodes.utils.deprecate.deprecation_message(what: str, reason: Optional[str] = None, alternative: Optional[str] = None) str[source]
qcodes.utils.deprecate.issue_deprecation_warning(what: str, reason: Optional[str] = None, alternative: Optional[str] = None, stacklevel: int = 2) None[source]