bokeh.core.has_props

为可以具有声明性、类型化和可序列化属性的对象提供基类。

注解

这些类构成实现Bokeh模型和属性系统的非常低级的机制的一部分。任何人都不可能直接使用这些基础设施来开发他们的任何类。

class HasProps(**properties)

所有具有Bokeh属性的类类型的基类。

__init__(**properties)

apply_theme(property_values)

应用一组主题值，这些值将被使用而不是默认值，但不会覆盖应用程序集值。

传入的字典可以保持原样，并与其他实例共享以节省内存（因此无论是调用方还是 HasProps 实例应该修改它）。

参数

property_values (dict) -- 主题值用于替代默认值

返回

没有

classmethod dataspecs()

收集所有人的名字 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称 DataSpec 性质

返回类型

set[str]

classmethod dataspecs_with_props()

收集一张记录所有人姓名的字典 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称和 DataSpec 性质

返回类型

dict[str, DataSpec]

equals(other)

模型的结构相等。

参数

other (HasProps) -- 要比较的另一个实例

返回

如果属性在结构上相等，则为True，否则为False

classmethod lookup(name)

找到 PropertyDescriptor 对于类上的Bokeh属性，给定属性名。

参数

name (str) -- 要搜索的属性的名称

返回

名为的属性的描述符 name

返回类型

PropertyDescriptor

classmethod properties(with_bases=True)

收集此类的属性名称。

这种方法 任选地 遍历类层次结构并包含在任何父类上定义的属性。

参数

with_bases (bool, optional) -- 是否在结果中包含在父类上定义的属性。（默认值：True）

返回

属性名称

返回类型

set[str]

classmethod properties_containers()

收集此类上所有容器属性的名称。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

容器属性名称

返回类型

set[str]

classmethod properties_with_refs()

收集该类上也有引用的所有属性的名称。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

具有引用的属性的名称

返回类型

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

收集将属性名称映射到其值的dict。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

跳过不可序列化的属性，属性值采用“序列化”格式，这可能与通常从属性中读取的值略有不同；此方法的目的是返回无损重建对象实例所需的信息。

参数

include_defaults (bool, optional) -- 是否包含自创建对象后尚未显式设置的属性。（默认值：True）

返回

从属性名到属性值的映射

返回类型

dict

query_properties_with_values(query, include_defaults=True)

查询的属性值 HasProps 带有谓词的实例。

参数

• query (callable) -- 接受属性描述符并返回True或False的可调用文件

• include_defaults (bool, optional) -- 是否包含尚未由用户显式设置的属性（默认值：True）

返回

为匹配的属性映射属性名称和值

返回类型

dict

set_from_json(name, json, models=None, setter=None)

从JSON设置此对象的属性值。

参数

• name -- （str）：要设置的属性的名称

• json -- （JSON value）：要设置为的属性的值

• models (dict or None, optional) -- 模型ID到模型的映射（默认值：无）在要更新的属性也有引用的值的情况下，需要这样做。

• setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较，并禁止任何源自自身的更新。

返回

没有

themed_values()

获取任何主题提供的覆盖。

结果以dict形式从属性名返回到值，或者 None 如果没有主题覆盖此实例的任何值。

返回

不记名

unapply_theme()

删除所有主题值并恢复默认值。

返回

没有

update(**kwargs)

从给定的关键字参数更新对象的属性。

返回

没有

实际案例

以下是等效的：

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, models=None, setter=None)

对象的属性从字典中更新。

参数

• json_attributes -- （JSON dict）：要更新的属性和值

• models (dict or None, optional) -- 模型ID到模型的映射（默认值：无）在要更新的属性也有引用的值的情况下，需要这样做。

• setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较，并禁止任何源自自身的更新。

返回

没有

class MetaHasProps(class_name, bases, class_dict)

专门建造 HasProps 类。

这个班是 metaclass 对于 HasProps 负责创建和添加 PropertyDescriptor 将验证和序列化委托给 Property 属性。

abstract(cls)

用于标记派生自的抽象基类的修饰符 HasProps .

accumulate_dict_from_superclasses(cls, propname)

遍历类层次结构并积累特殊的dict MetaHasProps 存储在类上：

参数

name (str) -- 要收集的特殊属性的名称。通常有意义的值是： __dataspecs__ ， __overridden_defaults__

accumulate_from_superclasses(cls, propname)

遍历类层次结构并累积特殊的名称集 MetaHasProps 存储在类上：

参数

name (str) -- 要收集的特殊属性的名称。通常有意义的值是： __container_props__ ， __properties__ ， __properties_with_refs__