Pyo3 Polars

https://docs.rs/pyo3-polars/latest/pyo3_polars
Admin
A Rust crate that provides `PySeries` and `PyDataFrame` wrappers for Polars Series and DataFrame,...
Tokens:4,292
Snippets:68
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### PolarsAllocator::new

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/struct.PolarsAllocator.html

Creates a new instance of the PolarsAllocator.

```APIDOC
## pub const fn new() -> Self

### Description
Creates a new `PolarsAllocator` instance.

### Signature
`pub const fn new() -> Self`
```

--------------------------------

### Define PyTypeInfo constants and methods

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ShapeError.html?search=std%3A%3Avec

Constants and methods for PyTypeInfo implementation on ShapeError.

```rust
const NAME: &'static str = "ShapeError"
```

```rust
const MODULE: Option<&'static str>
```

```rust
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
```

```rust
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
```

```rust
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
```

```rust
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
```

--------------------------------

### Define PyTypeInfo constants

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.SQLSyntax.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constants for the class and module names associated with SQLSyntax.

```rust
const NAME: &'static str = "SQLSyntax"
```

```rust
const MODULE: Option<&'static str>
```

--------------------------------

### SQLInterface Type Information Methods

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.SQLInterface.html?search=

Methods for retrieving type information and performing type checks on SQLInterface instances.

```rust
const NAME: &'static str = "SQLInterface"
```

```rust
const MODULE: Option<&'static str>
```

```rust
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
```

```rust
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
```

```rust
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
```

```rust
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
```

--------------------------------

### PyTypeInfo constants and methods

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.SchemaFieldNotFound.html?search=

Constants and methods for interacting with the Python type information of SchemaFieldNotFound.

```rust
const NAME: &'static str = "SchemaFieldNotFound"
```

```rust
const MODULE: Option<&'static str>
```

```rust
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
```

```rust
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
```

```rust
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
```

```rust
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
```

--------------------------------

### PyTypeInfo Constants and Methods

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.StructFieldNotFound.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constants and methods for retrieving type information for StructFieldNotFound.

```rust
const NAME: &'static str = "StructFieldNotFound"
```

```rust
const MODULE: Option<&'static str>
```

```rust
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
```

```rust
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
```

```rust
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
```

```rust
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
```

--------------------------------

### PyTypeInfo Constants and Methods

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.StringCacheMismatchError.html?search=

Constants and methods for interacting with the Python type system for StringCacheMismatchError.

```rust
const NAME: &'static str = "StringCacheMismatchError"
```

```rust
const MODULE: Option<&'static str>
```

```rust
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
```

```rust
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
```

```rust
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
```

```rust
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
```

--------------------------------

### ColumnNotFound PyTypeInfo methods

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ColumnNotFound.html?search=

Methods for retrieving type information and checking object types for ColumnNotFound.

```rust
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
```

```rust
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
```

```rust
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
```

```rust
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
```

--------------------------------

### SQLInterface::new_err

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.SQLInterface.html

Creates a new PyErr instance associated with the SQLInterface type.

```APIDOC
## pub fn new_err<A>(args: A) -> PyErr

### Description
Creates a new `PyErr` of this type using the provided arguments.

### Parameters
- **args** (A) - Required - The arguments implementing `PyErrArguments` to construct the error.
```

--------------------------------

### StructFieldNotFound::new_err

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.StructFieldNotFound.html?search=std%3A%3Avec

Creates a new PyErr instance for the StructFieldNotFound error type.

```APIDOC
## pub fn new_err<A>(args: A) -> PyErr

### Description
Creates a new `PyErr` of this type, allowing the error to be raised within the Python interpreter.

### Parameters
- **args** (A) - Required - The arguments to pass to the error constructor, must implement `PyErrArguments`, `Send`, `Sync`, and be `'static`.
```

--------------------------------

### PyTimeUnit struct definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/types/struct.PyTimeUnit.html?search=

The definition of the PyTimeUnit struct.

```rust
pub struct PyTimeUnit(/* private fields */);
```

--------------------------------

### Define SQLInterface struct

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.SQLInterface.html

The definition of the SQLInterface struct.

```rust
pub struct SQLInterface(/* private fields */);
```

--------------------------------

### Create a new PyErr

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ColumnNotFound.html

Creates a new PyErr of the ColumnNotFound type.

```rust
pub fn new_err<A>(args: A) -> PyErr
where A: PyErrArguments + Send + Sync + 'static,
```

--------------------------------

### SQLSyntax Struct Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.SQLSyntax.html

The definition of the SQLSyntax struct.

```rust
pub struct SQLSyntax(/* private fields */);
```

--------------------------------

### ColumnNotFound PyTypeInfo constants

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ColumnNotFound.html?search=

Constants defining the class and module names for the ColumnNotFound type.

```rust
const NAME: &'static str = "ColumnNotFound"
```

```rust
const MODULE: Option<&'static str>
```

--------------------------------

### Configure PolarsAllocator as the global allocator

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/struct.PolarsAllocator.html

Use the #[global_allocator] attribute to set PolarsAllocator as the primary memory allocator for the Rust program.

```rust
use pyo3_polars::PolarsAllocator;

#[global_allocator]
static ALLOC: PolarsAllocator = PolarsAllocator::new();
```

--------------------------------

### PyField Struct Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/types/struct.PyField.html

The basic definition of the PyField struct.

```rust
pub struct PyField(/* private fields */);
```

--------------------------------

### StringCacheMismatchError::new_err

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.StringCacheMismatchError.html?search=std%3A%3Avec

Creates a new PyErr instance for the StringCacheMismatchError.

```APIDOC
## pub fn new_err<A>(args: A) -> PyErr

### Description
Creates a new `PyErr` of this type, allowing the error to be raised within the Python interpreter.

### Parameters
- **args** (A) - Required - Arguments implementing `PyErrArguments`, `Send`, `Sync`, and `'static` to populate the error details.
```

--------------------------------

### Implement a Python-accessible function with PyDataFrame

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/index.html

Use PyDataFrame to wrap Polars DataFrames for use in Python modules. Requires the pyo3 and polars crates.

```rust
#[pyfunction]
fn my_cool_function(pydf: PyDataFrame) -> PyResult<PyDataFrame> {
    let df: DataFrame = pydf.into();
    let df = {
        // some work on the dataframe here
        todo!()
    };

    // wrap the dataframe and it will be automatically converted to a python polars dataframe
    Ok(PyDataFrame(df))
}

/// A Python module implemented in Rust.
#[pymodule]
fn expression_lib(_py: Python, m: &Bound<PyModule>) -> PyResult<()> {
    m.add_function(wrap_pyfunction!(my_cool_function, m)?)?;
    Ok(())
}
```

--------------------------------

### PySchema Struct Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/types/struct.PySchema.html

The core structure definition for PySchema, which wraps a SchemaRef.

```rust
#[repr(transparent)]
pub struct PySchema(pub SchemaRef);
```

--------------------------------

### Invoke Rust-implemented function from Python

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/index.html

Import and call the Rust-defined function using a standard Polars DataFrame in Python.

```python
from expression_lib import my_cool_function

df = pl.DataFrame({
    "foo": [1, 2, None],
    "bar": ["a", None, "c"],
})
out_df = my_cool_function(df)
```

--------------------------------

### ComputeError::new_err

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ComputeError.html

Creates a new PyErr of the ComputeError type.

```APIDOC
## pub fn new_err<A>(args: A) -> PyErr

### Description
Creates a new `PyErr` of this type. This is used to propagate errors from Rust to Python.

### Parameters
- **args** (A) - Required - The arguments for the error, must implement `PyErrArguments`, `Send`, `Sync`, and be `'static`.

### Returns
- **PyErr** - The resulting Python exception object.
```

--------------------------------

### NoDataError::new_err

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.NoDataError.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new PyErr instance for the NoDataError type.

```APIDOC
## pub fn new_err<A>(args: A) -> PyErr

### Description
Creates a new `PyErr` of this type. This is used to propagate errors from Rust to Python.

### Parameters
- **args** (A) - Required - The arguments for the error, must implement PyErrArguments, Send, Sync, and 'static.

### Returns
- **PyErr** - The resulting Python error object.
```

--------------------------------

### Define ColumnNotFound struct

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ColumnNotFound.html

The definition of the ColumnNotFound struct.

```rust
pub struct ColumnNotFound(/* private fields */);
```

--------------------------------

### SchemaError::new_err

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.SchemaError.html?search=

Creates a new PyErr instance of the SchemaError type, which can be used to propagate errors from Rust to Python.

```APIDOC
## pub fn new_err<A>(args: A) -> PyErr

### Description
Creates a new `PyErr` of the `SchemaError` type. This is typically used to raise a specific schema-related error in the Python runtime.

### Parameters
- **args** (PyErrArguments + Send + Sync + 'static) - Required - The arguments to initialize the error with.
```

--------------------------------

### PyTypeInfo Implementation for DuplicateError

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.DuplicateError.html?search=std%3A%3Avec

Trait implementation providing type information and inspection methods for DuplicateError.

```rust
const NAME: &'static str = "DuplicateError"
```

```rust
const MODULE: Option<&'static str>
```

```rust
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
```

```rust
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
```

```rust
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
```

```rust
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
```

--------------------------------

### SchemaFieldNotFound Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.SchemaFieldNotFound.html

The definition of the SchemaFieldNotFound struct.

```rust
pub struct SchemaFieldNotFound(/* private fields */);
```

--------------------------------

### ShapeError::new_err

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ShapeError.html

Creates a new PyErr instance representing a ShapeError. This is used to propagate errors from Rust to Python.

```APIDOC
## pub fn new_err<A>(args: A) -> PyErr

### Description
Creates a new `PyErr` of this type, allowing Rust code to raise a `ShapeError` exception in the Python interpreter.

### Parameters
- **args** (A) - Required - The arguments to initialize the error, must implement `PyErrArguments`, `Send`, `Sync`, and be `'static`.

### Returns
- **PyErr** - The constructed Python exception object.
```

--------------------------------

### AssertionError::new_err

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.AssertionError.html

Creates a new PyErr instance representing an AssertionError. This is used to propagate errors from Rust to Python.

```APIDOC
## pub fn new_err<A>(args: A) -> PyErr

### Description
Creates a new `PyErr` of the `AssertionError` type. This allows Rust code to raise an `AssertionError` that can be caught or handled by Python.

### Parameters
- **args** (A) - Required - The arguments to pass to the AssertionError constructor, where A must implement `PyErrArguments`.
```

--------------------------------

### AssertionError type information

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.AssertionError.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for retrieving type information and checking object instances for AssertionError.

```rust
const NAME: &'static str = "AssertionError"
```

```rust
const MODULE: Option<&'static str>
```

```rust
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
```

```rust
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
```

```rust
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
```

```rust
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
```

--------------------------------

### DuplicateError::new_err

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.DuplicateError.html

Creates a new PyErr instance for the DuplicateError type.

```APIDOC
## pub fn new_err<A>(args: A) -> PyErr

### Description
Creates a new `PyErr` of this type.

### Parameters
- **args** (A) - Required - Arguments that implement `PyErrArguments`, `Send`, `Sync`, and are `'static`.
```

--------------------------------

### StructFieldNotFound definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.StructFieldNotFound.html

The definition of the StructFieldNotFound struct.

```rust
pub struct StructFieldNotFound(/* private fields */);
```

--------------------------------

### Define PolarsAllocator

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/struct.PolarsAllocator.html?search=u32+-%3E+bool

The definition of the PolarsAllocator struct.

```rust
pub struct PolarsAllocator(/* private fields */);
```

--------------------------------

### AssertionError PyTypeInfo constants

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.AssertionError.html?search=

Constants for the AssertionError type name and module.

```rust
const NAME: &'static str = "AssertionError"
```

```rust
const MODULE: Option<&'static str>
```

--------------------------------

### Define PyDataFrame struct

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/types/struct.PyDataFrame.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The core structure definition for PyDataFrame, using a transparent representation to wrap a Polars DataFrame.

```rust
#[repr(transparent)]
pub struct PyDataFrame(pub DataFrame);
```

--------------------------------

### ComputeError Type Information

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ComputeError.html?search=

Methods for retrieving type information and performing type checks on ComputeError instances.

```rust
const NAME: &'static str = "ComputeError"
```

```rust
const MODULE: Option<&'static str>
```

```rust
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
```

```rust
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
```

```rust
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
```

```rust
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
```

--------------------------------

### ComputeError PyTypeInfo constants

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ComputeError.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constants defining the class and module names for the ComputeError type.

```rust
const NAME: &'static str = "ComputeError"
```

```rust
const MODULE: Option<&'static str>
```

--------------------------------

### SchemaError Struct Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.SchemaError.html

The definition of the SchemaError struct.

```rust
pub struct SchemaError(/* private fields */);
```

--------------------------------

### Define NoDataError struct

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.NoDataError.html

The definition of the NoDataError struct.

```rust
pub struct NoDataError(/* private fields */);
```

--------------------------------

### DuplicateError Type Information Constants

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.DuplicateError.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constants defining the class and module names for DuplicateError.

```rust
const NAME: &'static str = "DuplicateError"
```

```rust
const MODULE: Option<&'static str>
```

--------------------------------

### PySeries Struct Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/types/struct.PySeries.html?search=

The core definition of the PySeries struct, which uses a transparent representation to wrap a Polars Series.

```rust
#[repr(transparent)]
pub struct PySeries(pub Series);
```

--------------------------------

### Define PyDataType struct

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/types/struct.PyDataType.html

The structure is defined as a transparent wrapper around a Polars DataType.

```rust
#[repr(transparent)]
pub struct PyDataType(pub DataType);
```

--------------------------------

### PyPolarsErr Enum Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/enum.PyPolarsErr.html?search=

The definition of the PyPolarsErr enum, which encapsulates Polars errors and custom string errors.

```rust
pub enum PyPolarsErr {
    Polars(PolarsError),
    Other(String),
}
```

--------------------------------

### Define AssertionError struct

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.AssertionError.html?search=

The definition of the AssertionError struct.

```rust
pub struct AssertionError(/* private fields */);
```

--------------------------------

### ShapeError Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ShapeError.html

The definition of the ShapeError struct.

```rust
pub struct ShapeError(/* private fields */);
```

--------------------------------

### StringCacheMismatchError Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.StringCacheMismatchError.html

The definition of the StringCacheMismatchError struct.

```rust
pub struct StringCacheMismatchError(/* private fields */);
```

--------------------------------

### ComputeError struct definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.ComputeError.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The definition of the ComputeError struct.

```rust
pub struct ComputeError(/* private fields */);
```

--------------------------------

### DuplicateError Struct Definition

Source: https://docs.rs/pyo3-polars/latest/pyo3_polars/error/struct.DuplicateError.html

The definition of the DuplicateError struct.

```rust
pub struct DuplicateError(/* private fields */);
```
Tokens:
Raw