polars-array-algorithms 0.1.0__tar.gz

polars_array_algorithms-0.1.0/.github/copilot-instructions.md

@@ -0,0 +1,93 @@
+# Polars Array Algorithms - Copilot Instructions
+
+## Project Overview
+This is a Rust + Python hybrid project implementing additional array algorithms for the Polars library. The project uses:
+- **Rust**: Core algorithm implementations with PyO3 bindings via `pyo3-polars`
+- **Python**: Plugin registration, type stubs, and tests using Pytest
+- **Build System**: Maturin for compiling Rust to Python extension modules
+
+## Architecture
+
+### Rust Side (`src/`)
+- **lib.rs**: Module root and PyO3 module definition with `#[pymodule]` decorator
+- **expressions.rs**: Custom expression implementations using `#[polars_expr]` macro
+  - Functions must accept `&[Series]` and return `PolarsResult<Series>`
+  - Use `apply_into_string_amortized()` for string operations and similar chunked array methods for performance
+
+### Python Side (`polars_array_algorithms/`)
+- **__init__.py**: Plugin registration via `register_plugin_function()`
+- **_internal.pyi**: Type stubs for Rust-compiled module
+- **typing.py**: Custom type definitions like `IntoExprColumn`
+
+### Testing & CI
+- **tests/**: Pytest-based tests for all expressions
+- **Makefile**: Build, install, and testing commands
+- Pre-commit checks: `cargo fmt`, `cargo clippy`, `ruff`, `mypy`
+
+## Development Guidelines
+
+### Adding New Expressions
+1. **Rust Implementation** (`src/expressions.rs`):
+   - Use `#[polars_expr(output_type=<Type>)]` macro
+   - Handle chunked arrays efficiently (avoid unnecessary allocations)
+   - Use Polars' built-in methods for array operations
+
+2. **Python Wrapper** (`polars_array_algorithms/__init__.py`):
+   - Create a function that calls `register_plugin_function()`
+   - Set `is_elementwise=True` for element-wise operations
+   - Update type hints using `IntoExprColumn`
+
+3. **Type Stub** (`polars_array_algorithms/_internal.pyi`):
+   - Add function signature for the compiled Rust function
+
+4. **Tests** (`tests/`):
+   - Create test file following `test_<expression_name>.py` pattern
+   - Use Pytest with Polars DataFrames for validation
+
+### Code Quality
+- Run `make pre-commit` before committing
+- Rust formatting: `cargo +nightly fmt --all`
+- Linting: `cargo clippy --all-features`
+- Python formatting: `ruff` (enforces consistent style)
+- Type checking: `mypy` (strict typing for Python)
+
+### Building & Running
+- **Development**: `make install` (builds with debug symbols)
+- **Release**: `make install-release` (optimized build)
+- **Tests**: `make test` (runs all Pytest tests)
+- **Full run**: `make run` or `make run-release`
+
+## Important Constraints
+
+### 🚫 STRICTLY DO NOT CREATE NEW FILES
+- **Do NOT create new files or directories unless explicitly prompted by the user**
+- This includes:
+  - Documentation files (Markdown, RST, etc.)
+  - Configuration files
+  - Test files
+  - Source files
+  - Any other files not explicitly requested
+- Only modify existing files or create files when the user specifically asks for it
+
+## Best Practices
+
+- Keep algorithm implementations focused and modular
+- Leverage Polars' chunked array API for performance
+- Add comprehensive tests for edge cases
+- Use descriptive variable names and comments for complex logic
+- Document performance considerations for algorithms
+- Maintain compatibility with Polars >= 0.52.0 and Python >= 3.8
+
+## Common Tasks
+
+| Task | Command |
+|------|---------|
+| Setup environment | `make venv && make install` |
+| Run all checks | `make pre-commit` |
+| Run tests | `make test` |
+| Rebuild after changes | `make install` |
+| Release build | `make install-release && make run-release` |
+
+## Dependencies
+- **Rust**: pyo3 (0.26.0), pyo3-polars (0.25.0), polars (0.52.0)
+- **Python**: polars, maturin, pytest, ruff, mypy

polars_array_algorithms-0.1.0/.github/workflows/publish_to_pypi.yml

@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "*"
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  RUSTFLAGS: "-Dwarnings"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - uses: PyO3/maturin-action@v1
+        with:
+          target: x86_64
+          args: --release --out dist
+          sccache: "true"
+          manylinux: auto
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-x86_64
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-sdist
+          path: dist
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: [build, sdist]
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: write
+      attestations: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist
+      - uses: actions/attest-build-provenance@v1
+        with:
+          subject-path: "dist/*"
+      - uses: PyO3/maturin-action@v1
+        with:
+          command: upload
+          args: --non-interactive --skip-existing dist/*

polars_array_algorithms-0.1.0/.gitignore

@@ -0,0 +1,140 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Rust build artifacts
+/target/
+Cargo.lock
+
+# IDE
+.zed/
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Maturin
+dist/
+build/