Prop

class Prop(name)

Bases: object

A reference to a property used for constructing filters

Use ==, !=, <, <=, >, >= to filter based on property value (these filters always exclude entities that do not have the property) or use one of the methods to construct other kinds of filters.

Parameters:

name (str) – the name of the property

Methods:

any(values)	Create a filter that keeps entities if their property value is in the set
is_none()	Create a filter that only keeps entities that do not have the property
is_some()	Create a filter that only keeps entities if they have the property
not_any(values)	Create a filter that keeps entities if their property value is not in the set or if they don't have the property

any(values)

Create a filter that keeps entities if their property value is in the set

Parameters:

values (set[PropValue]) – the set of values to match

Returns:

the property filter

Return type:

PropertyFilter

is_none()

Create a filter that only keeps entities that do not have the property

Returns:

the property filter

Return type:

PropertyFilter

is_some()

Create a filter that only keeps entities if they have the property

Returns:

the property filter

Return type:

PropertyFilter

not_any(values)

Create a filter that keeps entities if their property value is not in the set or if they don’t have the property

Parameters:

values (set[PropValue]) – the set of values to exclude

Returns:

the property filter

Return type:

PropertyFilter