Bamboost

bamboostindex _filtering

bamboost.index._filtering

Source: https://gitlab.com/cmbm-ethz/bamboost/-/blob/main/bamboost/index_/_filtering.py

Attributes

Operand=typing.Union['_Key', 'Operator', str, float, int, datetime.datetime, datetime.timedelta]

Functions

add_operators(cls)

Arguments:

cls

Classes

_SupportsOperators

_SupportsOperators.__and__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__or__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__pow__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__mod__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__floordiv__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__truediv__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__mul__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__sub__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__add__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__ge__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__gt__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__ne__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__eq__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__le__(self, other) -> 'Operator'

Arguments:

other:Operand

_SupportsOperators.__lt__(self, other) -> 'Operator'

Arguments:

other:Operand

Operator

Operator(self, op, a, b=None)

Arguments:

op
a
b=None

Attributes:

_op=bamboost.index._filtering.Operator(op)
_a=bamboost.index._filtering.Operator(a)
_b=bamboost.index._filtering.Operator(b)

Bases

_SupportsOperators15

Operator.__repr__(self) -> str

Operator.evaluate(self, item) -> bool

Arguments:

item:dict

_Key

_Key(self, key) -> None

Arguments:

key:str

Attributes:

_value=bamboost.index._filtering._Key(key)

Bases

_SupportsOperators15

_Key.__repr__(self) -> str

Filter

Filter(self, *operators) -> None

Filter applied to a collection.

Arguments:

operators:Operator=()

Attributes:

_ops:typing.Sequence[Operator]=bamboost.index._filtering.Filter(operators)

Filter.__repr__(self) -> str

Filter.__and__(self, other) -> Filter

Arguments:

other:Filter | None

Filter.apply(self, df) -> DataFrame | Series | Any

Arguments:

df:pandas.DataFrame

SortInstruction

SortInstruction(self, key, ascending=True) -> None

Arguments:

key:str
ascending:bool=True

Attributes:

key=bamboost.index._filtering.SortInstruction(key)
ascending=bamboost.index._filtering.SortInstruction(ascending)

SortInstruction.__repr__(self) -> str

Sorter

Sorter(self, *instructions) -> None

Sorter applied to a collection.

Arguments:

instructions:SortInstruction=()

Attributes:

_instructions:typing.Sequence[SortInstruction]=bamboost.index._filtering.Sorter(instructions)

Sorter.__repr__(self) -> str

Sorter.__and__(self, other) -> Sorter

Arguments:

other:Sorter | None

Sorter.apply(self, df) -> DataFrame

Arguments:

df:pandas.DataFrame

index

Module for indexing BAMBOOST collections.

base

Indexing of bamboost collections and their simulations/parameters. SQLAlchemy is used to interact with the SQLite database.