U /ePZ@szdZddlmZddlZeeZddlmZddl m Z ddl m Z m Z mZmZmZmZmZmZddlmZdd lmZmZdd lmZdd lmZmZmZm Z dd l!m"Z"dd l#m$Z%ddl&m'Z'm(Z(ddl)m*Z*ddl+m,Z,m-Z-ddl.m/Z/m0Z0m1Z1m2Z2e rXddlm3Z3ddl4m5Z5ddlm6Z6ddl7m8Z8ddl9m:Z:ddl;mZ>dZ?eGdddee/e(e'Z@dS)z` Provide a base class for all objects (called Bokeh Models) that can go in a Bokeh |Document|. ) annotationsN)isclass)loads) TYPE_CHECKINGAnyClassVarDictIterableListSetType) properties)HasPropsabstract)serialize_json)IDRef ReferenceJsonUnknown)Event)default)EventCallbackManagerPropertyCallbackManager)make_id) html_reprprocess_example)HasDocumentRefcollect_modelsqualified_model(visit_value_and_its_immediate_references)Setter) SelectorType)JSON)Document)DocumentPatchedEvent)Callback)PropertyCallback)ModelcsreZdZUdZiZded<efddZded<ddfd d Zd d d fdd Z ddddZ e Z d dddZ e ddddZejejddZded<ejejddZded<ejejeedddZejejd dZejejeedd!dZejd"d#d$Zd%ed&<e d'dd(d)Ze d*dd+d,Zd-d.d d/d0d1Zdidddd3d d4d5d6Z dd.d d/d7d8Z!dd9d d:fd;d< Z"d=dd>d?Z#d@dAdBdCdDZ$d@dEdBdFdGZ%dHdId dJdKdLZ&d%dMdNdOdPZ'd%ddNdQdRZ(djddSdSdTdUd dVfdWdX Z)dYd dZd[d\Z*ed dd]d^Z+d dd_d`Z,d%dadbdcZ-dddddeZ.dfddgdhZ/Z0S)kr)zH Base class for all objects stored in Bokeh |Document| instances. z ClassVar[Dict[str, Type[Model]]]model_class_reverse_mapcstd|jkr|j|_d|jkr.|j|_t|}||_|j |d}|dk rpt |dspt d|d|||j |<t |dS)N__view_model____view_module____implementation__z*Duplicate qualified model declaration of 'z'. Previous definition: )super__init_subclass____dict____name__r+ __module__r,r __qualified_model__r*gethasattrWarningr)clsZ qualifiedprevious __class__5/tmp/pip-unpacked-wheel-f5fndrjf/bokeh/model/model.pyr/\s    zModel.__init_subclass__r_id)returncs t|}|dt|_|SNid)r.__new__poprr=)r7argskwargsobjr9r;r<rAts z Model.__new__rNone)rDr>c s(|ddtjf|t|dSr?)rBr.__init__ default_themeapply_to_model)selfrDr9r;r<rGys zModel.__init__strcCs|jj}|d|jdS)Nz(id=z, ...))r:r1r@)rJnamer;r;r<__str__sz Model.__str__cCsd|_d|_|jdS)z; Clean up references to the document and property N) _documentZ_temp_documentZ_property_valuesclearrJr;r;r<destroysz Model.destroycCs|jSN)r=rPr;r;r<r@szModel.ida  An arbitrary, user-supplied name for this model. This name can be useful when querying the document to retrieve specific Bokeh models. .. code:: python >>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)] .. note:: No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason. )helpz str | NonerLa An optional list of arbitrary, user-supplied values to attach to this model. This data can be useful when querying the document to retrieve specific Bokeh models: .. code:: python >>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)] Or simply a convenient way to attach any necessary metadata to a model that can be accessed by ``CustomJS`` callbacks, etc. .. note:: No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason. z List[Any]tagszbokeh.models.callbacks.CustomJSaQ A mapping of event names to lists of ``CustomJS`` callbacks. Typically, rather then modifying this property directly, callbacks should be added using the ``Model.js_on_event`` method: .. code:: python callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback) z List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model. a A mapping of attribute names to lists of ``CustomJS`` callbacks, to be set up on BokehJS side when the document is created. Typically, rather then modifying this property directly, callbacks should be added using the ``Model.js_on_change`` method: .. code:: python callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback) Ta Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to ``False`` may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don't need. .. note:: Setting this property to ``False`` will prevent any ``on_change()`` callbacks on this object from triggering. However, any JS-side callbacks will still work. )rrSboolsyncablercCs t|jdS)N)r@)rr=rPr;r;r<refsz Model.refrcCsRt|j|jid}d|jjkrN|dd}|j|d<d||d<|j|d<|S)a; A Bokeh protocol "structure" of this model, i.e. a dict of the form: .. code-block:: python { 'type' : << view model name >> 'id' : << unique model id >> } Additionally there may be a `subtype` field if this model is a subtype. )r@type attributes __subtype__rX.subtype) rr@r3r:r0splitr+joinrZ)rJthispartsr;r;r<structs   z Model.structzstr | Type[Event]JSEventCallback)event callbacksr>cGsrt|tr n*t|tr(t|tr(|j}ntd|t|j |g}|D]}||krL| |qL||j|<dS)Nz/expected string event name or event class, got ) isinstancerKrX issubclassrZ event_name ValueErrorlistjs_event_callbacksr4append)rJrdreZ all_callbackscallbackr;r;r< js_on_events  zModel.js_on_eventNzint | str | None)attrother other_attr attr_selectorr>c Cs|j|dd}|dkr&td||ft|tstd|j|dd}|d k r`d |j}d d |jD}||jkrg|j|<|D]$}||j|krq|j| |q| d ||jd S)a Attach a ``CustomJS`` callback to an arbitrary BokehJS model event. On the BokehJS side, change events for model properties have the form ``"change:property_name"``. As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with ``"change:"`` automatically: .. code:: python # these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback) However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ``ColumnDataSource``, use the ``"stream"`` event on the source: .. code:: python source.js_on_change('streaming', callback) rzRjs_on_change takes an event name and one or more callbacks, got only one parameterrsc3s|]}t|VqdSrR)rf).0xrsr;r< sz%Model.js_on_change..z.not all callback values are CustomJS instancesFrrNzchange:cSs i|]\}}|dd|DqS)cSsg|]}|qSr;r;)rrr;r;r< sz1Model.js_on_change...r;)rkZcbsr;r;r< sz&Model.js_on_change..js_property_callbacks) lenrhrzrtallryrLritemsrktrigger)rJrdrer}oldrlr;rsr<r|ts      zModel.js_on_changer()rnrer>cs"||}tj|jf|dS)ay Add a callback on this object to trigger when ``attr`` changes. Args: attr (str) : an attribute name on this object *callbacks (callable) : callback functions to register Returns: None Example: .. code-block:: python widget.on_change('value', callback1, callback2, ..., callback_n) N)ryr. on_changerL)rJrnrer}r9r;r<rs zModel.on_changez Set[Model]cCs tt|S)zE Returns all ``Models`` that this object has references to. )setrrPr;r;r< referencesszModel.referencesr#zIterable[Model])r~r>cCsddlm}|||S)z Query this object and all of its references for objects that match the given selector. Args: selector (JSON-like) : Returns: seq[Model] r )find) core.queryrr)rJr~rr;r;r<selects z Model.selectz Model | NonecCsBt||}t|dkr*td||ft|dkr:dS|dS)a5 Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found Args: selector (JSON-like) : Returns: Model rz*Found more than one object matching %s: %rrN)rirrrh)rJr~resultr;r;r< select_ones   zModel.select_onezType[Model] | SelectorTypezDict[str, Unknown])r~updatesr>cCsNt|rt|trt|d}||D]"}|D]\}}t|||q2q&dS)z Update objects that match a given selector with the specified attribute/value updates. Args: selector (JSON-like) : updates (dict) : Returns: None )rXN)rrgr)r{rrsetattr)rJr~rrEkeyvalr;r;r< set_selects  zModel.set_selectr$)include_defaultsr>cCst|j|dS)a Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list). References to other objects are serialized as "refs" (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects. There's no corresponding ``from_json()`` because to deserialize an object is normally done in the context of a Document (since the Document can resolve references). For most purposes it's best to serialize and deserialize entire documents. Args: include_defaults (bool) : whether to include attributes that haven't been changed from the default r)rto_json_string)rJrr;r;r<to_jsonsz Model.to_jsoncCs|j|d}|j|d<t|S)a Returns a JSON string encoding the attributes of this object. References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects. There's no corresponding ``from_json_string()`` because to deserialize an object is normally done in the context of a Document (since the Document can resolve references). For most purposes it's best to serialize and deserialize entire documents. Args: include_defaults (bool) : whether to include attributes that haven't been changed from the default rr@) _to_json_liker@r)rJrZ json_liker;r;r<rs  zModel.to_json_stringrzDocumentPatchedEvent | Nonez Setter | None)rnrnewhintsetterr>csv|dkrPdddfdd }|jdk rPt||t||dkrP|jj||}tj|j||||ddS)z Nrr_cs d7dS)Nrr;rZ dirty_countr;r< mark_dirty-sz!Model.trigger..mark_dirty)rr) rNr!documentmodelsZ invalidateryr.rrL)rJrnrrrrrr}r9rr<rs      z Model.triggerr%)docr>cCsF|j|krdS|jdk r(td|d|j|||_|dS)z Attach a model to a Bokeh |Document|. This private interface should only ever called by the Document implementation to set the private ._document field properly Nz0Models must be owned by only a single document, z is already in a doc)r RuntimeErrorZthemerIZ_update_event_callbacks)rJrr;r;r<_attach_document9s   zModel._attach_documentcCsdd|jD|_dS)NcSsFi|]>\}}t|dddkrt|dddkrt|dddkr||qS)r-NZ__javascript__Z__css__)getattr)rrvr;r;r<rLs z+Model._clear_extensions..)r*r)r7r;r;r<_clear_extensionsJszModel._clear_extensionscCsd|_t|dS)z Detach a model from a Bokeh |Document|. This private interface should only ever called by the Document implementation to unset the private ._document field properly N)rrHrIrPr;r;r<_detach_documentSszModel._detach_documentrc Cs|j|d}t|jdd}|dk r^||jjkr^i}|D] \}}||jjkrRq:q:|||<q:n|}|D]&\}}t|trj|tdkrjd||<qj|S)a Returns a dictionary of the attributes of this object, in a layout corresponding to what BokehJS expects at unmarshalling time. This method does not convert "Bokeh types" into "plain JSON types," for example each child Model will still be a Model, rather than turning into a reference, numpy isn't handled, etc. That's what "json like" means. This method should be considered "private" or "protected", for use internal to Bokeh; use ``to_json()`` instead because it gives you only plain JSON-compatible types. Args: include_defaults (bool) : whether to include attributes that haven't been changed from the default. rrZNinf)Zproperties_with_valuesrr:r+rr0rffloat) rJrZ all_attrsr]attrsrnvaluerrr;r;r<r]s    zModel._to_json_likecCst|SrR)rrPr;r;r< _repr_html_szModel._repr_html_z int | NonecCsdSrRr;rPr;r;r<_sphinx_height_hintszModel._sphinx_height_hint)N)NN)1r1r2 __qualname____doc__r*__annotations__ classmethodr/rArGrM__repr__rQpropertyr@pZNullableStringrLr ZAnyRefrTrZInstancerjZsubscribed_eventsrZBoolrVrWrbrmrr|rrrrrrrrrrrrrr __classcell__r;r;r9r<r)TsX    Q- -r))Ar __future__rlogging getLoggerr1loginspectrjsonrtypingrrrrr r r r corerrZcore.has_propsrrZcore.json_encoderrZ core.typesrrrreventsrZthemesrrHZutil.callback_managerrrZutil.serializationrZdocsrrutilrrr r!r"rr#r$rr%Zdocument.eventsr&Zmodels.callbacksr'rcr(__all__r)r;r;r;r<s6    (