dtoolkit.accessor.series.query#

dtoolkit.accessor.series.query(s: Series, /, expr: str, **kwargs) → Series[source]#

Query the columns of a Series with a boolean expression.

Parameters:

exprstr: The query string to evaluate.
**kwargs: See the documentation for pandas.eval() for complete details on the keyword arguments.

Returns:

Series

See also

pandas.eval: Evaluate a Python expression as a string using various backends.
pandas.DataFrame.query: Evaluates a boolean expression to query DataFrame.
dtoolkit.accessor.series.eval: Evaluate a string describing operations on Series columns.

Examples

>>> import dtoolkit
>>> import pandas as pd

The name should be set.

>>> s = pd.Series([1, 2, 3], index=["a", "b", "c"], name="col")
>>> s
a    1
b    2
c    3
Name: col, dtype: int64
>>> s.query("col == 1")
a    1
Name: col, dtype: int64
>>> s.query("index == 'c'")
c    3
Name: col, dtype: int64