-
Notifications
You must be signed in to change notification settings - Fork 2.2k
fix: add support for const-only smart pointers #5718
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
0318287
add support for const pointers in smart pointers
Rosdf 8fe9412
use c++11 compatible code
Rosdf 51a1942
add template parameter in test
Rosdf fc8ca60
Make the const-removal clearly visible. This simplifies the productio…
rwgk 9102c5c
test without leaks
Rosdf ab77b17
add namespace for test
Rosdf fd5624c
rename test
Rosdf 4384d08
fix test compilation
Rosdf 769964c
using namespace test_const_only_smart_ptr;
rwgk 39bca7a
fix smartptr in test
Rosdf 05e756b
smaller test body
Rosdf 7e6af28
move test
Rosdf a8fa43e
style: pre-commit fixes
pre-commit-ci[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
#include "pybind11/cast.h" | ||
#include "pybind11_tests.h" | ||
|
||
#include <string> | ||
|
||
template <class T> | ||
class StaticPtr { | ||
public: | ||
explicit StaticPtr(const T *ptr) : ptr_(ptr) {} | ||
|
||
const T *get() const { return ptr_; } | ||
|
||
const T &operator*() const { return *ptr_; } | ||
const T *operator->() const { return ptr_; } | ||
|
||
private: | ||
const T *ptr_ = nullptr; | ||
}; | ||
|
||
PYBIND11_DECLARE_HOLDER_TYPE(T, StaticPtr<T>, true) | ||
|
||
class MyData { | ||
public: | ||
static StaticPtr<MyData> create(std::string name) { | ||
return StaticPtr<MyData>(new MyData(std::move(name))); | ||
} | ||
|
||
const std::string &getName() const { return name_; } | ||
|
||
private: | ||
explicit MyData(std::string &&name) : name_(std::move(name)) {} | ||
|
||
std::string name_; | ||
}; | ||
|
||
TEST_SUBMODULE(const_module, m) { | ||
py::class_<MyData, StaticPtr<MyData>>(m, "Data") | ||
.def(py::init([](const std::string &name) { return MyData::create(name); })) | ||
.def_property_readonly("name", &MyData::getName); | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
from __future__ import annotations | ||
|
||
import pytest | ||
|
||
asyncio = pytest.importorskip("asyncio") | ||
m = pytest.importorskip("pybind11_tests.const_module") | ||
|
||
|
||
def test_const_smart_ptr(): | ||
cons = m.Data("my_name") | ||
assert cons.name == "my_name" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Assuming the CI still passes, I'm fine with the production code changes.
However, we need a test case that does not leak. I wouldn't want to surprise someone (years) later who's trying to use this test for leak detection while working on a refactoring, and is plausibly unaware that the test code has leaks. It's also possible that future tooling will flag this code.