Skip to content

GH-49717: [Python] Document validation requirements for array buffer … #54922

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.

Sign up for GitHub

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

Open
MarkCruz911 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GH-49717: [Python] Document validation requirements for array buffer … #54922

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 32 additions & 0 deletions python/pyarrow/array.pxi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1354,6 +1354,14 @@ cdef class Array(_PandasConvertible):

The concrete type returned depends on the datatype.

.. warning::

The caller is responsible for providing valid Arrow data.
Only basic validation checks are performed when constructing
the array. Call ``validate(full=True)`` on the resulting array
before using it to perform thorough validation checks.
Using an array with invalid data may lead to crashes.

Parameters
----------
type : DataType
Expand Down Expand Up @@ -4211,6 +4219,14 @@ cdef class StringArray(Array):
If there are nulls in the data, also a null_bitmap and the matching
null_count must be passed.

.. warning::

The caller is responsible for providing valid Arrow data.
Only basic validation checks are performed when constructing
the array. Call ``validate(full=True)`` on the resulting array
before using it to perform thorough validation checks.
Using an array with invalid data may lead to crashes.

Parameters
----------
length : int
Expand Down Expand Up @@ -4249,6 +4265,14 @@ cdef class LargeStringArray(Array):
If there are nulls in the data, also a null_bitmap and the matching
null_count must be passed.

.. warning::

The caller is responsible for providing valid Arrow data.
Only basic validation checks are performed when constructing
the array. Call ``validate(full=True)`` on the resulting array
before using it to perform thorough validation checks.
Using an array with invalid data may lead to crashes.

Parameters
----------
length : int
Expand Down Expand Up @@ -4369,6 +4393,14 @@ cdef class DictionaryArray(Array):
"""
Construct a DictionaryArray from buffers.

.. warning::

The caller is responsible for providing valid Arrow data.
Only basic validation checks are performed when constructing
the array. Call ``validate(full=True)`` on the resulting array
before using it to perform thorough validation checks.
Using an array with invalid data may lead to crashes.

Parameters
----------
type : pyarrow.DataType
Expand Down
Loading