From 172e98ce562b43ea5e0c0e91a844d3b486792a0d Mon Sep 17 00:00:00 2001 From: Mike Date: Thu, 28 Nov 2024 14:31:48 +0100 Subject: [PATCH 1/4] Add missing canonical extension types to PyArrow arrays and datatypes docs --- docs/source/python/api/arrays.rst | 5 +++++ docs/source/python/api/datatypes.rst | 16 ++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/docs/source/python/api/arrays.rst b/docs/source/python/api/arrays.rst index 4ad35b190cdd0..6dc99b3e73699 100644 --- a/docs/source/python/api/arrays.rst +++ b/docs/source/python/api/arrays.rst @@ -86,6 +86,11 @@ may expose data type-specific methods or properties. ExtensionArray FixedShapeTensorArray OpaqueArray + JsonArray + UuidArray + Bool8Array + Decimal256Array + .. _api.scalar: diff --git a/docs/source/python/api/datatypes.rst b/docs/source/python/api/datatypes.rst index 86c29296873e5..c316aa226077d 100644 --- a/docs/source/python/api/datatypes.rst +++ b/docs/source/python/api/datatypes.rst @@ -72,6 +72,12 @@ These should be used to create Arrow data types and schemas. field schema from_numpy_dtype + bool8 + uuid + json_ + union + dense_union + sparse_union Utility Functions ----------------- @@ -109,6 +115,12 @@ functions above. Field Schema RunEndEncodedType + ListViewType + LargeListViewType + FixedSizeListType + SparseUnionType + DenseUnionType + DurationType Specific classes and functions for extension types. @@ -117,6 +129,7 @@ Specific classes and functions for extension types. ExtensionType PyExtensionType + UnknownExtensionType register_extension_type unregister_extension_type @@ -128,6 +141,9 @@ implemented by PyArrow. FixedShapeTensorType OpaqueType + JsonType + UuidType + Bool8Type .. _api.types.checking: .. currentmodule:: pyarrow.types From 306df4ffc3edade07ff8617b355599e448bfd6bc Mon Sep 17 00:00:00 2001 From: Sutou Kouhei Date: Fri, 29 Nov 2024 11:01:19 +0900 Subject: [PATCH 2/4] Remove a needless change --- docs/source/python/api/arrays.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/python/api/arrays.rst b/docs/source/python/api/arrays.rst index 6dc99b3e73699..e9d3ed1a326e2 100644 --- a/docs/source/python/api/arrays.rst +++ b/docs/source/python/api/arrays.rst @@ -91,7 +91,6 @@ may expose data type-specific methods or properties. Bool8Array Decimal256Array - .. _api.scalar: Scalars From 73b5813f39ff6a99bcf8ed1ae60b6981466e7abf Mon Sep 17 00:00:00 2001 From: Mike Date: Fri, 29 Nov 2024 15:58:19 +0100 Subject: [PATCH 3/4] Reorder new entries --- docs/source/python/api/arrays.rst | 2 +- docs/source/python/api/datatypes.rst | 25 +++++++++++++------------ 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/source/python/api/arrays.rst b/docs/source/python/api/arrays.rst index e9d3ed1a326e2..b44b27bfed2f2 100644 --- a/docs/source/python/api/arrays.rst +++ b/docs/source/python/api/arrays.rst @@ -73,6 +73,7 @@ may expose data type-specific methods or properties. DurationArray MonthDayNanoIntervalArray Decimal128Array + Decimal256Array DictionaryArray ListArray FixedSizeListArray @@ -89,7 +90,6 @@ may expose data type-specific methods or properties. JsonArray UuidArray Bool8Array - Decimal256Array .. _api.scalar: diff --git a/docs/source/python/api/datatypes.rst b/docs/source/python/api/datatypes.rst index c316aa226077d..65f6da56a553c 100644 --- a/docs/source/python/api/datatypes.rst +++ b/docs/source/python/api/datatypes.rst @@ -68,16 +68,16 @@ These should be used to create Arrow data types and schemas. dictionary run_end_encoded fixed_shape_tensor + union + dense_union + sparse_union opaque - field - schema - from_numpy_dtype bool8 uuid json_ - union - dense_union - sparse_union + field + schema + from_numpy_dtype Utility Functions ----------------- @@ -102,31 +102,32 @@ functions above. DataType DictionaryType ListType + ListViewType + FixedSizeListType LargeListType + LargeListViewType MapType StructType UnionType + DenseUnionType + SparseUnionType TimestampType Time32Type Time64Type + DurationType FixedSizeBinaryType Decimal128Type Decimal256Type Field Schema RunEndEncodedType - ListViewType - LargeListViewType - FixedSizeListType - SparseUnionType - DenseUnionType - DurationType Specific classes and functions for extension types. .. autosummary:: :toctree: ../generated/ + BaseExtensionType ExtensionType PyExtensionType UnknownExtensionType From 27f6d2348d8a3092e67a4a033183b4a512c66eee Mon Sep 17 00:00:00 2001 From: Mike Date: Wed, 4 Dec 2024 09:27:52 +0100 Subject: [PATCH 4/4] Add missing entries to PyArrow scalars docs --- docs/source/python/api/arrays.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/python/api/arrays.rst b/docs/source/python/api/arrays.rst index b44b27bfed2f2..5219902362375 100644 --- a/docs/source/python/api/arrays.rst +++ b/docs/source/python/api/arrays.rst @@ -116,6 +116,7 @@ classes may expose data type-specific methods or properties. Int16Scalar Int32Scalar Int64Scalar + NullScalar UInt8Scalar UInt16Scalar UInt32Scalar @@ -138,9 +139,11 @@ classes may expose data type-specific methods or properties. DurationScalar MonthDayNanoIntervalScalar Decimal128Scalar + Decimal256Scalar DictionaryScalar RunEndEncodedScalar ListScalar + FixedSizeListScalar LargeListScalar ListViewScalar LargeListViewScalar @@ -150,3 +153,6 @@ classes may expose data type-specific methods or properties. ExtensionScalar FixedShapeTensorScalar OpaqueScalar + JsonScalar + UuidScalar + Bool8Scalar