summaryrefslogtreecommitdiff
path: root/libs/python/doc/reference/implicit.qbk
blob: 67ce162ec6f0dbcbe80033133c8c8fb7c16f3304 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
[section boost/python/implicit.hpp]
[section Introduction]
`implicitly_convertible` allows Boost.Python to implicitly take advantage of a C++ implicit or explicit conversion when matching Python objects to C++ argument types. 
[endsect]
[section Function template `implicit_convertible`]
``
template <class Source, class Target>
void implicitly_convertible();
``
[table
[[Parameter][Description]]
[[Source][The source type of the implicit conversion]]
[[Target][The target type of the implicit conversion]]
]
[variablelist
[[Requires][The declaration `Target t(s);`, where s is of type Source, is valid.]]
[[Effects][registers an rvalue `from_python` converter to Target which can succeed for any `PyObject* p` iff there exists any registered converter which can produce Source rvalues]]
[[Rationale][C++ users expect to be able to take advantage of the same sort of interoperability in Python as they do in C++.]]
]
[endsect]
[section Example]
In C++:
``
#include <boost/python/class.hpp>
#include <boost/python/implicit.hpp>
#include <boost/python/module.hpp>

using namespace boost::python;

struct X
{
    X(int x) : v(x) {}
    operator int() const { return v; }
    int v;
};

int x_value(X const& x)
{
    return x.v;
}

X make_x(int n) { return X(n); }

BOOST_PYTHON_MODULE(implicit_ext)
{
    def("x_value", x_value);
    def("make_x", make_x);

    class_<X>("X", 
        init<int>())
        ;

    implicitly_convertible<X,int>();
    implicitly_convertible<int,X>();
}
``
In Python:
``
>>> from implicit_ext import *
>>> x_value(X(42))
42
>>> x_value(42)
42
>>> x = make_x(X(42))
>>> x_value(x)
42
``
[endsect]
[endsect]