mirror of
https://github.com/pybind/pybind11.git
synced 2024-11-11 08:03:55 +00:00
48f25275c4
* Put bakein branch @ 18b72c0ffa on top of smart_holder branch:
Commands used:
```
git checkout bakein
git diff smart_holder > ~/zd
git checkout smart_holder
git checkout -b bakein_sh
patch -p 1 < ~/zd
git checkout smart_holder \
MANIFEST.in \
README.rst \
README_smart_holder.rst \
docs/advanced/smart_ptrs.rst \
ubench/holder_comparison.cpp \
ubench/holder_comparison.py \
ubench/holder_comparison_extract_sheet_data.py \
ubench/number_bucket.h \
ubench/python/number_bucket.clif
git add -A
```
* Add back README_smart_holder.rst in tests/extra_python_package/test_files.py
* Restore smart_holder_poc.h as-is on smart_holder branch (i.e. undo `PYBIND11_SMART_HOLDER_PADDING`, which was meant for stress-testing only).
* Insert `std::move()` as suggested by @laramiel
* `property_cpp_function_sh_*` named specializations, as suggested by @laramiel (https://github.com/pybind/pybind11/pull/5257#discussion_r1688346807)
* Call `property_cpp_function_classic` member functions, rather than inlining the implementations.
* Use `PYBIND11_HAVE_INTERNALS_WITH_SMART_HOLDER_SUPPORT` in holder_comparison.cpp (holder_comparison.py is NOT changed accordingly in this commit, i.e. can still only be run if the smart_holder functionality is available).
* Systematically rename `loaded_as` to `load_as` (`shared_ptr`, `unique_ptr`) as suggested by @laramiel
* Make change as suggested by @laramiel. This makes it much more obvious that the latest implementation of `smart_holder_from_unique_ptr()` accepts all existing `return_value_policy` enum values except `copy`.
* Resolve `BAKEIN_WIP: Rewrite comment.` for `property_cpp_function_*` specializations.
* Resolve `BAKEIN_WIP: Add comment to explain: This is meant for stress-testing only.`
* Resolve all remaining BAKEIN_WIP (in pybind11/cast.h).
Leave only two pairs of SMART_HOLDER_BAKEIN_FOLLOW_ON comments: refactoring of copyable_holder_caster, move_only_holder_caster. This is best left until after the smart_holder branch is merged into the master branch.
* Remove obsolete `using holder_type = smart_holder;` in `load_helper`
* Add SMART_HOLDER_BAKEIN_FOLLOW_ON comment for `internals::default_holder`
* README_smart_holder.rst update (line count reduced from 356 to 123).
318 lines
9.3 KiB
Python
318 lines
9.3 KiB
Python
from __future__ import annotations
|
|
|
|
import pytest
|
|
|
|
m = pytest.importorskip("pybind11_tests.smart_ptr")
|
|
from pybind11_tests import ConstructorStats # noqa: E402
|
|
|
|
|
|
def test_smart_ptr(capture):
|
|
# Object1
|
|
for i, o in enumerate(
|
|
[m.make_object_1(), m.make_object_2(), m.MyObject1(3)], start=1
|
|
):
|
|
assert o.getRefCount() == 1
|
|
with capture:
|
|
m.print_object_1(o)
|
|
m.print_object_2(o)
|
|
m.print_object_3(o)
|
|
m.print_object_4(o)
|
|
assert capture == f"MyObject1[{i}]\n" * 4
|
|
|
|
for i, o in enumerate(
|
|
[m.make_myobject1_1(), m.make_myobject1_2(), m.MyObject1(6), 7], start=4
|
|
):
|
|
print(o)
|
|
with capture:
|
|
if not isinstance(o, int):
|
|
m.print_object_1(o)
|
|
m.print_object_2(o)
|
|
m.print_object_3(o)
|
|
m.print_object_4(o)
|
|
m.print_myobject1_1(o)
|
|
m.print_myobject1_2(o)
|
|
m.print_myobject1_3(o)
|
|
m.print_myobject1_4(o)
|
|
|
|
times = 4 if isinstance(o, int) else 8
|
|
assert capture == f"MyObject1[{i}]\n" * times
|
|
|
|
cstats = ConstructorStats.get(m.MyObject1)
|
|
assert cstats.alive() == 0
|
|
expected_values = [f"MyObject1[{i}]" for i in range(1, 7)] + ["MyObject1[7]"] * 4
|
|
assert cstats.values() == expected_values
|
|
assert cstats.default_constructions == 0
|
|
assert cstats.copy_constructions == 0
|
|
# assert cstats.move_constructions >= 0 # Doesn't invoke any
|
|
assert cstats.copy_assignments == 0
|
|
assert cstats.move_assignments == 0
|
|
|
|
# Object2
|
|
for i, o in zip(
|
|
[8, 6, 7], [m.MyObject2(8), m.make_myobject2_1(), m.make_myobject2_2()]
|
|
):
|
|
print(o)
|
|
with capture:
|
|
m.print_myobject2_1(o)
|
|
m.print_myobject2_2(o)
|
|
m.print_myobject2_3(o)
|
|
m.print_myobject2_4(o)
|
|
assert capture == f"MyObject2[{i}]\n" * 4
|
|
|
|
cstats = ConstructorStats.get(m.MyObject2)
|
|
assert cstats.alive() == 1
|
|
o = None
|
|
assert cstats.alive() == 0
|
|
assert cstats.values() == ["MyObject2[8]", "MyObject2[6]", "MyObject2[7]"]
|
|
assert cstats.default_constructions == 0
|
|
assert cstats.copy_constructions == 0
|
|
# assert cstats.move_constructions >= 0 # Doesn't invoke any
|
|
assert cstats.copy_assignments == 0
|
|
assert cstats.move_assignments == 0
|
|
|
|
# Object3
|
|
for i, o in zip(
|
|
[9, 8, 9], [m.MyObject3(9), m.make_myobject3_1(), m.make_myobject3_2()]
|
|
):
|
|
print(o)
|
|
with capture:
|
|
m.print_myobject3_1(o)
|
|
m.print_myobject3_2(o)
|
|
m.print_myobject3_3(o)
|
|
m.print_myobject3_4(o)
|
|
assert capture == f"MyObject3[{i}]\n" * 4
|
|
|
|
cstats = ConstructorStats.get(m.MyObject3)
|
|
assert cstats.alive() == 1
|
|
o = None
|
|
assert cstats.alive() == 0
|
|
assert cstats.values() == ["MyObject3[9]", "MyObject3[8]", "MyObject3[9]"]
|
|
assert cstats.default_constructions == 0
|
|
assert cstats.copy_constructions == 0
|
|
# assert cstats.move_constructions >= 0 # Doesn't invoke any
|
|
assert cstats.copy_assignments == 0
|
|
assert cstats.move_assignments == 0
|
|
|
|
# Object
|
|
cstats = ConstructorStats.get(m.Object)
|
|
assert cstats.alive() == 0
|
|
assert cstats.values() == []
|
|
assert cstats.default_constructions == 10
|
|
assert cstats.copy_constructions == 0
|
|
# assert cstats.move_constructions >= 0 # Doesn't invoke any
|
|
assert cstats.copy_assignments == 0
|
|
assert cstats.move_assignments == 0
|
|
|
|
# ref<>
|
|
cstats = m.cstats_ref()
|
|
assert cstats.alive() == 0
|
|
assert cstats.values() == ["from pointer"] * 10
|
|
assert cstats.default_constructions == 30
|
|
assert cstats.copy_constructions == 12
|
|
# assert cstats.move_constructions >= 0 # Doesn't invoke any
|
|
assert cstats.copy_assignments == 30
|
|
assert cstats.move_assignments == 0
|
|
|
|
|
|
def test_smart_ptr_refcounting():
|
|
assert m.test_object1_refcounting()
|
|
|
|
|
|
def test_unique_nodelete():
|
|
o = m.MyObject4(23)
|
|
assert o.value == 23
|
|
cstats = ConstructorStats.get(m.MyObject4)
|
|
assert cstats.alive() == 1
|
|
del o
|
|
assert cstats.alive() == 1
|
|
m.MyObject4.cleanup_all_instances()
|
|
assert cstats.alive() == 0
|
|
|
|
|
|
def test_unique_nodelete4a():
|
|
o = m.MyObject4a(23)
|
|
assert o.value == 23
|
|
cstats = ConstructorStats.get(m.MyObject4a)
|
|
assert cstats.alive() == 1
|
|
del o
|
|
assert cstats.alive() == 1
|
|
m.MyObject4a.cleanup_all_instances()
|
|
assert cstats.alive() == 0
|
|
|
|
|
|
def test_unique_deleter():
|
|
m.MyObject4a(0)
|
|
o = m.MyObject4b(23)
|
|
assert o.value == 23
|
|
cstats4a = ConstructorStats.get(m.MyObject4a)
|
|
assert cstats4a.alive() == 2
|
|
cstats4b = ConstructorStats.get(m.MyObject4b)
|
|
assert cstats4b.alive() == 1
|
|
del o
|
|
assert cstats4a.alive() == 1 # Should now only be one leftover
|
|
assert cstats4b.alive() == 0 # Should be deleted
|
|
m.MyObject4a.cleanup_all_instances()
|
|
assert cstats4a.alive() == 0
|
|
assert cstats4b.alive() == 0
|
|
|
|
|
|
def test_large_holder():
|
|
o = m.MyObject5(5)
|
|
assert o.value == 5
|
|
cstats = ConstructorStats.get(m.MyObject5)
|
|
assert cstats.alive() == 1
|
|
del o
|
|
assert cstats.alive() == 0
|
|
|
|
|
|
def test_shared_ptr_and_references():
|
|
s = m.SharedPtrRef()
|
|
stats = ConstructorStats.get(m.A)
|
|
assert stats.alive() == 2
|
|
|
|
ref = s.ref # init_holder_helper(holder_ptr=false, owned=false)
|
|
assert stats.alive() == 2
|
|
assert s.set_ref(ref)
|
|
with pytest.raises(RuntimeError) as excinfo:
|
|
assert s.set_holder(ref)
|
|
assert "Unable to cast from non-held to held instance" in str(excinfo.value)
|
|
|
|
copy = s.copy # init_holder_helper(holder_ptr=false, owned=true)
|
|
assert stats.alive() == 3
|
|
assert s.set_ref(copy)
|
|
assert s.set_holder(copy)
|
|
|
|
holder_ref = s.holder_ref # init_holder_helper(holder_ptr=true, owned=false)
|
|
assert stats.alive() == 3
|
|
assert s.set_ref(holder_ref)
|
|
assert s.set_holder(holder_ref)
|
|
|
|
holder_copy = s.holder_copy # init_holder_helper(holder_ptr=true, owned=true)
|
|
assert stats.alive() == 3
|
|
assert s.set_ref(holder_copy)
|
|
assert s.set_holder(holder_copy)
|
|
|
|
del ref, copy, holder_ref, holder_copy, s
|
|
assert stats.alive() == 0
|
|
|
|
|
|
def test_shared_ptr_from_this_and_references():
|
|
s = m.SharedFromThisRef()
|
|
stats = ConstructorStats.get(m.B)
|
|
assert stats.alive() == 2
|
|
|
|
ref = s.ref # init_holder_helper(holder_ptr=false, owned=false, bad_wp=false)
|
|
assert stats.alive() == 2
|
|
assert s.set_ref(ref)
|
|
assert s.set_holder(
|
|
ref
|
|
) # std::enable_shared_from_this can create a holder from a reference
|
|
|
|
bad_wp = s.bad_wp # init_holder_helper(holder_ptr=false, owned=false, bad_wp=true)
|
|
assert stats.alive() == 2
|
|
assert s.set_ref(bad_wp)
|
|
with pytest.raises(RuntimeError) as excinfo:
|
|
assert s.set_holder(bad_wp)
|
|
assert "Unable to cast from non-held to held instance" in str(excinfo.value)
|
|
|
|
copy = s.copy # init_holder_helper(holder_ptr=false, owned=true, bad_wp=false)
|
|
assert stats.alive() == 3
|
|
assert s.set_ref(copy)
|
|
assert s.set_holder(copy)
|
|
|
|
holder_ref = (
|
|
s.holder_ref
|
|
) # init_holder_helper(holder_ptr=true, owned=false, bad_wp=false)
|
|
assert stats.alive() == 3
|
|
assert s.set_ref(holder_ref)
|
|
assert s.set_holder(holder_ref)
|
|
|
|
holder_copy = (
|
|
s.holder_copy
|
|
) # init_holder_helper(holder_ptr=true, owned=true, bad_wp=false)
|
|
assert stats.alive() == 3
|
|
assert s.set_ref(holder_copy)
|
|
assert s.set_holder(holder_copy)
|
|
|
|
del ref, bad_wp, copy, holder_ref, holder_copy, s
|
|
assert stats.alive() == 0
|
|
|
|
z = m.SharedFromThisVirt.get()
|
|
y = m.SharedFromThisVirt.get()
|
|
assert y is z
|
|
|
|
|
|
def test_move_only_holder():
|
|
a = m.TypeWithMoveOnlyHolder.make()
|
|
b = m.TypeWithMoveOnlyHolder.make_as_object()
|
|
stats = ConstructorStats.get(m.TypeWithMoveOnlyHolder)
|
|
assert stats.alive() == 2
|
|
del b
|
|
assert stats.alive() == 1
|
|
del a
|
|
assert stats.alive() == 0
|
|
|
|
|
|
def test_holder_with_addressof_operator():
|
|
# this test must not throw exception from c++
|
|
a = m.TypeForHolderWithAddressOf.make()
|
|
a.print_object_1()
|
|
a.print_object_2()
|
|
a.print_object_3()
|
|
a.print_object_4()
|
|
|
|
stats = ConstructorStats.get(m.TypeForHolderWithAddressOf)
|
|
assert stats.alive() == 1
|
|
|
|
np = m.TypeForHolderWithAddressOf.make()
|
|
assert stats.alive() == 2
|
|
del a
|
|
assert stats.alive() == 1
|
|
del np
|
|
assert stats.alive() == 0
|
|
|
|
b = m.TypeForHolderWithAddressOf.make()
|
|
c = b
|
|
assert b.get() is c.get()
|
|
assert stats.alive() == 1
|
|
|
|
del b
|
|
assert stats.alive() == 1
|
|
|
|
del c
|
|
assert stats.alive() == 0
|
|
|
|
|
|
def test_move_only_holder_with_addressof_operator():
|
|
a = m.TypeForMoveOnlyHolderWithAddressOf.make()
|
|
a.print_object()
|
|
|
|
stats = ConstructorStats.get(m.TypeForMoveOnlyHolderWithAddressOf)
|
|
assert stats.alive() == 1
|
|
|
|
a.value = 42
|
|
assert a.value == 42
|
|
|
|
del a
|
|
assert stats.alive() == 0
|
|
|
|
|
|
def test_smart_ptr_from_default():
|
|
instance = m.HeldByDefaultHolder()
|
|
with pytest.raises(RuntimeError) as excinfo:
|
|
m.HeldByDefaultHolder.load_shared_ptr(instance)
|
|
assert (
|
|
"Unable to load a custom holder type from a "
|
|
"default-holder instance" in str(excinfo.value)
|
|
)
|
|
|
|
|
|
def test_shared_ptr_gc():
|
|
"""#187: issue involving std::shared_ptr<> return value policy & garbage collection"""
|
|
el = m.ElementList()
|
|
for i in range(10):
|
|
el.add(m.ElementA(i))
|
|
pytest.gc_collect()
|
|
for i, v in enumerate(el.get()):
|
|
assert i == v.value()
|