Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

examples: export __doc__ in example projects #1895

Merged
merged 1 commit into from
Oct 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions examples/maturin-starter/maturin_starter/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# import the contents of the Rust library into the Python extension
# optional: include the documentation from the Rust module
from .maturin_starter import *
from .maturin_starter import __all__, __doc__

__all__ = __all__ + ["PythonClass"]


class PythonClass:
Expand Down
1 change: 1 addition & 0 deletions examples/maturin-starter/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ impl ExampleClass {
}
}

/// An example module implemented in Rust using PyO3.
#[pymodule]
fn maturin_starter(py: Python, m: &PyModule) -> PyResult<()> {
m.add_class::<ExampleClass>()?;
Expand Down
10 changes: 9 additions & 1 deletion examples/maturin-starter/tests/test_maturin_starter.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from maturin_starter import PythonClass, ExampleClass
from maturin_starter import ExampleClass, PythonClass


def test_python_class() -> None:
Expand All @@ -9,3 +9,11 @@ def test_python_class() -> None:
def test_example_class() -> None:
example = ExampleClass(value=11)
assert example.value == 11


def test_doc() -> None:
import maturin_starter

assert (
maturin_starter.__doc__ == "An example module implemented in Rust using PyO3."
)
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# import the contents of the Rust library into the Python extension
# optional: include the documentation from the Rust module
from ._setuptools_rust_starter import *
from ._setuptools_rust_starter import __all__, __doc__

__all__ = __all__ + ["PythonClass"]


class PythonClass:
Expand Down
1 change: 1 addition & 0 deletions examples/setuptools-rust-starter/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ impl ExampleClass {
}
}

/// An example module implemented in Rust using PyO3.
#[pymodule]
fn _setuptools_rust_starter(py: Python, m: &PyModule) -> PyResult<()> {
m.add_class::<ExampleClass>()?;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from setuptools_rust_starter import PythonClass, ExampleClass
from setuptools_rust_starter import ExampleClass, PythonClass


def test_python_class() -> None:
Expand All @@ -9,3 +9,12 @@ def test_python_class() -> None:
def test_example_class() -> None:
example = ExampleClass(value=11)
assert example.value == 11


def test_doc() -> None:
import setuptools_rust_starter

assert (
setuptools_rust_starter.__doc__
== "An example module implemented in Rust using PyO3."
)