Merge pull request #1537 from davidhewitt/maturin-examples-v2

examples: maturin and setuptools_rust examples

Author: davidhewitt

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
-      - run: pip install black==19.10b0
+      - run: pip install black==20.8b1
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
@@ -141,15 +141,13 @@ jobs:
         run: cargo test --manifest-path=pyo3-macros-backend/Cargo.toml
 
       - name: Install python test dependencies
-        run: |
-          python -m pip install -U pip setuptools
-          pip install setuptools-rust pytest pytest-benchmark tox
+        run: python -m pip install -U pip tox
 
       - name: Test example extension modules
         shell: bash
         run: |
           for example_dir in examples/*; do
-              tox --discover $(which python) -c $example_dir -e py
+              tox -c $example_dir -e py
           done
         env:
           TOX_TESTENV_PASSENV: "CARGO_BUILD_TARGET"

Cargo.toml

@@ -73,7 +73,9 @@ nightly = []
 members = [
     "pyo3-macros",
     "pyo3-macros-backend",
-    "examples/pyo3_benchmarks",
-    "examples/rustapi_module",
+    "examples/pyo3-benchmarks",
+    "examples/pyo3-pytests",
+    "examples/maturin-starter",
+    "examples/setuptools-rust-starter",
     "examples/word-count"
 ]

examples/maturin-starter/Cargo.toml

@@ -0,0 +1,27 @@
+[package]
+authors = ["PyO3 Authors"]
+name = "maturin-starter"
+version = "0.1.0"
+description = "An example project to get started using PyO3 with maturin"
+edition = "2018"
+
+[dependencies]
+
+[dependencies.pyo3]
+path = "../../"
+features = ["extension-module"]
+
+[lib]
+name = "maturin_starter"
+crate-type = ["cdylib"]
+
+[package.metadata.maturin]
+classifier=[
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Rust",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS :: MacOS X",
+]

examples/pyo3_benchmarks/MANIFEST.in renamed to examples/maturin-starter/MANIFEST.in

@@ -0,0 +1,24 @@
+# maturin-starter
+
+An example of a basic Python extension module built using PyO3 and [`maturin`](https://github.com/PyO3/maturin).
+
+## Building and Testing
+
+To build this package, first install `maturin`:
+
+```shell
+pip install maturin
+```
+
+To build and test use `maturin develop`:
+
+```shell
+pip install -r requirements-dev.txt
+maturin develop && pytest
+```
+
+Alternatively, install tox and run the tests inside an isolated environment:
+
+```shell
+tox -e py
+```

examples/maturin-starter/README.md

@@ -0,0 +1,7 @@
+# import the contents of the Rust library into the Python extension
+from .maturin_starter import *
+
+
+class PythonClass:
+    def __init__(self, value: int) -> None:
+        self.value = value

examples/maturin-starter/maturin_starter/__init__.py

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["maturin>=0.10,<0.11"]
+build-backend = "maturin"

examples/maturin-starter/pyproject.toml

@@ -0,0 +1 @@
+pytest>=3.5.0

examples/maturin-starter/requirements-dev.txt

@@ -0,0 +1,35 @@
+use pyo3::prelude::*;
+use pyo3::types::PyDict;
+use pyo3::wrap_pymodule;
+
+mod submodule;
+use submodule::*;
+
+#[pyclass]
+struct ExampleClass {
+    #[pyo3(get, set)]
+    value: i32,
+}
+
+#[pymethods]
+impl ExampleClass {
+    #[new]
+    pub fn new(value: i32) -> Self {
+        ExampleClass { value }
+    }
+}
+
+#[pymodule]
+fn maturin_starter(py: Python, m: &PyModule) -> PyResult<()> {
+    m.add_class::<ExampleClass>()?;
+    m.add_wrapped(wrap_pymodule!(submodule))?;
+
+    // Inserting to sys.modules allows importing submodules nicely from Python
+    // e.g. from maturin_starter.submodule import SubmoduleClass
+
+    let sys = PyModule::import(py, "sys")?;
+    let sys_modules: &PyDict = sys.getattr("modules")?.downcast()?;
+    sys_modules.set_item("maturin_starter.submodule", m.getattr("submodule")?)?;
+
+    Ok(())
+}

examples/maturin-starter/src/lib.rs

@@ -0,0 +1,22 @@
+use pyo3::prelude::*;
+
+#[pyclass]
+struct SubmoduleClass {}
+
+#[pymethods]
+impl SubmoduleClass {
+    #[new]
+    pub fn __new__() -> Self {
+        SubmoduleClass {}
+    }
+
+    pub fn greeting(&self) -> &'static str {
+        "Hello, world!"
+    }
+}
+
+#[pymodule]
+pub fn submodule(_py: Python, m: &PyModule) -> PyResult<()> {
+    m.add_class::<SubmoduleClass>()?;
+    Ok(())
+}

examples/maturin-starter/src/submodule.rs

@@ -0,0 +1,11 @@
+from maturin_starter import PythonClass, ExampleClass
+
+
+def test_python_class() -> None:
+    py_class = PythonClass(value=10)
+    assert py_class.value == 10
+
+
+def test_example_class() -> None:
+    example = ExampleClass(value=11)
+    assert example.value == 11

examples/maturin-starter/tests/test_maturin_starter.py

@@ -0,0 +1,6 @@
+from maturin_starter.submodule import SubmoduleClass
+
+
+def test_submodule_class() -> None:
+    submodule_class = SubmoduleClass()
+    assert submodule_class.greeting() == "Hello, world!"

examples/maturin-starter/tests/test_submodule.py

@@ -6,5 +6,7 @@ skipsdist = true
 description = Run the unit tests under {basepython}
 deps = -rrequirements-dev.txt
 commands =
-    python setup.py install
+    # Use pip master with in-tree-build feature (to be released in pip 21.0)
+    python -m pip install --upgrade git+https://github.com/pypa/pip.git
+    python -m pip install . --use-feature=in-tree-build
     pytest {posargs}

examples/rustapi_module/tox.ini renamed to examples/maturin-starter/tox.ini

@@ -0,0 +1,3 @@
+include Cargo.toml
+recursive-include src *
+recursive-include tests

examples/pyo3_benchmarks/Cargo.toml renamed to examples/pyo3-benchmarks/Cargo.toml

@@ -0,0 +1,18 @@
+# pyo3-benchmarks
+
+This extension module contains benchmarks for pieces of PyO3's API accessible from Python.
+
+## Running the benchmarks
+
+You can install the module in your Python environment and then run the benchmarks with pytest:
+
+```shell
+python setup.py develop
+pytest
+```
+
+Or with tox:
+
+```shell
+tox -e py
+```

examples/pyo3-benchmarks/MANIFEST.in

@@ -1,6 +1,4 @@
 pip>=19.1
-hypothesis>=3.55
 pytest>=3.5.0
 setuptools-rust>=0.10.2
-psutil>=5.6
 pytest-benchmark~=3.2

examples/pyo3-benchmarks/README.md

@@ -1,24 +1,7 @@
-import sys
-import platform
-
 from setuptools import setup
 from setuptools_rust import RustExtension
 
 
-def get_py_version_cfgs():
-    # For now each Cfg Py_3_X flag is interpreted as "at least 3.X"
-    version = sys.version_info[0:2]
-    py3_min = 6
-    out_cfg = []
-    for minor in range(py3_min, version[1] + 1):
-        out_cfg.append("--cfg=Py_3_%d" % minor)
-
-    if platform.python_implementation() == "PyPy":
-        out_cfg.append("--cfg=PyPy")
-
-    return out_cfg
-
-
 setup(
     name="pyo3-benchmarks",
     version="0.1.0",
@@ -35,7 +18,6 @@ def get_py_version_cfgs():
     rust_extensions=[
         RustExtension(
             "pyo3_benchmarks._pyo3_benchmarks",
-            rustc_flags=get_py_version_cfgs(),
             debug=False,
         ),
     ],

examples/pyo3_benchmarks/pyo3_benchmarks/__init__.py renamed to examples/pyo3-benchmarks/pyo3_benchmarks/__init__.py

@@ -0,0 +1,27 @@
+[package]
+authors = ["PyO3 Authors"]
+name = "pyo3-pytests"
+version = "0.1.0"
+description = "Python-based tests for PyO3"
+edition = "2018"
+
+[dependencies]
+
+[dependencies.pyo3]
+path = "../../"
+features = ["extension-module"]
+
+[lib]
+name = "pyo3_pytests"
+crate-type = ["cdylib"]
+
+[package.metadata.maturin]
+classifier=[
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Rust",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS :: MacOS X",
+]

examples/pyo3_benchmarks/requirements-dev.txt renamed to examples/pyo3-benchmarks/requirements-dev.txt

@@ -0,0 +1,19 @@
+# pyo3-pytests
+
+An extension module built using PyO3, used to test PyO3 from Python.
+
+## Testing
+
+This package is intended to be built using `maturin`. Once built, you can run the tests using `pytest`:
+
+```shell
+pip install maturin
+maturin develop
+pytest
+```
+
+Alternatively, install tox and run the tests inside an isolated environment:
+
+```shell
+tox -e py
+```

examples/pyo3_benchmarks/setup.py renamed to examples/pyo3-benchmarks/setup.py

@@ -0,0 +1,28 @@
+use std::process::Command;
+
+fn main() {
+    let out = Command::new("python")
+        .args(&["-c", "import sys; import platform; print(sys.version_info[1]); print(platform.python_implementation())"])
+        .output()
+        .expect("python version did not print");
+
+    let output = String::from_utf8_lossy(&out.stdout);
+    let mut lines = output.trim().lines();
+
+    println!("{}", output);
+
+    let version: u8 = lines
+        .next()
+        .unwrap()
+        .parse()
+        .expect("python version was not parsed");
+    let implementation = lines.next().unwrap();
+
+    for each in 6..version {
+        println!("cargo:rustc-cfg=Py_3_{}", each);
+    }
+
+    if implementation == "PyPy" {
+        println!("cargo:rustc-cfg=PyPy");
+    }
+}

examples/pyo3_benchmarks/src/lib.rs renamed to examples/pyo3-benchmarks/src/lib.rs

@@ -0,0 +1 @@
+from .pyo3_pytests import *

examples/pyo3_benchmarks/tests/test_benchmarks.py renamed to examples/pyo3-benchmarks/tests/test_benchmarks.py

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["maturin>=0.10,<0.11"]
+build-backend = "maturin"

examples/pyo3_benchmarks/tox.ini renamed to examples/pyo3-benchmarks/tox.ini

@@ -1,5 +1,4 @@
 pip>=19.1
 hypothesis>=3.55
 pytest>=3.5.0
-setuptools-rust>=0.10.2
 psutil>=5.6

examples/pyo3-pytests/Cargo.toml

@@ -3,7 +3,7 @@ use pyo3::prelude::*;
 use pyo3::types::PyDict;
 
 #[pymodule]
-fn test_dict(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
+fn dict_iter(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
     m.add_class::<DictSize>()?;
     Ok(())
 }