Merge pull request #80 from awestlake87/release-0.17

Release 0.17 Prep

Author: awestlake87

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/rust/.devcontainer/base.Dockerfile
+
+# [Choice] Debian OS version (use bullseye on local arm64/Apple Silicon): buster, bullseye
+ARG VARIANT="buster"
+FROM mcr.microsoft.com/vscode/devcontainers/rust:0-${VARIANT}
+
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get -y install python3-dev python3-pip
+
+RUN python3 -m pip install uvloop

.devcontainer/devcontainer.json

@@ -0,0 +1,56 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/rust
+{
+	"name": "Rust",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": {
+			// Use the VARIANT arg to pick a Debian OS version: buster, bullseye
+			// Use bullseye when on local on arm64/Apple Silicon.
+			"VARIANT": "buster"
+		}
+	},
+	"runArgs": [
+		"--cap-add=SYS_PTRACE",
+		"--security-opt",
+		"seccomp=unconfined"
+	],
+
+	// Configure tool-specific properties.
+	"customizations": {
+		// Configure properties specific to VS Code.
+		"vscode": {
+			// Set *default* container specific settings.json values on container create.
+			"settings": { 
+				"lldb.executable": "/usr/bin/lldb",
+				// VS Code don't watch files under ./target
+				"files.watcherExclude": {
+					"**/target/**": true
+				},
+				"rust-analyzer.checkOnSave.command": "clippy"
+			},
+			
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"vadimcn.vscode-lldb",
+				"mutantdino.resourcemonitor",
+				"rust-lang.rust-analyzer",
+				"tamasfe.even-better-toml",
+				"serayuzgur.crates"
+			]
+		}
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "rustc --version",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode",
+	"features": {
+		"git": "latest",
+		"git-lfs": "latest"
+	}
+}

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
-      - run: pip install black==19.10b0
+      - run: pip install black==22.8.0
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
@@ -110,6 +110,7 @@ jobs:
                 python-architecture: "x64",
                 rust-target: "x86_64-unknown-linux-gnu",
               }
+            msrv: "nightly"
             extra_features: "nightly"
 
     steps:
@@ -133,6 +134,16 @@ jobs:
         name: Prepare LD_LIBRARY_PATH (Ubuntu only)
         run: echo LD_LIBRARY_PATH=${pythonLocation}/lib >> $GITHUB_ENV
 
+      - if: matrix.msrv == 'MSRV'
+        name: Prepare minimal package versions (MSRV only)
+        run: |
+          set -x
+          cargo update -p tokio --precise 1.13.1
+          cargo update -p indexmap --precise 1.6.2
+          cargo update -p parking_lot:0.12.1 --precise 0.11.2
+          cargo update -p async-global-executor --precise 2.2.0
+          cargo update -p once_cell --precise 1.14.0
+
       - name: Build (no features)
         run: cargo build --no-default-features --verbose --target ${{ matrix.platform.rust-target }}
 
@@ -145,6 +156,14 @@ jobs:
         run: |
           python -m pip install -U uvloop
 
+      - if: ${{ matrix.msrv != 'MSRV' && matrix.python-version != '3.11-dev' && !startsWith(matrix.python-version, 'pypy') }}
+        name: Test
+        run: cargo test --all-features --target ${{ matrix.platform.rust-target }}
+
+      - if: ${{ matrix.msrv == 'MSRV' && matrix.python-version != '3.11-dev' && !startsWith(matrix.python-version, 'pypy') }}
+        name: Test (MSRV, --no-default-features)
+        run: cargo test --no-default-features --features tokio-runtime,async-std-runtime,attributes,unstable-streams --target ${{ matrix.platform.rust-target }}
+
     env:
       RUST_BACKTRACE: 1
       RUSTFLAGS: "-D warnings"

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "pyo3-asyncio"
 description = "PyO3 utilities for Python's Asyncio library"
-version = "0.16.0"
+version = "0.17.0"
 authors = ["Andrew J Westlake <[email protected]>"]
 readme = "README.md"
 keywords = ["pyo3", "python", "ffi", "async", "asyncio"]
@@ -18,7 +18,7 @@ members = ["pyo3-asyncio-macros"]
 
 [features]
 async-std-runtime = ["async-std"]
-attributes = ["pyo3-asyncio-macros", "inventory"]
+attributes = ["pyo3-asyncio-macros"]
 testing = ["clap", "inventory"]
 tokio-runtime = ["tokio"]
 unstable-streams = ["async-channel"]
@@ -102,25 +102,32 @@ path = "pytests/test_tokio_multi_thread_uvloop.rs"
 harness = false
 required-features = ["tokio-runtime", "testing"]
 
+
+[[test]]
+name = "test_race_condition_regression"
+path = "pytests/test_race_condition_regression.rs"
+harness = false
+required-features = ["async-std-runtime", "testing"]
+
 [dependencies]
 async-channel = { version = "1.6", optional = true }
-clap = { version = "3.1.5", optional = true }
+clap = { version = "3.2", optional = true }
 futures = "0.3"
-inventory = { version = "0.2", optional = true }
-once_cell = "1.5"
+inventory = { version = "0.3", optional = true }
+once_cell = "1.14"
 pin-project-lite = "0.2"
-pyo3 = "0.16"
-pyo3-asyncio-macros = { path = "pyo3-asyncio-macros", version = "=0.16.0", optional = true }
+pyo3 = "0.17"
+pyo3-asyncio-macros = { path = "pyo3-asyncio-macros", version = "=0.17.0", optional = true }
 
 [dev-dependencies]
-pyo3 = { version = "0.16", features = ["macros"] }
+pyo3 = { version = "0.17", features = ["macros"] }
 
 [dependencies.async-std]
-version = "1.10"
+version = "1.12"
 features = ["unstable"]
 optional = true
 
 [dependencies.tokio]
-version = "1.13" 
+version = "1.13"
 features = ["full"]
 optional = true

README.md

@@ -52,8 +52,8 @@ Here we initialize the runtime, import Python's `asyncio` library and run the gi
 ```toml
 # Cargo.toml dependencies
 [dependencies]
-pyo3 = { version = "0.16" }
-pyo3-asyncio = { version = "0.16", features = ["attributes", "async-std-runtime"] }
+pyo3 = { version = "0.17" }
+pyo3-asyncio = { version = "0.17", features = ["attributes", "async-std-runtime"] }
 async-std = "1.9"
 ```
 
@@ -82,8 +82,8 @@ attribute.
 ```toml
 # Cargo.toml dependencies
 [dependencies]
-pyo3 = { version = "0.16" }
-pyo3-asyncio = { version = "0.16", features = ["attributes", "tokio-runtime"] }
+pyo3 = { version = "0.17" }
+pyo3-asyncio = { version = "0.17", features = ["attributes", "tokio-runtime"] }
 tokio = "1.9"
 ```
 
@@ -127,17 +127,17 @@ For `async-std`:
 
 ```toml
 [dependencies]
-pyo3 = { version = "0.16", features = ["extension-module"] }
-pyo3-asyncio = { version = "0.16", features = ["async-std-runtime"] }
+pyo3 = { version = "0.17", features = ["extension-module"] }
+pyo3-asyncio = { version = "0.17", features = ["async-std-runtime"] }
 async-std = "1.9"
 ```
 
 For `tokio`:
 
 ```toml
 [dependencies]
-pyo3 = { version = "0.16", features = ["extension-module"] }
-pyo3-asyncio = { version = "0.16", features = ["tokio-runtime"] }
+pyo3 = { version = "0.17", features = ["extension-module"] }
+pyo3-asyncio = { version = "0.17", features = ["tokio-runtime"] }
 tokio = "1.9"
 ```
 
@@ -431,8 +431,8 @@ name = "my_async_module"
 crate-type = ["cdylib"]
 
 [dependencies]
-pyo3 = { version = "0.16", features = ["extension-module"] }
-pyo3-asyncio = { version = "0.16", features = ["tokio-runtime"] }
+pyo3 = { version = "0.17", features = ["extension-module"] }
+pyo3-asyncio = { version = "0.17", features = ["tokio-runtime"] }
 async-std = "1.9"
 tokio = "1.9"
 ```
@@ -491,8 +491,8 @@ event loop before we can install the `uvloop` policy.
 ```toml
 [dependencies]
 async-std = "1.9"
-pyo3 = "0.16"
-pyo3-asyncio = { version = "0.16", features = ["async-std-runtime"] }
+pyo3 = "0.17"
+pyo3-asyncio = { version = "0.17", features = ["async-std-runtime"] }
 ```
 
 ```rust no_run

pyo3-asyncio-macros/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "pyo3-asyncio-macros"
 description = "Proc Macro Attributes for PyO3 Asyncio"
-version = "0.16.0"
+version = "0.17.0"
 authors = ["Andrew J Westlake <[email protected]>"]
 readme = "../README.md"
 keywords = ["pyo3", "python", "ffi", "async", "asyncio"]

pytests/common/mod.rs

@@ -4,7 +4,7 @@ use pyo3::prelude::*;
 use pyo3_asyncio::TaskLocals;
 
 pub(super) const TEST_MOD: &'static str = r#"
-import asyncio 
+import asyncio
 
 async def py_sleep(duration):
     await asyncio.sleep(duration)

pytests/test_async_std_asyncio.rs

@@ -9,7 +9,6 @@ use std::{
 use async_std::task;
 use pyo3::{
     prelude::*,
-    proc_macro::pymodule,
     types::{IntoPyDict, PyType},
     wrap_pyfunction, wrap_pymodule,
 };
@@ -174,12 +173,12 @@ async fn test_cancel() -> PyResult<()> {
 
 #[cfg(feature = "unstable-streams")]
 const ASYNC_STD_TEST_MOD: &str = r#"
-import asyncio 
+import asyncio
 
 async def gen():
     for i in range(10):
         await asyncio.sleep(0.1)
-        yield i        
+        yield i
 "#;
 
 #[cfg(feature = "unstable-streams")]
@@ -257,15 +256,15 @@ fn test_local_cancel(event_loop: PyObject) -> PyResult<()> {
 #[pymodule]
 fn test_mod(_py: Python, m: &PyModule) -> PyResult<()> {
     #![allow(deprecated)]
-    #[pyfunction]
-    fn sleep(py: Python) -> PyResult<&PyAny> {
+    #[pyfunction(name = "sleep")]
+    fn sleep_(py: Python) -> PyResult<&PyAny> {
         pyo3_asyncio::async_std::future_into_py(py, async move {
             async_std::task::sleep(Duration::from_millis(500)).await;
             Ok(())
         })
     }
 
-    m.add_function(wrap_pyfunction!(sleep, m)?)?;
+    m.add_function(wrap_pyfunction!(sleep_, m)?)?;
 
     Ok(())
 }

pytests/test_race_condition_regression.rs

@@ -0,0 +1,66 @@
+use pyo3::{prelude::*, wrap_pyfunction};
+
+#[pyfunction]
+fn sleep<'p>(py: Python<'p>, secs: &'p PyAny) -> PyResult<&'p PyAny> {
+    let secs = secs.extract()?;
+
+    pyo3_asyncio::async_std::future_into_py(py, async move {
+        async_std::task::sleep(std::time::Duration::from_secs_f64(secs)).await;
+        Ok(())
+    })
+}
+
+const RACE_CONDITION_REGRESSION_TEST: &str = r#"
+import asyncio
+import random
+
+async def trigger_race_condition(rust_sleeper, delay):
+    coro = asyncio.wrap_future(rust_sleeper(0.1))
+    await asyncio.sleep(delay)
+    coro.cancel()
+
+def main(rust_sleeper):
+    race_condition_triggered = False
+
+    for i in range(1000):
+        delay = random.uniform(0.099, 0.101)
+        loop = asyncio.new_event_loop()
+        loop.set_debug(True)
+
+        def custom_exception_handler(loop, context):
+            nonlocal race_condition_triggered
+            race_condition_triggered = True
+
+        try:
+            loop.set_exception_handler(custom_exception_handler)
+            loop.run_until_complete(trigger_race_condition(rust_sleeper, delay))
+
+            if race_condition_triggered:
+                raise Exception("Race condition triggered")
+
+        finally:
+            loop.run_until_complete(loop.shutdown_asyncgens())
+            if hasattr(loop, 'shutdown_default_executor'):
+                loop.run_until_complete(loop.shutdown_default_executor())
+            loop.close()
+"#;
+
+fn main() -> pyo3::PyResult<()> {
+    pyo3::prepare_freethreaded_python();
+
+    Python::with_gil(|py| -> PyResult<()> {
+        let sleeper_mod = PyModule::new(py, "rust_sleeper")?;
+
+        sleeper_mod.add_wrapped(wrap_pyfunction!(sleep))?;
+
+        let test_mod = PyModule::from_code(
+            py,
+            RACE_CONDITION_REGRESSION_TEST,
+            "race_condition_regression_test.py",
+            "race_condition_regression_test",
+        )?;
+
+        test_mod.call_method1("main", (sleeper_mod.getattr("sleep")?,))?;
+        Ok(())
+    })
+}