docs: Fix errors in string "Explicit conversions" #4658
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`PyUnicode_DecodeLatin1` requires you to pass in the `error` parameter. The code as it is in the docs didn't compile. There is a reference leak in the example code. `PyUnicode_DecodeLatin1` returns a new reference. Calling `py::str(PyObject*)` calls `PyObject_Str`, which also returns a new reference. That reference is managed by the `py::str` constructor (which correctly steals the reference, using the `stolen_t` constructor), but the original reference returned by `PyUnicode_DecodeLatin1` is never decref'd: it never makes it into an `object`, and it's never manually decremented. This fixes both of those issues. The code compiles, and I viewed the sphinx docs locally.
rwgk
approved these changes
May 9, 2023
Collaborator
rwgk
left a comment
rwgk
left a comment
There was a problem hiding this comment.
Thanks for the fix! (I'll merge as soon as I see that the pre-commit checks are happy.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
PyUnicode_DecodeLatin1requires you to pass in theerrorparameter. The code as it is in the docs didn't compile.There is a reference leak in the example code.
PyUnicode_DecodeLatin1returns a new reference. Callingpy::str(PyObject*)callsPyObject_Str, which also returns a new reference. That reference is managed by thepy::strconstructor (which correctly steals the reference, using thestolen_tconstructor), but the original reference returned byPyUnicode_DecodeLatin1is never decref'd: it never makes it into anobject, and it's never manually decremented.This fixes both of those issues. The code compiles, and I viewed the sphinx docs locally.