3 di@sdZddlmZmZddlZddlmZmZmZddl m Z ddl m Z ddl mZmZmZdd lmZmZdd lmZdd lmZmZmZdd lmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$dd l%m&Z&ddl'm(Z(e)dZ*e*e+e,e-e.fZ/e.e+e,e-e0e1e2eee)e*f Z3eefZ4ee fZ5e.de+de,de-de0ge1fe2ie6diZ7ddZ8Gddde9Z:Gddde9Z;ddZe&e>Z>Gdd d e9Z?e ej@ZAe(d!d"d#ZBe&eBZBe(d$d%d&ZCe&eCZCe(d'd(d)ZDe&eDZDdS)+a Defines the 'core' traits for the Traits package. A trait is a type definition that can be used for normal Python object attributes, giving the attributes some additional characteristics: Initialization: Traits have predefined values that do not need to be explicitly initialized in the class constructor or elsewhere. Validation: Trait attributes have flexible, type-checked values. Delegation: Trait attributes' values can be delegated to other objects. Notification: Trait attributes can automatically notify interested parties when their values change. Visualization: Trait attributes can automatically construct (automatic or programmer-defined) user interfaces that allow their values to be edited or displayed) .. note:: 'trait' is a synonym for 'property', but is used instead of the word 'property' to differentiate it from the Python language 'property' feature. ) FunctionType MethodTypeN)ComparisonMode DefaultValue TraitKind)CTrait) TraitError) SequenceTypes TypeTypes add_article) trait_cast check_trait) TraitHandler)_infer_default_value_type _read_only _write_only) TraitInstance TraitFunctionTraitCoerceType TraitCastType TraitEnum TraitCompoundTraitMap_undefined_get_undefined_set) TraitFactory) deprecatedgyFcGs|j|f|S)z" Unpickles new-style objects. )__new__)clsargsr"//tmp/pip-build-7vycvbft/traits/traits/traits.py __newobj__wsr$c@seZdZddZdS) _InstanceArgscCs|f||_||_dS)N)r!kw)selffactoryr!r&r"r"r#__init__s z_InstanceArgs.__init__N)__name__ __module__ __qualname__r)r"r"r"r#r%sr%c@s eZdZdZdfdfddZdS)Defaultz Generates a value the first time it is accessed. A Default object can be used anywhere a default trait value would normally be specified, to generate a default value dynamically. NcCs|||f|_dS)N) default_value)r'funcr!r&r"r"r#r)szDefault.__init__)r*r+r,__doc__r)r"r"r"r#r-sr-cOst||jS)aq Creates a trait definition. .. note:: The :func:`~.Trait` function is not recommended for use in new code, and may eventually be deprecated and removed. Consider using :class:`~.Union` instead. This function accepts a variety of forms of parameter lists: +-------------------+---------------+-------------------------------------+ | Format | Example | Description | +===================+===============+=====================================+ | Trait(*default*) | Trait(150.0) | The type of the trait is inferred | | | | from the type of the default value, | | | | which must be in *ConstantTypes*. | +-------------------+---------------+-------------------------------------+ | Trait(*default*, | Trait(None, | The trait accepts any of the | | *other1*, | 0, 1, 2, | enumerated values, with the first | | *other2*, ...) | 'many') | value being the default value. The | | | | values must be of types in | | | | *ConstantTypes*, but they need not | | | | be of the same type. The *default* | | | | value is not valid for assignment | | | | unless it is repeated later in the | | | | list. | +-------------------+---------------+-------------------------------------+ | Trait([*default*, | Trait([None, | Similar to the previous format, but | | *other1*, | 0, 1, 2, | takes an explicit list or a list | | *other2*, ...]) | 'many']) | variable. | +-------------------+---------------+-------------------------------------+ | Trait(*type*) | Trait(Int) | The *type* parameter must be a name | | | | of a Python type (see | | | | *PythonTypes*). Assigned values | | | | must be of exactly the specified | | | | type; no casting or coercion is | | | | performed. The default value is the | | | | appropriate form of zero, False, | | | | or emtpy string, set or sequence. | +-------------------+---------------+-------------------------------------+ | Trait(*class*) |:: | Values must be instances of *class* | | | | or of a subclass of *class*. The | | | class MyClass:| default value is None, but None | | | pass | cannot be assigned as a value. | | | foo = Trait( | | | | MyClass) | | +-------------------+---------------+-------------------------------------+ | Trait(None, |:: | Similar to the previous format, but | | *class*) | | None *can* be assigned as a value. | | | class MyClass:| | | | pass | | | | foo = Trait( | | | | None, MyClass)| | +-------------------+---------------+-------------------------------------+ | Trait(*instance*) |:: | Values must be instances of the | | | | same class as *instance*, or of a | | | class MyClass:| subclass of that class. The | | | pass | specified instance is the default | | | i = MyClass() | value. | | | foo = | | | | Trait(i) | | +-------------------+---------------+-------------------------------------+ | Trait(*handler*) | Trait( | Assignment to this trait is | | | TraitEnum ) | validated by an object derived from | | | | **traits.TraitHandler**. | +-------------------+---------------+-------------------------------------+ | Trait(*default*, | Trait(0.0, 0.0| This is the most general form of | | { *type* | | 'stuff', | the function. The notation: | | *constant* | | TupleType) | ``{...|...|...}+`` means a list of | | *dict* | *class* || | one or more of any of the items | | *function* | | | listed between the braces. Thus, the| | *handler* | | | most general form of the function | | *trait* }+ ) | | consists of a default value, | | | | followed by one or more of several | | | | possible items. A trait defined by | | | | multiple items is called a | | | | "compound" trait. | +-------------------+---------------+-------------------------------------+ All forms of the Trait function accept both predefined and arbitrary keyword arguments. The value of each keyword argument becomes bound to the resulting trait object as the value of an attribute having the same name as the keyword. This feature lets you associate metadata with a trait. The following predefined keywords are accepted: desc : str Describes the intended meaning of the trait. It is used in exception messages and fly-over help in user interfaces. label : str Provides a human-readable name for the trait. It is used to label user interface editors for traits. editor : traits.api.Editor Instance of a subclass Editor object to use when creating a user interface editor for the trait. See the "Traits UI User Guide" for more information on trait editors. comparison_mode : int Indicates when trait change notifications should be generated based upon the result of comparing the old and new values of a trait assignment. Possible values come from the ``ComparisonMode`` enum: * 0 (none): The values are not compared and a trait change notification is generated on each assignment. * 1 (identity): A trait change notification is generated if the old and new values are not the same object. * 2 (equality): A trait change notification is generated if the old and new values are not equal using Python's standard equality testing. This is the default. ) _TraitMaker as_ctrait) value_typemetadatar"r"r#Traitsor5c@s:eZdZejejdZddZddZddZ dd Z d S) r1)eventconstantcOs|jdd|j||dS)Ntypetrait) setdefaultdefine)r'r3r4r"r"r#r) s z_TraitMaker.__init__c Os tj}d}}}t|dkr\|d}|dd}t|dkrZt|tkrZ|d|}}t|dkrt|}|tkrt|}tj |}n~t |t r|}|j \}}|j|d<nXt |t r|}d}nDt|}|tkrt|}n*|jddt|}||jkr\tj |}nNg}g} i} |j||| | t|dkr|ddkrt| dkrt | dtrg}| dj|jddt|dkrt| t| dkr||kr|jd|| jt|t| dkr| jt| t| dkrt }n`t| dkr| d}t |t r4|d}}|j|d<nt |tr\|jdd|dkr`|jnt |trtj}|j|j|jf}nrt|dkr\t| dkr\|j} t|}|tkrtj}| f|f}n,t || s\|tk r|f}tj}| |df}ndxbt | D]N\} } t | t r| jdkr4t!dt"| j| j#}|dkrFP|| | <qWt$| }||_#||_%|dkrt |t&rtj}|j }nf|dkr|dk r|j#}|dk r|j'}|dkry|j(dd |}Wn YnX|dkrt)|}||_'||_ |j*|_+dS) z Define the trait. Nrrr8Zinstance_handlerZ_instance_changed_handlerr9z2Cannot create a complex trait containing %s trait.r),rZ unspecifiedlenr8r try_trait_cast PythonTypesr DefaultValuesget isinstancerr.rr rr:raClassdo_list allow_noneinsertappendrrr%Zcallable_and_argsZcreate_default_valuer!r&dicttuple enumerater r handlerrcloner-default_value_typevalidatercopyr4)r'r3r4rLr.rJrKZ typeValueenumothermaprBiitemr"r"r#r;s                                    z_TraitMaker.definecCsx|D]}|tkr"|jt|qt|}t|}|tkrF|j|q|tkr`|j||||q|tkrt|j |q|t kr|jt |qt |t r|j|q|jt|qWdS)z= Determine the correct TraitHandler for each item in a list. N)r>rFrr=r8 ConstantTypesr rCrGupdate CallableTypesrrA TraitTypesr)r'listrOrQrPrSZtypeItemr"r"r#rCs      z_TraitMaker.do_listc Cs>|j}t|jj|jdtj}|j}|dk rN|j||jdk rN|jj|_|j |j |j |j }|dk r||_ t |dd}|dkr|j}|j|t |dd}|dk r||_|j|_|jd}|dk rtjdtdd|rtj|_ntj|_|jd d}|dk r ||_t|d kr:|jdkr.||_n |jj||S) z2 Return a properly initialized 'CTrait' instance. r8NZ fast_validate post_setattr rich_comparezThe 'rich_compare' metadata has been deprecated. Please use the 'comparison_mode' metadata instead. In a future release, rich_compare will have no effect.) stacklevelcomparison_moder)r4rtype_mapr@rr9rK__dict__rNZset_default_valuerLr.rJgetattrrMZ set_validaterYZ is_mappedwarningswarnDeprecationWarningrZequalityr]identitypopr<rU) r'r4r9rKrJrMrYrZr]r"r"r#r2sJ            z_TraitMaker.as_ctraitN) r*r+r,rr6r7r^r)r;rCr2r"r"r"r#r1s r1cKsd|d<| r|dkr|dk |dk |dk }|dkr|dkrFt|Sd}|dk rV|}|dk rt|}|dk r|j}}|dk r|j}|dk s|dk rd|kr|dk r|jdk r|j|d<t|||S|dkrd|d<|dkrt}t}nt}n|dkrt}d|d<|dk rVt|}|j}|dkr6|dk r6|j}d|krV|jdk rV|j|d<|j d t |d dt |d d r|j d dt t j }|j|_|||f|_||_|S) aU Returns a trait whose value is a Python property. If no getter, setter or validate functions are specified (and **force** is not True), it is assumed that they are defined elsewhere on the class whose attribute this trait is assigned to. For example:: class Bar(HasTraits): # A float traits Property that should be always positive. foo = Property(Float) # Shadow trait attribute _foo = Float def _set_foo(self,x): self._foo = x def _validate_foo(self, x): if x <= 0: raise TraitError( 'foo property should be a positive number') return x def _get_foo(self): return self._foo You can use the **observe** metadata attribute to indicate that the property depends on the value of another trait. The value of **observe** follows the same signature as the **expression** parameter in ``HasTraits.observe``. The property will fire a trait change notification if any of the traits specified by **observe** change. For example:: class Wheel(Part): axle = Instance(Axle) position = Property(observe='axle.chassis.position') For details of the extended trait name syntax, refer to the observe() method of the HasTraits class. Parameters ---------- fget : function The "getter" function for the property. fset : function The "setter" function for the property. fvalidate : function The validation function for the property. The method should return the value to set or raise TraitError if the new value is not valid. force : bool Indicates whether to use only the function definitions specified by **fget** and **fset**, and not look elsewhere on the class. handler : function A trait handler function for the trait. trait : Trait or value A trait definition or a value that can be converted to a trait that constrains the values of the property trait. propertyr8NrreditorTZ transientZ depends_oncached_propertyFcached)ForwardPropertyr rJrMrgrrrrr:r`rrrfrNr_Zproperty_fields)fgetfsetZ fvalidateforcerJr9r4sumr"r"r#PropertysXB          roc@seZdZdZdddZdS)rjzi Used to implement Property traits where accessor functions are defined implicitly on the class. NcCs|j|_||_||_dS)N)rNr4rMrJ)r'r4rMrJr"r"r#r)s zForwardProperty.__init__)NN)r*r+r,r0r)r"r"r"r#rjsrjz]'Color' in 'traits' package has been deprecated. Use 'Color' from 'traitsui' package instead.cOsddlm}|||S)z Returns a trait whose value must be a GUI toolkit-specific color. .. deprecated:: 6.1.0 ``Color`` trait in this package will be removed in the future. It is replaced by ``Color`` trait in TraitsUI package. r) ColorTrait)traitsui.toolkit_traitsrp)r!r4rpr"r"r#Colors rrzc'RGBColor' in 'traits' package has been deprecated. Use 'RGBColor' from 'traitsui' package instead.cOsddlm}|||S)z Returns a trait whose value must be a GUI toolkit-specific RGB-based color. .. deprecated:: 6.1.0 ``RGBColor`` trait in this package will be removed in the future. It is replaced by ``RGBColor`` trait in TraitsUI package. r) RGBColorTrait)rqrs)r!r4rsr"r"r#RGBColors rtz['Font' in 'traits' package has been deprecated. Use 'Font' from 'traitsui' package instead.cOsddlm}|||S)z Returns a trait whose value must be a GUI toolkit-specific font. .. deprecated:: 6.1.0 ``Font`` trait in this package will be removed in the future. It is replaced by ``Font`` trait in TraitsUI package. r) FontTrait)rqru)r!r4rur"r"r#Fonts rv)NNNFNN)Er0typesrrra constantsrrrZctraitrZ trait_errorsr Z trait_baser r r Ztrait_convertersr rr=Z trait_handlerrZ trait_typerrrZtrait_handlersrrrrrrrrrZ trait_factoryrZutil.deprecatedrr8ZNoneTypeintfloatcomplexstrrTrXrHrGr>rVrWboolr?r$objectr%r-r5r1rorjZgenericZ generic_traitrrrtrvr"r"r"r#"sp   ,      ry z