mirror of
https://github.com/pybind/pybind11.git
synced 2025-03-25 18:07:43 +00:00
* Pure `git merge --squash smart_holder` (no manual interventions). * Remove ubench/ directory. * Remove include/pybind11/smart_holder.h * [ci skip] smart_ptrs.rst updates [WIP/unfinished] * [ci skip] smart_ptrs.rst updates continued; also updating classes.rst, advanced/classes.rst * Remove README_smart_holder.rst * Restore original README.rst from master * [ci skip] Minimal change to README.rst, to leave a hint that this is pybind11v3 * [ci skip] Work in ChatGPT suggestions. * Change macro name to PYBIND11_RUN_TESTING_WITH_SMART_HOLDER_AS_DEFAULT_BUT_NEVER_USE_IN_PRODUCTION_PLEASE * Add a note pointing to the holder reinterpret_cast. * Incorporate suggestion by @virtuald: https://github.com/pybind/pybind11/pull/5542#discussion_r1967000989 * Systematically change most py::class_ to py::classh under docs/ * Remove references to README_smart_holder.rst This should have been part of commiteb550d03d3
. * [ci skip] Fix minor oversight (``class_`` -> ``py::class_``) noticed by chance. * [ci skip] Resolve suggestion by @virtuald https://github.com/pybind/pybind11/pull/5542#discussion_r1969940605 * [ci skip] Apply suggestions by @timohl (thanks!) * https://github.com/pybind/pybind11/pull/5542#discussion_r1970714551 * https://github.com/pybind/pybind11/pull/5542#discussion_r1971315329 * https://github.com/pybind/pybind11/pull/5542#discussion_r1971322821 * Replace `classh : class_` inhertance with `using`, as suggested by @henryiii https://github.com/pybind/pybind11/pull/5542#issuecomment-2689034104 * Revert "Systematically change most py::class_ to py::classh under docs/" This reverts commitac9d31e13f
. * docs: focus on py::smart_holder instead of py::classh Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> * Restore minor general fixes that got lost whenac9d31e13f
was reverted. * Remove `- smart_holder` from list of branches in all .github/workflows * Extend classh note to explain whitespace noise motivation. * Suggest `py::smart_holder` for "most situations for safety" * Add back PYBIND11_HAS_INTERNALS_WITH_SMART_HOLDER_SUPPORT This define was * introduced with https://github.com/pybind/pybind11/pull/5286 * removed with https://github.com/pybind/pybind11/pull/5531 It is has been in use here: *f02a2b7653/pybind11_protobuf/native_proto_caster.h (L89-L101)
Currently pybind11 unit tests for the two holder caster backwards compatibility traits * `copyable_holder_caster_shared_ptr_with_smart_holder_support_enabled` * `move_only_holder_caster_unique_ptr_with_smart_holder_support_enabled` are missing. * Add py::trampoline_self_life_support to all trampoline examples under docs/. Address suggestion by @timohl: * https://github.com/pybind/pybind11/pull/5542#issuecomment-2686452062 Add to the "please think twice" note: the overhead for safety is likely in the noise. Also fix a two-fold inconsistency introduced by revert-commit1e646c91b4
: 1. py::trampoline_self_life_support is mentioned in a note, but is missing in the example right before. 2. The section starting with To enable safely passing a ``std::unique_ptr`` to a trampoline object between is obsolete. * Fix whitespace accident (indentation) introduced with1e646c91b4
Apparently the mis-indentation was introduced when resolving merge conflicts for what became1e646c91b4
* WHITESPACE CHANGES ONLY in README.rst (list of people that made significant contributions) * Add Ethan Steinberg to list of people that made significant contributions (for completeness, unrelated to smart_holder work). * [ci skip] Add to list of people that made significant contributions: major and/or influential contributors to smart_holder branch * #2904 by @rhaschke was merged on Mar 16, 2021 * #3012 by @rhaschke was merged on May 28, 2021 * #3039 by @jakobandersen was merged on Jun 29, 2021 * #3048 by @Skylion007 was merged on Jun 18, 2021 * #3588 by @virtuald was merged on Jan 3, 2022 * #3633 by @wangxf123456 was merged on Jan 25, 2022 * #3635 by @virtuald was merged on Jan 26, 2022 * #3645 by @wangxf123456 was merged on Jan 25, 2022 * #3796 by @wangxf123456 was merged on Mar 10, 2022 * #3807 by @wangxf123456 was merged on Mar 18, 2022 * #3838 by @wangxf123456 was merged on Apr 15, 2022 * #3929 by @tomba was merged on May 7, 2022 * #4031 by @wangxf123456 was merged on Jun 27, 2022 * #4343 by @wangxf123456 was merged on Nov 18, 2022 * #4381 by @wangxf123456 was merged on Dec 5, 2022 * #4539 by @wangxf123456 was merged on Feb 28, 2023 * #4609 by @wangxf123456 was merged on Apr 6, 2023 * #4775 by @wangxf123456 was merged on Aug 3, 2023 * #4921 by @iwanders was merged on Nov 7, 2023 * #4924 by @iwanders was merged on Nov 6, 2023 * #5401 by @msimacek was merged on Oct 8, 2024 Co-authored-by: Aaron Gokaslan <aaronGokaslan@gmail.com> Co-authored-by: Dustin Spicuzza <dustin@virtualroadside.com> Co-authored-by: Ivor Wanders <iwanders@users.noreply.github.com> Co-authored-by: Jakob Lykke Andersen <Jakob@caput.dk> Co-authored-by: Michael Šimáček <michael.simacek@oracle.com> Co-authored-by: Robert Haschke <rhaschke@users.noreply.github.com> Co-authored-by: Tomi Valkeinen <tomi.valkeinen@iki.fi> Co-authored-by: Xiaofei Wang <6218006+wangxf123456@users.noreply.github.com> --------- Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> Co-authored-by: Henry Schreiner <henryschreineriii@gmail.com> Co-authored-by: Aaron Gokaslan <aaronGokaslan@gmail.com> Co-authored-by: Dustin Spicuzza <dustin@virtualroadside.com> Co-authored-by: Ivor Wanders <iwanders@users.noreply.github.com> Co-authored-by: Jakob Lykke Andersen <Jakob@caput.dk> Co-authored-by: Michael Šimáček <michael.simacek@oracle.com> Co-authored-by: Robert Haschke <rhaschke@users.noreply.github.com> Co-authored-by: Tomi Valkeinen <tomi.valkeinen@iki.fi> Co-authored-by: Xiaofei Wang <6218006+wangxf123456@users.noreply.github.com>
247 lines
5.3 KiB
Python
247 lines
5.3 KiB
Python
from __future__ import annotations
|
|
|
|
import pytest
|
|
|
|
import env # noqa: F401
|
|
from pybind11_tests import class_sh_disowning_mi as m
|
|
|
|
|
|
def test_diamond_inheritance():
|
|
# Very similar to test_multiple_inheritance.py:test_diamond_inheritance.
|
|
d = m.D()
|
|
assert d is d.d()
|
|
assert d is d.c0()
|
|
assert d is d.c1()
|
|
assert d is d.b()
|
|
assert d is d.c0().b()
|
|
assert d is d.c1().b()
|
|
assert d is d.c0().c1().b().c0().b()
|
|
|
|
|
|
def is_disowned(callable_method):
|
|
try:
|
|
callable_method()
|
|
except ValueError as e:
|
|
assert "Python instance was disowned" in str(e) # noqa: PT017
|
|
return True
|
|
return False
|
|
|
|
|
|
def test_disown_b():
|
|
b = m.B()
|
|
assert b.get() == 10
|
|
m.disown_b(b)
|
|
assert is_disowned(b.get)
|
|
|
|
|
|
@pytest.mark.parametrize("var_to_disown", ["c0", "b"])
|
|
def test_disown_c0(var_to_disown):
|
|
c0 = m.C0()
|
|
assert c0.get() == 1020
|
|
b = c0.b()
|
|
m.disown_b(locals()[var_to_disown])
|
|
assert is_disowned(c0.get)
|
|
assert is_disowned(b.get)
|
|
|
|
|
|
@pytest.mark.parametrize("var_to_disown", ["c1", "b"])
|
|
def test_disown_c1(var_to_disown):
|
|
c1 = m.C1()
|
|
assert c1.get() == 1021
|
|
b = c1.b()
|
|
m.disown_b(locals()[var_to_disown])
|
|
assert is_disowned(c1.get)
|
|
assert is_disowned(b.get)
|
|
|
|
|
|
@pytest.mark.parametrize("var_to_disown", ["d", "c1", "c0", "b"])
|
|
def test_disown_d(var_to_disown):
|
|
d = m.D()
|
|
assert d.get() == 10202130
|
|
b = d.b()
|
|
c0 = d.c0()
|
|
c1 = d.c1()
|
|
m.disown_b(locals()[var_to_disown])
|
|
assert is_disowned(d.get)
|
|
assert is_disowned(c1.get)
|
|
assert is_disowned(c0.get)
|
|
assert is_disowned(b.get)
|
|
|
|
|
|
# Based on test_multiple_inheritance.py:test_multiple_inheritance_python.
|
|
class MI1(m.Base1, m.Base2):
|
|
def __init__(self, i, j):
|
|
m.Base1.__init__(self, i)
|
|
m.Base2.__init__(self, j)
|
|
|
|
|
|
class B1:
|
|
def v(self):
|
|
return 1
|
|
|
|
|
|
class MI2(B1, m.Base1, m.Base2):
|
|
def __init__(self, i, j):
|
|
B1.__init__(self)
|
|
m.Base1.__init__(self, i)
|
|
m.Base2.__init__(self, j)
|
|
|
|
|
|
class MI3(MI2):
|
|
def __init__(self, i, j):
|
|
MI2.__init__(self, i, j)
|
|
|
|
|
|
class MI4(MI3, m.Base2):
|
|
def __init__(self, i, j):
|
|
MI3.__init__(self, i, j)
|
|
# This should be ignored (Base2 is already initialized via MI2):
|
|
m.Base2.__init__(self, i + 100)
|
|
|
|
|
|
class MI5(m.Base2, B1, m.Base1):
|
|
def __init__(self, i, j):
|
|
B1.__init__(self)
|
|
m.Base1.__init__(self, i)
|
|
m.Base2.__init__(self, j)
|
|
|
|
|
|
class MI6(m.Base2, B1):
|
|
def __init__(self, i):
|
|
m.Base2.__init__(self, i)
|
|
B1.__init__(self)
|
|
|
|
|
|
class B2(B1):
|
|
def v(self):
|
|
return 2
|
|
|
|
|
|
class B3:
|
|
def v(self):
|
|
return 3
|
|
|
|
|
|
class B4(B3, B2):
|
|
def v(self):
|
|
return 4
|
|
|
|
|
|
class MI7(B4, MI6):
|
|
def __init__(self, i):
|
|
B4.__init__(self)
|
|
MI6.__init__(self, i)
|
|
|
|
|
|
class MI8(MI6, B3):
|
|
def __init__(self, i):
|
|
MI6.__init__(self, i)
|
|
B3.__init__(self)
|
|
|
|
|
|
class MI8b(B3, MI6):
|
|
def __init__(self, i):
|
|
B3.__init__(self)
|
|
MI6.__init__(self, i)
|
|
|
|
|
|
@pytest.mark.xfail("env.PYPY")
|
|
def test_multiple_inheritance_python():
|
|
# Based on test_multiple_inheritance.py:test_multiple_inheritance_python.
|
|
# Exercises values_and_holders with 2 value_and_holder instances.
|
|
|
|
mi1 = MI1(1, 2)
|
|
assert mi1.foo() == 1
|
|
assert mi1.bar() == 2
|
|
|
|
mi2 = MI2(3, 4)
|
|
assert mi2.v() == 1
|
|
assert mi2.foo() == 3
|
|
assert mi2.bar() == 4
|
|
|
|
mi3 = MI3(5, 6)
|
|
assert mi3.v() == 1
|
|
assert mi3.foo() == 5
|
|
assert mi3.bar() == 6
|
|
|
|
mi4 = MI4(7, 8)
|
|
assert mi4.v() == 1
|
|
assert mi4.foo() == 7
|
|
assert mi4.bar() == 8
|
|
|
|
mi5 = MI5(10, 11)
|
|
assert mi5.v() == 1
|
|
assert mi5.foo() == 10
|
|
assert mi5.bar() == 11
|
|
|
|
mi6 = MI6(12)
|
|
assert mi6.v() == 1
|
|
assert mi6.bar() == 12
|
|
|
|
mi7 = MI7(13)
|
|
assert mi7.v() == 4
|
|
assert mi7.bar() == 13
|
|
|
|
mi8 = MI8(14)
|
|
assert mi8.v() == 1
|
|
assert mi8.bar() == 14
|
|
|
|
mi8b = MI8b(15)
|
|
assert mi8b.v() == 3
|
|
assert mi8b.bar() == 15
|
|
|
|
|
|
DISOWN_CLS_I_J_V_LIST = [
|
|
(MI1, 1, 2, None),
|
|
(MI2, 3, 4, 1),
|
|
(MI3, 5, 6, 1),
|
|
(MI4, 7, 8, 1),
|
|
(MI5, 10, 11, 1),
|
|
]
|
|
|
|
|
|
@pytest.mark.xfail("env.PYPY", strict=False)
|
|
@pytest.mark.parametrize(("cls", "i", "j", "v"), DISOWN_CLS_I_J_V_LIST)
|
|
def test_disown_base1_first(cls, i, j, v):
|
|
obj = cls(i, j)
|
|
assert obj.foo() == i
|
|
assert m.disown_base1(obj) == 2000 * i + 1
|
|
assert is_disowned(obj.foo)
|
|
assert obj.bar() == j
|
|
assert m.disown_base2(obj) == 2000 * j + 2
|
|
assert is_disowned(obj.bar)
|
|
if v is not None:
|
|
assert obj.v() == v
|
|
|
|
|
|
@pytest.mark.xfail("env.PYPY", strict=False)
|
|
@pytest.mark.parametrize(("cls", "i", "j", "v"), DISOWN_CLS_I_J_V_LIST)
|
|
def test_disown_base2_first(cls, i, j, v):
|
|
obj = cls(i, j)
|
|
assert obj.bar() == j
|
|
assert m.disown_base2(obj) == 2000 * j + 2
|
|
assert is_disowned(obj.bar)
|
|
assert obj.foo() == i
|
|
assert m.disown_base1(obj) == 2000 * i + 1
|
|
assert is_disowned(obj.foo)
|
|
if v is not None:
|
|
assert obj.v() == v
|
|
|
|
|
|
@pytest.mark.xfail("env.PYPY", strict=False)
|
|
@pytest.mark.parametrize(
|
|
("cls", "j", "v"),
|
|
[
|
|
(MI6, 12, 1),
|
|
(MI7, 13, 4),
|
|
(MI8, 14, 1),
|
|
(MI8b, 15, 3),
|
|
],
|
|
)
|
|
def test_disown_base2(cls, j, v):
|
|
obj = cls(j)
|
|
assert obj.bar() == j
|
|
assert m.disown_base2(obj) == 2000 * j + 2
|
|
assert is_disowned(obj.bar)
|
|
assert obj.v() == v
|