Карта сайта Kansoftware
НОВОСТИУСЛУГИРЕШЕНИЯКОНТАКТЫ
Разработка программного обеспечения

Function documentation

Boost , Boost.Python Reference Manual , Chapter 4. Function Invocation and Creation

Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

PrevUpHomeNext
boost/python/function_doc_signature.hpp
boost/python/pytype_function.hpp
Introduction
Class function_doc_signature_generator
Example

Повышаю. Python поддерживает докстринги с автоматическим добавлением подписей Pythonic и C++. Эта функция реализована классом<function_doc_signature_generator>. Класс использует все перегрузки, поставляемые имена arg и значения по умолчанию, а также определяемые пользователем докстринги для создания документации для данной функции.

Класс имеет только одну публичную функцию, которая возвращает список строк, документирующих перегрузки функции.

namespace boost { namespace python { namespace objects {
    class function_doc_signature_generator
    {
      public:
          static list function_doc_signatures(function const *f);
    };
}}}

#include <boost/python/module.hpp>
#include <boost/python/def.hpp>
#include <boost/python/args.hpp>
#include <boost/python/tuple.hpp>
#include <boost/python/class.hpp>
#include <boost/python/overloads.hpp>
#include <boost/python/raw_function.hpp>
using namespace boost::python;
tuple f(int x = 1, double y = 4.25, char const* z = "wow")
{
    return make_tuple(x, y, z);
}
BOOST_PYTHON_FUNCTION_OVERLOADS(f_overloads, f, 0, 3)
struct X
{
    tuple f(int x = 1, double y = 4.25, char const* z = "wow")
    {
        return make_tuple(x, y, z);
    }
};
BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(X_f_overloads, X::f, 0, 3)
tuple raw_func(tuple args, dict kw)
{
    return make_tuple(args, kw);
}
BOOST_PYTHON_MODULE(args_ext)
{
    def("f", f, (arg("x")=1, arg("y")=4.25, arg("z")="wow")
        , "This is f's docstring"
        );
    def("raw", raw_function(raw_func));
    def("f1", f, f_overloads("f1's docstring", args("x", "y", "z")));
    class_<X>("X", "This is X's docstring", init<>(args("self")))
        .def("f", &X::f
             , "This is X.f's docstring"
             , args("self","x", "y", "z"))
        ;
}

Код Python:

>>> import args_ext
>>> help(args_ext)
Help on module args_ext:
NAME
    args_ext
FILE
    args_ext.pyd
CLASSES
    Boost.Python.instance(__builtin__.object)
        X
    class X(Boost.Python.instance)
     |  This is X's docstring
     |
     |  Method resolution order:
     |      X
     |      Boost.Python.instance
     |      __builtin__.object
     |
     |  Methods defined here:
     |
     |  __init__(...)
     |      __init__( (object)self) -> None :
     |       C++ signature:
     |           void __init__(struct _object *)
     |
     |  f(...)
     |      f( (X)self, (int)x, (float)y, (str)z) -> tuple : This is X.f's docstring
     |      C++ signature:
     |          class boost::python::tuple f(struct X {lvalue},int,double,char const *)
     |
     |    .................
     |
FUNCTIONS
    f(...)
        f([ (int)x=1 [, (float)y=4.25 [, (str)z='wow']]]) -> tuple : This is f's docstring
        C++ signature:
            class boost::python::tuple f([ int=1 [,double=4.25 [,char const *='wow']]])
    f1(...)
        f1([ (int)x [, (float)y [, (str)z]]]) -> tuple : f1's docstring
        C++ signature:
            class boost::python::tuple f1([ int [,double [,char const *]]])
    raw(...)
        object raw(tuple args, dict kwds) :
        C++ signature:
            object raw(tuple args, dict kwds)
Introduction
Class wrap_pytype
Class registered_pytype
Class expected_from_python_type
Class to_python_target_type
Example

Для поддержки Pythonic-подписей преобразователи должны предоставить функцию<get_pytype>, возвращающую указатель на связанные<PyTypeObject>. См., например,<ResultConverter>или.<to_python_converter>. Классы в этом файле заголовка предназначены для использования при импликации<get_pytype>. Существуют также<_direct>версии шаблонов<classT>, которые должны использоваться с параметром неокрашенного типа, который, как ожидается, будет в реестре преобразования при загрузке модуля.

Этот шаблон генерирует статический<get_pytype>элемент, возвращающий параметр шаблона.

namespace boost { namespace python { namespace converter{
    template < PyTypeObject const *pytype >
    class wrap_pytype
    {
      public:
          static PyTypeObject const *get_pytype(){return pytype; }
    };
}}}

Этот шаблон должен использоваться с параметрами шаблона, которые являются (возможно, украшенными) типами, экспортируемыми на питон с использованием<class_>. Полученный статический<get_pytype>элемент возвращает соответствующий тип питона.

namespace boost { namespace python { namespace converter{
    template < class T >
    class registered_pytype
    {
      public:
          static PyTypeObject const *get_pytype();
    };
}}}

Этот шаблон генерирует статический<get_pytype>элемент, который проверяет зарегистрированные<from_python>преобразователи для типа<T>и возвращает соответствующий тип питона.

namespace boost { namespace python { namespace converter{
    template < class T >
    class expected_from_python_type
    {
      public:
          static PyTypeObject const *get_pytype();
    };
}}}

Этот шаблон генерирует статический<get_pytype>элемент, возвращающий тип питона, к которому<T>может быть преобразован.

namespace boost { namespace python { namespace converter{
    template < class T >
    class to_python_target_type
    {
      public:
          static PyTypeObject const *get_pytype();
    };
}}}

В этом примере предполагается, что кто-то внедрил стандартный модуль кивок из документации Python и поместил соответствующие декларации в «noddy.h». Поскольку<noddy_NoddyObject>является конечным тривиальным типом расширения, пример немного надуманный: он обертывает функцию, для которой вся информация содержится в типе ее обратного значения.

Определение модуля C++:

#include <boost/python/reference.hpp>
#include <boost/python/module.hpp>
#include "noddy.h"
struct tag {};
tag make_tag() { return tag(); }
using namespace boost::python;
struct tag_to_noddy
#if defined BOOST_PYTHON_SUPPORTS_PY_SIGNATURES //unnecessary overhead if py signatures are not supported
: wrap_pytype<&noddy_NoddyType> //inherits get_pytype from wrap_pytype
#endif
{
    static PyObject* convert(tag const& x)
    {
        return PyObject_New(noddy_NoddyObject, &noddy_NoddyType);
    }
};
BOOST_PYTHON_MODULE(to_python_converter)
{
    def("make_tag", make_tag);
    to_python_converter<tag, tag_to_noddy
#if defined BOOST_PYTHON_SUPPORTS_PY_SIGNATURES //invalid if py signatures are not supported
          , true
#endif
          >(); //"true" because tag_to_noddy has member get_pytype
}

Следующий пример регистрируется в преобразователи Python и из них с использованием шаблонов expected_from_python_type и to_pyhton_target_type.

#include <boost/python/module.hpp>
#include <boost/python/def.hpp>
#include <boost/python/extract.hpp>
#include <boost/python/to_python_converter.hpp>
#include <boost/python/class.hpp>
using namespace boost::python;
struct A
{
};
struct B
{
  A a;
  B(const A& a_):a(a_){}
};
// Converter from A to python int
struct BToPython
#if defined BOOST_PYTHON_SUPPORTS_PY_SIGNATURES //unnecessary overhead if py signatures are not supported
   : converter::to_python_target_type<A>  //inherits get_pytype
#endif
{
  static PyObject* convert(const B& b)
  {
    return incref(object(b.a).ptr());
  }
};
// Conversion from python int to A
struct BFromPython
{
  BFromPython()
  {
    boost::python::converter::registry::push_back
        ( &convertible
        , &construct
        , type_id< B >()
#if defined BOOST_PYTHON_SUPPORTS_PY_SIGNATURES //invalid if py signatures are not supported
        , &converter::expected_from_python_type<A>::get_pytype//convertible to A can be converted to B
#endif
        );
  }
  static void* convertible(PyObject* obj_ptr)
  {
      extract<const A&> ex(obj_ptr);
      if (!ex.check()) return 0;
      return obj_ptr;
  }
  static void construct(
      PyObject* obj_ptr,
      converter::rvalue_from_python_stage1_data* data)
  {
    void* storage = (
        (converter::rvalue_from_python_storage< B >*)data)-> storage.bytes;
    extract<const A&> ex(obj_ptr);
    new (storage) B(ex());
    data->convertible = storage;
  }
};
B func(const B& b) { return b ; }
BOOST_PYTHON_MODULE(pytype_function_ext)
{
  to_python_converter< B , BToPython
#if defined BOOST_PYTHON_SUPPORTS_PY_SIGNATURES //invalid if py signatures are not supported
             ,true
#endif
             >(); //has get_pytype
  BFromPython();
  class_<A>("A") ;
  def("func", &func);
}
>>> from pytype_function_ext import *
>>> print func.__doc__
func( (A)arg1) -> A :
    C++ signature:
         struct B func(struct B)
Copyright © 2002-2005, 2015 David Abrahams, Stefan Seefeld

Распространяется под лицензией Boost Software License, версия 1.0. (См. сопроводительный файл LICENSE_1_0.txt или копию по адресу) http://www.boost.org/LICENSE_1_0.txt
PrevUpHomeNext

Статья Function documentation раздела Boost.Python Reference Manual Chapter 4. Function Invocation and Creation может быть полезна для разработчиков на c++ и boost.




Материалы статей собраны из открытых источников, владелец сайта не претендует на авторство. Там где авторство установить не удалось, материал подаётся без имени автора. В случае если Вы считаете, что Ваши права нарушены, пожалуйста, свяжитесь с владельцем сайта.


:: Главная :: Chapter 4. Function Invocation and Creation ::

реклама
©KANSoftWare (разработка программного обеспечения, создание программ, создание интерактивных сайтов), 2007
Top.Mail.Ru

Время компиляции файла: 2024-08-30 11:47:00
2025-07-05 04:08:01/0.0052790641784668/0