Deprecate the PySet::empty gil-ref constructor (#4082)

* Deprecate the `PySet::empty` gil-ref constructor * add newsfragment
PyO3 · Apr 16, 2024 · bd15f92 · bd15f92
1 parent 4f7c706
commit bd15f92
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/newsfragments/4082.changed.md b/newsfragments/4082.changed.md
@@ -0,0 +1 @@
+Deprecate the `PySet::empty()` gil-ref constructor.
diff --git a/src/types/set.rs b/src/types/set.rs
@@ -58,7 +58,14 @@ impl PySet {
     }
 
     /// Deprecated form of [`PySet::empty_bound`].
-    pub fn empty(py: Python<'_>) -> PyResult<&'_ PySet> {
+    #[cfg_attr(
+        not(feature = "gil-refs"),
+        deprecated(
+            since = "0.21.2",
+            note = "`PySet::empty` will be replaced by `PySet::empty_bound` in a future PyO3 version"
+        )
+    )]
+    pub fn empty(py: Python<'_>) -> PyResult<&PySet> {
         Self::empty_bound(py).map(Bound::into_gil_ref)
     }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Deprecate the `PySet::empty()` gil-ref constructor.