Refactor to allow mixed Python Rust code - #444
Closed
relf wants to merge 8 commits into
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Until now the Rust pyo3 project was directly used from Python. With this PR Python wraps the Rust code we get the following structure:
Repository Layout
The project is organized as a Cargo workspace. Core optimization algorithms are implemented as reusable Rust crates. The Python distribution, including the PyO3 bindings, is contained entirely within the
python/directory.Workspace Organization
The Cargo workspace consists of reusable Rust crates:
doegpmoeegopythonThe Python binding crate depends on the workspace crates but does not implement optimization algorithms itself.
Python Distribution
The
python/directory is a self-contained Python project.It contains:
Cargo.toml,src/)egobox/)pyproject.tomlBuilding the Python package is always performed from the
python/directory.Maturin Configuration
python/pyproject.tomlconfigures maturin.This installs the compiled extension as
alongside the Python modules.
Public API
Only the Python package is public.
The compiled module
is private and should never be imported directly by users.
Python modules wrap the Rust implementation, perform validation, convert NumPy arrays, and expose an idiomatic object-oriented API.
Design Principles