Skip to content

Commit

Permalink
GH-44711: [Docs][Python] Add missing canonical extension types to PyA…
Browse files Browse the repository at this point in the history
…rrow arrays and datatypes docs (#44880)

Some of the canonical extension types which are implemented in PyArrow
missing from the PyArrow arrays and datatypes docs pages have been added
like JSON, UUID, Decimal256 and Bool8.
* GitHub Issue: #44711
  • Loading branch information
msebbah authored Dec 9, 2024
1 parent 1416f62 commit 5207f1e
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/python/api/arrays.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ may expose data type-specific methods or properties.
DurationArray
MonthDayNanoIntervalArray
Decimal128Array
Decimal256Array
DictionaryArray
ListArray
FixedSizeListArray
Expand All @@ -86,6 +87,9 @@ may expose data type-specific methods or properties.
ExtensionArray
FixedShapeTensorArray
OpaqueArray
JsonArray
UuidArray
Bool8Array

.. _api.scalar:

Expand All @@ -112,6 +116,7 @@ classes may expose data type-specific methods or properties.
Int16Scalar
Int32Scalar
Int64Scalar
NullScalar
UInt8Scalar
UInt16Scalar
UInt32Scalar
Expand All @@ -134,9 +139,11 @@ classes may expose data type-specific methods or properties.
DurationScalar
MonthDayNanoIntervalScalar
Decimal128Scalar
Decimal256Scalar
DictionaryScalar
RunEndEncodedScalar
ListScalar
FixedSizeListScalar
LargeListScalar
ListViewScalar
LargeListViewScalar
Expand All @@ -146,3 +153,6 @@ classes may expose data type-specific methods or properties.
ExtensionScalar
FixedShapeTensorScalar
OpaqueScalar
JsonScalar
UuidScalar
Bool8Scalar
17 changes: 17 additions & 0 deletions docs/source/python/api/datatypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,13 @@ These should be used to create Arrow data types and schemas.
dictionary
run_end_encoded
fixed_shape_tensor
union
dense_union
sparse_union
opaque
bool8
uuid
json_
field
schema
from_numpy_dtype
Expand Down Expand Up @@ -96,13 +102,19 @@ functions above.
DataType
DictionaryType
ListType
ListViewType
FixedSizeListType
LargeListType
LargeListViewType
MapType
StructType
UnionType
DenseUnionType
SparseUnionType
TimestampType
Time32Type
Time64Type
DurationType
FixedSizeBinaryType
Decimal128Type
Decimal256Type
Expand All @@ -115,8 +127,10 @@ Specific classes and functions for extension types.
.. autosummary::
:toctree: ../generated/

BaseExtensionType
ExtensionType
PyExtensionType
UnknownExtensionType
register_extension_type
unregister_extension_type

Expand All @@ -128,6 +142,9 @@ implemented by PyArrow.

FixedShapeTensorType
OpaqueType
JsonType
UuidType
Bool8Type

.. _api.types.checking:
.. currentmodule:: pyarrow.types
Expand Down

0 comments on commit 5207f1e

Please sign in to comment.