polars の API リファレンス

polars (pola-rs/polars) の公開 API 400 件 —— クラス 85、関数 85、メソッド 230。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	85
関数	85
メソッド	230

API 一覧

funcpy-polars.debug.launch.launch_debugging() -> None

Debug Rust files via Python.

funcpy-polars.runtime.template.template(s:str, rt:str) -> str

Apply the runtime template substitutions.

methodpy-polars.src.polars._typing.Cursor.fetchall(*args:Any, **kwargs:Any) -> Any

Fetch all results.

methodpy-polars.src.polars._typing.Cursor.fetchmany(*args:Any, **kwargs:Any) -> Any

Fetch results in batches.

classpy-polars.src.polars._typing.SeriesBuffers

Underlying buffers of a Series.

methodpy-polars.src.polars._utils.cache.LRUCache.clear() -> None

Clear the cache, removing all items.

methodpy-polars.src.polars._utils.cache.LRUCache.keys() -> KeysView[K]

Return an iterable view of the cache's keys.

methodpy-polars.src.polars._utils.cache.LRUCache.pop(key:K, default:D | NoDefault=NO_DEFAULT) -> V | D

Remove specified key from the cache and return the associated value.

methodpy-polars.src.polars._utils.cache.LRUCache.values() -> ValuesView[V]

Return an iterable view of the cache's values.

funcpy-polars.src.polars._utils.construction.other.coerce_arrow(array:pa.Array) -> pa.Array

...

func

py-polars.src.polars._utils.construction.series.numpy_to_pyseries(name:str, values:np.ndarray[Any, Any], *strict:bool=True, *nan_to_null:bool=False) -> PySeries

Construct a PySeries from a numpy array.

funcpy-polars.src.polars._utils.construction.utils.get_first_non_none(values:Sequence[Any | None] | pl.Series) -> Any

Return the first value from a sequence that isn't None.

funcpy-polars.src.polars._utils.construction.utils.is_namedtuple(cls:Any, *annotated:bool=False) -> bool

Check if given class derives from NamedTuple.

funcpy-polars.src.polars._utils.construction.utils.is_pydantic_model(value:Any) -> bool

Check if value derives from a pydantic.BaseModel.

funcpy-polars.src.polars._utils.construction.utils.nt_unpack(obj:Any) -> Any

Recursively unpack a nested NamedTuple.

funcpy-polars.src.polars._utils.convert.date_to_int(d:date) -> int

Convert a Python time object to an integer.

funcpy-polars.src.polars._utils.convert.datetime_to_int(dt:datetime, time_unit:TimeUnit) -> int

Convert a Python datetime object to an integer.

funcpy-polars.src.polars._utils.convert.negate_duration_string(duration:str) -> str

Negate a Polars duration string.

funcpy-polars.src.polars._utils.convert.time_to_int(t:time) -> int

Convert a Python time object to an integer.

funcpy-polars.src.polars._utils.convert.timedelta_to_int(td:timedelta, time_unit:TimeUnit) -> int

Convert a Python timedelta object to an integer.

funcpy-polars.src.polars._utils.convert.to_py_date(value:int | float) -> date

Convert an integer or float to a Python date object.

funcpy-polars.src.polars._utils.convert.to_py_decimal(prec:int, value:str) -> Decimal

Convert decimal components to a Python Decimal object.

funcpy-polars.src.polars._utils.convert.to_py_time(value:int) -> time

Convert an integer to a Python time object.

funcpy-polars.src.polars._utils.convert.to_py_timedelta(value:int | float, time_unit:TimeUnit) -> timedelta

Convert an integer or float to a Python timedelta object.

funcpy-polars.src.polars._utils.deprecation.issue_deprecation_warning(message:str, *version:str='') -> None

Issue a deprecation warning.

funcpy-polars.src.polars._utils.nest_asyncio.manage_run(self)

Set up the loop for running.

func

py-polars.src.polars._utils.parse.expr.parse_into_expression(input:IntoExpr, *str_as_lit:bool=False, *list_as_series:bool=False, *structify:bool=False, *dtype:PolarsDataType | None=None, *require_selector:bool=False) -> PyExpr

Parse a single input into an expression.

func

py-polars.src.polars._utils.parse.expr.parse_into_list_of_expressions(*inputs:IntoExpr | Iterable[IntoExpr], **named_inputs:IntoExpr) -> list[PyExpr]

Parse multiple inputs into a list of expressions.

funcpy-polars.src.polars._utils.pycapsule.is_pycapsule(obj:Any) -> bool

Check if object looks like it supports the PyCapsule interface.

func

py-polars.src.polars._utils.pycapsule.pycapsule_to_frame(obj:Any, *schema:SchemaDefinition | None=None, *schema_overrides:SchemaDict | None=None, *rechunk:bool=False) -> DataFrame

Convert PyCapsule object to DataFrame.

funcpy-polars.src.polars._utils.reduce_balanced.reduce_balanced(function:Callable[[T, T], T], iterable:Iterable[T]) -> T

Applies a reduction in a balanced tree pattern.

classpy-polars.src.polars._utils.slice.LazyPolarsSlice

Apply python slice object to Polars LazyFrame.

methodpy-polars.src.polars._utils.slice.LazyPolarsSlice.apply(s:slice) -> LazyFrame

Apply a slice operation.

classpy-polars.src.polars._utils.slice.PolarsSlice

Apply Python slice object to Polars DataFrame or Series.

funcpy-polars.src.polars._utils.unstable.issue_unstable_warning(message:str | None=None) -> None

Issue a warning for use of unstable functionality.

funcpy-polars.src.polars._utils.unstable.unstable() -> IdentityFunction

Decorator to mark a function as unstable.

funcpy-polars.src.polars._utils.various.is_column(obj:Any) -> bool

Indicate if the given object is a basic/unaliased column.

func

py-polars.src.polars._utils.various.is_str_sequence(val:object, *allow_str:bool=False, *include_series:bool=False) -> TypeGuard[Sequence[str]]

Check that `val` is a sequence of strings.

funcpy-polars.src.polars._utils.various.normalize_filepath(path:str | Path, *check_not_directory:bool=True) -> str

Create a string path, expanding the home directory if present.

funcpy-polars.src.polars._utils.various.qualified_type_name(obj:Any, *qualify_polars:bool=False) -> str

Return the module-qualified name of the given object as a string.

funcpy-polars.src.polars._utils.various.range_to_series(name:str, rng:range, dtype:PolarsDataType | None=None) -> pl.Series

Fast conversion of the given range to a Series.

funcpy-polars.src.polars._utils.various.range_to_slice(rng:range) -> slice

Return the given range as an equivalent slice.

funcpy-polars.src.polars._utils.various.re_escape(s:str) -> str

Escape a string for use in a Polars (Rust) regex.

funcpy-polars.src.polars._utils.various.require_same_type(current:Any, other:Any) -> None

Raise an error if the two arguments are not of the same type.

funcpy-polars.src.polars._utils.various.warn_null_comparison(obj:Any) -> None

Warn for possibly unintentional comparisons with None.

funcpy-polars.src.polars._warnings.find_stacklevel() -> int

Find the first place in the stack that is not inside Polars.

funcpy-polars.src.polars._warnings.issue_warning(message:str, category:type[Warning], **kwargs:Any) -> None

Issue a warning.

classpy-polars.src.polars.catalog.unity.client.Catalog

Unity catalog client.

method

py-polars.src.polars.catalog.unity.client.Catalog.create_catalog(catalog_name:str, *comment:str | None=None, *storage_root:str | None=None) -> CatalogInfo

Create a catalog.

methodpy-polars.src.polars.catalog.unity.client.Catalog.delete_catalog(catalog_name:str, *force:bool=False) -> None

Delete a catalog.

method

py-polars.src.polars.catalog.unity.client.Catalog.delete_namespace(catalog_name:str, namespace:str, *force:bool=False) -> None

Delete a namespace (unity schema) in the catalog.

methodpy-polars.src.polars.catalog.unity.client.Catalog.delete_table(catalog_name:str, namespace:str, table_name:str) -> None

Delete the table stored at this location.

method

py-polars.src.polars.catalog.unity.client.Catalog.get_table_info(catalog_name:str, namespace:str, table_name:str) -> TableInfo

Retrieve the metadata of the specified table.

methodpy-polars.src.polars.catalog.unity.client.Catalog.list_catalogs() -> list[CatalogInfo]

List the available catalogs.

methodpy-polars.src.polars.catalog.unity.client.Catalog.list_tables(catalog_name:str, namespace:str) -> list[TableInfo]

List the available tables under the specified schema.

classpy-polars.src.polars.catalog.unity.models.CatalogInfo

Information for a catalog within a metastore.

classpy-polars.src.polars.catalog.unity.models.ColumnInfo

Information for a column within a catalog table.

methodpy-polars.src.polars.catalog.unity.models.ColumnInfo.get_polars_dtype() -> DataType

Get the native polars datatype of this column.

classpy-polars.src.polars.catalog.unity.models.NamespaceInfo

Information for a namespace within a catalog.

classpy-polars.src.polars.catalog.unity.models.TableInfo

Information for a catalog table.

methodpy-polars.src.polars.catalog.unity.models.TableInfo.get_polars_schema() -> Schema | None

Get the native polars schema of this table.

classpy-polars.src.polars.config.Config

Configure polars; offers options for table formatting and more.

methodpy-polars.src.polars.config.Config.load(cfg:str) -> Config

Load (and set) previously saved Config options from a JSON string.

methodpy-polars.src.polars.config.Config.load_from_file(file:Path | str) -> Config

Load (and set) previously saved Config options from file.

methodpy-polars.src.polars.config.Config.save(*if_set:bool=False) -> str

Save the current set of Config options as a JSON string.

methodpy-polars.src.polars.config.Config.save_to_file(file:Path | str) -> None

Save the current set of Config options as a JSON file.

methodpy-polars.src.polars.config.Config.set_ascii_tables(active:bool | None=True) -> type[Config]

Use ASCII characters to display table outlines.

methodpy-polars.src.polars.config.Config.set_decimal_separator(separator:str | None=None) -> type[Config]

Set the decimal separator character.

method

py-polars.src.polars.config.Config.set_default_credential_provider(credential_provider:CredentialProviderFunction | Literal['auto'] | None) -> type[Config]

Set a default credential provider.

methodpy-polars.src.polars.config.Config.set_engine_affinity(engine:EngineType | None=None) -> type[Config]

Set which engine to use by default.

methodpy-polars.src.polars.config.Config.set_fmt_float(fmt:FloatFmt | None='mixed') -> type[Config]

Control how floating point values are displayed.

methodpy-polars.src.polars.config.Config.set_fmt_str_lengths(n:int | None) -> type[Config]

Set the number of characters used to display string values.

methodpy-polars.src.polars.config.Config.set_fmt_table_cell_list_len(n:int | None) -> type[Config]

Set the number of elements to display for List values.

methodpy-polars.src.polars.config.Config.set_streaming_chunk_size(size:int | None) -> type[Config]

Overwrite chunk size used in `streaming` engine.

methodpy-polars.src.polars.config.Config.set_tbl_cell_alignment(format:Alignment | None) -> type[Config]

Set table cell alignment.

methodpy-polars.src.polars.config.Config.set_tbl_cell_numeric_alignment(format:Alignment | None) -> type[Config]

Set table cell alignment for numeric columns.

method

py-polars.src.polars.config.Config.set_tbl_formatting(format:TableFormatNames | None=None, rounded_corners:bool | None=False) -> type[Config]

Set table formatting style.

methodpy-polars.src.polars.config.Config.set_tbl_hide_column_data_types(active:bool | None=True) -> type[Config]

Hide table column data types (i64, f64, str etc.).

methodpy-polars.src.polars.config.Config.set_tbl_hide_column_names(active:bool | None=True) -> type[Config]

Hide table column names.

methodpy-polars.src.polars.config.Config.set_tbl_width_chars(width:int | None) -> type[Config]

Set the maximum width of a table in characters.

methodpy-polars.src.polars.config.Config.set_thousands_separator(separator:str | bool | None=None) -> type[Config]

Set the thousands grouping separator character.

methodpy-polars.src.polars.config.Config.set_trim_decimal_zeros(active:bool | None=True) -> type[Config]

Strip trailing zeros from Decimal data type values.

methodpy-polars.src.polars.config.Config.set_verbose(active:bool | None=True) -> type[Config]

Enable additional verbose/debug logging.

methodpy-polars.src.polars.config.Config.warn_unstable(active:bool | None=True) -> type[Config]

Issue a warning when unstable functionality is used.

classpy-polars.src.polars.config.ConfigParameters

Parameters supported by the polars Config.

methodpy-polars.src.polars.dataframe._html.HTMLFormatter.render() -> list[str]

Return the lines needed to render a HTML table.

methodpy-polars.src.polars.dataframe._html.HTMLFormatter.write(inner:str) -> None

Append a raw string to the inner HTML.

methodpy-polars.src.polars.dataframe._html.HTMLFormatter.write_body() -> None

Write the body of an HTML table.

methodpy-polars.src.polars.dataframe._html.HTMLFormatter.write_header() -> None

Write the header of an HTML table.

classpy-polars.src.polars.dataframe._html.Tag

Class for representing an HTML tag.

funcpy-polars.src.polars.dataframe._html.replace_consecutive_spaces(s:str) -> str

Replace consecutive spaces with HTML non-breaking spaces.

classpy-polars.src.polars.dataframe.group_by.DynamicGroupBy

A dynamic grouper.

classpy-polars.src.polars.dataframe.group_by.DynamicGroupByIter

Iterator returned by :meth:`DynamicGroupBy.__iter__`.

classpy-polars.src.polars.dataframe.group_by.GroupBy

Starts a new GroupBy operation.

method

py-polars.src.polars.dataframe.group_by.GroupBy.agg(*aggs:IntoExpr | Iterable[IntoExpr], **named_aggs:IntoExpr) -> DataFrame

Compute aggregations for each group of a group by operation.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.all() -> DataFrame

Aggregate the groups into Series.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.count() -> DataFrame

Return the number of rows in each group.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.first(*ignore_nulls:bool=False) -> DataFrame

Aggregate the first values in the group.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.head(n:int=5) -> DataFrame

Get the first `n` rows of each group.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.last(*ignore_nulls:bool=False) -> DataFrame

Aggregate the last values in the group.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.len(name:str | None=None) -> DataFrame

Return the number of rows in each group.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.max() -> DataFrame

Reduce the groups to the maximal value.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.mean() -> DataFrame

Reduce the groups to the mean values.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.median() -> DataFrame

Return the median per group.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.min() -> DataFrame

Reduce the groups to the minimal value.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.n_unique() -> DataFrame

Count the unique values per group.

method

py-polars.src.polars.dataframe.group_by.GroupBy.quantile(quantile:float, interpolation:QuantileMethod='nearest') -> DataFrame

Compute the quantile per group.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.sum() -> DataFrame

Reduce the groups to the sum.

methodpy-polars.src.polars.dataframe.group_by.GroupBy.tail(n:int=5) -> DataFrame

Get the last `n` rows of each group.

classpy-polars.src.polars.dataframe.group_by.GroupByIter

Iterator returned by :meth:`GroupBy.__iter__`.

classpy-polars.src.polars.dataframe.group_by.RollingGroupBy

A rolling grouper.

classpy-polars.src.polars.dataframe.group_by.RollingGroupByIter

Iterator returned by :meth:`RollingGroupBy.__iter__`.

classpy-polars.src.polars.dataframe.plotting.DataFramePlot

DataFrame.plot namespace.

method

py-polars.src.polars.dataframe.plotting.DataFramePlot.bar(x:X | None=None, y:Y | None=None, color:Color | None=None, **kwargs:Unpack[EncodeKwds]) -> alt.Chart

Draw bar plot.

method

py-polars.src.polars.dataframe.plotting.DataFramePlot.line(x:X | None=None, y:Y | None=None, color:Color | None=None, order:Order | None=None, **kwargs:Unpack[EncodeKwds]) -> alt.Chart

Draw line plot.

method

py-polars.src.polars.dataframe.plotting.DataFramePlot.point(x:X | None=None, y:Y | None=None, color:Color | None=None, size:Size | None=None, **kwargs:Unpack[EncodeKwds]) -> alt.Chart

Draw scatter plot.

classpy-polars.src.polars.datatype_expr.array.DataTypeExprArrNameSpace

Namespace for arr datatype expressions.

methodpy-polars.src.polars.datatype_expr.array.DataTypeExprArrNameSpace.inner_dtype() -> pl.DataTypeExpr

Get the inner DataType of array.

methodpy-polars.src.polars.datatype_expr.array.DataTypeExprArrNameSpace.shape() -> pl.Expr

Get the array shape.

methodpy-polars.src.polars.datatype_expr.array.DataTypeExprArrNameSpace.width() -> pl.Expr

Get the array width.

classpy-polars.src.polars.datatype_expr.list.DataTypeExprListNameSpace

Namespace for list datatype expressions.

methodpy-polars.src.polars.datatype_expr.list.DataTypeExprListNameSpace.inner_dtype() -> pl.DataTypeExpr

Get the inner DataType of list.

classpy-polars.src.polars.datatype_expr.struct.DataTypeExprStructNameSpace

Namespace for struct datatype expressions.

methodpy-polars.src.polars.datatype_expr.struct.DataTypeExprStructNameSpace.field_names() -> pl.Expr

Get the field names in a struct as a list.

funcpy-polars.src.polars.datatypes._parse.parse_into_datatype_expr(input:Any) -> pl.DataTypeExpr

Parse an input into a DataTypeExpr.

funcpy-polars.src.polars.datatypes._parse.parse_into_dtype(input:Any) -> PolarsDataType

Parse an input into a Polars data type.

funcpy-polars.src.polars.datatypes._parse.parse_py_type_into_dtype(input:PythonDataType | type[object]) -> PolarsDataType

Convert Python data type to Polars data type.

funcpy-polars.src.polars.datatypes._utils.dtype_to_init_repr(dtype:PolarsDataType, prefix:str='pl.') -> str

Convert a Polars dtype to a prefixed string representation.

classpy-polars.src.polars.datatypes.classes.Array

Fixed length list type.

methodpy-polars.src.polars.datatypes.classes.Array.width() -> int

The size of the Array.

classpy-polars.src.polars.datatypes.classes.BaseExtension

Base class for extension data types.

methodpy-polars.src.polars.datatypes.classes.BaseExtension.ext_metadata() -> str | None

Returns the metadata for this extension type.

methodpy-polars.src.polars.datatypes.classes.BaseExtension.ext_name() -> str

Returns the name of this extension type.

methodpy-polars.src.polars.datatypes.classes.BaseExtension.ext_storage() -> PolarsDataType

Returns the storage type for this extension type.

classpy-polars.src.polars.datatypes.classes.Binary

Binary type.

classpy-polars.src.polars.datatypes.classes.Boolean

Boolean type.

classpy-polars.src.polars.datatypes.classes.Categorical

A categorical encoding of a set of strings.

classpy-polars.src.polars.datatypes.classes.DataType

Base class for all Polars data types.

methodpy-polars.src.polars.datatypes.classes.DataType.is_(other:PolarsDataType) -> bool

Check if this DataType is the same as another DataType.

methodpy-polars.src.polars.datatypes.classes.DataType.is_decimal() -> bool

Check whether the data type is a decimal type.

methodpy-polars.src.polars.datatypes.classes.DataType.is_extension() -> bool

Check whether the data type is an extension type.

methodpy-polars.src.polars.datatypes.classes.DataType.is_integer() -> bool

Check whether the data type is an integer type.

methodpy-polars.src.polars.datatypes.classes.DataType.is_nested() -> bool

Check whether the data type is a nested type.

methodpy-polars.src.polars.datatypes.classes.DataType.is_numeric() -> bool

Check whether the data type is a numeric type.

methodpy-polars.src.polars.datatypes.classes.DataType.is_object() -> bool

Check whether the data type is an object type.

methodpy-polars.src.polars.datatypes.classes.DataType.is_temporal() -> bool

Check whether the data type is a temporal type.

classpy-polars.src.polars.datatypes.classes.DataTypeClass

Metaclass for nicely printing DataType classes.

classpy-polars.src.polars.datatypes.classes.Date

Data type representing a calendar date.

classpy-polars.src.polars.datatypes.classes.Datetime

Data type representing a calendar date and time of day.

classpy-polars.src.polars.datatypes.classes.Duration

Data type representing a time duration.

classpy-polars.src.polars.datatypes.classes.Enum

A fixed categorical encoding of a unique set of strings.

methodpy-polars.src.polars.datatypes.classes.Enum.union(other:Enum) -> Enum

Union of two Enums.

classpy-polars.src.polars.datatypes.classes.Extension

Generic extension data type.

classpy-polars.src.polars.datatypes.classes.Field

Definition of a single field within a `Struct` DataType.

classpy-polars.src.polars.datatypes.classes.Float16

16-bit floating point type.

classpy-polars.src.polars.datatypes.classes.Float32

32-bit floating point type.

classpy-polars.src.polars.datatypes.classes.Float64

64-bit floating point type.

classpy-polars.src.polars.datatypes.classes.FloatType

Base class for float data types.

classpy-polars.src.polars.datatypes.classes.Int128

128-bit signed integer type.

classpy-polars.src.polars.datatypes.classes.Int16

16-bit signed integer type.

classpy-polars.src.polars.datatypes.classes.Int32

32-bit signed integer type.

classpy-polars.src.polars.datatypes.classes.Int64

64-bit signed integer type.

classpy-polars.src.polars.datatypes.classes.Int8

8-bit signed integer type.

classpy-polars.src.polars.datatypes.classes.IntegerType

Base class for integer data types.

classpy-polars.src.polars.datatypes.classes.List

Variable length list type.

classpy-polars.src.polars.datatypes.classes.NestedType

Base class for nested data types.

classpy-polars.src.polars.datatypes.classes.Null

Data type representing null values.

classpy-polars.src.polars.datatypes.classes.NumericType

Base class for numeric data types.

classpy-polars.src.polars.datatypes.classes.Object

Data type for wrapping arbitrary Python objects.

classpy-polars.src.polars.datatypes.classes.ObjectType

Base class for object data types.

classpy-polars.src.polars.datatypes.classes.SignedIntegerType

Base class for signed integer data types.

classpy-polars.src.polars.datatypes.classes.String

UTF-8 encoded string type.

classpy-polars.src.polars.datatypes.classes.Struct

Struct composite type.

methodpy-polars.src.polars.datatypes.classes.Struct.to_schema() -> OrderedDict[str, PolarsDataType]

Return Struct dtype as a schema dict.

classpy-polars.src.polars.datatypes.classes.TemporalType

Base class for temporal data types.

classpy-polars.src.polars.datatypes.classes.Time

Data type representing the time of day.

classpy-polars.src.polars.datatypes.classes.UInt128

128-bit unsigned integer type.

classpy-polars.src.polars.datatypes.classes.UInt16

16-bit unsigned integer type.

classpy-polars.src.polars.datatypes.classes.UInt32

32-bit unsigned integer type.

classpy-polars.src.polars.datatypes.classes.UInt64

64-bit unsigned integer type.

classpy-polars.src.polars.datatypes.classes.UInt8

8-bit unsigned integer type.

classpy-polars.src.polars.datatypes.classes.UnsignedIntegerType

Base class for unsigned integer data types.

funcpy-polars.src.polars.datatypes.convert.dtype_to_ffiname(dtype:PolarsDataType) -> str

Return FFI function name associated with the given Polars dtype.

funcpy-polars.src.polars.datatypes.convert.dtype_to_py_type(dtype:PolarsDataType) -> PythonDataType

Convert a Polars dtype to a Python dtype.

funcpy-polars.src.polars.datatypes.convert.numpy_char_code_to_dtype(dtype_char:str) -> PolarsDataType

Convert a numpy character dtype to a Polars dtype.

funcpy-polars.src.polars.datatypes.convert.py_type_to_arrow_type(dtype:PythonDataType) -> pa.DataType

Convert a Python dtype to an Arrow dtype.

funcpy-polars.src.polars.datatypes.convert.supported_numpy_char_code(dtype_char:str) -> bool

Check if the input can be mapped to a Polars dtype.

funcpy-polars.src.polars.datatypes.extension.unregister_extension_type(ext_name:str) -> None

Unregister the extension type for the given extension name.

classpy-polars.src.polars.datatypes.group.DataTypeGroup

Group of data types.

classpy-polars.src.polars.exceptions.ColumnNotFoundError

Exception raised when a specified column is not found.

classpy-polars.src.polars.exceptions.DuplicateError

Exception raised when a column name is duplicated.

classpy-polars.src.polars.exceptions.OutOfBoundsError

Exception raised when the given index is out of bounds.

classpy-polars.src.polars.exceptions.PolarsError

Base class for all Polars errors.

classpy-polars.src.polars.exceptions.PolarsWarning

Base class for all Polars warnings.

classpy-polars.src.polars.exceptions.UnstableWarning

Warning issued when unstable functionality is used.

classpy-polars.src.polars.expr.array.ExprArrayNameSpace

Namespace for array related expressions.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.agg(expr:Expr) -> Expr

Run any polars aggregation expression against the arrays' elements.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.any(*ignore_nulls:bool=True) -> Expr

Evaluate whether any boolean value is true for every subarray.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.contains(item:IntoExpr, *nulls_equal:bool=True) -> Expr

Check if sub-arrays contain the given item.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.count_matches(element:IntoExpr) -> Expr

Count how often the value produced by `element` occurs.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.eval(expr:Expr, *as_list:bool=False) -> Expr

Run any polars expression against the arrays' elements.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.first() -> Expr

Get the first value of the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.get(index:int | IntoExprColumn, *null_on_oob:bool=False) -> Expr

Get the value by index in the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.head(n:int | str | Expr=5, *as_array:bool=False) -> Expr

Get the first `n` elements of the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.last() -> Expr

Get the last value of the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.len() -> Expr

Return the number of elements in each array.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.max() -> Expr

Compute the max values of the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.mean() -> Expr

Compute the mean of the values of the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.median() -> Expr

Compute the median of the values of the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.min() -> Expr

Compute the min values of the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.reverse() -> Expr

Reverse the sub-arrays in this column.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.shift(n:int | IntoExprColumn=1) -> Expr

Shift array values by the given number of indices.

method

py-polars.src.polars.expr.array.ExprArrayNameSpace.slice(offset:int | str | Expr, length:int | str | Expr | None=None, *as_array:bool=False) -> Expr

Slice every subarray.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.sort(*descending:bool=False, *nulls_last:bool=False) -> Expr

Sort every sub-array.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.std(ddof:int=1) -> Expr

Compute the std of the values of the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.sum() -> Expr

Compute the sum values of the sub-arrays.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.tail(n:int | str | Expr=5, *as_array:bool=False) -> Expr

Slice the last `n` values of every sublist.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.unique(*maintain_order:bool=False) -> Expr

Get the unique/distinct values in every sub-array.

methodpy-polars.src.polars.expr.array.ExprArrayNameSpace.var(ddof:int=1) -> Expr

Compute the var of the values of the sub-arrays.

classpy-polars.src.polars.expr.binary.ExprBinaryNameSpace

Namespace for bin related expressions.

methodpy-polars.src.polars.expr.binary.ExprBinaryNameSpace.contains(literal:IntoExpr) -> Expr

Check if binaries in Series contain a binary substring.

methodpy-polars.src.polars.expr.binary.ExprBinaryNameSpace.decode(encoding:TransferEncoding, *strict:bool=True) -> Expr

Decode values using the provided encoding.

methodpy-polars.src.polars.expr.binary.ExprBinaryNameSpace.encode(encoding:TransferEncoding) -> Expr

Encode a value using the provided encoding.

methodpy-polars.src.polars.expr.binary.ExprBinaryNameSpace.ends_with(suffix:IntoExpr) -> Expr

Check if string values end with a binary substring.

methodpy-polars.src.polars.expr.binary.ExprBinaryNameSpace.get(index:int | IntoExpr, *null_on_oob:bool=False) -> Expr

Get the byte value at the given index.

methodpy-polars.src.polars.expr.binary.ExprBinaryNameSpace.head(n:int | IntoExpr=5) -> Expr

Take the first `n` bytes of the binary values.

method

py-polars.src.polars.expr.binary.ExprBinaryNameSpace.reinterpret(*dtype:PolarsDataType | DataTypeExpr, *endianness:Endianness='little') -> Expr

Interpret bytes as another type.

methodpy-polars.src.polars.expr.binary.ExprBinaryNameSpace.size(unit:SizeUnit='b') -> Expr

Get the size of binary values in the given unit.

method

py-polars.src.polars.expr.binary.ExprBinaryNameSpace.slice(offset:int | IntoExpr, length:int | IntoExpr | None=None) -> Expr

Slice the binary values.

methodpy-polars.src.polars.expr.binary.ExprBinaryNameSpace.starts_with(prefix:IntoExpr) -> Expr

Check if values start with a binary substring.

methodpy-polars.src.polars.expr.binary.ExprBinaryNameSpace.tail(n:int | IntoExpr=5) -> Expr

Take the last `n` bytes of the binary values.

classpy-polars.src.polars.expr.categorical.ExprCatNameSpace

Namespace for categorical related expressions.

methodpy-polars.src.polars.expr.categorical.ExprCatNameSpace.get_categories() -> Expr

Get the categories stored in this data type.

method

py-polars.src.polars.expr.categorical.ExprCatNameSpace.to(dtype:PolarsDataType | pl.DataTypeExpr, *strict:bool=True) -> Expr

Convert to a categorical or enum `dtype`.

classpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace

Namespace for datetime related expressions.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.base_utc_offset() -> Expr

Base offset from UTC.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.cast_time_unit(time_unit:TimeUnit) -> Expr

Cast the underlying data to another time unit.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.date() -> Expr

Extract date from date(time).

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.datetime() -> Expr

Return datetime.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.day() -> Expr

Extract day from underlying Date representation.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.month() -> Expr

Extract month from underlying Date representation.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.month_end() -> Expr

Roll forward to the last day of the month.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.month_start() -> Expr

Roll backward to the first day of the month.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.offset_by(by:str | Expr) -> Expr

Offset this date by a relative time offset.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.round(every:str | dt.timedelta | IntoExprColumn) -> Expr

Divide the date/datetime range into buckets.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.second(*fractional:bool=False) -> Expr

Extract seconds from underlying DateTime representation.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.time() -> Expr

Extract time.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.timestamp(time_unit:TimeUnit='us') -> Expr

Return a timestamp in the given time unit.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.total_days(*fractional:bool=False) -> Expr

Extract the total days from a Duration type.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.total_hours(*fractional:bool=False) -> Expr

Extract the total hours from a Duration type.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.total_microseconds(*fractional:bool=False) -> Expr

Extract the total microseconds from a Duration type.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.total_milliseconds(*fractional:bool=False) -> Expr

Extract the total milliseconds from a Duration type.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.total_minutes(*fractional:bool=False) -> Expr

Extract the total minutes from a Duration type.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.total_nanoseconds(*fractional:bool=False) -> Expr

Extract the total nanoseconds from a Duration type.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.total_seconds(*fractional:bool=False) -> Expr

Extract the total seconds from a Duration type.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.truncate(every:str | dt.timedelta | Expr) -> Expr

Divide the date/datetime range into buckets.

methodpy-polars.src.polars.expr.datetime.ExprDateTimeNameSpace.year() -> Expr

Extract year from underlying Date representation.

classpy-polars.src.polars.expr.ext.ExprExtensionNameSpace

Namespace for extension type related expressions.

methodpy-polars.src.polars.expr.ext.ExprExtensionNameSpace.storage() -> Expr

Get the storage values of an extension data type.

methodpy-polars.src.polars.expr.ext.ExprExtensionNameSpace.to(dtype:PolarsDataType | pl.DataTypeExpr) -> Expr

Convert to an extension `dtype`.

classpy-polars.src.polars.expr.list.ExprListNameSpace

Namespace for list related expressions.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.agg(expr:Expr) -> Expr

Run any polars aggregation expression against the lists' elements.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.all(*ignore_nulls:bool=True) -> Expr

Evaluate whether all boolean values in a list are true.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.any(*ignore_nulls:bool=True) -> Expr

Evaluate whether any boolean value in a list is true.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.contains(item:IntoExpr, *nulls_equal:bool=True) -> Expr

Check if sub-lists contain the given item.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.count_matches(element:IntoExpr) -> Expr

Count how often the value produced by `element` occurs.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.drop_nulls() -> Expr

Drop all null values in the list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.eval(expr:Expr, *parallel:bool=False) -> Expr

Run any polars expression against every lists' elements.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.filter(predicate:Expr) -> Expr

Filter elements in each list by a boolean expression.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.first() -> Expr

Get the first value of every sub-list.

method

py-polars.src.polars.expr.list.ExprListNameSpace.gather(indices:Expr | Series | list[int] | list[list[int]], *null_on_oob:bool=False) -> Expr

Take sub-lists by multiple indices.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.get(index:int | Expr | str, *null_on_oob:bool=False) -> Expr

Get the value by index in every sublist.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.head(n:int | str | Expr=5) -> Expr

Slice the first `n` values of every sub-list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.item(*allow_empty:bool=False) -> Expr

Get the single value of the sub-list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.last() -> Expr

Get the last value of every sub-list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.len() -> Expr

Return the number of elements in each list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.max() -> Expr

Compute the max value of the lists in the array.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.mean() -> Expr

Compute the mean value of the lists in the array.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.median() -> Expr

Compute the median value of the lists in the array.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.min() -> Expr

Compute the min value of the lists in the array.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.n_unique() -> Expr

Count the number of unique values in every sub-list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.reverse() -> Expr

Reverse the arrays in the list.

method

py-polars.src.polars.expr.list.ExprListNameSpace.sample(n:int | IntoExprColumn | None=None, *fraction:float | IntoExprColumn | None=None, *with_replacement:bool=False, *shuffle:bool | None=None, *seed:int | None=None) -> Expr

Sample from this list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.shift(n:int | IntoExprColumn=1) -> Expr

Shift every sub-lists values by the given number of indices.

method

py-polars.src.polars.expr.list.ExprListNameSpace.slice(offset:int | str | Expr, length:int | str | Expr | None=None) -> Expr

Slice every sub-list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.sort(*descending:bool=False, *nulls_last:bool=False) -> Expr

Sort the lists in this column.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.std(ddof:int=1) -> Expr

Compute the std value of the lists in the array.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.sum() -> Expr

Sum all the lists in the array.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.tail(n:int | str | Expr=5) -> Expr

Slice the last `n` values of every sub-list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.unique(*maintain_order:bool=False) -> Expr

Get the unique/distinct values in every sub-list.

methodpy-polars.src.polars.expr.list.ExprListNameSpace.var(ddof:int=1) -> Expr

Compute the var value of the lists in the array.

classpy-polars.src.polars.expr.meta.ExprMetaNameSpace

Namespace for expressions on a meta level.

methodpy-polars.src.polars.expr.meta.ExprMetaNameSpace.as_expression() -> Expr

Return the original expression.

methodpy-polars.src.polars.expr.meta.ExprMetaNameSpace.as_selector() -> pl.Selector

Try to turn this expression in a selector.

methodpy-polars.src.polars.expr.meta.ExprMetaNameSpace.eq(other:ExprMetaNameSpace | Expr) -> bool

Indicate if this expression is the same as another expression.

methodpy-polars.src.polars.expr.meta.ExprMetaNameSpace.root_names() -> list[str]

Get a list with the root column name.

methodpy-polars.src.polars.expr.name.ExprNameNameSpace.keep() -> Expr

Keep the original root name of the expression.

methodpy-polars.src.polars.expr.name.ExprNameNameSpace.prefix(prefix:str) -> Expr

Add a prefix to the root column name of the expression.

methodpy-polars.src.polars.expr.name.ExprNameNameSpace.prefix_fields(prefix:str) -> Expr

Add a prefix to all field names of a struct.

methodpy-polars.src.polars.expr.name.ExprNameNameSpace.suffix(suffix:str) -> Expr

Add a suffix to the root column name of the expression.

methodpy-polars.src.polars.expr.name.ExprNameNameSpace.suffix_fields(suffix:str) -> Expr

Add a suffix to all field names of a struct.

methodpy-polars.src.polars.expr.name.ExprNameNameSpace.to_lowercase() -> Expr

Make the root column name lowercase.

methodpy-polars.src.polars.expr.name.ExprNameNameSpace.to_uppercase() -> Expr

Make the root column name uppercase.

classpy-polars.src.polars.expr.string.ExprStringNameSpace

Namespace for string related expressions.

method

py-polars.src.polars.expr.string.ExprStringNameSpace.contains_any(patterns:IntoExpr, *ascii_case_insensitive:bool=False) -> Expr

Use the Aho-Corasick algorithm to find matches.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.count_matches(pattern:str | Expr, *literal:bool=False) -> Expr

Count all successive non-overlapping regex matches.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.decode(encoding:TransferEncoding, *strict:bool=True) -> Expr

Decode values using the provided encoding.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.encode(encoding:TransferEncoding) -> Expr

Encode values using the provided encoding.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.ends_with(suffix:str | Expr) -> Expr

Check if string values end with a substring.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.extract_all(pattern:str | Expr) -> Expr

Extract all matches for the given regex pattern.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.extract_groups(pattern:str) -> Expr

Extract all capture groups for the given regex pattern.

method

py-polars.src.polars.expr.string.ExprStringNameSpace.json_decode(dtype:PolarsDataType | pl.DataTypeExpr, *infer_schema_length:int | None=None) -> Expr

Parse string values as JSON.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.normalize(form:UnicodeForm='NFC') -> Expr

Returns the Unicode normal form of the string values.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.reverse() -> Expr

Returns string values in reversed order.

method

py-polars.src.polars.expr.string.ExprStringNameSpace.slice(offset:int | IntoExprColumn, length:int | IntoExprColumn | None=None) -> Expr

Extract a substring from each string value.

method

py-polars.src.polars.expr.string.ExprStringNameSpace.split(by:IntoExpr, *inclusive:bool=False, *literal:bool=True, *strict:bool=True) -> Expr

Split the string by a substring.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.split_exact(by:IntoExpr, n:int, *inclusive:bool=False) -> Expr

Split the string by a substring using `n` splits.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.starts_with(prefix:str | Expr) -> Expr

Check if string values start with a substring.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.strip_chars(characters:IntoExpr=None) -> Expr

Remove leading and trailing characters.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.strip_chars_end(characters:IntoExpr=None) -> Expr

Remove trailing characters.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.strip_chars_start(characters:IntoExpr=None) -> Expr

Remove leading characters.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.strip_prefix(prefix:IntoExpr) -> Expr

Remove prefix.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.strip_suffix(suffix:IntoExpr) -> Expr

Remove suffix.

method

py-polars.src.polars.expr.string.ExprStringNameSpace.to_date(format:str | None=None, *strict:bool=True, *exact:bool=True, *cache:bool=True) -> Expr

Convert a String column into a Date column.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.to_decimal(*scale:int) -> Expr

Convert a String column into a Decimal column.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.to_lowercase() -> Expr

Modify strings to their lowercase equivalent.

method

py-polars.src.polars.expr.string.ExprStringNameSpace.to_time(format:str | None=None, *strict:bool=True, *cache:bool=True) -> Expr

Convert a String column into a Time column.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.to_titlecase() -> Expr

Modify strings to their titlecase equivalent.

methodpy-polars.src.polars.expr.string.ExprStringNameSpace.to_uppercase() -> Expr

Modify strings to their uppercase equivalent.

classpy-polars.src.polars.expr.struct.ExprStructNameSpace

Namespace for struct related expressions.

methodpy-polars.src.polars.expr.struct.ExprStructNameSpace.drop(names:Sequence[str], *strict:bool=True) -> Expr

Drop one or more fields from the struct.

methodpy-polars.src.polars.expr.struct.ExprStructNameSpace.field(name:str | list[str], *more_names:str) -> Expr

Retrieve one or multiple `Struct` field(s) as a new Series.

methodpy-polars.src.polars.expr.struct.ExprStructNameSpace.rename_fields(names:Sequence[str]) -> Expr

Rename the fields of the struct.

methodpy-polars.src.polars.expr.struct.ExprStructNameSpace.unnest() -> Expr

Expand the struct into its individual fields.

method

py-polars.src.polars.expr.struct.ExprStructNameSpace.with_fields(*exprs:IntoExpr | Iterable[IntoExpr], **named_exprs:IntoExpr) -> Expr

Add or overwrite fields of this struct.

classpy-polars.src.polars.expr.whenthen.ChainedThen

Utility class for the `when-then-otherwise` expression.

methodpy-polars.src.polars.expr.whenthen.ChainedThen.otherwise(statement:IntoExpr) -> Expr

Define a default for the `when-then-otherwise` expression.

classpy-polars.src.polars.expr.whenthen.ChainedWhen

Utility class for the `when-then-otherwise` expression.

methodpy-polars.src.polars.expr.whenthen.ChainedWhen.then(statement:IntoExpr) -> ChainedThen

Attach a statement to the corresponding condition.

classpy-polars.src.polars.expr.whenthen.Then

Utility class for the `when-then-otherwise` expression.

methodpy-polars.src.polars.expr.whenthen.Then.otherwise(statement:IntoExpr) -> Expr

Define a default for the `when-then-otherwise` expression.

method

py-polars.src.polars.expr.whenthen.Then.when(*predicates:IntoExpr | Iterable[IntoExpr], **constraints:Any) -> ChainedWhen

Add a condition to the `when-then-otherwise` expression.

classpy-polars.src.polars.expr.whenthen.When

Utility class for the `when-then-otherwise` expression.

methodpy-polars.src.polars.expr.whenthen.When.then(statement:IntoExpr) -> Then

Attach a statement to the corresponding condition.

funcpy-polars.src.polars.functions.aggregation.horizontal.all_horizontal(*exprs:IntoExpr | Iterable[IntoExpr]) -> Expr

Compute the logical AND horizontally across columns.

funcpy-polars.src.polars.functions.aggregation.horizontal.any_horizontal(*exprs:IntoExpr | Iterable[IntoExpr]) -> Expr

Compute the logical OR horizontally across columns.

funcpy-polars.src.polars.functions.aggregation.horizontal.max_horizontal(*exprs:IntoExpr | Iterable[IntoExpr]) -> Expr

Get the maximum value horizontally across columns.

funcpy-polars.src.polars.functions.aggregation.horizontal.min_horizontal(*exprs:IntoExpr | Iterable[IntoExpr]) -> Expr

Get the minimum value horizontally across columns.

func

py-polars.src.polars.functions.aggregation.horizontal.sum_horizontal(*ignore_nulls:bool=True, *exprs:IntoExpr | Iterable[IntoExpr]) -> Expr

Sum all values horizontally across columns.

funcpy-polars.src.polars.functions.aggregation.vertical.any(*ignore_nulls:bool=True, *names:str) -> Expr | bool | None

Evaluate a bitwise OR operation.

funcpy-polars.src.polars.functions.aggregation.vertical.cum_sum(*names:str) -> Expr

Cumulatively sum all values.

funcpy-polars.src.polars.functions.aggregation.vertical.max(*names:str) -> Expr

Get the maximum value.

funcpy-polars.src.polars.functions.aggregation.vertical.min(*names:str) -> Expr

Get the minimum value.

funcpy-polars.src.polars.functions.aggregation.vertical.sum(*names:str) -> Expr

Sum all values.

func

py-polars.src.polars.functions.as_datatype.date_(year:Expr | str | int, month:Expr | str | int, day:Expr | str | int) -> Expr

Create a Polars literal expression of type Date.

funcpy-polars.src.polars.functions.as_datatype.format(f_string:str, *args:IntoExpr) -> Expr

Format expressions as a string.

classpy-polars.src.polars.functions.col.Col

Create Polars column expressions.

funcpy-polars.src.polars.functions.escape_regex.escape_regex(s:str) -> str

Escapes string regex meta characters.

funcpy-polars.src.polars.functions.lazy.approx_n_unique(*columns:str) -> Expr

Approximate count of unique values.

funcpy-polars.src.polars.functions.lazy.arctan2(y:str | Expr, x:str | Expr) -> Expr

Compute two argument arctan in radians.

funcpy-polars.src.polars.functions.lazy.arctan2d(y:str | Expr, x:str | Expr) -> Expr

Compute two argument arctan in degrees.

funcpy-polars.src.polars.functions.lazy.count(*columns:str) -> Expr

Return the number of non-null values in the column.

funcpy-polars.src.polars.functions.lazy.field(name:str | list[str]) -> Expr

Select a field in the current `struct.with_fields` scope.

funcpy-polars.src.polars.functions.lazy.first(*columns:str) -> Expr

Get the first column or value.

funcpy-polars.src.polars.functions.lazy.groups(column:str) -> Expr

Syntactic sugar for `pl.col("foo").agg_groups()`.

funcpy-polars.src.polars.functions.lazy.head(column:str, n:int=10) -> Expr

Get the first `n` rows.

funcpy-polars.src.polars.functions.lazy.implode(*maintain_order:bool=True, *columns:str) -> Expr

Aggregate all column values into a list.

funcpy-polars.src.polars.functions.lazy.last(*columns:str) -> Expr

Get the last column or value.

funcpy-polars.src.polars.functions.lazy.mean(*columns:str) -> Expr

Get the mean value.

funcpy-polars.src.polars.functions.lazy.median(*columns:str) -> Expr

Get the median value.

funcpy-polars.src.polars.functions.lazy.n_unique(*columns:str) -> Expr

Count unique values.

funcpy-polars.src.polars.functions.lazy.nth(*strict:bool=True, *indices:int | Sequence[int]) -> Expr

Get the nth column(s) of the context.

func

py-polars.src.polars.functions.lazy.quantile(column:str, quantile:float | Expr, interpolation:QuantileMethod='nearest') -> Expr

Syntactic sugar for `pl.col("foo").quantile(..)`.

funcpy-polars.src.polars.functions.lazy.row_index(name:str='index') -> pl.Expr

Generates a sequence of integers.

funcpy-polars.src.polars.functions.lazy.std(column:str, ddof:int=1) -> Expr

Get the standard deviation.

funcpy-polars.src.polars.functions.lazy.tail(column:str, n:int=10) -> Expr

Get the last `n` rows.

funcpy-polars.src.polars.functions.lazy.var(column:str, ddof:int=1) -> Expr

Get the variance.

funcpy-polars.src.polars.functions.len.len() -> Expr

Return the number of rows in the context.

func

py-polars.src.polars.functions.lit.lit(value:Any, dtype:PolarsDataType | DataTypeExpr | None=None, *allow_object:bool=False) -> Expr

Return an expression representing a literal value.

funcpy-polars.src.polars.functions.random.set_random_seed(seed:int) -> None

Set the global random seed for Polars.

funcpy-polars.src.polars.functions.range._utils.parse_interval_argument(interval:str | timedelta) -> str

Parse the interval argument as a Polars duration string.

func

py-polars.src.polars.functions.whenthen.when(*predicates:IntoExprColumn | Iterable[IntoExprColumn] | bool, **constraints:Any) -> pl.When

Start a `when-then-otherwise` expression.

classpy-polars.src.polars.interchange.column.PolarsColumn

A column object backed by a Polars Series.

methodpy-polars.src.polars.interchange.column.PolarsColumn.dtype() -> Dtype

Data type of the column.

methodpy-polars.src.polars.interchange.column.PolarsColumn.get_chunks(n_chunks:int | None=None) -> Iterator[PolarsColumn]

Return an iterator yielding the column chunks.

methodpy-polars.src.polars.interchange.column.PolarsColumn.metadata() -> dict[str, Any]

The metadata for the column.

methodpy-polars.src.polars.interchange.column.PolarsColumn.null_count() -> int

The number of null elements.

methodpy-polars.src.polars.interchange.column.PolarsColumn.num_chunks() -> int

Return the number of chunks the column consists of.

methodpy-polars.src.polars.interchange.column.PolarsColumn.size() -> int

Size of the column in elements.

classpy-polars.src.polars.interchange.dataframe.PolarsDataFrame

A dataframe object backed by a Polars DataFrame.

methodpy-polars.src.polars.interchange.dataframe.PolarsDataFrame.column_names() -> list[str]

Return the column names.

methodpy-polars.src.polars.interchange.dataframe.PolarsDataFrame.get_column(i:int) -> PolarsColumn

Return the column at the indicated position.

methodpy-polars.src.polars.interchange.dataframe.PolarsDataFrame.get_column_by_name(name:str) -> PolarsColumn

Return the column with the given name.

methodpy-polars.src.polars.interchange.dataframe.PolarsDataFrame.get_columns() -> Iterator[PolarsColumn]

Return an iterator yielding the columns.

methodpy-polars.src.polars.interchange.dataframe.PolarsDataFrame.metadata() -> dict[str, Any]

The metadata for the dataframe.

methodpy-polars.src.polars.interchange.dataframe.PolarsDataFrame.num_columns() -> int

Return the number of columns in the dataframe.

methodpy-polars.src.polars.interchange.dataframe.PolarsDataFrame.num_rows() -> int

Return the number of rows in the dataframe.

classpy-polars.src.polars.interchange.protocol.Buffer

Interchange buffer object.

methodpy-polars.src.polars.interchange.protocol.Buffer.bufsize() -> int

Buffer size in bytes.

methodpy-polars.src.polars.interchange.protocol.Buffer.ptr() -> int

Pointer to start of the buffer as an integer.

この情報について

掲載しているシグネチャは pola-rs/polars の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る