U /eQI@sdZddlmZddlZeeZddlZddlmZddl m Z m Z m Z m Z mZmZmZmZmZmZddlZddlmZddlmZd d lmZd d lmZmZmZd d l m!Z!d dl"m#Z#d dl$m%Z%m&Z&m'Z'm(Z(e rddl)m*Z*d dlm+Z+edZ,dZ-edZ.eee.e.fZ/ee.e(e&fZ0Gddde1Z2Gddde!e.Z3ede3e dZ4Gddde3e4Z5Gddde5e.Z6Gdd d e3e.Z7Gd!d"d"e5e.Z8d#d$d%d&Z9ee6d'd(Z:dS))al Provide base classes for the Bokeh property system. .. note:: These classes form part of the very low-level machinery that implements the Bokeh model and property system. It is unlikely that any of these classes or their methods will be applicable to any standard usage or to anyone who is not directly developing on Bokeh's own infrastructure. ) annotationsN)copy) TYPE_CHECKINGAnyCallableClassVarDictListTupleTypeTypeVarUnion)import_optional) nice_join)HasProps) property_linkregister_type_link type_link)PropertyDescriptorFactoryPropertyDescriptor) Intrinsic IntrinsicType Undefined UndefinedType)DocumentPatchedEvent)IDZpandas)ContainerPropertyDeserializationErrorPrimitivePropertyProperty validation_onTc@s eZdZdS)r!N)__name__ __module__ __qualname__r)r)=/tmp/pip-unpacked-wheel-f5fndrjf/bokeh/core/property/bases.pyr!^sr!c@seZdZUdZdZded<ded<ded<d ed <ed d d fd ddddddZddddZdddddZ ddddZ e dddd d!Z ddd"d#Z d$dd%dd&d'd(Zeddd)d*Zeddd+d,Zdddd-d.d/Zd d0d1d2dd3d4d5Zdd1d6d7d8Zd1dd6d9d:ZdYd1dd;d<d=d>Zd1dd6d?d@Zddd6dAdBZd1dCd1dDdEdFZd dGdHdd1dCddIdJdKZedddLdMZdNdOdPdQdRdSZdTdUdPdVdWdXZd S)Zr#a Base class for Bokeh property instances, which can be added to Bokeh Models. Args: default (obj, optional) : A default value for attributes created from this property to have. help (str or None, optional) : A documentation string for this property. It will be automatically used by the :ref:`bokeh.sphinxext.bokeh_prop` extension when generating Spinx documentation. (default: None) serialized (bool, optional) : Whether attributes created from this property should be included in serialization (default: True) readonly (bool, optional) : Whether attributes created from this property are read-only. (default: False) TzClassVar[bool]_should_validatebool _readonlyz8List[Tuple[Property[Any], Callable[[Property[Any]], T]]] alternativeszTList[Tuple[Callable[[HasProps, T], bool], str | Callable[[HasProps, str, T], None]]] assertionsNFInit[T] str | None bool | Nonedefaulthelp serializedreadonlycCs^|tk r |nt}|dkr0|r(|tkr(dnd|_n||_||_||_||_||_g|_g|_dS)NFT) rr _serializedr-_default_help__doc__r.r/)selfr4r5r6r7r)r)r*__init__szProperty.__init__strreturncCs|jjSN) __class__r&r<r)r)r*__str__szProperty.__str__zList[PropertyDescriptor[T]])namer@cCs t||gS)a Return a list of ``PropertyDescriptor`` instances to install on a class, in order to delegate attribute access to this property. Args: name (str) : the name of the property these descriptors are for Returns: list[PropertyDescriptor] The descriptors returned are collected by the ``MetaHasProps`` metaclass and added to ``HasProps`` subclasses during class creation. r)r<rEr)r)r*make_descriptorss zProperty.make_descriptorscCst|jtjS)z False if we have a default that is immutable, and will be the same every time (some defaults are generated on demand by a function to be called). ) isinstancer9types FunctionTyperCr)r)r*_may_have_unstable_defaultsz#Property._may_have_unstable_defaultzCallable[[], T] | Tr%)r4r@cCst|tjst|S|SdS)zj Return a copy of the default, or a new value if the default is specified by a function. N)rGrHrIr)clsr4r)r)r* _copy_defaults zProperty._copy_defaultcCs ||jS)z Return the untransformed default value. The raw_default() needs to be validated and transformed by prepare_value() before use, and may also be replaced later by subclass overrides or by themes. )rLr9rCr)r)r* _raw_defaultszProperty._raw_defaultzType[HasProps]zDict[str, Any] | None)rKrEtheme_overridesr@cCsJ|}|dks||kr|}||kr4|||}n|}||||S)zO The default, transformed by prepare_value() and the theme overrides. N)Z_overridden_defaultsrLrM prepare_value)r<rKrErNZ overridesr4r)r)r*themed_defaultszProperty.themed_defaultcCs|jS)z Whether the property should be serialized when serializing an object. This would be False for a "virtual" or "convenience" property that duplicates information already available in other properties, for example. )r8rCr)r)r*r6szProperty.serializedcCs|jS)z Whether this property is read-only. Read-only properties may only be modified by the client (i.e., by BokehJS in the browser). )r-rCr)r)r*r7szProperty.readonly)newoldr@csttjsttjr$tStrpttjs@ttjrLtSttjsdttjrptSzXttrttrt t krWdSt fddDWSkWSt k rYdSXdS)aj Whether two parameters match values. If either ``new`` or ``old`` is a NumPy array or Pandas Series or Index, then the result of ``np.array_equal`` will determine if the values match. Otherwise, the result of standard Python equality will be returned. Returns: True, if new and old match, False otherwise Fc3s"|]}||VqdSrA)matches).0krQrRr<r)r* sz#Property.matches..N) rGnpZndarrayZ array_equalpdZSeriesZIndexdictsetkeysall ValueError)r<rQrRr)rVr*rSs     zProperty.matchesmodelsrzDict[ID, HasProps] | Nonejsonr`r@cCs|S)z Convert from JSON-compatible values into a value for this property. JSON-compatible values are: list, dict, number, string, bool, None r)r<rbr`r)r)r* from_json szProperty.from_jsonvaluer@cCs|S)z< Change the value into a JSON serializable format. r)r<rfr)r)r*serialize_valueszProperty.serialize_valuecCs|S)z Change the value into the canonical format for this property. Args: value (obj) : the value to apply transformation to. Returns: obj: transformed value r)rgr)r)r* transforms zProperty.transformNonerfdetailr@cCsdS)a Determine whether we can set this property from this value. Validation happens before transform() Args: value (obj) : the value to validate against this property type detail (bool, options) : whether to construct detailed exceptions Generating detailed type validation error messages can be expensive. When doing type checks internally that will not escape exceptions to users, these messages can be skipped by setting this value to False (default: True) Returns: None Raises: ValueError if the value is not valid for this property type Nr)r<rfrlr)r)r*validate#szProperty.validatecCs6ztr||dWntk r,YdSXdSdS)z Whether the value passes validation Args: value (obj) : the value to validate against this property type Returns: True if valid, False otherwise FTN)r$rnr^rgr)r)r*is_valid:s zProperty.is_validcCs|S)zT Some property types need to wrap their values in special containers, etc. r)rgr)r)r*wrapLsz Property.wrapzDocumentPatchedEvent | None)rfhintr@cCs|SrAr))r<rfrqr)r)r* _hinted_valueRszProperty._hinted_value)rqzHasProps | Type[HasProps])ownerrErfrqr@c CsJ|tkr|}|tkr|Sd}z tr>|||}||WnLtk r}z.|jD]\}} ||rX| |}q|qX|}W5d}~XYnX|dkr| |}n.t |t r|n|j } td| d|d|t |t r@|} |j D]X\} } t | tr| }n | | |}t |tst|st | tr2t| q| | ||q||S)Nzfailed to validate .z: )rrMrr$rrrnr^r.rorirGrr&r/r,AssertionErrorr>rp)r<rsrErfrqerrorZ hinted_valueetp converterZobj_reprobjfn msg_or_fnresultr)r)r*rOUs>        zProperty.prepare_valuecCsdS)NFr)rCr)r)r*has_refszProperty.has_refTypeOrInst[Property[Any]]zCallable[[Property[Any]], T]z Property[T])rxryr@cCst|}|j||f|S)a Declare that other types may be converted to this property type. Args: tp (Property) : A type that may be converted automatically to this property type. converter (callable) : A function accepting ``value`` to perform conversion of the value to this property type. Returns: self )ParameterizedProperty_validate_type_paramr.append)r<rxryr)r)r*acceptss zProperty.acceptszCallable[[HasProps, T], bool]z(str | Callable[[HasProps, str, T], None])r{r|r@cCs|j||f|S)a Assert that prepared values satisfy given conditions. Assertions are intended in enforce conditions beyond simple value type validation. For instance, this method can be use to assert that the columns of a ``ColumnDataSource`` all collectively have the same length at all times. Args: fn (callable) : A function accepting ``(obj, value)`` that returns True if the value passes the assertion, or False otherwise. msg_or_fn (str or callable) : A message to print in case the assertion fails, or a function accepting ``(obj, name, value)`` to call in in case the assertion fails. Returns: self )r/r)r<r{r|r)r)r*assertsszProperty.asserts)T)r&r'r(r;r+__annotations__rr=rDrFrJ classmethodrLrMrPpropertyr6r7rSrdrhrirnrorprrrOr~rrr)r)r)r*r#asB     ( -r#TItem)boundc@sPeZdZdZedddddddd Zed d d d Zedd ddZdS)rzT A base class for Properties that have type parameters, e.g. ``List(String)``. F) help_allowedrr,z Property[Any]) type_paramrr@cCsXt|tr"t|tr|S|j}n$t|trF|jdk rB|sBtd|Std|dS)Nz4setting 'help' on type parameters doesn't make sensez+expected a Property as type parameter, got )rGtype issubclassr#r&r:r^)rrr)r)r*rs   z*ParameterizedProperty._validate_type_paramList[Property[Any]]r?cCs tddS)Nzabstract method)NotImplementedErrorrCr)r)r* type_paramssz!ParameterizedProperty.type_paramscCstdd|jDS)Ncss|] }|jVqdSrA)r~)rTrr)r)r*rWsz0ParameterizedProperty.has_ref..)anyrrCr)r)r*r~szParameterizedProperty.has_refN) r&r'r(r; staticmethodrrrr~r)r)r)r*rsrcseZdZdZeddddddddd d fd d Zed dddZddddZd'dd ddfdd Z ddddddddZ ddd d!d"Z ddd d#d$Z d dd%d&Z ZS)(SingleParameterizedPropertyz8 A parameterized property with a single type parameter. NFr3rr0r1r2r,)rr4r5r6r7cs:|||_|tk r|n|j}tj||||ddS)Nr3)rrrrMsuperr=)r<rr4r5r6r7rBr)r*r=s z$SingleParameterizedProperty.__init__rr?cCs|jgSrA)rrCr)r)r*rsz'SingleParameterizedProperty.type_paramsr>cCs|jjd|jdSN())rBr&rrCr)r)r*rDsz#SingleParameterizedProperty.__str__Trrjrkcs$tj||d|jj||ddS)N)rl)rrnrrmrr)r*rnsz$SingleParameterizedProperty.validater_Dict[str, HasProps] | Noner%racCs|jj||dS)Nr_)rrdrcr)r)r*rdsz%SingleParameterizedProperty.from_jsonrecCs |j|SrA)rrirgr)r)r*risz%SingleParameterizedProperty.transformcCs |j|SrA)rrprgr)r)r*rpsz SingleParameterizedProperty.wrapcCs |jSrA)rrJrCr)r)r*rJsz6SingleParameterizedProperty._may_have_unstable_default)T)r&r'r(r;rr=rrrDrnrdrirprJ __classcell__r)r)rr*rsrcsNeZdZUdZded<dddddfd d Zd d dd ddddZZS)r"a A base class for simple property types. Subclasses should define a class attribute ``_underlying_type`` that is a tuple of acceptable type values for the property. Example: A trivial version of a ``Float`` property might look like: .. code-block:: python class Float(PrimitiveProperty): _underlying_type = (numbers.Real,) zClassVar[Tuple[Type[T]]]_underlying_typeTrr,rjrkcsft||t||jrdS|s*tdtdd|jD}d|d|dt|j}t|dS)NcSsg|] }|jqSr)r&rTrKr)r)r* sz.PrimitiveProperty.validate..zexpected a value of type , got of type )rrnrGrr^rrr&)r<rfrl expected_typemsgrr)r*rns zPrimitiveProperty.validateNr_rr%racCsPt||jr|Stdd|jD}|d|d|dt|j}t|dS)NcSsg|] }|jqSr)rrr)r)r*rsz/PrimitiveProperty.from_json..z expected rr)rGrrrr&r!)r<rbr`rrr)r)r*rds   zPrimitiveProperty.from_json)T)r&r'r(r;rrnrdrr)r)rr*r"s  r"c@seZdZdZddddZdS)r z7 A base class for Container-like type properties. r,r?cCsdS)NTr)rCr)r)r*rJsz,ContainerProperty._may_have_unstable_defaultN)r&r'r(r;rJr)r)r)r*r sr r,r?cCstjS)zR Check if property validation is currently active Returns: bool )r#r+r)r)r)r*r$"sr$cCst|dt|jdSr)rrr)rzr)r)r* _sphinx_type3sr);r; __future__rlogging getLoggerr&logrHrtypingrrrrrr r r r r ZnumpyrXZutil.dependenciesrZ util.stringrZ has_propsrZ_sphinxrrrZdescriptor_factoryrZ descriptorsrZ singletonsrrrrZdocument.eventsrrrY__all__r%Z TypeOrInstZInit Exceptionr!r#rrrr"r r$rr)r)r)r*sD   0        U '