g8dZddlZddlZddlZddlZddlZddlZddlZddlZddlm Z m Z m Z m Z m Z mZddlmZmZddlmZGddZGd d ejZGd d eZGd deZdS)z#Lazy testers for optional features.N)UnionIterableDictOptionalCallableType)MissingOptionalLibraryErrorOptionalDependencyImportWarning) wrap_methodc"eZdZdZdZdZdZdS) _RequireNowzHelper callable that accepts all function signatures and simply calls :meth:`.LazyDependencyManager.require_now`. This helpful when used with :func:`.wrap_method`, as the callable needs to be compatible with all signatures and be picklable._tester_featurec"||_||_dSNr)selftesterfeatures N/granary/edev/quantum/lib/python3.11/site-packages/qiskit/utils/lazy_tester.py__init__z_RequireNow.__init__$s  cD|j|jdSr)r require_nowr)r_args_kwargss r__call__z_RequireNow.__call__(s    /////rN)__name__ __module__ __qualname____doc__ __slots__rrrrrrsETT(I   00000rrcXeZdZdZdZddddddZejdefdZ dZ e j d e de fd Ze j d ede e ge ffd Zd Ze j d edefdZe j d ede egeffdZdZdefdZejdZdS)LazyDependencyManageraoA mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as ``if x``, and will evaluate ``True`` if the dependency they test for is available, and ``False`` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. These objects also encapsulate the error handling if their dependency is not present, so you can do things such as:: from qiskit.utils import LazyImportManager HAS_MATPLOTLIB = LazyImportManager("matplotlib") @HAS_MATPLOTLIB.require_in_call def my_visualisation(): ... def my_other_visualisation(): # ... some setup ... HAS_MATPLOTLIB.require_now("my_other_visualisation") ... def my_third_visualisation(): if HAS_MATPLOTLIB: from matplotlib import pyplot else: ... In all of these cases, ``matplotlib`` is not imported until the functions are entered. In the case of the decorator, ``matplotlib`` is tested for import when the function is called for the first time. In the second and third cases, the loader attempts to import ``matplotlib`` when the :meth:`require_now` method is called, or when the Boolean context is evaluated. For the ``require`` methods, an error is raised if the library is not available. This is the base class, which provides the Boolean context checking and error management. The concrete classes :class:`LazyImportTester` and :class:`LazySubprocessTester` provide convenient entry points for testing that certain symbols are importable from modules, or certain command-line tools are available, respectively. _bool _callback_name_install_msgNnamecallbackinstallmsgcLd|_||_||_||_||_dS)a Args: name: the name of this optional dependency. callback: a callback that is called immediately after the availability of the library is tested with the result. This will only be called once. install: how to install this optional dependency. Passed to :class:`.MissingOptionalLibraryError` as the ``pip_install`` parameter. msg: an extra message to include in the error raised if this is required. Nr')rr.r/r0r1s rrzLazyDependencyManager.__init__Xs+ !   rreturncdS)a4Subclasses of :class:`LazyDependencyManager` should override this method to implement the actual test of availability. This method should return a Boolean, where ``True`` indicates that the dependency was available. This method will only ever be called once. :meta public: Fr$rs r _is_availablez#LazyDependencyManager._is_availablehs urc|j:||_|j||j|jSr)r(r6r)r5s r__bool__zLazyDependencyManager.__bool__rsA : ++--DJ~)tz***zrfeature_or_callablecdSrr$rr9s rrequire_in_callz%LazyDependencyManager.require_in_callysJM#rcdSrr$r;s rr<z%LazyDependencyManager.require_in_call|s[^[^rct|tr |fd}|S|tddptddpttjfd}|S)aCreate a decorator for callables that requires that the dependency is available when the decorated function or method is called. Args: feature_or_callable (str or Callable): the name of the feature that requires these dependencies. If this function is called directly as a decorator (for example ``@HAS_X.require_in_call`` as opposed to ``@HAS_X.require_in_call("my feature")``), then the feature name will be taken to be the function name, or class and method name as appropriate. Returns: Callable: a decorator that will make its argument require this dependency before it is called. cLtjfd}|S)Nc>|i|Srrargskwargsrfunctionrs routzELazyDependencyManager.require_in_call..decorator..outs,$$W---#8T4V444r) functoolswraps)rErFrrs` r decoratorz8LazyDependencyManager.require_in_call..decoratorsC**555555+*5 rr!Nrc>|i|SrrArBs rrFz2LazyDependencyManager.require_in_call..outs,   W % % %8T,V,, ,r) isinstancestrgetattrrGrH)rr9rIrFrrEs` @@rr<z%LazyDependencyManager.require_in_calls )3 / / )G       & Hnd 3 3 xT22 8}}   " " - - - - - - # " - rfeature_or_classcdSrr$rrNs rrequire_in_instancez)LazyDependencyManager.require_in_instancesCF3rcdSrr$rPs rrQz)LazyDependencyManager.require_in_instancesTWTWrct|tr |fd}|S|}t|ddpt|ddpt|t|dt |S)aA class decorator that requires the dependency is available when the class is initialized. This decorator can be used even if the class does not define an ``__init__`` method. Args: feature_or_class (str or Type): the name of the feature that requires these dependencies. If this function is called directly as a decorator (for example ``@HAS_X.require_in_instance`` as opposed to ``@HAS_X.require_in_instance("my feature")``), then the feature name will be taken as the name of the class. Returns: Callable: a class decorator that ensures that the wrapped feature is present if the class is initialized. cHt|dt|S)Nrbefore)r r)class_rrs rrIz.decorators'FJ{47Q7QRRRR rr!NrrrU)rKrLrMr r)rrNrIrWrs` @rrQz)LazyDependencyManager.require_in_instances & , , &G       ! FND 1 1 vz400 6{{  FJ{4/I/IJJJJ rrcN|rdSt|j||j|j)aBEagerly attempt to import the dependencies in this object, and raise an exception if they cannot be imported. Args: feature: the name of the feature that is requiring these dependencies. Raises: MissingOptionalLibraryError: if the dependencies cannot be imported. N)libnamer. pip_installr1)r r*r+r,)rrs rrz!LazyDependencyManager.require_nows7   F)JW$-TY    rc#VK|j}d|_ dV||_dS#||_wxYw)a Create a context, during which the value of the dependency manager will be ``False``. This means that within the context, any calls to this object will behave as if the dependency is not available, including raising errors. It is valid to call this method whether or not the dependency has already been evaluated. This is most useful in tests. FN)r()rpreviouss rdisable_locallyz%LazyDependencyManager.disable_locallysB:  " EEE!DJJJDJ ! ! ! !s ()rr r!r"r#rabcabstractmethodboolr6r8typingoverloadrr<rLrrQr contextlibcontextmanagerr]r$rrr&r&,s''RDI#dDd  t _M8MMMM_M _^3^8XJPXDX;Y^^^_^(((T _FDFTFFF_F _WCWHdVT\ import , , ...``. If simply a string or iterable of strings, then it should be valid to write ``import `` for each of them. Raises: ValueError: if no modules are given. c4i|]\}}|t|Sr$)tuple).0modulenamess r z-LazyImportTester.__init__.. s$cccmfeVU5\\cccrr$ci|]}|dS)r$r$)rlrms rroz-LazyImportTester.__init__..sJJJFVRJJJrzno modules suppliedNr z, z and r-) rKdictitemsrgrL ValueErrorlenkeysrkjoinsuperr)rrhr.r/r0r1 all_names __class__s rrzLazyImportTester.__init__s0( )4 0 0 KccGZG`G`GbGbcccDMM +S 1 1 K0"5DMMJJ6IJJJDM} 4233 3      1 $ $m((**GTTdm002233Iii #2#//EEimEED dXwCPPPPPrc i}tjt}|jD]\}} t j|}n#t$r`}|j d}| d}||dt|krYd}~dS|||<Yd}~d}~wt$r}|||<Yd}~d}~wwxYw|D]>} t|| } #t$r||| Y;wxYw|s|r|jr d|jdnd} d| d} |D]#\}}| dd|d |z } $|D]H\}}t|d kr d |d dnd |} | dd|d| dz } It#j| t&dSdS)N.F'zoptional packageszWhile trying to import z, some components were located but raised other errors during import. You might have an incompatible version installed. Qiskit will continue as if the optional is not available.z - module 'z' failed to import with: r z attribute 'rz attributes z - 'z' imported, but z couldn't be found)categoryT) collections defaultdictlistrgrs importlib import_moduleModuleNotFoundErrorr.splitru ImportErrorrMAttributeErrorappendr*rwwarningswarnr )rfailed_modules failed_namesrmrnimportedexc failed_parts target_partsr._package_descriptionmessage attributess rr6zLazyImportTester._is_availables".t44 !]0022 6 6MFE $26::&   "x~~c22 %||C00 <0C#l2C2C0C#DDD!555555),v&   ),v&  6 66$//AA%666 (//555556 6  \ 7;z"Z"3dj"3"3"3"3GZ M*=MMM  .3355 ] ] 277#[6#[#[TW#[#[\\\!-!3!3!5!5 d d :=e**//6586666Od]bOdOd 277#bF#b#bJ#b#b#bccc M',K L L L L5ts<A CA B5+B55 CC  CC**%DD)rr r!r"r#rrLrrrrr`rr6 __classcell__rzs@rrfrfsOOI #59!%!#Q#Q#Q"3S(3--?(@(3-#OP#Qsm #Q 8TFDL12 #Q # #Qc]#Q#Q#Q#Q#Q#QJ'''''''rrfc eZdZdZdZddddddeeeefdeedee e gdfdeed eef fd Z d Z xZ S) LazySubprocessTesterzA lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. )_commandNr-commandr.r/r0r1ct|tr|fnt||_|jst dt |p |jd|||dS)z Args: command: the strings that make up the command to be run. For example, ``["pdflatex", "-version"]``. Raises: ValueError: if an empty command is given. zno command suppliedrr-N)rKrLrkrrtrxr)rrr.r/r0r1rzs rrzLazySubprocessTester.__init__Msu"'1#&>&>R E'NN } 4233 3 d6dmA&6SZ`cdddddrc tj|jdtjtjdS#ttjf$rYdSwxYw)NT)checkstdoutstderrF) subprocessrunrDEVNULLOSErrorSubprocessErrorr5s rr6z"LazySubprocessTester._is_availablecsd  N T*2DZM_     434   55 s15AA)rr r!r"r#rrLrrrr`rr6rrs@rrrFsI #59!%!eeesHSM)*esm e 8TFDL12 e # ec]eeeeee,rr)r"r^rrcrGrrrarrrrrrrqiskit.exceptionsr r classtoolsr rABCr&rfrr$rrrs*)  BBBBBBBBBBBBBBBBZZZZZZZZ###### 0 0 0 0 0 0 0 0B"B"B"B"B"CGB"B"B"JRRRRR,RRRj%%%%%0%%%%%r