Repository navigation
GH-55652: [Python] Document the default cast safety setting - #55674
Open
ViktorBystrov72 wants to merge 1 commit into
Open
ViktorBystrov72 wants to merge 1 commit into
ViktorBystrov72 wants to merge 1 commit into
Conversation
ViktorBystrov72
requested review from
AlenkaF,
raulcd and
rok
as code owners
November 19, 2026 07:43
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Rationale for this change
Fixes #55652. The cast APIs use
safe=Nonein their signatures. Their docstrings listTrueas the default.What changes are included in this PR?
Document the
Nonedefault on the compute function and six cast methods. Explain that omittingCastOptionsmakesNonerequest a safe cast.Are these changes tested?
Checked the seven source docstrings against their signatures and exercised the default and explicit unsafe modes on PyArrow 26.0.1. The compute function and expression method were also checked with explicit
CastOptions.Are there any user-facing changes?
The API documentation now shows the signature default and explains how it affects a cast.
Was AI used for this PR?
Codex drafted and reviewed the docstring edits and this description.
PR code and description written by
Reviewed before submission by