Guide: focus on the module way of creating python modules #5430
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
Tpt
force-pushed
the
tpt/doc-modules
branch
from
706ec52 to
da505bd
Compare
davidhewitt
reviewed
Sep 14, 2025
guide/src/module.md
Outdated
Comment on lines
88
to
96
| # Python::attach(|py| { | ||
| # use pyo3::wrap_pymodule; | ||
| # use pyo3::types::IntoPyDict; | ||
| # use pyo3::ffi::c_str; | ||
| # let parent_module = wrap_pymodule!(parent_module)(py); | ||
| # let ctx = [("parent_module", parent_module)].into_py_dict(py).unwrap(); | ||
| # | ||
| # py.run(c_str!("assert parent_module.child_module.func() == 'func'"), None, Some(&ctx)).unwrap(); | ||
| # }) |
There was a problem hiding this comment.
Do we really need to remove the doctest?
guide/src/module.md
Outdated
| ```rust,no_run | ||
| # mod declarative_module_module_attr_test { | ||
| use pyo3::prelude::*; | ||
| You can provide the `submodule` argument to `#[pymodule()]` for modules that are not top-level modules in order for them to properly generate the `#[pyclass]` `module` attribute automatically. |
There was a problem hiding this comment.
I think this probably needs to be moved up into the submodules section (and can have a note saying the inline form will do it automatically).
| @@ -3,6 +3,7 @@ | |||
| You can create a module using `#[pymodule]`: | |||
There was a problem hiding this comment.
We should decide if we prefer the inline or use-ing form? I note the readme used the inline form, so we should introduce that first maybe? Or maybe introduce both here, just for functions, and then add more detail below?
There was a problem hiding this comment.
I have updated the first example to present both ways of exposing a function (each with an inline comment) and kept the dedicated section about inline elements, describing them all
Co-authored-by: David Hewitt <[email protected]>
Tpt
force-pushed
the
tpt/doc-modules
branch
from
824d470 to
61478d9
Compare
davidhewitt
approved these changes
Sep 18, 2025
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.
They have been stable for a few releases now