narwhals.DataFrameshape: tuple[int, int]
+
+
+ property
+
+
+schema: dict[str, DType]
+
+
+ property
+
+
+columns: list[str]
+
+
+ property
+
+
+to_pandas()
+
+to_numpy()
+
+__getitem__(col_name)
+
+to_dict(*, as_series=True)
+
+with_columns(*exprs, **named_exprs)
+
+select(*exprs, **named_exprs)
+
+rename(mapping)
+
+head(n)
+
+drop(*columns)
+
+unique(subset)
+
+filter(*predicates)
+
+group_by(*keys)
+
+sort(by, *more_by, descending=False)
+
+join(other, *, how='inner', left_on, right_on)
+
+narwhals.Exprstr: ExprStringNamespace
+
+
+ property
+
+
+alias(name)
+
+cast(dtype)
+
+mean()
+
+sum()
+
+min()
+
+max()
+
+n_unique()
+
+unique()
+
+is_between(lower_bound, upper_bound, closed='both')
+
+is_in(other)
+
+is_null()
+
+drop_nulls()
+
+sample(n=None, fraction=None, *, with_replacement=False)
+
+narwhals.LazyFrameschema: dict[str, DType]
+
+
+ property
+
+
+columns: list[str]
+
+
+ property
+
+
+with_columns(*exprs, **named_exprs)
+
+select(*exprs, **named_exprs)
+
+rename(mapping)
+
+head(n)
+
+drop(*columns)
+
+unique(subset)
+
+filter(*predicates)
+
+group_by(*keys)
+
+sort(by, *more_by, descending=False)
+
+join(other, *, how='inner', left_on, right_on)
+
+collect()
+
+narwhalsHere are the top-level functions available in Narwhals.
+ + +from_native(native_dataframe)
+
+Convert dataframe to Narwhals DataFrame or LazyFrame.
+ + + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
native_dataframe |
+
+ Any
+ |
+
+
+
+ Raw dataframe from user. +Input object can be: +
|
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ DataFrame | LazyFrame
+ |
+
+
+
+ narwhals.DataFrame or narwhals.LazyFrame + |
+
to_native(narwhals_object)
+
+Convert Narwhals object to native one.
+ + + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
narwhals_object |
+
+ LazyFrame | DataFrame | Series
+ |
+
+
+
+ Narwhals object. + |
+ + required + | +
Returns:
+| Type | +Description | +
|---|---|
+ Any
+ |
+
+
+
+ Object of class that user started with. + |
+
col(*names)
+
+Instantiate an expression, similar to polars.col.
min(*columns)
+
+Instantiate an expression representing the minimum of one or more columns, similar to polars.min.
max(*columns)
+
+Instantiate an expression representing the maximum of one or more columns, similar to polars.max.
mean(*columns)
+
+Instantiate an expression representing the mean of one or more columns, similar to polars.mean.
sum(*columns)
+
+Instantiate an expression representing the sum of one or more columns, similar to polars.sum.
len()
+
+Instantiate an expression representing the length of a dataframe, similar to polars.len.
sum_horizontal(*exprs)
+
+Instantiate an expression representing the horzontal sum of one or more expressions, similar to polars.sum_horizontal.
narwhals.Seriesname: str
+
+
+ property
+
+
+dtype: Any
+
+
+ property
+
+
+shape: tuple[int]
+
+
+ property
+
+
+alias(name)
+
+rename(name)
+
+cast(dtype)
+
+item()
+
+is_between(lower_bound, upper_bound, closed='both')
+
+is_in(other)
+
+is_null()
+
+drop_nulls()
+
+n_unique()
+
+unique()
+
+zip_with(mask, other)
+
+sample(n=None, fraction=None, *, with_replacement=False)
+
+to_numpy()
+
+to_pandas()
+
+mean()
+
+std()
+
+