pybind/pybind11

Unkown objects in docstring function signatures

Open

#1,585 创建于 2018年11月1日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)C++ (2,005 fork)batch import
enhancementhelp wanted

仓库指标

Star
 (14,677 star)
PR 合并指标
 (平均合并 5天 2小时) (30 天内合并 10 个 PR)

描述

I try to rely on mypy's stubgen (with recent improvements) to generate *.pyi files from Python classes generated by pybind11. It's almost perfect, though there are just a few things that needs a bit of polishing:

  • iterator - when creating method with .def("some_func", [](some_type const &a) {return py::make_iterator(a.cbegin<elem_type>(), a.cend<elem_type>());}; then docstring is some_func() -> iterator. Type should be either Iterator (from typing) or even better, if it would be Iterator[elem_type]
  • buffer - when binding method with signature add_buffer(py::buffer const &buf) the docstring is add_buffer(buffer: buffer). Is this buffer in Python2 and bytearray in Python3? Should stubgen alias bytearray as buffer in such cases?

贡献者指南