bokeh.core.has_props

Provide a base class for objects that can have declarative, typed, serializable properties.

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.

class HasProps(**properties: Any)[source]

Base class for all class types that have Bokeh properties.

Public Methods:

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.
__init__(**properties: Any) → None[source]
apply_theme(property_values: Dict[str, Any]) → None[source]

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters

property_values (dict) – theme values to use in place of defaults

Returns

None

classmethod dataspecs() → Dict[str, DataSpec][source]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns

names of DataSpec properties

Return type

set[str]

equals(other: bokeh.core.has_props.HasProps) → bool[source]

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

classmethod lookup(name: str, *, raises: Literal[True] = 'True') → bokeh.core.property.descriptors.PropertyDescriptor[Any][source]
classmethod lookup(name: str, *, raises: Literal[False] = 'False') → Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters

  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns

descriptor for property named name

Return type

PropertyDescriptor

classmethod properties(*, _with_props: Literal[False] = 'False') → Set[str][source]
classmethod properties(*, _with_props: Literal[True] = 'True') → Dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns

property names

classmethod properties_with_refs() → Dict[str, Property[Any]][source]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns

names of properties that have references

Return type

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → Dict[str, Any][source]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns

mapping from property names to their values

Return type

dict

query_properties_with_values(query: Callable[[bokeh.core.property.descriptors.PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → Dict[str, Any][source]

Query the properties values of HasProps instances with a predicate.

Parameters

  • query (callable) – A callable that accepts property descriptors and returns True or False

  • include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns

mapping of property names and values for matching properties

Return type

dict

set_from_json(name: str, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) → None[source]

Set a property value on this object from JSON.

Parameters

  • name – (str) : name of the attribute to set

  • json – (JSON-value) : value to set to the attribute to

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • setter (ClientSession or ServerSession or None, optional) –

    This is used to prevent “boomerang” updates to Bokeh apps.

    In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns

None

classmethod static_to_serializable(serializer: StaticSerializer) → ModelRef[source]
themed_values() → Optional[Dict[str, Any]][source]

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns

dict or None

to_serializable(serializer: Any) → Any[source]
unapply_theme() → None[source]

Remove any themed values and restore defaults.

Returns

None

update(**kwargs: Any) → None[source]

Updates the object’s properties from the given keyword arguments.

Returns

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None[source]

Updates the object’s properties from a JSON attributes dictionary.

Parameters

  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • setter (ClientSession or ServerSession or None, optional) –

    This is used to prevent “boomerang” updates to Bokeh apps.

    In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns

None

class MetaHasProps(class_name: str, bases: Tuple[type, ...], class_dict: Dict[str, Any])[source]

Specialize the construction of HasProps classes.

This class is a metaclass for HasProps that is responsible for creating and adding the PropertyDescriptor instances that delegate validation and serialization to Property attributes.

abstract(cls: bokeh.core.has_props.C) → bokeh.core.has_props.C[source]

A decorator to mark abstract base classes derived from HasProps.

previous

bokeh.core.enums

next

bokeh.core.json_encoder