Skip to main content

Blazingly fast DataFrame library

Project description

Polars logo

Documentation: Python - Rust - Node.js - R | StackOverflow: Python - Rust - Node.js - R | User guide | Discord

Polars: Blazingly fast DataFrames in Rust, Python, Node.js, R, and SQL

Polars is a DataFrame interface on top of an OLAP Query Engine implemented in Rust using Apache Arrow Columnar Format as the memory model.

  • Lazy | eager execution
  • Multi-threaded
  • SIMD
  • Query optimization
  • Powerful expression API
  • Hybrid Streaming (larger-than-RAM datasets)
  • Rust | Python | NodeJS | R | ...

To learn more, read the user guide.

Python

>>> import polars as pl
>>> df = pl.DataFrame(
...     {
...         "A": [1, 2, 3, 4, 5],
...         "fruits": ["banana", "banana", "apple", "apple", "banana"],
...         "B": [5, 4, 3, 2, 1],
...         "cars": ["beetle", "audi", "beetle", "beetle", "beetle"],
...     }
... )

# embarrassingly parallel execution & very expressive query language
>>> df.sort("fruits").select(
...     "fruits",
...     "cars",
...     pl.lit("fruits").alias("literal_string_fruits"),
...     pl.col("B").filter(pl.col("cars") == "beetle").sum(),
...     pl.col("A").filter(pl.col("B") > 2).sum().over("cars").alias("sum_A_by_cars"),
...     pl.col("A").sum().over("fruits").alias("sum_A_by_fruits"),
...     pl.col("A").reverse().over("fruits").alias("rev_A_by_fruits"),
...     pl.col("A").sort_by("B").over("fruits").alias("sort_A_by_B_by_fruits"),
... )
shape: (5, 8)
┌──────────┬──────────┬──────────────┬─────┬─────────────┬─────────────┬─────────────┬─────────────┐
 fruits    cars      literal_stri  B    sum_A_by_ca  sum_A_by_fr  rev_A_by_fr  sort_A_by_B 
 ---       ---       ng_fruits     ---  rs           uits         uits         _by_fruits  
 str       str       ---           i64  ---          ---          ---          ---         
                     str                i64          i64          i64          i64         
╞══════════╪══════════╪══════════════╪═════╪═════════════╪═════════════╪═════════════╪═════════════╡
 "apple"   "beetle"  "fruits"      11   4            7            4            4           
 "apple"   "beetle"  "fruits"      11   4            7            3            3           
 "banana"  "beetle"  "fruits"      11   4            8            5            5           
 "banana"  "audi"    "fruits"      11   2            8            2            2           
 "banana"  "beetle"  "fruits"      11   4            8            1            1           
└──────────┴──────────┴──────────────┴─────┴─────────────┴─────────────┴─────────────┴─────────────┘

SQL

>>> df = pl.scan_csv("docs/assets/data/iris.csv")
>>> ## OPTION 1
>>> # run SQL queries on frame-level
>>> df.sql("""
...	SELECT species,
...	  AVG(sepal_length) AS avg_sepal_length
...	FROM self
...	GROUP BY species
...	""").collect()
shape: (3, 2)
┌────────────┬──────────────────┐
 species     avg_sepal_length 
 ---         ---              
 str         f64              
╞════════════╪══════════════════╡
 Virginica   6.588            
 Versicolor  5.936            
 Setosa      5.006            
└────────────┴──────────────────┘
>>> ## OPTION 2
>>> # use pl.sql() to operate on the global context
>>> df2 = pl.LazyFrame({
...    "species": ["Setosa", "Versicolor", "Virginica"],
...    "blooming_season": ["Spring", "Summer", "Fall"]
...})
>>> pl.sql("""
... SELECT df.species,
...     AVG(df.sepal_length) AS avg_sepal_length,
...     df2.blooming_season
... FROM df
... LEFT JOIN df2 ON df.species = df2.species
... GROUP BY df.species, df2.blooming_season
... """).collect()

SQL commands can also be run directly from your terminal using the Polars CLI:

# run an inline SQL query
> polars -c "SELECT species, AVG(sepal_length) AS avg_sepal_length, AVG(sepal_width) AS avg_sepal_width FROM read_csv('docs/assets/data/iris.csv') GROUP BY species;"

# run interactively
> polars
Polars CLI v0.3.0
Type .help for help.

> SELECT species, AVG(sepal_length) AS avg_sepal_length, AVG(sepal_width) AS avg_sepal_width FROM read_csv('docs/assets/data/iris.csv') GROUP BY species;

Refer to the Polars CLI repository for more information.

Performance 🚀🚀

Blazingly fast

Polars is very fast. In fact, it is one of the best performing solutions available. See the PDS-H benchmarks results.

Lightweight

Polars is also very lightweight. It comes with zero required dependencies, and this shows in the import times:

  • polars: 70ms
  • numpy: 104ms
  • pandas: 520ms

Handles larger-than-RAM data

If you have data that does not fit into memory, Polars' query engine is able to process your query (or parts of your query) in a streaming fashion. This drastically reduces memory requirements, so you might be able to process your 250GB dataset on your laptop. Collect with collect(streaming=True) to run the query streaming. (This might be a little slower, but it is still very fast!)

Setup

Python

Install the latest Polars version with:

pip install polars

We also have a conda package (conda install -c conda-forge polars), however pip is the preferred way to install Polars.

Install Polars with all optional dependencies.

pip install 'polars[all]'

You can also install a subset of all optional dependencies.

pip install 'polars[numpy,pandas,pyarrow]'

See the User Guide for more details on optional dependencies

To see the current Polars version and a full list of its optional dependencies, run:

pl.show_versions()

Releases happen quite often (weekly / every few days) at the moment, so updating Polars regularly to get the latest bugfixes / features might not be a bad idea.

Rust

You can take latest release from crates.io, or if you want to use the latest features / performance improvements point to the main branch of this repo.

polars = { git = "https://github.com/pola-rs/polars", rev = "<optional git tag>" }

Requires Rust version >=1.80.

Contributing

Want to contribute? Read our contributing guide.

Python: compile Polars from source

If you want a bleeding edge release or maximal performance you should compile Polars from source.

This can be done by going through the following steps in sequence:

  1. Install the latest Rust compiler
  2. Install maturin: pip install maturin
  3. cd py-polars and choose one of the following:
    • make build, slow binary with debug assertions and symbols, fast compile times
    • make build-release, fast binary without debug assertions, minimal debug symbols, long compile times
    • make build-nodebug-release, same as build-release but without any debug symbols, slightly faster to compile
    • make build-debug-release, same as build-release but with full debug symbols, slightly slower to compile
    • make build-dist-release, fastest binary, extreme compile times

By default the binary is compiled with optimizations turned on for a modern CPU. Specify LTS_CPU=1 with the command if your CPU is older and does not support e.g. AVX2.

Note that the Rust crate implementing the Python bindings is called py-polars to distinguish from the wrapped Rust crate polars itself. However, both the Python package and the Python module are named polars, so you can pip install polars and import polars.

Using custom Rust functions in Python

Extending Polars with UDFs compiled in Rust is easy. We expose PyO3 extensions for DataFrame and Series data structures. See more in https://github.com/pola-rs/pyo3-polars.

Going big...

Do you expect more than 2^32 (~4.2 billion) rows? Compile Polars with the bigidx feature flag or, for Python users, install pip install polars-u64-idx.

Don't use this unless you hit the row boundary as the default build of Polars is faster and consumes less memory.

Legacy

Do you want Polars to run on an old CPU (e.g. dating from before 2011), or on an x86-64 build of Python on Apple Silicon under Rosetta? Install pip install polars-lts-cpu. This version of Polars is compiled without AVX target features.

Sponsors

JetBrains logo

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

polars-1.13.1.tar.gz (4.1 MB view details)

Uploaded Source

Built Distributions

polars-1.13.1-cp39-abi3-win_amd64.whl (35.2 MB view details)

Uploaded CPython 3.9+ Windows x86-64

polars-1.13.1-cp39-abi3-manylinux_2_24_aarch64.whl (31.8 MB view details)

Uploaded CPython 3.9+ manylinux: glibc 2.24+ ARM64

polars-1.13.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (35.4 MB view details)

Uploaded CPython 3.9+ manylinux: glibc 2.17+ x86-64

polars-1.13.1-cp39-abi3-macosx_11_0_arm64.whl (30.1 MB view details)

Uploaded CPython 3.9+ macOS 11.0+ ARM64

polars-1.13.1-cp39-abi3-macosx_10_12_x86_64.whl (34.2 MB view details)

Uploaded CPython 3.9+ macOS 10.12+ x86-64

File details

Details for the file polars-1.13.1.tar.gz.

File metadata

  • Download URL: polars-1.13.1.tar.gz
  • Upload date:
  • Size: 4.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for polars-1.13.1.tar.gz
Algorithm Hash digest
SHA256 a8a7bb70aca0657939552a4505eccabb07c9d59d330d5a66409fe67295082860
MD5 caef07ba549b826c029423ddd9a71018
BLAKE2b-256 75336c5028a3a3253a89b73d8398b52ea357876340b5e5c6bca91633db251dad

See more details on using hashes here.

Provenance

The following attestation bundles were made for polars-1.13.1.tar.gz:

Publisher: GitHub
  • Repository: pola-rs/polars
  • Workflow: release-python.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: polars-1.13.1.tar.gz
    • Subject digest: a8a7bb70aca0657939552a4505eccabb07c9d59d330d5a66409fe67295082860
    • Transparency log index: 148751843
    • Transparency log integration time:

File details

Details for the file polars-1.13.1-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: polars-1.13.1-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 35.2 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for polars-1.13.1-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 060148c687920c7af2dc16a9de0aa6de293233f1a2634db503c497504fdb19ad
MD5 e614460faaf5561c9aca70c0650d1b86
BLAKE2b-256 4525b37b81c70595d1eda0f2c62b2e9163243168cf6a8c888f3836473e172083

See more details on using hashes here.

Provenance

The following attestation bundles were made for polars-1.13.1-cp39-abi3-win_amd64.whl:

Publisher: GitHub
  • Repository: pola-rs/polars
  • Workflow: release-python.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: polars-1.13.1-cp39-abi3-win_amd64.whl
    • Subject digest: 060148c687920c7af2dc16a9de0aa6de293233f1a2634db503c497504fdb19ad
    • Transparency log index: 148751857
    • Transparency log integration time:

File details

Details for the file polars-1.13.1-cp39-abi3-manylinux_2_24_aarch64.whl.

File metadata

File hashes

Hashes for polars-1.13.1-cp39-abi3-manylinux_2_24_aarch64.whl
Algorithm Hash digest
SHA256 792d9de49de6ebcfb137885e1643e09b35bcad1ae3bc86971f0d82a06372e1a4
MD5 9b1d6f0665b6fb2fbc2a68225a62c446
BLAKE2b-256 674ea337779a9653ff271ef57484fba9e298c9be4ddcedd422ea1eb9fdaae65a

See more details on using hashes here.

Provenance

The following attestation bundles were made for polars-1.13.1-cp39-abi3-manylinux_2_24_aarch64.whl:

Publisher: GitHub
  • Repository: pola-rs/polars
  • Workflow: release-python.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: polars-1.13.1-cp39-abi3-manylinux_2_24_aarch64.whl
    • Subject digest: 792d9de49de6ebcfb137885e1643e09b35bcad1ae3bc86971f0d82a06372e1a4
    • Transparency log index: 148751848
    • Transparency log integration time:

File details

Details for the file polars-1.13.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for polars-1.13.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 405826a78c20721d0f47ee58bafdbd5311551c306cc52ff2e8dc0e2f5fc53d07
MD5 cd97636c19dd93f09be26de2f2a678e0
BLAKE2b-256 cee89fd44ad4c091f911724f4cbe34f960c2e8016391e88f4da75ab0a2b83493

See more details on using hashes here.

Provenance

The following attestation bundles were made for polars-1.13.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: GitHub
  • Repository: pola-rs/polars
  • Workflow: release-python.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: polars-1.13.1-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
    • Subject digest: 405826a78c20721d0f47ee58bafdbd5311551c306cc52ff2e8dc0e2f5fc53d07
    • Transparency log index: 148751846
    • Transparency log integration time:

File details

Details for the file polars-1.13.1-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for polars-1.13.1-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 faa436c721179fca978a470ade1072acc5e510396a88ce7e3aa4fcc75186739f
MD5 1c4fef866b7894414e7ff892c74ba83c
BLAKE2b-256 6eec5d4b0f6cdbd63b75913bae18f2abc1b30f4e776eab00d646f282bd405aeb

See more details on using hashes here.

Provenance

The following attestation bundles were made for polars-1.13.1-cp39-abi3-macosx_11_0_arm64.whl:

Publisher: GitHub
  • Repository: pola-rs/polars
  • Workflow: release-python.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: polars-1.13.1-cp39-abi3-macosx_11_0_arm64.whl
    • Subject digest: faa436c721179fca978a470ade1072acc5e510396a88ce7e3aa4fcc75186739f
    • Transparency log index: 148751853
    • Transparency log integration time:

File details

Details for the file polars-1.13.1-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for polars-1.13.1-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 9d5c74229fdc180fdbe99e4dc121a2ce0de6f0fcea2769a208f033112d5729dd
MD5 ca8db1e5a4672dbec9d8371d80cfd0bb
BLAKE2b-256 ca73b6db1017f0f80290b408f7576886115ab7c26d98b137bb7c8d20333c1154

See more details on using hashes here.

Provenance

The following attestation bundles were made for polars-1.13.1-cp39-abi3-macosx_10_12_x86_64.whl:

Publisher: GitHub
  • Repository: pola-rs/polars
  • Workflow: release-python.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: polars-1.13.1-cp39-abi3-macosx_10_12_x86_64.whl
    • Subject digest: 9d5c74229fdc180fdbe99e4dc121a2ce0de6f0fcea2769a208f033112d5729dd
    • Transparency log index: 148751856
    • Transparency log integration time:

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