Skip to content

Migrate to Pybind11 v3 #30291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/missing-references.json
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,12 @@
"doc/api/_as_gen/mpl_toolkits.axisartist.floating_axes.rst:32:<autosummary>:1"
],
"numpy.float64": [
"doc/docstring of matplotlib.ft2font.pybind11_detail_function_record_v1_system_libstdcpp_gxx_abi_1xxx_use_cxx11_abi_1.set_text:1",
"doc/docstring of matplotlib.ft2font.PyCapsule.set_text:1"
],
"numpy.typing.NDArray": [
"doc/docstring of matplotlib.ft2font.pybind11_detail_function_record_v1_system_libstdcpp_gxx_abi_1xxx_use_cxx11_abi_1.set_text:1"
],
"numpy.uint8": [
"<unknown>:1"
]
Expand Down
2 changes: 1 addition & 1 deletion meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ py_mod = import('python')
py3 = py_mod.find_installation(pure: false)
py3_dep = py3.dependency()

pybind11_dep = dependency('pybind11', version: '>=2.13.2')
pybind11_dep = dependency('pybind11', version: '>=3')

subdir('extern')
subdir('src')
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ requires-python = ">=3.11"
# Should be a copy of the build dependencies below.
dev = [
"meson-python>=0.13.1,!=0.17.*",
"pybind11>=2.13.2,!=2.13.3",
"pybind11>=3",
"setuptools_scm>=7",
# Not required by us but setuptools_scm without a version, cso _if_
# installed, then setuptools_scm 8 requires at least this version.
Expand All @@ -73,7 +73,7 @@ requires = [
# meson-python 0.17.x breaks symlinks in sdists. You can remove this pin if
# you really need it and aren't using an sdist.
"meson-python>=0.13.1,!=0.17.*",
"pybind11>=2.13.2,!=2.13.3",
"pybind11>=3",
"setuptools_scm>=7",
]

Expand Down
2 changes: 1 addition & 1 deletion requirements/dev/build-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pybind11>=2.13.2,!=2.13.3
pybind11>=3
meson-python
setuptools-scm
4 changes: 2 additions & 2 deletions src/_backend_agg_wrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ PyRendererAgg_draw_gouraud_triangles(RendererAgg *self,

PYBIND11_MODULE(_backend_agg, m, py::mod_gil_not_used())
{
py::class_<RendererAgg>(m, "RendererAgg", py::buffer_protocol())
py::classh<RendererAgg>(m, "RendererAgg", py::buffer_protocol())
.def(py::init<unsigned int, unsigned int, double>(),
"width"_a, "height"_a, "dpi"_a)

Expand Down Expand Up @@ -266,7 +266,7 @@ PYBIND11_MODULE(_backend_agg, m, py::mod_gil_not_used())
return py::buffer_info(renderer->pixBuffer, shape, strides);
});

py::class_<BufferRegion>(m, "BufferRegion", py::buffer_protocol())
py::classh<BufferRegion>(m, "BufferRegion", py::buffer_protocol())
// BufferRegion is not constructible from Python, thus no py::init is added.
.def("set_x", &PyBufferRegion_set_x)
.def("set_y", &PyBufferRegion_set_y)
Expand Down
95 changes: 0 additions & 95 deletions src/_enums.h

This file was deleted.

164 changes: 72 additions & 92 deletions src/ft2font_wrapper.cpp
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION
#include <pybind11/pybind11.h>
#include <pybind11/native_enum.h>
#include <pybind11/numpy.h>
#include <pybind11/stl.h>

#include "ft2font.h"
#include "_enums.h"

#include <set>
#include <sstream>
Expand Down Expand Up @@ -50,13 +50,6 @@ const char *Kerning__doc__ = R"""(
.. versionadded:: 3.10
)""";

P11X_DECLARE_ENUM(
"Kerning", "Enum",
{"DEFAULT", FT_KERNING_DEFAULT},
{"UNFITTED", FT_KERNING_UNFITTED},
{"UNSCALED", FT_KERNING_UNSCALED},
);

const char *FaceFlags__doc__ = R"""(
Flags returned by `FT2Font.face_flags`.

Expand Down Expand Up @@ -103,29 +96,6 @@ enum class FaceFlags : FT_Long {
#undef DECLARE_FLAG
};

P11X_DECLARE_ENUM(
"FaceFlags", "Flag",
{"SCALABLE", FaceFlags::SCALABLE},
{"FIXED_SIZES", FaceFlags::FIXED_SIZES},
{"FIXED_WIDTH", FaceFlags::FIXED_WIDTH},
{"SFNT", FaceFlags::SFNT},
{"HORIZONTAL", FaceFlags::HORIZONTAL},
{"VERTICAL", FaceFlags::VERTICAL},
{"KERNING", FaceFlags::KERNING},
{"FAST_GLYPHS", FaceFlags::FAST_GLYPHS},
{"MULTIPLE_MASTERS", FaceFlags::MULTIPLE_MASTERS},
{"GLYPH_NAMES", FaceFlags::GLYPH_NAMES},
{"EXTERNAL_STREAM", FaceFlags::EXTERNAL_STREAM},
{"HINTER", FaceFlags::HINTER},
{"CID_KEYED", FaceFlags::CID_KEYED},
{"TRICKY", FaceFlags::TRICKY},
{"COLOR", FaceFlags::COLOR},
{"VARIATION", FaceFlags::VARIATION},
{"SVG", FaceFlags::SVG},
{"SBIX", FaceFlags::SBIX},
{"SBIX_OVERLAY", FaceFlags::SBIX_OVERLAY},
);

const char *LoadFlags__doc__ = R"""(
Flags for `FT2Font.load_char`, `FT2Font.load_glyph`, and `FT2Font.set_text`.

Expand Down Expand Up @@ -174,36 +144,6 @@ enum class LoadFlags : FT_Int32 {
#undef DECLARE_FLAG
};

P11X_DECLARE_ENUM(
"LoadFlags", "Flag",
{"DEFAULT", LoadFlags::DEFAULT},
{"NO_SCALE", LoadFlags::NO_SCALE},
{"NO_HINTING", LoadFlags::NO_HINTING},
{"RENDER", LoadFlags::RENDER},
{"NO_BITMAP", LoadFlags::NO_BITMAP},
{"VERTICAL_LAYOUT", LoadFlags::VERTICAL_LAYOUT},
{"FORCE_AUTOHINT", LoadFlags::FORCE_AUTOHINT},
{"CROP_BITMAP", LoadFlags::CROP_BITMAP},
{"PEDANTIC", LoadFlags::PEDANTIC},
{"IGNORE_GLOBAL_ADVANCE_WIDTH", LoadFlags::IGNORE_GLOBAL_ADVANCE_WIDTH},
{"NO_RECURSE", LoadFlags::NO_RECURSE},
{"IGNORE_TRANSFORM", LoadFlags::IGNORE_TRANSFORM},
{"MONOCHROME", LoadFlags::MONOCHROME},
{"LINEAR_DESIGN", LoadFlags::LINEAR_DESIGN},
{"NO_AUTOHINT", LoadFlags::NO_AUTOHINT},
{"COLOR", LoadFlags::COLOR},
{"COMPUTE_METRICS", LoadFlags::COMPUTE_METRICS},
{"BITMAP_METRICS_ONLY", LoadFlags::BITMAP_METRICS_ONLY},
{"NO_SVG", LoadFlags::NO_SVG},
// These must be unique, but the others can be OR'd together; I don't know if
// there's any way to really enforce that.
{"TARGET_NORMAL", LoadFlags::TARGET_NORMAL},
{"TARGET_LIGHT", LoadFlags::TARGET_LIGHT},
{"TARGET_MONO", LoadFlags::TARGET_MONO},
{"TARGET_LCD", LoadFlags::TARGET_LCD},
{"TARGET_LCD_V", LoadFlags::TARGET_LCD_V},
);

const char *StyleFlags__doc__ = R"""(
Flags returned by `FT2Font.style_flags`.

Expand All @@ -221,13 +161,6 @@ enum class StyleFlags : FT_Long {
#undef DECLARE_FLAG
};

P11X_DECLARE_ENUM(
"StyleFlags", "Flag",
{"NORMAL", StyleFlags::NORMAL},
{"ITALIC", StyleFlags::ITALIC},
{"BOLD", StyleFlags::BOLD},
);

/**********************************************************************
* FT2Image
* */
Expand Down Expand Up @@ -1552,13 +1485,70 @@ PYBIND11_MODULE(ft2font, m, py::mod_gil_not_used())
FT_Library_Version(_ft2Library, &major, &minor, &patch);
snprintf(version_string, sizeof(version_string), "%d.%d.%d", major, minor, patch);

p11x::bind_enums(m);
p11x::enums["Kerning"].attr("__doc__") = Kerning__doc__;
p11x::enums["LoadFlags"].attr("__doc__") = LoadFlags__doc__;
p11x::enums["FaceFlags"].attr("__doc__") = FaceFlags__doc__;
p11x::enums["StyleFlags"].attr("__doc__") = StyleFlags__doc__;

py::class_<FT2Image>(m, "FT2Image", py::is_final(), py::buffer_protocol(),
py::native_enum<FT_Kerning_Mode>(m, "Kerning", "enum.Enum", Kerning__doc__)
.value("DEFAULT", FT_KERNING_DEFAULT)
.value("UNFITTED", FT_KERNING_UNFITTED)
.value("UNSCALED", FT_KERNING_UNSCALED)
.finalize();

py::native_enum<LoadFlags>(m, "LoadFlags", "enum.Flag", LoadFlags__doc__)
.value("DEFAULT", LoadFlags::DEFAULT)
.value("NO_SCALE", LoadFlags::NO_SCALE)
.value("NO_HINTING", LoadFlags::NO_HINTING)
.value("RENDER", LoadFlags::RENDER)
.value("NO_BITMAP", LoadFlags::NO_BITMAP)
.value("VERTICAL_LAYOUT", LoadFlags::VERTICAL_LAYOUT)
.value("FORCE_AUTOHINT", LoadFlags::FORCE_AUTOHINT)
.value("CROP_BITMAP", LoadFlags::CROP_BITMAP)
.value("PEDANTIC", LoadFlags::PEDANTIC)
.value("IGNORE_GLOBAL_ADVANCE_WIDTH", LoadFlags::IGNORE_GLOBAL_ADVANCE_WIDTH)
.value("NO_RECURSE", LoadFlags::NO_RECURSE)
.value("IGNORE_TRANSFORM", LoadFlags::IGNORE_TRANSFORM)
.value("MONOCHROME", LoadFlags::MONOCHROME)
.value("LINEAR_DESIGN", LoadFlags::LINEAR_DESIGN)
.value("NO_AUTOHINT", LoadFlags::NO_AUTOHINT)
.value("COLOR", LoadFlags::COLOR)
.value("COMPUTE_METRICS", LoadFlags::COMPUTE_METRICS)
.value("BITMAP_METRICS_ONLY", LoadFlags::BITMAP_METRICS_ONLY)
.value("NO_SVG", LoadFlags::NO_SVG)
// These must be unique, but the others can be OR'd together; I don't know if
// there's any way to really enforce that.
.value("TARGET_NORMAL", LoadFlags::TARGET_NORMAL)
.value("TARGET_LIGHT", LoadFlags::TARGET_LIGHT)
.value("TARGET_MONO", LoadFlags::TARGET_MONO)
.value("TARGET_LCD", LoadFlags::TARGET_LCD)
.value("TARGET_LCD_V", LoadFlags::TARGET_LCD_V)
.finalize();

py::native_enum<FaceFlags>(m, "FaceFlags", "enum.Flag", FaceFlags__doc__)
.value("SCALABLE", FaceFlags::SCALABLE)
.value("FIXED_SIZES", FaceFlags::FIXED_SIZES)
.value("FIXED_WIDTH", FaceFlags::FIXED_WIDTH)
.value("SFNT", FaceFlags::SFNT)
.value("HORIZONTAL", FaceFlags::HORIZONTAL)
.value("VERTICAL", FaceFlags::VERTICAL)
.value("KERNING", FaceFlags::KERNING)
.value("FAST_GLYPHS", FaceFlags::FAST_GLYPHS)
.value("MULTIPLE_MASTERS", FaceFlags::MULTIPLE_MASTERS)
.value("GLYPH_NAMES", FaceFlags::GLYPH_NAMES)
.value("EXTERNAL_STREAM", FaceFlags::EXTERNAL_STREAM)
.value("HINTER", FaceFlags::HINTER)
.value("CID_KEYED", FaceFlags::CID_KEYED)
.value("TRICKY", FaceFlags::TRICKY)
.value("COLOR", FaceFlags::COLOR)
.value("VARIATION", FaceFlags::VARIATION)
.value("SVG", FaceFlags::SVG)
.value("SBIX", FaceFlags::SBIX)
.value("SBIX_OVERLAY", FaceFlags::SBIX_OVERLAY)
.finalize();

py::native_enum<StyleFlags>(m, "StyleFlags", "enum.Flag", StyleFlags__doc__)
.value("NORMAL", StyleFlags::NORMAL)
.value("ITALIC", StyleFlags::ITALIC)
.value("BOLD", StyleFlags::BOLD)
.finalize();

py::classh<FT2Image>(m, "FT2Image", py::is_final(), py::buffer_protocol(),
PyFT2Image__doc__)
.def(py::init(
[](double_or_<long> width, double_or_<long> height) {
Expand All @@ -1581,7 +1571,7 @@ PYBIND11_MODULE(ft2font, m, py::mod_gil_not_used())
return py::buffer_info(self.get_buffer(), shape, strides);
});

py::class_<PyGlyph>(m, "Glyph", py::is_final(), PyGlyph__doc__)
py::classh<PyGlyph>(m, "Glyph", py::is_final(), PyGlyph__doc__)
.def(py::init<>([]() -> PyGlyph {
// Glyph is not useful from Python, so mark it as not constructible.
throw std::runtime_error("Glyph is not constructible");
Expand All @@ -1605,8 +1595,8 @@ PYBIND11_MODULE(ft2font, m, py::mod_gil_not_used())
.def_property_readonly("bbox", &PyGlyph_get_bbox,
"The control box of the glyph.");

auto cls = py::class_<PyFT2Font>(m, "FT2Font", py::is_final(), py::buffer_protocol(),
PyFT2Font__doc__)
py::classh<PyFT2Font>(m, "FT2Font", py::is_final(), py::buffer_protocol(),
PyFT2Font__doc__)
.def(py::init(&PyFT2Font_init),
"filename"_a, "hinting_factor"_a=8, py::kw_only(),
"_fallback_list"_a=py::none(), "_kerning_factor"_a=0,
Expand Down Expand Up @@ -1640,20 +1630,10 @@ PYBIND11_MODULE(ft2font, m, py::mod_gil_not_used())
.def("get_descent", &PyFT2Font_get_descent, PyFT2Font_get_descent__doc__)
.def("draw_glyphs_to_bitmap", &PyFT2Font_draw_glyphs_to_bitmap,
py::kw_only(), "antialiased"_a=true,
PyFT2Font_draw_glyphs_to_bitmap__doc__);
// The generated docstring uses an unqualified "Buffer" as type hint,
// which causes an error in sphinx. This is fixed as of pybind11
// master (since #5566) which now uses "collections.abc.Buffer";
// restore the signature once that version is released.
{
py::options options{};
options.disable_function_signatures();
cls
.def("draw_glyph_to_bitmap", &PyFT2Font_draw_glyph_to_bitmap,
"image"_a, "x"_a, "y"_a, "glyph"_a, py::kw_only(), "antialiased"_a=true,
PyFT2Font_draw_glyph_to_bitmap__doc__);
}
cls
PyFT2Font_draw_glyphs_to_bitmap__doc__)
.def("draw_glyph_to_bitmap", &PyFT2Font_draw_glyph_to_bitmap,
"image"_a, "x"_a, "y"_a, "glyph"_a, py::kw_only(), "antialiased"_a=true,
PyFT2Font_draw_glyph_to_bitmap__doc__)
.def("get_glyph_name", &PyFT2Font_get_glyph_name, "index"_a,
PyFT2Font_get_glyph_name__doc__)
.def("get_charmap", &PyFT2Font_get_charmap, PyFT2Font_get_charmap__doc__)
Expand Down
Loading