Complete abi3 support

.github/workflows/ci.yml

@@ -82,7 +82,7 @@ jobs:
       - run: rustup set default-host ${{ matrix.platform.rust-target }}
 
       - name: Build without default features
-        run: cargo build --no-default-features --verbose
+        run: cargo build --no-default-features --features "unstable-api" --verbose
 
       - name: Build with default features
         run: cargo build --features "num-bigint num-complex" --verbose

Cargo.toml

@@ -33,8 +33,12 @@ trybuild = "1.0.23"
 rustversion = "1.0"
 
 [features]
-default = ["macros"]
+default = ["macros", "unstable-api"]
 macros = ["ctor", "indoc", "inventory", "paste", "pyo3cls", "unindent"]
+# Enable unstable API incompatible with abi3(PEP384).
+# See https://www.python.org/dev/peps/pep-0384/ more.
+unstable-api = []
+
 # Optimizes PyObject to Vec conversion and so on.
 nightly = []
 
@@ -46,11 +50,6 @@ python3 = []
 # so that the module can also be used with statically linked python interpreters.
 extension-module = []
 
-# The stable cpython abi as defined in PEP 384. Currently broken with
-# many compilation errors. Pull Requests working towards fixing that
-# are welcome.
-# abi3 = []
-
 [workspace]
 members = [
     "pyo3cls",

build.rs

@@ -757,7 +757,7 @@ fn configure(interpreter_config: &InterpreterConfig) -> Result<String> {
         bail!("Python 2 is not supported");
     }
 
-    if env::var_os("CARGO_FEATURE_ABI3").is_some() {
+    if env::var_os("CARGO_FEATURE_UNSTABLE_API").is_none() {
         println!("cargo:rustc-cfg=Py_LIMITED_API");
     }
 

examples/rustapi_module/tests/test_datetime.py

@@ -1,6 +1,7 @@
 import datetime as pdt
 import platform
 import struct
+import re
 import sys
 
 import pytest
@@ -327,4 +328,5 @@ def test_tz_class_introspection():
     tzi = rdt.TzClass()
 
     assert tzi.__class__ == rdt.TzClass
-    assert repr(tzi).startswith("<TzClass object at")
+    # PyPy generate <importlib.bootstrap.TzClass ...> for some reason.
+    assert re.match(r"^<[\w\.]*TzClass object at", repr(tzi))

guide/src/class.md

@@ -205,7 +205,7 @@ or by `self_.into_super()` as `PyRef<Self::BaseClass>`.
 ```rust
 # use pyo3::prelude::*;
 
-#[pyclass]
+#[pyclass(subclass)]
 struct BaseClass {
     val1: usize,
 }
@@ -222,7 +222,7 @@ impl BaseClass {
     }
 }
 
-#[pyclass(extends=BaseClass)]
+#[pyclass(extends=BaseClass, subclass)]
 struct SubClass {
     val2: usize,
 }

pyo3-derive-backend/src/defs.rs

@@ -171,7 +171,7 @@ pub const OBJECT: Proto = Proto {
 
 pub const ASYNC: Proto = Proto {
     name: "Async",
-    slot_table: "pyo3::ffi::PyAsyncMethods",
+    slot_table: "pyo3::class::pyasync::PyAsyncMethods",
     set_slot_table: "set_async_methods",
     methods: &[
         MethodProto::UnaryS {
@@ -220,7 +220,7 @@ pub const ASYNC: Proto = Proto {
 
 pub const BUFFER: Proto = Proto {
     name: "Buffer",
-    slot_table: "pyo3::ffi::PyBufferProcs",
+    slot_table: "pyo3::class::buffer::PyBufferProcs",
     set_slot_table: "set_buffer_methods",
     methods: &[
         MethodProto::Unary {
@@ -358,7 +358,7 @@ pub const ITER: Proto = Proto {
 
 pub const MAPPING: Proto = Proto {
     name: "Mapping",
-    slot_table: "pyo3::ffi::PyMappingMethods",
+    slot_table: "pyo3::class::mapping::PyMappingMethods",
     set_slot_table: "set_mapping_methods",
     methods: &[
         MethodProto::Unary {
@@ -401,7 +401,7 @@ pub const MAPPING: Proto = Proto {
 
 pub const SEQ: Proto = Proto {
     name: "Sequence",
-    slot_table: "pyo3::ffi::PySequenceMethods",
+    slot_table: "pyo3::class::sequence::PySequenceMethods",
     set_slot_table: "set_sequence_methods",
     methods: &[
         MethodProto::Unary {
@@ -467,7 +467,7 @@ pub const SEQ: Proto = Proto {
 
 pub const NUM: Proto = Proto {
     name: "Number",
-    slot_table: "pyo3::ffi::PyNumberMethods",
+    slot_table: "pyo3::class::number::PyNumberMethods",
     set_slot_table: "set_number_methods",
     methods: &[
         MethodProto::BinaryS {

src/class/basic.rs

@@ -147,14 +147,6 @@ pub struct PyObjectMethods {
 
 #[doc(hidden)]
 impl PyObjectMethods {
-    pub(crate) fn update_typeobj(&self, type_object: &mut ffi::PyTypeObject) {
-        type_object.tp_str = self.tp_str;
-        type_object.tp_repr = self.tp_repr;
-        type_object.tp_hash = self.tp_hash;
-        type_object.tp_getattro = self.tp_getattro;
-        type_object.tp_richcompare = self.tp_richcompare;
-        type_object.tp_setattro = self.tp_setattro;
-    }
     // Set functions used by `#[pyproto]`.
     pub fn set_str<T>(&mut self)
     where
@@ -216,6 +208,16 @@ impl PyObjectMethods {
     {
         self.nb_bool = py_unary_func!(PyObjectBoolProtocol, T::__bool__, c_int);
     }
+
+    pub(crate) fn update_slots(&self, slots: &mut crate::pyclass::TypeSlots) {
+        slots.maybe_push(ffi::Py_tp_str, self.tp_str.map(|v| v as _));
+        slots.maybe_push(ffi::Py_tp_repr, self.tp_repr.map(|v| v as _));
+        slots.maybe_push(ffi::Py_tp_hash, self.tp_hash.map(|v| v as _));
+        slots.maybe_push(ffi::Py_tp_getattro, self.tp_getattro.map(|v| v as _));
+        slots.maybe_push(ffi::Py_tp_richcompare, self.tp_richcompare.map(|v| v as _));
+        slots.maybe_push(ffi::Py_tp_setattro, self.tp_setattro.map(|v| v as _));
+        slots.maybe_push(ffi::Py_nb_bool, self.nb_bool.map(|v| v as _));
+    }
 }
 
 fn tp_getattro<T>() -> Option<ffi::binaryfunc>

src/class/buffer.rs

@@ -5,12 +5,19 @@
 //! For more information check [buffer protocol](https://docs.python.org/3/c-api/buffer.html)
 //! c-api
 use crate::callback::IntoPyCallbackOutput;
-use crate::{
-    ffi::{self, PyBufferProcs},
-    PyCell, PyClass, PyRefMut,
-};
+use crate::{ffi, PyCell, PyClass, PyRefMut};
 use std::os::raw::c_int;
 
+#[cfg(Py_LIMITED_API)]
+#[derive(Clone, Default)]
+pub struct PyBufferProcs {
+    pub bf_getbuffer: Option<ffi::getbufferproc>,
+    pub bf_releasebuffer: Option<ffi::releasebufferproc>,
+}
+
+#[cfg(not(Py_LIMITED_API))]
+pub use ffi::PyBufferProcs;
+
 /// Buffer protocol interface
 ///
 /// For more information check [buffer protocol](https://docs.python.org/3/c-api/buffer.html)

src/class/descr.rs

@@ -79,10 +79,6 @@ pub struct PyDescrMethods {
 
 #[doc(hidden)]
 impl PyDescrMethods {
-    pub(crate) fn update_typeobj(&self, type_object: &mut ffi::PyTypeObject) {
-        type_object.tp_descr_get = self.tp_descr_get;
-        type_object.tp_descr_set = self.tp_descr_set;
-    }
     pub fn set_descr_get<T>(&mut self)
     where
         T: for<'p> PyDescrGetProtocol<'p>,
@@ -95,4 +91,8 @@ impl PyDescrMethods {
     {
         self.tp_descr_set = py_ternarys_func!(PyDescrSetProtocol, T::__set__, c_int);
     }
+    pub(crate) fn update_slots(&self, slots: &mut crate::pyclass::TypeSlots) {
+        slots.maybe_push(ffi::Py_tp_descr_get, self.tp_descr_get.map(|v| v as _));
+        slots.maybe_push(ffi::Py_tp_descr_set, self.tp_descr_set.map(|v| v as _));
+    }
 }

src/class/gc.rs

@@ -27,9 +27,9 @@ pub struct PyGCMethods {
 
 #[doc(hidden)]
 impl PyGCMethods {
-    pub(crate) fn update_typeobj(&self, type_object: &mut ffi::PyTypeObject) {
-        type_object.tp_traverse = self.tp_traverse;
-        type_object.tp_clear = self.tp_clear;
+    pub(crate) fn update_slots(&self, slots: &mut crate::pyclass::TypeSlots) {
+        slots.maybe_push(ffi::Py_tp_traverse, self.tp_traverse.map(|v| v as _));
+        slots.maybe_push(ffi::Py_tp_clear, self.tp_clear.map(|v| v as _));
     }
 
     pub fn set_traverse<T>(&mut self)
@@ -48,7 +48,7 @@ impl PyGCMethods {
 }
 
 /// Object visitor for GC.
-#[derive(Copy, Clone)]
+#[derive(Clone)]
 pub struct PyVisit<'p> {
     visit: ffi::visitproc,
     arg: *mut c_void,

src/class/iter.rs

@@ -79,10 +79,6 @@ pub struct PyIterMethods {
 
 #[doc(hidden)]
 impl PyIterMethods {
-    pub(crate) fn update_typeobj(&self, type_object: &mut ffi::PyTypeObject) {
-        type_object.tp_iter = self.tp_iter;
-        type_object.tp_iternext = self.tp_iternext;
-    }
     pub fn set_iter<T>(&mut self)
     where
         T: for<'p> PyIterIterProtocol<'p>,
@@ -95,6 +91,10 @@ impl PyIterMethods {
     {
         self.tp_iternext = py_unarys_func!(PyIterNextProtocol, T::__next__);
     }
+    pub(crate) fn update_slots(&self, slots: &mut crate::pyclass::TypeSlots) {
+        slots.maybe_push(ffi::Py_tp_iter, self.tp_iter.map(|v| v as _));
+        slots.maybe_push(ffi::Py_tp_iternext, self.tp_iternext.map(|v| v as _));
+    }
 }
 
 /// Output of `__next__` which can either `yield` the next value in the iteration, or

src/class/mapping.rs

@@ -7,6 +7,17 @@ use crate::callback::IntoPyCallbackOutput;
 use crate::err::PyErr;
 use crate::{exceptions, ffi, FromPyObject, PyClass, PyObject};
 
+#[cfg(Py_LIMITED_API)]
+#[derive(Clone, Default)]
+pub struct PyMappingMethods {
+    pub mp_length: Option<ffi::lenfunc>,
+    pub mp_subscript: Option<ffi::binaryfunc>,
+    pub mp_ass_subscript: Option<ffi::objobjargproc>,
+}
+
+#[cfg(not(Py_LIMITED_API))]
+pub use ffi::PyMappingMethods;
+
 /// Mapping interface
 #[allow(unused_variables)]
 pub trait PyMappingProtocol<'p>: PyClass {
@@ -74,7 +85,7 @@ pub trait PyMappingReversedProtocol<'p>: PyMappingProtocol<'p> {
 }
 
 #[doc(hidden)]
-impl ffi::PyMappingMethods {
+impl PyMappingMethods {
     pub fn set_length<T>(&mut self)
     where
         T: for<'p> PyMappingLenProtocol<'p>,
@@ -111,4 +122,12 @@ impl ffi::PyMappingMethods {
             __delitem__
         );
     }
+    pub(crate) fn update_slots(&self, slots: &mut crate::pyclass::TypeSlots) {
+        slots.maybe_push(ffi::Py_mp_length, self.mp_length.map(|v| v as _));
+        slots.maybe_push(ffi::Py_mp_subscript, self.mp_subscript.map(|v| v as _));
+        slots.maybe_push(
+            ffi::Py_mp_ass_subscript,
+            self.mp_ass_subscript.map(|v| v as _),
+        );
+    }
 }