Extremely lightweight compatibility layer between pandas, Polars, cuDF, and Modin
Project description
Narwhals
Extremely lightweight compatibility layer between Polars, pandas, and more.
Seamlessly support both, without depending on either!
- ✅ Just use a subset of the Polars API, no need to learn anything new
- ✅ No dependencies (not even Polars), keep your library lightweight
- ✅ Be lazy
- ✅ Use Polars Expressions
Note: this is work-in-progress, and a bit of an experiment, don't take it too seriously.
Installation
pip install narwhals
Or just vendor it, it's only a bunch of pure-Python files.
Usage
There are three steps to writing dataframe-agnostic code using Narwhals:
-
use
narwhals.DataFrameto wrap a pandas or Polars DataFrame to a Narwhals DataFrame -
use the subset of the Polars API supported by Narwhals. Some methods are only available if you passed
is_eager=Truetonarwhals.DataFrame -
use
narwhals.to_nativeto return an object to the user in its original dataframe flavour. For example:- if you started with pandas, you'll get pandas back
- if you started with Polars, you'll get Polars back
Example
Here's an example of a dataframe agnostic function:
from typing import Any
import pandas as pd
import polars as pl
import narwhals as nw
def my_agnostic_function(
suppliers_native,
parts_native,
):
suppliers = nw.DataFrame(suppliers_native)
parts = nw.DataFrame(parts_native)
result = (
suppliers.join(parts, left_on="city", right_on="city")
.filter(
nw.col("color").is_in(["Red", "Green"]),
nw.col("weight") > 14,
)
.group_by("s", "p")
.agg(
weight_mean=nw.col("weight").mean(),
weight_max=nw.col("weight").max(),
)
).with_columns(nw.col("weight_max").cast(nw.Int64))
return nw.to_native(result)
You can pass in a pandas or Polars dataframe, the output will be the same! Let's try it out:
suppliers = {
"s": ["S1", "S2", "S3", "S4", "S5"],
"sname": ["Smith", "Jones", "Blake", "Clark", "Adams"],
"status": [20, 10, 30, 20, 30],
"city": ["London", "Paris", "Paris", "London", "Athens"],
}
parts = {
"p": ["P1", "P2", "P3", "P4", "P5", "P6"],
"pname": ["Nut", "Bolt", "Screw", "Screw", "Cam", "Cog"],
"color": ["Red", "Green", "Blue", "Red", "Blue", "Red"],
"weight": [12.0, 17.0, 17.0, 14.0, 12.0, 19.0],
"city": ["London", "Paris", "Oslo", "London", "Paris", "London"],
}
print("pandas output:")
print(
my_agnostic_function(
pd.DataFrame(suppliers),
pd.DataFrame(parts),
)
)
print("\nPolars output:")
print(
my_agnostic_function(
pl.DataFrame(suppliers),
pl.DataFrame(parts),
)
)
print("\nPolars lazy output:")
print(
my_agnostic_function(
pl.LazyFrame(suppliers),
pl.LazyFrame(parts),
).collect()
)
pandas output:
s p weight_mean
0 S1 P6 19.0
1 S2 P2 17.0
2 S3 P2 17.0
3 S4 P6 19.0
Polars output:
shape: (4, 3)
┌─────┬─────┬─────────────┐
│ s ┆ p ┆ weight_mean │
│ --- ┆ --- ┆ --- │
│ str ┆ str ┆ f64 │
╞═════╪═════╪═════════════╡
│ S1 ┆ P6 ┆ 19.0 │
│ S3 ┆ P2 ┆ 17.0 │
│ S4 ┆ P6 ┆ 19.0 │
│ S2 ┆ P2 ┆ 17.0 │
└─────┴─────┴─────────────┘
Polars lazy output:
shape: (4, 3)
┌─────┬─────┬─────────────┐
│ s ┆ p ┆ weight_mean │
│ --- ┆ --- ┆ --- │
│ str ┆ str ┆ f64 │
╞═════╪═════╪═════════════╡
│ S1 ┆ P6 ┆ 19.0 │
│ S3 ┆ P2 ┆ 17.0 │
│ S4 ┆ P6 ┆ 19.0 │
│ S2 ┆ P2 ┆ 17.0 │
└─────┴─────┴─────────────┘
Magic! 🪄
Scope
- Do you maintain a dataframe-consuming library?
- Is there a Polars function which you'd like Narwhals to have, which would make your job easier?
If, I'd love to hear from you!
Note: You might suspect that this is a secret ploy to infiltrate the Polars API everywhere. Indeed, you may suspect that.
Why "Narwhals"?
Because they are so awesome.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file narwhals-0.4.1.tar.gz.
File metadata
- Download URL: narwhals-0.4.1.tar.gz
- Upload date:
- Size: 131.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0024d6e77f7229fa77a68ac9eae512d5c339fc130cc5e5da4d0bcfd92a1f5113 |
|
| MD5 | eb8b57472eb4936299c476d279d7df86 |
|
| BLAKE2b-256 | 67a1d05417e5983beace913b6e501e0744ab798a81f0b293f0ead306d00ebd45 |
File details
Details for the file narwhals-0.4.1-py3-none-any.whl.
File metadata
- Download URL: narwhals-0.4.1-py3-none-any.whl
- Upload date:
- Size: 25.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 838392ace7d7649adcdce32559064c83f1ab008313c96936b46041e3320d7057 |
|
| MD5 | 024832b27d8939cbf19fe19d67e601cd |
|
| BLAKE2b-256 | 2ec42a74c3a9cdd10ee1853fb842d25877fd23c7bc25c688cfadeaf1fa67dfc5 |
