bokeh.core.query

query 模块提供了用于搜索 Bokeh 模型集合以查找与指定条件匹配的实例的函数。

class EQ

用于测试属性值是否等于某个值的谓词。

构造和 EQ 谓词，使用 EQ 作为键，以及要比较的值，以字典形式表示。

# matches any models with .size == 10
dict(size={ EQ: 10 })

class GEQ

用于测试属性值是否大于或等于某个值的谓词。

构造和 GEQ 谓词，使用 GEQ 作为键，以及要比较的值，以字典形式表示。

# matches any models with .size >= 10
dict(size={ GEQ: 10 })

class GT

用于测试属性值是否大于某个值的谓词。

构造和 GT 谓词，使用 GT 作为键，以及要比较的值，以字典形式表示。

# matches any models with .size > 10
dict(size={ GT: 10 })

class IN

用于测试属性值是否在某个集合中的谓词。

构造和 IN 谓词，使用 IN 作为键，以及要检查的值列表，以字典形式表示。

# matches any models with .name in ['a', 'mycircle', 'myline']
dict(name={ IN: ['a', 'mycircle', 'myline'] })

class LEQ

用于测试属性值是否小于或等于某个值的谓词。

构造和 LEQ 谓词，使用 LEQ 作为键，以及要比较的值，以字典形式表示。

# matches any models with .size <= 10
dict(size={ LEQ: 10 })

class LT

用于测试属性值是否小于某个值的谓词。

构造和 LT 谓词，使用 LT 作为键，以及要比较的值，以字典形式表示。

# matches any models with .size < 10
dict(size={ LT: 10 })

class NEQ

用于测试属性值是否不等于某个值的谓词。

构造和 NEQ 谓词，使用 NEQ 作为键，以及要比较的值，以字典形式表示。

# matches any models with .size != 10
dict(size={ NEQ: 10 })

class OR

从其他查询谓词形成析取。

构造一个 OR 表达式，使用 OR 作为键，以及其他查询表达式的列表作为值，以字典形式表示

# matches any Axis subclasses or models with .name == "mycircle"
{ OR: [dict(type=Axis), dict(name="mycircle")] }

find(objs: Iterable[Model], selector: dict[str | type[_Operator], Any]) → Iterable[Model]

查询 Bokeh 模型集合，并生成任何与选择器匹配的模型。

参数:

• objs (Iterable[Model]) – 要测试的模型对象

• selector (JSON-like) – 查询选择器

Yields:

Model – 与查询匹配的对象

查询被指定为类似于 MongoDB 风格查询选择器的选择器，如 match() 中所述。

示例

# find all objects with type Grid
find(p.references(), {'type': Grid})

# find all objects with type Grid or Axis
find(p.references(), {OR: [
    {'type': Grid}, {'type': Axis}
]})

# same query, using IN operator
find(p.references(), {'type': {IN: [Grid, Axis]}})

is_single_string_selector(selector: dict[str | type[_Operator], Any], field: str) → bool

判断选择器是否为简单的单字段，例如 {name: "foo"}

参数:

• selector (JSON-like) – 查询选择器

• field (str) – 要检查的字段名称

返回

bool

match(obj: Model, selector: dict[str | type[_Operator], Any]) → bool

测试给定的 Bokeh 模型是否与给定的选择器匹配。

参数:

• obj (Model) – 要测试的对象

• selector (JSON-like) – 查询选择器

返回:

如果对象匹配，则为 True，否则为 False

返回类型:

bool

通常，选择器具有以下形式

{ attrname : predicate }

其中谓词由运算符 EQ、GT 等构成，并用于与名为 attrname 的模型属性的值进行比较。

例如

>>> from bokeh.plotting import figure
>>> p = figure(width=400)

>>> match(p, {'width': {EQ: 400}})
True

>>> match(p, {'width': {GT: 500}})
False

有两个选择器键被特殊处理。第一个是 ‘type’，它将执行 isinstance 检查

>>> from bokeh.plotting import figure
>>> from bokeh.models import Axis
>>> p = figure()

>>> match(p.xaxis[0], {'type': Axis})
True

>>> match(p.title, {'type': Axis})
False

还有一个 'tags' 属性，Model 对象具有该属性，它是由用户提供的值列表。'tags' 选择器键可用于查询此标签列表。如果选择器中的任何标签与对象上的任何标签匹配，则对象匹配

>>> from bokeh.plotting import figure
>>> p = figure(tags = ["my plot", 10])

>>> match(p, {'tags': "my plot"})
True

>>> match(p, {'tags': ["my plot", 10]})
True

>>> match(p, {'tags': ["foo"]})
False