Skip to main content

Extremely lightweight compatibility layer between pandas, Polars, cuDF, and Modin

Project description

Narwhals

narwhals_small

PyPI version

Extremely lightweight and extensible compatibility layer between Polars, pandas, Modin, and cuDF (and more!).

Seamlessly support all, without depending on any!

  • Just use a subset of the Polars API, no need to learn anything new
  • No dependencies (not even Polars), keep your library lightweight
  • ✅ Separate lazy and eager APIs
  • ✅ Use Expressions
  • ✅ 100% branch coverage, tested against pandas and Polars nightly builds
  • ✅ Preserve your Index (if present) without it getting in the way
  • Zero 3rd party imports, Narwhals only uses what you already have

Used by

Join the party!

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:

  1. use narwhals.from_native to wrap a pandas/Polars/Modin/cuDF DataFrame/LazyFrame in a Narwhals class

  2. use the subset of the Polars API supported by Narwhals

  3. use narwhals.to_native to 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
    • if you started with Modin, you'll get Modin back (and compute will be distributed)
    • if you started with cuDF, you'll get cuDF back (and compute will happen on GPU)

What about Ibis?

Like Ibis, Narwhals aims to enable dataframe-agnostic code. However, Narwhals comes with zero dependencies, is about as lightweight as it gets, and is aimed at library developers rather than at end users. It also does not aim to support as many backends, instead preferring to focus on dataframes. So, which should you use?

  • If you need to run complicated analyses and aren't too bothered about package size: Ibis!
  • If you're a library maintainer and want the thinnest-possible layer to get cross-dataframe library support: Narwhals!

Here is the package size increase which would result from installing each tool in a non-pandas environment:

image

Example

See the tutorial for several examples!

Scope

  • Do you maintain a dataframe-consuming library?
  • Do you have a specific Polars function in mind that you would like Narwhals to have in order to make your work easier?

If you said yes to both, we'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"?

Coz they are so awesome.

Thanks to Olha Urdeichuk for the illustration!

Project details


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

narwhals-0.8.20.tar.gz (337.8 kB view details)

Uploaded Source

Built Distribution

narwhals-0.8.20-py3-none-any.whl (59.9 kB view details)

Uploaded Python 3

File details

Details for the file narwhals-0.8.20.tar.gz.

File metadata

  • Download URL: narwhals-0.8.20.tar.gz
  • Upload date:
  • Size: 337.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for narwhals-0.8.20.tar.gz
Algorithm Hash digest
SHA256 2cd0804df9678fb91ea79a6a15ef9ade2d30f8b610b2dadd717179b22bb1465c
MD5 5d4ad3d4a0e909ea5588f2c0b393dd5c
BLAKE2b-256 d6aa015ea58e6c0a0ceb3b1232f7fc98e4ed0d18645ecd3e6c4f86557d6dc858

See more details on using hashes here.

Provenance

File details

Details for the file narwhals-0.8.20-py3-none-any.whl.

File metadata

  • Download URL: narwhals-0.8.20-py3-none-any.whl
  • Upload date:
  • Size: 59.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for narwhals-0.8.20-py3-none-any.whl
Algorithm Hash digest
SHA256 b0bdda315e86b2e0051151158e76e750bb1c4114f1bdf1b02534ff14b073c60a
MD5 658fe73a651bca534a564e0e53a21425
BLAKE2b-256 789c83246e750cd3501e215fbf924ec7c78d04fa60f587465934bacf8227868f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page