bokeh.core.property.bases

为Bokeh属性系统提供基类。

注解

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

exception DeserializationError

class ContainerProperty(default=None, help=None, serialized=None, readonly=False)

类容器类型属性的基类。

class PrimitiveProperty(default=None, help=None, serialized=None, readonly=False)

用于简单属性类型的基类。

子类应该定义一个类属性 _underlying_type 属性的可接受类型值的元组。

示例

一个 Float 属性可能看起来像：

class Float(PrimitiveProperty):
    _underlying_type = (numbers.Real,)

from_json(json, models=None)

将JSON兼容值转换为此属性的值。

与JSON兼容的值有：list、dict、number、string、bool、None

validate(value, detail=True)

确定是否可以从此值设置此属性。

验证发生在transform（）之前

参数

• value (obj) -- 要针对此属性类型验证的值

• detail (bool, options) -- 是否构造生成详细类型验证错误消息的详细异常可能代价高昂。在内部执行类型检查时，如果不将异常转义给用户，则可以通过将此值设置为False（默认值：True）跳过这些消息

返回

没有

引发

ValueError if the value is not valid for this property type --

class Property(default=None, help=None, serialized=None, readonly=False)

Bokeh属性实例的基类，可以将其添加到Bokeh模型中。

参数

• default (obj or None, optional) -- 从该属性创建的属性的默认值（默认值：无）

• help (str or None, optional) -- 此属性的文档字符串。它将由 bokeh_prop 生成Spinx文档时的扩展。（默认值：无）

• serialized (bool, optional) -- 从该属性创建的属性是否应包含在序列化中（默认值：True）

• readonly (bool, optional) -- 从该属性创建的属性是否为只读。（默认值：False）

__init__(default=None, help=None, serialized=None, readonly=False)

初始化自身。请参阅帮助（键入（self））以获得准确的签名。

__str__()

返回str（self）。

accepts(tp, converter)

声明其他类型可以转换为此属性类型。

参数

• tp (Property) -- 可以自动转换为此属性类型的类型。

• converter (callable) -- 接受的功能 value 将值转换为此属性类型。

返回

自己

asserts(fn, msg_or_fn)

断言准备好的值满足给定条件。

断言用于强制条件，而不是简单的值类型验证。例如，可以使用此方法断言 ColumnDataSource 所有人在任何时候都有相同的长度。

参数

• fn (callable) -- 接受的功能 (obj, value) 如果值通过断言，则返回True，否则返回False。

• msg_or_fn (str or callable) -- 断言失败时要打印的消息，或接受的函数 (obj, name, value) 在断言失败时调用。

返回

自己

from_json(json, models=None)

将JSON兼容值转换为此属性的值。

与JSON兼容的值有：list、dict、number、string、bool、None

is_valid(value)

值是否通过验证

参数

value (obj) -- 要针对此属性类型验证的值

返回

如果有效则为真，否则为假

make_descriptors(base_name)

返回的列表 BasicPropertyDescriptor 要安装在类上的实例，以便委托对此属性的属性访问。

参数

name (str) -- 这些描述符用于的属性的名称

返回

列表 [BasicPropertyDescriptor]

返回的描述符由 MetaHasProps 元类并添加到 HasProps 类创建期间的子类。

matches(new, old)

两个参数是否匹配值。

如果任一 new 或 old 是NumPy数组或Pandas系列或索引，则 np.array_equal 将确定值是否匹配。

否则，将返回标准Python相等的结果。

返回

如果新旧匹配，则为True，否则为False

serialize_value(value)

将值更改为JSON可序列化格式。

themed_default(cls, name, theme_overrides)

由prepare_value（）和主题重写转换的默认值。

transform(value)

将值更改为此属性的规范格式。

参数

value (obj) -- 要应用转换的值。

返回

转化价值

返回类型

obj

validate(value, detail=True)

确定是否可以从此值设置此属性。

验证发生在transform（）之前

参数

• value (obj) -- 要针对此属性类型验证的值

• detail (bool, options) -- 是否构造生成详细类型验证错误消息的详细异常可能代价高昂。在内部执行类型检查时，如果不将异常转义给用户，则可以通过将此值设置为False（默认值：True）跳过这些消息

返回

没有

引发

ValueError if the value is not valid for this property type --

classmethod wrap(value)

某些属性类型需要将其值包装在特殊容器中，等等。

property readonly

此属性是否为只读。

只读属性只能由客户端（即浏览器中的BokehJS）修改。

property serialized

序列化对象时是否应序列化属性。

例如，对于“虚拟”或“便利”属性，如果该属性复制了其他属性中已有的信息，则该属性将为False。

validation_on()

检查属性验证当前是否处于活动状态

返回

布尔