pybind / pybind/pybind11

[BUG] Clearer commitment to public / stable API? (most importantly, type_caster)

Open
#2,763 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

casters
Dominant language
C++
Stars
18k
Forks
2.3k
Avg merge
5d 17h
Merged PRs (30d)
10

Description

At present, type_caster is something that exists in the py::detail namespace, but may be overloaded in downstream applications, either via a macro, or more directly.

A naive downstream example (that I wrote 😬):
https://github.com/RobotLocomotion/drake/blob/v0.25.0/bindings/pydrake/common/wrap_pybind.h#L54-L114
https://github.com/RobotLocomotion/drake/blob/v0.25.0/bindings/pydrake/common/cpp_param_pybind.h#L149-L158

At present, my reading of py::detail is that it's generally internal implementation details, i.e. it's internal, not public API, and should not be expected to be stable.

It seems like the base contract of py::detail::type_caster may more-or-less be leaked into a public details. We may want to consider making this more public, and having some level of public stability for this. In this way, we could hoist it outside of py::detail, so we could keep that reserved for truly internal details.

Possibly related:

  • #2646 - holders (may be internal, but may motivate public contract for holder-type casters)
  • #2732 - contract - exception handling
  • #864 - mention backwards-compatibility, which mentions some semblance of stabliity

\cc @rwgk @YannickJadoul @rhaschke @wjakob

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the current py::detail::type_caster contract and the downstream examples in Drake's wrap_pybind.h and cpp_param_pybind.h. Review related issues #2646, #2732, and #864, then define the intended public-stability boundary and namespace before any implementation; the issue is done only when that decision and its compatibility implications are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.