eeddlZddlZddlZddlmZddlmZddlm Z ddl m Z ia ia ia ddZdd Zd ZGd d e j"ZGd deZy)N) OrderedDict) functions)QtCore ParameterItemcv|tvr|std|d|xst}|t|<t|||y)az Similar to :func:`registerParameterType`, but works on ParameterItems. This is useful for Parameters where the `itemClass` does all the heavy lifting, and a redundant Parameter class must be defined just to house `itemClass`. Instead, use `registerParameterItemType`. If this should belong to a subclass of `Parameter`, specify which one in `parameterCls`. zParameter item type '/' already exists (use override=True to replace)N)_PARAM_ITEM_TYPES ValueError ParameterregisterParameterType)nameitemCls parameterClsoverrides C/usr/lib/python3/dist-packages/pyqtgraph/parametertree/Parameter.pyregisterParameterItemTypersL   #D6)X Y   ,9L%d$ h7cZ|tvr|std|d|t|<|t|<y)zRegister a parameter type in the parametertree system. This enables construction of custom Parameter classes by name in :meth:`~pyqtgraph.parametertree.Parameter.create`. zParameter type 'r N) PARAM_TYPESr PARAM_NAMES)rclsrs rrr"s8 {8+D61`abbKKrctj|jditj|jdiy)Nrr)rupdategetr)olds r __reload__r/s4sww}b12sww}b12rceZdZdZej eeZej eeZej eeeZ ej eeZ ej eZ ej eeZ ej eeZ ej eeZej eeZej eeZej eeeZej eeZej eeZedZdZedZdZdZdZdZd Zd Zd ZdFd Z dZ!dZ"dZ#dZ$dFdZ%dGdZ&dZ'dZ(dHdZ)dZ*dZ+dZ,dZ-dZ.dIdZ/dZ0dIdZ1dZ2d Z3d!Z4d"Z5d#Z6d$Z7d%Z8d&Z9d'Z:d(Z;d)Zd,Z?dJd-Z@d.ZAd/ZBd0ZCd1ZDd2ZEd3ZFd4ZGd5ZHd6ZId7ZJd8ZKd9ZLd:ZMd;ZNd<ZOd=ZPd>ZQd?ZRdId@ZSdAZTdBZUdCZVdDZWdEZXy )Kra A Parameter is the basic unit of data in a parameter tree. Each parameter has a name, a type, a value, and several other properties that modify the behavior of the Parameter. Parameters may have parent / child / sibling relationships to construct organized hierarchies. Parameters generally do not have any inherent GUI or visual interpretation; instead they manage ParameterItem instances which take care of display and user interaction. Note: It is fairly uncommon to use the Parameter class directly; mostly you will use subclasses which provide specialized type and data handling. The static method Parameter.create(...) is an easy way to generate instances of these subclasses. For more Parameter types, see ParameterTree.parameterTypes module. =================================== ========================================================= **Signals:** sigStateChanged(self, change, info) Emitted when anything changes about this parameter at all. The second argument is a string indicating what changed ('value', 'childAdded', etc..) The third argument can be any extra information about the change sigTreeStateChanged(self, changes) Emitted when any child in the tree changes state (but only if monitorChildren() is called) the format of *changes* is [(param, change, info), ...] sigValueChanged(self, value) Emitted when value is finished changing sigValueChanging(self, value) Emitted immediately for all value changes, including during editing. sigChildAdded(self, child, index) Emitted when a child is added sigChildRemoved(self, child) Emitted when a child is removed sigRemoved(self) Emitted when this parameter is removed sigParentChanged(self, parent) Emitted when this parameter's parent has changed sigLimitsChanged(self, limits) Emitted when this parameter's limits have changed sigDefaultChanged(self, default) Emitted when this parameter's default value has changed sigNameChanged(self, name) Emitted when this parameter's name has changed sigOptionsChanged(self, opts) Emitted when any of this parameter's options have changed sigContextMenu(self, name) Emitted when a context menu was clicked =================================== ========================================================= c `|jdd}|t}n t|d}|di|S)a% Static method that creates a new Parameter (or subclass) instance using opts['type'] to select the appropriate class. All options are passed directly to the new Parameter's __init__ method. Use registerParameterType() to add new class types. typeN)rrr)optstyprs rcreatezParameter.create~s8hhvt$ ;Cd6l+C{T{rc tjj|ddddddddddd |_|j dd}t |t s td|jj|d|jd<g|_ i|_ tj|_ d|_g|_d|_|j#||j%|jj'dgd |jvrFd |jvr8t)j*d t,d |jd |jd <|jj d |jj d d}d |jv}||j/|||_|j2j5|j6|j8j5|j:|j<j5|j>|j@j5|jB|jDj5|jF|jHj5|jJ|jLj5|jN|jPj5|jR|jTj5|jVy)a Initialize a Parameter object. Although it is rare to directly create a Parameter instance, the options available to this method are also allowed by most Parameter subclasses. ======================= ========================================================= **Keyword Arguments:** name The name to give this Parameter. This is the name that will appear in the left-most column of a ParameterTree for this Parameter. value The value to initially assign to this Parameter. default The default value for this Parameter (most Parameters provide an option to 'reset to default'). children A list of children for this Parameter. Children may be given either as a Parameter instance or as a dictionary to pass to Parameter.create(). In this way, it is possible to specify complex hierarchies of Parameters from a single nested data structure. readonly If True, the user will not be allowed to edit this Parameter. (default=False) enabled If False, any widget(s) for this parameter will appear disabled. (default=True) visible If False, the Parameter will not appear when displayed in a ParameterTree. (default=True) renamable If True, the user may rename this Parameter. (default=False) removable If True, the user may remove this Parameter. (default=False) expanded If True, the Parameter will initially be expanded in ParameterTrees: Its children will be visible. (default=True) syncExpanded If True, the `expanded` state of this Parameter is synchronized with all ParameterTrees it is displayed in. (default=False) title (str or None) If specified, then the parameter will be displayed to the user using this string as its name. However, the parameter will still be referred to internally using the *name* specified above. Note that this option is not compatible with renamable=True. (default=None; added in version 0.9.9) ======================= ========================================================= NFT) r"readonlyvisibleenabled renamable removable strictNamingexpanded syncExpandedtitlerz4Parameter must have a string name specified in opts.rchildrenvaluedefaultzParameter has no default value. Pass a default, or use setDefault(). This will no longer set an implicit default after January 2025.r stacklevel),rQObject__init__r$r isinstancestr TypeErrorrchildsnamesweakrefWeakKeyDictionaryitems_parenttreeStateChangesblockTreeChangeEmitsetName addChildrenpopwarningswarnDeprecationWarningsetValue_modifiedSinceResetsigValueChangedconnect_emitValueChanged sigChildAdded_emitChildAddedChangedsigChildRemoved_emitChildRemovedChangedsigParentChanged_emitParentChangedsigLimitsChanged_emitLimitsChangedsigDefaultChanged_emitDefaultChangedsigNameChanged_emitNameChangedsigOptionsChanged_emitOptionsChangedsigContextMenu_emitContextMenuChanged)selfr$rr2modifieds rr7zParameter.__init__sdV %!!   xx%$$RS S   &  ..0  "#$  T z267 dii ITYY$> MM:"   $(99W#5DIIi  gtyy}}Y'EFdii'   MM% #+  $$T%;%;< ""4#>#>? $$T%B%BC %%d&=&=> %%d&=&=> &&t'?'?@ ##D$9$9: &&t'?'?@ ##D$@$@ArctS)zf The class of ParameterItem to use when displaying this parameter in a ParameterTree. rr^s r itemClasszParameter.itemClasss rc |jdS)z"Return the name of this Parameter.rr$ras rrzParameter.nameyy  rcb|jjdd}||j}|S)zReturn the title of this Parameter. By default, the title is the same as the name unless it has been explicitly specified otherwise.r0N)r$rr)r^r0s rr0zParameter.titles-  gt, =IIKE rc<|jj||y)z!"A context menu entry was clickedN)r\emit)r^rs r contextMenuzParameter.contextMenus   t,rc~|jdrLt|dks/tjd|stjd|drt d|d|j }||j||}|jd|k7r+||jd<|jj|||S) zAttempt to change the name of this parameter; return the actual name. (The parameter may reject the name change or automatically pick a different name)r-rz\Wz\drzParameter name 'zh' is invalid. (Must contain only alphanumeric and underscore characters and may not start with a number)r) r$lenresearchmatchr parent _renameChildrXrh)r^rros rrCzParameter.setName s 99^ $#d)a-299UD;QUWU]U]^ceijkelUm"4&)/01 1  &&tT2D 99V  $ $DIIf     $ $T4 0 rc |jdS)z*Return the type string for this Parameter.r"rdras rr"zParameter.typererc|j|k(rytj|d}|td|d|j|uS)z Return True if this parameter type matches the name *typ*. This can occur either of two ways: - If self.type() == *typ* - If this parameter's class is registered with the name *typ* TNz Type name 'z' is not registered.)r"rrr __class__)r^r%rs risTypezParameter.isTypesN 99;# ooc4( ;{3%/CDE E~~$$rcg}||ur8|jd|j|j}|y||ur8|S)z Return the path of parameter names from self to child. If child is not a (grand)child of self, return None. rN)insertrro)r^childpaths r childPathzParameter.childPath-sI 4 KK5::< (LLNE} 4  rNc ||jj||j|}tj|j j dd|r |||jj|SSd|_||j d<|jj||||jj| |j dS#||jj|wwxYw)z Set the value of this Parameter; return the actual value that was set. (this may be different from the value that was requested) Nr2T) rK disconnect_interpretValuefneqr$rrLrJrh)r^r2 blockSignals rrIzParameter.setValue:s :&$$// <((/EuuTYY]]7D159 &$$,,[9' (,D $!&DIIg   % %dE 2&$$,,[9yy!!&$$,,[9'sAC2C C?c|SNr#)r^vs rr|zParameter._interpretValueNsrcd|jvS)z.Return True if this Parameter has a value set.r2rdras rhasValuezParameter.hasValueQs$))##rcd|jvrtjdtd|jj dS)za Return the value of this Parameter. Raises ValueError if no value has been set. r2zParameter has no value set. Pass an initial value or default, or use setValue() or setDefault(). This will be an error after January 2025.rr4r$rFrGrHrras rr2zParameter.valueUs< $)) # MM<"   yy}}W%%rct}|D]3}|j|jf||j<5|S)z Return a tree of all values that are children of this parameter. Raises ValueError if any child has no value. )rr2 getValuesr)r^valschs rrzParameter.getValuesbs?} ;B!xxz2<<>:DO ; rc |B|jj}|d]tjt |d|d<n:|dk(r&|j rd|j i}ni}ntd|dt|Dcgc]$}|j|j|f&c}}t|dkDr||d <|Scc}w) a Return a structure representing the entire state of the parameter tree. The tree state may be restored from this structure using restoreState(). If *filter* is set to 'user', then only user-settable data will be included in the returned state. Nr"userr2zUnrecognized filter argument: '')filterrr1) r$copyrrr"rr2r rr saveStaterk)r^rstaters rrzParameter.saveStateks >IINN$EV}$ +T D Af v }} $**,/>vhaHI I TRr2779bll&l&ABR S r7Q; "E*  Ss)C c|j}|jdg}t|trPg}|j D]9\}} |j | j|dj d|;|}|r|j |jd i||s |r|jyyd} t} |D]} | d} d}t|j| dD]Y\}}|j| k7rd}|dk7r|j| ||j| |||| j!|n|s;|st#j$d i| }|j| || j!|| d z } |r*|jddD]} | | vs|j'| |r|jyy#|r|jwwxYw) a Restore the state of this parameter and its children from a structure generated using saveState() If recursive is True, then attempt to restore the state of child parameters as well. If addChildren is True, then any children which are referenced in the state object will be created if they do not already exist. If removeChildren is True, then any children which are not referenced in the state object will be removed. If blockSignals is True, no signals will be emitted until the tree has been completely restored. This prevents signal handlers from responding to a partially-rebuilt network. r1rNrFT) recursiverDremoveChildrenrr#)rrEr8dictr?append setdefaultblockTreeChangeSignalsetOptsunblockTreeChangeSignalset enumerater;r insertChild restoreStateaddrr& removeChild)r^rrrDr blockSignals childStatecskrptr foundChildsrrgotChildich2s rrzParameter.restoreStates YYz2.  j$ 'B!'') -! !&&(#2!!&!, -J   & & (2 / DLL !5 !Z,,.WC%K! &z !' CD(9: FAsxxzT) #HAv((c2$$R9+ft$uOOC(  & #**0R0C$$S#.OOC(q? B++a.-B,((,- ,,.|,,.sG?C(G(GG$c|jS)zuReturn True if this parameter's value has been changed since the last time it was reset to its default value.)rJras r valueModifiedSinceResetToDefaultz*Parameter.valueModifiedSinceResetToDefaults'''rcd|jvrtjdtd|jj dS)zMReturn the default value for this parameter. Raises ValueError if no default.r3zMParameter has no default value. This will be a ValueError after January 2025.rr4rras r defaultValuezParameter.defaultValues8 DII % MMi,%& (yy}}Y''rc(|jjdd|k(ry||jd<d|jvs|r |js|j|j sd|_|j j||y)zSet the default value for this parameter. If updatePristineValues is True, then any values that haven't been modified since the last time they were reset to default will be updated to the new default value (default: False).r3Nr2T)r$rr setToDefaultvalueIsDefaultrJrVrh)r^valupdatePristineValuess r setDefaultzParameter.setDefaults| 99==D )S 0 " ) $)) #(|jjddduS)z3Returns True if this parameter has a default value.r3Nr$rras r hasDefaultzParameter.hasDefaultsyy}}Y-T99rc|jr|jsytj|j |j S)zEReturns True if this parameter's value is equal to the default value.F)rrr}r~r2rras rrzParameter.valueIsDefaults7}}doo&7uuTZZ\4#4#4#677rcd|jvr$tj|jd|ry||jd<|jj |||S)zSet limits on the acceptable values for this parameter. The format of limits depends on the type of the parameter and some parameters do not make use of limits at all.limitsN)r$r}r~rTrh)r^rs r setLimitszParameter.setLimitssR tyy RUU499X+>%G $ ( ""40 rc$|j S)z Returns True if this parameter's value can be changed by the user. Note that the value of the parameter can *always* be changed by calling setValue(). r(ras rwritablezParameter.writables ==?""rc*|j| y)zrSet whether this Parameter should be editable by the user. (This is exactly the opposite of setReadonly).rNr)r^rs r setWritablezParameter.setWritables (l +rc:|jjddS)zb Return True if this parameter is read-only. (this is the opposite of writable()) r(Frras rr(zParameter.readonlysyy}}Z//rc(|j|y)zmSet whether this Parameter's value may be edited by the user (this is the opposite of setWritable()).rNr)r^r(s r setReadonlyzParameter.setReadonlys h 'rc t}|D]}|dk(r|j|||dk(r|j||7|dk(r|j||Q|dk(r|j ||k||j vs't j|j |||r|||j |<||||<t|dkDr|jj||yy)a Set any arbitrary options on this parameter. The exact behavior of this function will depend on the parameter type, but most parameters will accept a common set of options: value, name, limits, default, readonly, removable, renamable, visible, enabled, expanded and syncExpanded. See :func:`Parameter.__init__ ` for more information on default options. r2rrr3rN) rrIrCrrr$r}r~rkrZrh)r^r$changedrs rrzParameter.setOptss- %AG| d1g&f T!W%htAw'iQ($))#2551tAw+G#Aw ! !!W  % w rc(|jd|y)Nr2rr^paramrs rrMzParameter._emitValueChangedBs gt,rc(|jd|y)N childAddedrrs rrOz Parameter._emitChildAddedChangedEs lD1rc(|jd|y)N childRemovedrrs rrQz"Parameter._emitChildRemovedChangedHs nd3rc(|jd|y)Nrorrs rrSzParameter._emitParentChangedK h-rc(|jd|y)Nrrrs rrUzParameter._emitLimitsChangedNrrc(|jd|y)Nr3rrs rrWzParameter._emitDefaultChangedQ i.rc(|jd|y)Nrrrs rrYzParameter._emitNameChangedTs fd+rc(|jd|y)Noptionsrrs rr[zParameter._emitOptionsChangedWrrc(|jd|y)Nrirrs rr]z!Parameter._emitContextMenuChangedZs mT2rc~|jxs'tj|jdt}|||S)a Return a TreeWidgetItem suitable for displaying/controlling the content of this parameter. This is called automatically when a ParameterTree attempts to display this Parameter. Most subclasses will want to override this function. r")rbr rr$r )r^depthrbs r makeTreeItemzParameter.makeTreeItem]s6NN]&7&;&;DIIf`. By default, the child's 'autoIncrementName' option determines whether the name will be adjusted to avoid prior name collisions. This behavior may be overridden by specifying the *autoIncrementName* argument. This argument was added in version 0.9.9. If 'autoIncrementName' is *False*, an error is raised when the inserted child already exists. However, if 'existOk' is *True*, the existing child will be returned instead, and this child will *not* be inserted. TNrFzAlready have child named %sr#)r8rrr&rr<r$r incrementNamerCr r9r;indexrroremoverv parentChangedsigTreeStateChangedrLtreeStateChangedrNrh)r^posrwrrrs rrzParameter.insertChildsk eT "$$-u-Ezz| 4:: %tzz$/?"? D(->-F5::>>ZmotKu))$/ d#zz$'' !>T!JKK c9 %++##C(C  # # % 6||~) $DJJt  KK  sE *    %  % % - -d.C.C D    # #D% 5 6  6 s =BF&&F0c|j}||jvs|j||urtdt|z|j|=|jj |jj ||jd |jj|j|jj||y#ttf$rY.wxYw)zRemove a child parameter.z+Parameter %s is not my child; can't remove.N)rr< Exceptionr9r;rErrrr{rr: RuntimeErrorrPrhr^rwrs rrzParameter.removeChildszz| tzz !TZZ%5U%BICPUJVW W JJt   ))%01 D!   % % 0 01F1F G !!$.<(   s%CC.-C.cN|jddD]}|j|y)zRemove all child parameters.N)r;r)r^rs r clearChildrenzParameter.clearChildrens'++a. !B   R  !rc |jddS)zeReturn a list of this parameter's children. Warning: this overrides QObject.children Nr;ras rr1zParameter.childrens{{1~rc2t|jdkDS)z+Return True if this Parameter has children.r)rkr;ras r hasChildrenzParameter.hasChildrens4;;!##rcJ||_|jj||y)z|This method is called when the parameter's parent has changed. It may be useful to extend this method in subclasses.N)r@rRrhr^ros rrzParameter.parentChangeds!  ""40rc|jS)z$Return the parent of this parameter.)r@ras rrozParameter.parents ||rc|j}| td|j||jj |y)z2Remove this parameter from its parent's child listNzCannot remove; no parent.)rorr sigRemovedrhrs rrzParameter.removes> >78 84  T"rctjd|j\}}t|}|dk(rd}d}n t |} |d|z|zz}||j vr|S|dz }!)Nz ([^\d]*)(\d*)rrrz%%0%dd)rlrngroupsrkintr<)r^rbasenumnumLennewNames rrzParameter.incrementNamesxHH-t4;;= cS Q;CFc(Chvo44Gdjj( 1HC rc#8K|jEd{y7wrrras r__iter__zParameter.__iter__s;;s cbt|ts|f}|j|jS)zGet the value of a child parameter. The name may also be a tuple giving the path to a sub-parameter:: value = param[('child', 'grandchild')] Raises ValueError if the child value is not set. )r8tuplerr2r^r<s r __getitem__zParameter.__getitem__s/%'HEtzz5!''))rcdt|tr|f}|j|j|S)zSet the value of a child parameter. The name may also be a tuple giving the path to a sub-parameter:: param[('child', 'grandchild')] = value )r8r9rrI)r^r<r2s r __setitem__zParameter.__setitem__s1 eS !HEtzz5!**511rc|jSr)r<ras rkeyszParameter.keyss zzrc |j|d}t|dkDr|j|ddS|S#t$r(}td|jd|d|d}~wwxYw)zReturn a child parameter. Accepts the name of the child or a tuple (path, to, child) Added in version 0.9.9. Earlier versions used the 'param' method, which is still implemented for backward compatibility. rz Parameter z has no child named Nr)r<KeyErrorrrkrw)r^r<res rrwzParameter.child s} \JJuQx(E u:>5;;ab * *L  \Z }4Hq STZ[ [ \s6 A'#A""A'c |j|Sr)rwr s rrzParameter.paramstzz5!!rchd|jj|jt|fzS)Nz<%s '%s' at 0x%x>)rs__name__ridras r__repr__zParameter.__repr__s("dnn&=&=tyy{BtH%UUUrc||jvr|jS||j|<|j|j=|Sr)r<rrs rrpzParameter._renameChild!s? 4:: ::<   4 JJuzz| $ rc"d|j|<yr)r?)r^items r registerItemzParameter.registerItem)s 4rc&|jdy)z{Hide this parameter. It and its children will no longer be visible in any ParameterTree widgets it is connected to.FN)showras rhidezParameter.hide,s %rc^||jd<|jj|d|iy)zShow this parameter. r)N)r$rZrh)r^ss rrzParameter.show1s*  ) ##D9a.9rcBt|j|jS)a Return an object that can be used to temporarily block and accumulate sigTreeStateChanged signals. This is meant to be used when numerous changes are about to be made to the tree and only one change signal should be emitted at the end. Example:: with param.treeChangeBlocker(): param.addChild(...) param.removeChild(...) param.setValue(...) ) SignalBlockerrrras rrzParameter.treeChangeBlocker7sT779U9UVVrc.|xjdz c_y)z Used to temporarily block and accumulate tree change signals. *You must remember to unblock*, so it is advisable to use treeChangeBlocker() instead. rN)rBras rrzParameter.blockTreeChangeSignalGs   A% rcN|xjdzc_|jy)z]Unblocks enission of sigTreeStateChanged and flushes the changes out through a single signal.rN)rBrras rrz!Parameter.unblockTreeChangeSignalNs   A%  rcZ|jj||jy)a Called when the state of any sub-parameter has changed. ============== ================================================================ **Arguments:** param The immediate child whose tree state has changed. note that the change may have originated from a grandchild. changes List of tuples describing all changes that have been made in this event: (param, changeDescr, data) ============== ================================================================ This function can be extended to react to tree state changes. N)rAextendr)r^rchangess rrzParameter.treeStateChangedTs$ $$W- rc|jdk(r?|j}g|_t|dkDr|jj ||yyy)Nr)rBrArkrrh)r^r(s rrzParameter.emitTreeChangesesO  # #q (++G$&D !7|a((--dG<  )rr)TTTTF)TNF)Yr __module__ __qualname____doc__rSignalobjectrKsigValueChangingrNrPrrRrTrVrXrZrrr\ staticmethodr&r7propertyrbrr0rirCr"rtryrIr|rr2rrrrrrrrrrrrr(rrrrMrOrQrSrUrWrYr[r]rrrDrrrr1rrrorrrr rrrwrrrprrrrrrrrr#rrrr4sv&T$fmmFF3O$v}}VV4!FMM&&&9M#fmmFF3Ov&J$v}}VV4$v}}VV4% ff5"V]]662N% ff5 $fmmFFF;O(&--7"V]]662N  aBF !- !% "($ &4K/Z( ( /- :8 #, 0 ( 78-24../,/3 &o"&(T /!  $1 #  *2""V  : W & "=rrceZdZdZdZdZy)r#c ||_||_yr)enterFnexitFn)r^r6r7s rr7zSignalBlocker.__init__ns  rc$|jyr)r6ras r __enter__zSignalBlocker.__enter__rs  rc$|jyr)r7)r^exc_type exc_valuetbs r__exit__zSignalBlocker.__exit__us  rN)rr,r-r7r9r>r#rrr#r#msrr#r+r*)rlrFr= collectionsrrr}Qtrr rrr rrrr6rr0r#r#rrrBsX #(  8$ 3 v =v =r F r