What's the recommended mixed project layout for multiple Rust extensions? #2126

DavidAntliff · 2024-06-28T00:58:48Z

DavidAntliff
Jun 28, 2024

Issue #490 led to a change in the recommended mixed project layout. Specifically, for a Python subdir within a Rust top-dir:

my-project
├── Cargo.toml
├── python
│   └── my_project
│       ├── __init__.py
│       └── bar.py
├── pyproject.toml
├── README.md
└── src
    └── lib.rs

How is this intended to work when there are multiple independent Rust extensions in a single Python project? I.e. multiple sub-directories with independent Cargo.toml files.

Is the following layout supported?

my-project
├── python
│   └── my_project
│       ├── __init__.py
│       └── bar.py
├── pyproject.toml
├── README.md
└── rust
    ├── my_project1
    |   ├── Cargo.toml
    |   └── src
    |       └── lib.rs
    └── my_project2
        ├── Cargo.toml
        └── src
            └── lib.rs

Answered by messense

Jun 28, 2024

No support for multiple extension modules in multiple Cargo projects yet, however you can use one Cargo project and add other modules as submodules.

For example: https://github.com/pyca/cryptography/blob/541beda62fde26ee16f98092e553a17cac8e8943/src/rust/src/backend/mod.rs#L28-L53

View full answer

messense · 2024-06-28T01:16:27Z

messense
Jun 28, 2024
Maintainer

No support for multiple extension modules in multiple Cargo projects yet, however you can use one Cargo project and add other modules as submodules.

For example: https://github.com/pyca/cryptography/blob/541beda62fde26ee16f98092e553a17cac8e8943/src/rust/src/backend/mod.rs#L28-L53

3 replies

DavidAntliff Jun 28, 2024
Author

Thanks, that seems like a good workaround.

Can I ask one more thing - I see in the User Guide there's an alternative layout where the (single) Rust project is moved into a subdirectory, and:

maturin will detect the following src layout automatically

(My emphasis)

Is the magic the fact the subdir is specifically called "rust", or will maturin go looking for a subdir containing a Cargo.toml? If so, how far does it look? Can this be configured?

my-rust-and-python-project
├── src  # put python code in src folder
│   └── my_project
│       ├── __init__.py
│       └── bar.py
├── pyproject.toml
├── README.md
└── rust # put rust code in rust folder
    |── Cargo.toml
    └── src
        └── lib.rs

messense Jun 28, 2024
Maintainer

It simply looks for src/<project_name> and rust subdirs, only python source dir can be configured ATM, see https://www.maturin.rs/config#maturin-options

DavidAntliff Jun 28, 2024
Author

Ok, useful info, thank you.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

What's the recommended mixed project layout for multiple Rust extensions? #2126

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 1 comment 3 replies

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply

What's the recommended mixed project layout for multiple Rust extensions? #2126

DavidAntliff Jun 28, 2024

Replies: 1 comment · 3 replies

messense Jun 28, 2024 Maintainer

DavidAntliff Jun 28, 2024 Author

messense Jun 28, 2024 Maintainer

DavidAntliff Jun 28, 2024 Author

DavidAntliff
Jun 28, 2024

Replies: 1 comment 3 replies

messense
Jun 28, 2024
Maintainer

DavidAntliff Jun 28, 2024
Author

messense Jun 28, 2024
Maintainer

DavidAntliff Jun 28, 2024
Author