Salome HOME
Various improvements.
[tools/py2cpp.git] / src / PyFunction.hxx
1 // Copyright (C) 2019  EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 #ifndef PY2CPP_FUNCTIONCALLS_HXX
20 #define PY2CPP_FUNCTIONCALLS_HXX
21 #include <Python.h>
22 #include <tuple>
23 #include "TypeConversions.hxx"
24 #include "Errors.hxx"
25
26 namespace py2cpp
27 {
28 class PyFunction : public PyPtr
29 {
30 public:
31   /*! Load a callable object from a python module.*/
32   bool load(const std::string& module, const std::string& function);
33   /*! Load a callable object member of a python object.*/
34   bool load(const PyPtr& obj, const std::string& function);
35   bool load(PyObject* obj, const std::string& function);
36
37   // The following versions of the functions throw ExecutionException in case of
38   // failure.
39   void loadExp(const std::string& module, const std::string& function);
40   void loadExp(const PyPtr& obj, const std::string& function);
41   void loadExp(PyObject* obj, const std::string& function);
42
43   /*!
44    * The evaluation returns nullptr if the python function throws an exception.
45    * See PyObject_CallObject documentation.
46    * You can use getLastPyError in order to get the last python error.
47    */
48   template <class ...Ts>
49   PyPtr operator()(const Ts&... args)
50   {
51     PyPtr result;
52     PyObject * myFunc = get();
53     if(myFunc && PyCallable_Check(myFunc))
54     {
55       std::tuple<const Ts&...> tupleArgs(args...);
56       PyPtr pyArgs(toPy(tupleArgs));
57       result.reset(PyObject_CallObject(myFunc, pyArgs.get()));
58     }
59     if(!result)
60     {
61       std::string errorMessage = "Failed to execute python function.\n";
62       throw ExecutionException(errorMessage+getLastPyError());
63     }
64     return result;
65   }
66 };
67 }
68
69 #endif //PY2CPP_FUNCTIONCALLS_HXX