A Possible Bug in Call Policies
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start with the linked pytest_isinstance_issue reproduction and run the two individual pytest files followed by the full suite. Read callpolicies.cpp, overloading.cpp, test_callpolicies.py, and the corresponding overloading test to compare the exported Example classes and factory result. Done means determining whether Boost.Python, pytest, or Python causes the wrong class to be returned and documenting or correcting the behavior.
Written by the indexing model from the issue text.
Description
Hi, I believe I just encountered a possible bug in boost-python...
First of all, the back story, I'm putting together a python-boost based example for my cmaketools project, which makes a cmake-based python package build as straight-forward as possible. I've taken the examples by TNG (who created his examples based off of the official documentation) and turned them into a package with modules with pytest tests. The modules based on his "09-Overloading" example is failing "08-CallPolicies" example in pytest only when they are run together.
Description
When there is a class with the same name but under different a module (in a same package?), return_value_policy<manage_new_object>() call (possibly?) picks a wrong class to instantiate under pytest running 2 test py files each testing one of the classes.
What is peculiar is that it works when only one test file is tested but fails when both are tested together. So, it could be a pytest issue (or Python's for that matter)...
Versions
Boost: 1.71 (official pre-built binary)
Boost Python DLL: boost_python37-vc142-mt-x64-1_71.dll
Python: 3.7.6 (conda)
Compiler: MSVC 2019 (16.6.1)
OS: Window 10
(Near) Minimal Example
Please find the entire example project at https://github.com/hokiedsp/pytest_isinstance_issue. Clone and run the following to reproduce (hopefully)
pip -e .
pytest tests/test_callpolicies.py # passes
pytest tests/test_nor.py # passes
pytest
Last pytest call fails with the assertion error:
def test_callpolicies():
f = policies.Example.factory()
> assert isinstance(f, policies.Example) and str(f) == "factory"
E AssertionError: assert (False)
E + where False = isinstance(<boost_python_example.overloading.Example object at 0x00000202D58B0300>, <class 'boost_python_example.callpolicies.Example'>)
E + where <class 'boost_python_example.callpolicies.Example'> = policies.Example
I'm anticipating f to be boost_python_example.callpolicies.Example but instead boost_python_example.overloading.Example.
Side Note: If CMake cannot find Boost, you need to modify Line 14 of setup.py
configure_opts = ['-DBOOST_ROOT=C:\\Users\\tikum\\AppData\\Local\\Programs\\boost_1_71_0']
code snippets
Here are the sections of most relevant:
callpolicies.cpp
#include <sstream>
#include <string>
class Example {
Example(std::string n) : mName(n) {}
std::string mName;
public:
std::string name() const { return mName; }
static Example* factory()
{
return new Example("factory");
}
// ... snip...
};
#include <boost/python.hpp>
using namespace boost::python;
BOOST_PYTHON_MODULE(callpolicies)
{
class_<Example>("Example", no_init)
.def("__str__", &Example::name)
.def("factory", &Example::factory,
return_value_policy<manage_new_object>())
.staticmethod("factory")
;
}
overloading.cpp
#include <sstream>
#include <string>
class Example {
public:
Example()
{}
// ... snip...
};
#include <boost/python.hpp>
using namespace boost::python;
BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(makeIt_overloads, makeIt, 1, 3)
BOOST_PYTHON_MODULE(overloading)
{
void (Example::*d1)() = &Example::doit;
std::string (Example::*d2)(unsigned int) = &Example::doit;
void (Example::*d3)(std::string) = &Example::doit;
class_<Example>("Example")
.def("__str__", &Example::print)
// ...snip...
;
}
test_callpolicies.py
#!/usr/bin/env python
import pytest
from boost_python_example import callpolicies as policies
def test_callpolicies():
# e = callpolicies.Example() # won't work, constructore not available from python
f = policies.Example.factory()
assert isinstance(f, policies.Example) and str(f) == "factory"
- Dominant language
- C++
- Stars
- 537
- Forks
- 223
- Avg merge
- 11h 22m
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from boostorg/python
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
-
BoostDetectToolset-1.90.0.cmake file not found in an include() call in boost_python-config.cmake Open
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Similar issues
-
AuTest Bug Tests
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/trafficserver#13714 ·
-
bug build
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
facebookincubator/velox#19143 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
tenstorrent/tt-metal#57393 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
objectionary/eo-graphs#74 ·