Make TypeErrors more informative when an optional header is missing #1077
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
One of the most frequent questions, both in the issues and Gitter, is: "Why doesn't the
std::vector<T>
conversion work?" The answer is usually: missing#include <pybind11/stl.h>
.As far as I know, there is no way to diagnose this issue at compile time (at least not while also keeping all the dependencies optional), but this PR attempts to add an informative message to conversion errors which are likely caused by missing headers.
The note is only appended if
std::
is found in the function signature. This should only be the case when a header is missing. E.g. whenstl.h
is included, the signature would containList[int]
instead ofstd::vector<int>
while usingstl_bind.h
would produce something likeMyVector
. Similarly forstd::map
/Dict
,complex
,std::function
/Callable
, etc.There's a possibility for false positives, but it's pretty low.
The full error message looks something like this: