3 dE@s~ddlZddlZddlmZddlmZddlmZmZddl m Z Gddde Z ej Gdd d eZGd d d eZdS) N)ref) IObservable) Undefined_validate_everything) TraitErrorc@s*eZdZdZddddddZddZdS)TraitDictEventa2 An object reporting in-place changes to a traits dict. Parameters ---------- removed : dict, optional Old keys and values that were just removed. added : dict, optional New keys and values that were just added. changed : dict, optional Updated keys and their previous values. Attributes ---------- removed : dict Old keys and values that were just removed. added : dict New keys and values that were just added. changed : dict Updated keys and their previous values. N)removedaddedchangedcCs:|dkr i}||_|dkri}||_|dkr0i}||_dS)N)rr r )selfrr r r :/tmp/pip-build-7vycvbft/traits/traits/trait_dict_object.py__init__*szTraitDictEvent.__init__cCs&|jjd|jd|jd|jdS)Nz (removed=z, added=z , changed=)) __class____name__rr r )r r r r __repr__7szTraitDictEvent.__repr__)r __module__ __qualname____doc__rrr r r r rs rcseZdZdZfddZd$ddddfdd Zdd Zfd d Zfd d Ze j d%krffddZ fddZ fddZ d&fdd Zeffdd ZfddZddZddZd d!Zd"d#ZZS)' TraitDictaX A subclass of dict that validates keys and values and notifies listeners of any change. Parameters ---------- value : dict or iterable, optional The initial dict or an iterable containing key-value pairs. key_validator : callable, optional Called to validate a key in the dict. The callable must accept a single key and return a validated key or raise a TraitError If not provided, all keys are considered valid. value_validator : callable, optional Called to validate a value in the dict. The callable must accept a single value and return a validated value or raise a TraitError If not provided, all values are considered valid. notifiers : list, optional A list of callables with the signature:: notifier(trait_dict, removed, added, changed) Where: 'removed' is a dict of key-values that are no longer in the dictionary. 'added' is a dict of new key-values that have been added. 'changed' is a dict with old values previously associated with the key. Attributes ---------- key_validator : callable Called to validate a key in the dict. The callable must accept a single key and return a validated key or raise a TraitError value_validator : callable Called to validate a value in the dict. The callable must accept a single value and return a validated value or raise a TraitError notifiers : list A list of callables with the signature:: notifier(trait_dict, removed, added, changed) Where: 'removed' is a dict of key-values that are no longer in the dictionary. 'added' is a dict of new key-values that have been added. 'changed' is a dict with old values previously associated with the key. cs"tj|}t|_t|_g|_|S)N)super__new__r key_validatorvalue_validator notifiers)clsargskwargsr )rr r rrs  zTraitDict.__new__N)rrrcsr|dk r|_|dk r|_|dkr(g}|_|dkr:i}t|drL|jn|}fdd|D}tj|dS)Nkeyscs"i|]\}}j|j|qSr )rr).0keyvalue)r r r sz&TraitDict.__init__..)rrrhasattritemsrr)r r"rrrr%)r)r r rys zTraitDict.__init__cCs"x|jD]}|||||qWdS)a Call all notifiers. This simply calls all notifiers provided by the class, if any. The notifiers are expected to have the signature:: notifier(trait_dict, removed, added, changed) Any return values are ignored. N)r)r rr r notifierr r r notifys zTraitDict.notifycs`i}|j|}|j|}||kr2|||i}i}n i}||i}tj|||j|||ddS)z Set a value for the key, implements self[key] = value. Parameters ---------- key : A hashable object. The key for the value. value : any The value to set for the corresponding key. )rr r N)rrr __setitem__r')r r!r"r validated_keyvalidated_valuer r )rr r r(s    zTraitDict.__setitem__cs8||kr|||ini}tj||j|iiddS)z Delete the item from the dict indicated by the key. Parameters ---------- key : A hashable object. The key to be deleted. Raises ------ KeyError If the key is not found. )rr r N)r __delitem__r')r r!r)rr r r+s zTraitDict.__delitem__ c si}i}i}t|dr|jn|}xJ|D]B\}}|j|}|j|} ||krZ||||<n| ||<| ||<q(Wtj|} |s|r|ji||d| S)z Update self with the contents of other. Parameters ---------- other : mapping or iterable of (key, value) pairs Values to be added to this dictionary. r)rr r )r$r%rrr__ior__r') r othervalidated_dictr r r%r!r"r)r*retval)rr r r.s    zTraitDict.__ior__cs2|ik}|j}tj|s.|j|iiddS)z! Remove all items from the dict. )rr r N)copyrclearr')r Z was_emptyr)rr r r3s  zTraitDict.clearc si}i}i}t|dr|jn|}xJ|D]B\}}|j|}|j|} ||krZ||||<n| ||<| ||<q(Wtj||s|r|ji||ddS)z Update the values in the dict by the new dict or an iterable of key-value pairs. Parameters ---------- other : dict or iterable The dict from which values will be updated into this dict. r)rr r N)r$r%rrrupdater') r r/r0r r r%r!r"r)r*)rr r r4s     zTraitDict.updatecsl||kr||S|j|}|j|}||kr>|||i}i}n i}||i}tj|||ji||d|S)z Returns the value if key is present in the dict, else creates the key-value pair and returns the value. Parameters ---------- key : A hashable object. Key to the item. )rr r )rrrr(r')r r!r"r)r*r r )rr r setdefaults    zTraitDict.setdefaultcsP|tkp||k}|tkr&tj|}ntj||}|rL|j||iiid|S)aZ Remove specified key and return the corresponding value. If key is not found, the default value is returned if given, otherwise KeyError is raised. Parameters ---------- key : A hashable object. Key to the dict item. value : any Value to return if key is absent. )rr r )rrpopr')r r!r"Z should_notifyr)rr r r60sz TraitDict.popcs$tj}|jt|giid|S)a Remove and return some (key, value) pair as a tuple. Raise KeyError if dict is empty. Returns ------- key_value : tuple Some 2-tuple from the dict. Raises ------ KeyError If the dict is empty )rr r )rpopitemr'dict)r item)rr r r7Ls zTraitDict.popitemcCs|jj}|d=|S)zw Get the state of the object for serialization. Notifiers are transient and should not be serialized. r)__dict__r2)r resultr r r __getstate__as zTraitDict.__getstate__cCsg|d<|jj|dS)z Restore the state of the object after serialization. Notifiers are transient and are restored to the empty list. rN)r:r4)r stater r r __setstate__lszTraitDict.__setstate__cs>ttfdd|jDtj|jtj|jgd}|S)zb Perform a deepcopy operation. Notifiers are transient and should not be copied. c3s|]}tj|VqdS)N)r2deepcopy)r x)memor r |sz)TraitDict.__deepcopy__..)rrr)rr8r%r2r?rr)r rAr;r )rAr __deepcopy__us   zTraitDict.__deepcopy__cCs|jS)a Return a list of callables where each callable is a notifier. The list is expected to be mutated for contributing or removing notifiers from the object. Parameters ---------- force_create: boolean Not used here. )r)r Z force_creater r r _notifierss zTraitDict._notifiers)N)r,r-)N)rrrrrrr'r(r+sys version_infor.r3r4r5rr6r7r<r>rCrD __classcell__r r )rr r@s$0        rcsTeZdZdZfddZddZddZdd Zfd d Zd d Z ddZ Z S)TraitDictObjecta[ A subclass of TraitDict that fires trait events when mutated. This is for backward compatibility with Traits 6.0 and lower. This is used by the Dict trait type, and all values set into a Dict trait will be copied into a new TraitDictObject instance. Mutation of the TraitDictObject will fire a "name_items" event with appropriate added, changed and removed values. Parameters ---------- trait : CTrait instance The CTrait instance associated with the attribute that this dict has been set to. object : HasTraits The object this dict belongs to. Can also be None in cases where the dict has been disconnected from its HasTraits parent. name : str The name of the attribute on the object. value : dict The dict of values to initialize the TraitDictObject with. Attributes ---------- trait : CTrait instance The CTrait instance associated with the attribute that this dict has been set to. object : callable A callable that when called with no arguments returns the HasTraits object that this dict belongs to, or None if there is no such object. name : str The name of the attribute on the object. name_items : str The name of the items event trait that the trait dict will fire when mutated. cs\||_|dkrddnt||_||_d|_|jr<|d|_tj||j|j |j gddS)NcSsdS)Nr r r r r sz*TraitDictObject.__init__..Z_items)rrr) traitrobjectname name_itemsZ has_itemsrr_key_validator_value_validatorr&)r rJrKrLr")rr r rs  zTraitDictObject.__init__cCst|dd}t|ddd}|dks.|dkr2|S|jj}|dkrF|Sy|||j|Stk r}z|jd|WYdd}~XnXdS)aa Key validator based on the Dict's key_trait. Parameters ---------- key : A hashable object. The key to validate. Returns ------- validated_key : A hashable object. The validated key. Raises ------ TraitError If the validation fails. rJNrKcSsdS)Nr r r r r rIsz0TraitDictObject._key_validator..zEach key of the)getattrZ key_traitvalidaterLr set_prefix)r r!rJrKrQexcepr r r rNs  zTraitDictObject._key_validatorcCst|dd}t|ddd}|dks.|dkr2|S|jj}|dkrF|Sy|||j|Stk r}z|jd|WYdd}~XnXdS)aO Value validator based on the Dict's value_trait. Parameters ---------- value : any The value to validate. Returns ------- validated_value : any The validated value. Raises ------ TraitError If the validation fails. rJNrKcSsdS)Nr r r r r rIsz2TraitDictObject._value_validator..zEach value of the)rPZ value_traitrQrLrrR)r r"rJrKrQrSr r r rOs  z TraitDictObject._value_validatorcCsb|jdkrdS|j}|dkr"dSt||j|k r6dSt|||d}|jj}|j|j||dS)aO Fire the TraitDictEvent with the provided parameters. Parameters ---------- trait_dict : dict The complete dictionary. removed : dict Dict of removed items. added : dict Dict of added items. changed : dict Dict of changed items. N)rr r )rMrKrPrLrrJ items_eventZtrait_items_event)r Z trait_dictrr r rKeventrTr r r r&s  zTraitDictObject.notifiercstj}|d=|d=|S)zl Get the state of the object for serialization. Object and trait should not be serialized. rKrJ)rr<)r r;)rr r r<1s zTraitDictObject.__getstate__cCs<|jdd|jg|d<dd|d<d|d<|jj|dS) z> Restore the state of the object after serialization. rLrcSsdS)Nr r r r r rIBsz.TraitDictObject.__setstate__..rKNrJ)r5r&r:r4)r r=r r r r><s    zTraitDictObject.__setstate__cs,t|jd|jtfdd|jD}|S)z_ Perform a deepcopy operation.. Object is a weakref and should not be copied. Nc3s|]}tj|VqdS)N)r2r?)r r@)rAr r rBOsz/TraitDictObject.__deepcopy__..)rHrJrLr8r%)r rAr;r )rAr rCFs zTraitDictObject.__deepcopy__) rrrrrrNrOr&r<r>rCrGr r )rr rHs$ %%#  rH)r2rEweakrefrZtraits.observation.i_observablerZtraits.trait_baserrZtraits.trait_errorsrrKrregisterr8rrHr r r r  s   ,S