FilterCapability#

class scikitplot.corpus.FilterCapability(supported=frozenset({}), emulated=frozenset({}), rejected=frozenset({}))[source]#

A backend’s declared answer for the operators in one expression.

Parameters:
supportedfrozenset of str

Executed natively.

emulatedfrozenset of str

Executed by a fallback path with equivalent semantics.

rejectedfrozenset of str

Refused; the query does not run.

Parameters:

Notes

Developer. Every operator in an expression must appear in exactly one set. for_expression enforces that, so “silently ignored” is not a reachable state rather than merely a discouraged one.

emulated: frozenset[str] = frozenset({})#
classmethod for_expression(expression, *, native=(), emulated=())[source]#

Classify every operator in expression.

Parameters:
expressionFilter

Filter

nativeiterable of str, optional

Operators this backend executes natively.

emulatediterable of str, optional

Operators it answers by a fallback path.

Returns:
FilterCapability

Anything neither native nor emulated is rejected – the default is refusal, never silent omission.

Parameters:
Return type:

FilterCapability

property ok: bool#

Whether every operator can be answered.

raise_if_rejected()[source]#

Raise if any operator was refused.

Raises:
UnsupportedOperatorError

Naming the refused operators.

Return type:

None

rejected: frozenset[str] = frozenset({})#
supported: frozenset[str] = frozenset({})#
to_dict()[source]#

Return a JSON-compatible mapping.

Return type:

dict[str, Any]