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(engine='streaming') 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.31.0.tar.gz (4.7 MB view details)

Uploaded Source

Built Distributions

polars-1.31.0-cp39-abi3-win_arm64.whl (31.5 MB view details)

Uploaded CPython 3.9+Windows ARM64

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

Uploaded CPython 3.9+Windows x86-64

polars-1.31.0-cp39-abi3-manylinux_2_24_aarch64.whl (32.3 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.24+ ARM64

polars-1.31.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (35.1 MB view details)

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

polars-1.31.0-cp39-abi3-macosx_11_0_arm64.whl (31.4 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

polars-1.31.0-cp39-abi3-macosx_10_12_x86_64.whl (34.5 MB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: polars-1.31.0.tar.gz
  • Upload date:
  • Size: 4.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for polars-1.31.0.tar.gz
Algorithm Hash digest
SHA256 59a88054a5fc0135386268ceefdbb6a6cc012d21b5b44fed4f1d3faabbdcbf32
MD5 ad3a074a713a27ff49e98abce8c4734b
BLAKE2b-256 fdf5de1b5ecd7d0bd0dd87aa392937f759f9cc3997c5866a9a7f94eabf37cd48

See more details on using hashes here.

Provenance

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

Publisher: release-python.yml on pola-rs/polars

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file polars-1.31.0-cp39-abi3-win_arm64.whl.

File metadata

  • Download URL: polars-1.31.0-cp39-abi3-win_arm64.whl
  • Upload date:
  • Size: 31.5 MB
  • Tags: CPython 3.9+, Windows ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for polars-1.31.0-cp39-abi3-win_arm64.whl
Algorithm Hash digest
SHA256 62ef23bb9d10dca4c2b945979f9a50812ac4ace4ed9e158a6b5d32a7322e6f75
MD5 c3a5dbec147355ed24448533aaa32994
BLAKE2b-256 404b0673a68ac4d6527fac951970e929c3b4440c654f994f0c957bd5556deb38

See more details on using hashes here.

Provenance

The following attestation bundles were made for polars-1.31.0-cp39-abi3-win_arm64.whl:

Publisher: release-python.yml on pola-rs/polars

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: polars-1.31.0-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/6.1.0 CPython/3.12.9

File hashes

Hashes for polars-1.31.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 3fd874d3432fc932863e8cceff2cff8a12a51976b053f2eb6326a0672134a632
MD5 cf75f225ae643c2f256263e4b1856d6a
BLAKE2b-256 6ef69d9ad9dc4480d66502497e90ce29efc063373e1598f4bd9b6a38af3e08e7

See more details on using hashes here.

Provenance

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

Publisher: release-python.yml on pola-rs/polars

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for polars-1.31.0-cp39-abi3-manylinux_2_24_aarch64.whl
Algorithm Hash digest
SHA256 b324e6e3e8c6cc6593f9d72fe625f06af65e8d9d47c8686583585533a5e731e1
MD5 2d51e72494674970f7abc21ebd5e0948
BLAKE2b-256 20e8a6bdfe7b687c1fe84bceb1f854c43415eaf0d2fdf3c679a9dc9c4776e462

See more details on using hashes here.

Provenance

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

Publisher: release-python.yml on pola-rs/polars

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for polars-1.31.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ada7940ed92bea65d5500ae7ac1f599798149df8faa5a6db150327c9ddbee4f1
MD5 6ba101ad15b2394b7f7a15ff43b43989
BLAKE2b-256 b8d95e2753784ea30d84b3e769a56f5e50ac5a89c129e87baa16ac0773eb4ef7

See more details on using hashes here.

Provenance

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

Publisher: release-python.yml on pola-rs/polars

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for polars-1.31.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a94c5550df397ad3c2d6adc212e59fd93d9b044ec974dd3653e121e6487a7d21
MD5 f01ec09d87706bc2164623248a92479e
BLAKE2b-256 77fe81aaca3540c1a5530b4bc4fd7f1b6f77100243d7bb9b7ad3478b770d8b3e

See more details on using hashes here.

Provenance

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

Publisher: release-python.yml on pola-rs/polars

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for polars-1.31.0-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 ccc68cd6877deecd46b13cbd2663ca89ab2a2cb1fe49d5cfc66a9cef166566d9
MD5 91f010356c5ff40ad2093ebf317bd952
BLAKE2b-256 3d6ebdd0937653c1e7a564a09ae3bc7757ce83fedbf19da600c8b35d62c0182a

See more details on using hashes here.

Provenance

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

Publisher: release-python.yml on pola-rs/polars

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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