z i-2SrSSKrSSKJr "SS\5rg)z$Container class for backend options.N)Mappingc^\rSrSrSrSrSrSrSrSr \ S5r S r S r S rU4S jrS rU4SjrSrSrSrSrU4SjrSrU=r$)OptionsaBase options object This class is what all backend options are based on. The properties of the class are intended to be all dynamically adjustable so that a user can reconfigure the backend on demand. If a property is immutable to the user (eg something like number of qubits) that should be a configuration of the backend class itself instead of the options. Instances of this class behave like dictionaries. Accessing an option with a default value can be done with the `get()` method: >>> options = Options(opt1=1, opt2=2) >>> options.get("opt1") 1 >>> options.get("opt3", default="hello") 'hello' Key-value pairs for all options can be retrieved using the `items()` method: >>> list(options.items()) [('opt1', 1), ('opt2', 2)] Options can be updated by name: >>> options["opt1"] = 3 >>> options.get("opt1") 3 Runtime validators can be registered. See `set_validator`. Updates through `update_options` and indexing (`__setitem__`) validate the new value before performing the update and raise `ValueError` if the new value is invalid. >>> options.set_validator("opt1", (1, 5)) >>> options["opt1"] = 4 >>> options["opt1"] 4 >>> options["opt1"] = 10 # doctest: +ELLIPSIS Traceback (most recent call last): ... ValueError: ... _fields validatorc URU$Nr)selfkeys R/home/james-whalen/.local/lib/python3.13/site-packages/qiskit/providers/options.py __getitem__Options.__getitem__is||C  c,[UR5$r )iterrr s r__iter__Options.__iter__lsDLL!!rc,[UR5$r )lenrrs r__len__Options.__len__os4<<  rc*UR"S0X0D6 g)N)update_optionsr rvalues r __setitem__Options.__setitem__ts +sl+rcUR$r r rs r__dict__Options.__dict__ys ||rcfURU$![an[SUS35UeSnAff=f)NzOption z is not defined)rKeyErrorAttributeError)r nameexs r __getattr__Options.__getattr__s?  J<<% % J 74&!@Ar I Js 0+0c X RU'gr r rs r __setattr__Options.__setattr__s! Src2URUR4$r rrs r __getstate__Options.__getstate__s dnn--rcN>Uup#[TU]SU5 [TU]SU5 gNrr superr.)r staterr __class__s r __setstate__Options.__setstate__s)" Iw/ K3rcUR[U55nURURR 5UR R 545 U$)zmReturn a copy of the Options. The returned option and validator values are shallow copies of the originals. )__new__typer9rcopyr )r outs r__copy__Options.__copy__sH ll4:& $,,++-t~~/B/B/DEF rc F>[TU]SU5 [TU]S05 gr4r5)r kwargsr8s r__init__Options.__init__s! Iv. K,rcSURR55n[U5RSSR U5S3$)Nc36# UHupUSU<3v M g7f)=Nr).0kvs r #Options.__repr__..s?*>$!A3au*>s(z, ))ritemsr=__name__join)r rPs r__repr__Options.__repr__sA?$,,*<*<*>?t*%%&a %(8'9;;rc[U[5(a.[U[5(aURUR:H$[$r ) isinstancerrNotImplemented)r others r__eq__Options.__eq__s4 dG $ $E7)C)C<<5==0 0rcvXR;a[SUS35e[U[5(a[ U5S:wa [ S5eO][U[ 5(a[ U5S:Xa [ S5eO-[U[5(aO[[U5S35eX RU'g) aSet an optional validator for a field in the options Setting a validator enables changes to an options values to be validated for correctness when :meth:`~qiskit.providers.Options.update_options` is called. For example if you have a numeric field like ``shots`` you can specify a bounds tuple that set an upper and lower bound on the value such as:: options.set_validator("shots", (1, 4096)) In this case whenever the ``"shots"`` option is updated by the user it will enforce that the value is >=1 and <=4096. A ``ValueError`` will be raised if it's outside those bounds. If a validator is already present for the specified field it will be silently overridden. Args: field (str): The field name to set the validator on validator_value (list or tuple or type): The value to use for the validator depending on the type indicates on how the value for a field is enforced. If a tuple is passed in it must have a length of two and will enforce the min and max value (inclusive) for an integer or float value option. If it's a list it will list the valid values for a field. If it's a ``type`` the validator will just enforce the value is of a certain type. Raises: KeyError: If field is not present in the options object ValueError: If the ``validator_value`` has an invalid value for a given type TypeError: If ``validator_value`` is not a valid type zField 'z'' is not present in this options objectzA tuple validator must be of the form '(lower, upper)' where lower and upper are the lower and upper bounds inclusive of the numeric valuerz-A list validator must have at least one entryzG is not a valid validator type, it must be a tuple, list, or class/typeN) rr'rVtupler ValueErrorlistr= TypeErrorr )r fieldvalidator_values r set_validatorOptions.set_validatorsB  $WUG+RST T ou - -?#q( 5)  . .?#q( !PQQ)  . . ()*77 !0urc UR5Hup#URRUS5n[U[5(a,X4S:dX4S:a[ SUSUSSUS35eMb[U[ 5(aX4;a[ SUSU35eM[U[5(dM[X45(aM[SUS U35e URRU5 g) zUpdate options with kwargsNrzSpecified value for 'z"' is not a valid value, must be >=z or <=zSpecified value for z' is not a valid choice, must be one of z is not of required type ) rPr getrVr]r^r_r=r`rupdate)r fields field_namerafield_validators rrOptions.update_optionss!' J"nn00TBO/5111--9K1K$/ |<%%4Q%7$8q?Q>RT2L OT22/$.zl;**9):<0 OT22!%99#.zl:STcSde!"0( F#rc F>[TU]5nUR(dU$[R"5nUR U5 UR S5 URR 5Hup4[U[5(a#UR SUSUSSUSS35 M=[U[5(aUR SUSUS35 Ml[U[5(dMUR SUS US35 M UR5$) Nz Where:  z is >= rz and <= rf z is one of z is of type ) r6__str__r ioStringIOwriterPrVr]r_r=getvalue)r no_validatorout_strrar r8s rrpOptions.__str__sw( ~~ kkmG MM, ' MM, ' $ 4 4 6 eU++MMBugWU1XJhuQxjPR"STt,,MMBug[r"BCt,,MMBug\%"CD !7##% %rr)rQ __module__ __qualname____firstlineno____doc__ __slots__rrrr!propertyr$r+r.r1r9r@rDrSrYrcrrp__static_attributes__ __classcell__)r8s@rrrsv*b)I!"! ,  J" .4 -< 40l$0&&rr)r{rqcollections.abcrrrrrrs+ #~&g~&r