You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "msebbah (via GitHub)" <gi...@apache.org> on 2024/11/28 14:28:34 UTC

[PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

msebbah opened a new pull request, #44880:
URL: https://github.com/apache/arrow/pull/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.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2506867738

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on code in PR #44880:
URL: https://github.com/apache/arrow/pull/44880#discussion_r1862885535


##########
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

Review Comment:
   I think a better order for these is:
   - `union`, `dense_union`, and `sparse_union` just above `opaque`
   - `bool8`, `uuid`, and `json_` just below `opaque`



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2508415564

   In the Scalars section of `arrays.rst`, I just noticed that some things are missing:
   - `NullScalar`
   - `Decimal256Scalar`
   - `FixedSizeListScalar`
   - `JsonScalar`
   - `UuidScalar`
   - `Bool8Scalar`
   
   These all appear in https://github.com/apache/arrow/blob/main/python/pyarrow/scalar.pxi but are missing here.
   
   @msebbah could you please add these, in roughly the same order as they appear in various other lists? Thanks!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2506950179

   I confirmed that all added changes are reflected in documents but I haven't checked whether the added changes cover all missing items... @ianmcook Could you review the change?
   
   @msebbah Could you use our PR template instead of removing it entirely next time?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2508204902

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2526609649

   Revision: 27f6d2348d8a3092e67a4a033183b4a512c66eee
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-f0f92dea49](https://github.com/ursacomputing/crossbow/branches/all?query=actions-f0f92dea49)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![GitHub Actions](https://github.com/ursacomputing/crossbow/actions/workflows/crossbow.yml/badge.svg?branch=actions-f0f92dea49-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/12227357771/job/34103974673)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2507050594

   Thanks for doing this @msebbah. This looks good to me except for the order of the new entries. See my comments above about that.
   
   > I confirmed that all added changes are reflected in documents but I haven't checked whether the added changes cover all missing items... @ianmcook Could you review the change?
   
   @kou This covers all the missing items that I was able to identify during 30+ minutes of searching.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2508365321

   http://crossbow.voltrondata.com/pr_docs/44880/python/api/arrays.html
   http://crossbow.voltrondata.com/pr_docs/44880/python/api/datatypes.html


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "msebbah (via GitHub)" <gi...@apache.org>.
msebbah commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2526211629

   Hi @ianmcook, it should be better now, could you review the PR, please ?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2526607139

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on code in PR #44880:
URL: https://github.com/apache/arrow/pull/44880#discussion_r1862906062


##########
docs/source/python/api/datatypes.rst:
##########
@@ -109,6 +115,12 @@ functions above.
    Field
    Schema
    RunEndEncodedType
+   ListViewType
+   LargeListViewType
+   FixedSizeListType
+   SparseUnionType
+   DenseUnionType
+   DurationType

Review Comment:
   I think `BaseExtensionType` is also missing from this list.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2508216076

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook merged PR #44880:
URL: https://github.com/apache/arrow/pull/44880


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2506869038

   Revision: 172e98ce562b43ea5e0c0e91a844d3b486792a0d
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-14d6423697](https://github.com/ursacomputing/crossbow/branches/all?query=actions-14d6423697)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![GitHub Actions](https://github.com/ursacomputing/crossbow/actions/workflows/crossbow.yml/badge.svg?branch=actions-14d6423697-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/12076802369/job/33678708283)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #44880:
URL: https://github.com/apache/arrow/pull/44880#discussion_r1862835770


##########
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
+

Review Comment:
   ```suggestion
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2506921955

   http://crossbow.voltrondata.com/pr_docs/44880/python/api/arrays.html
   http://crossbow.voltrondata.com/pr_docs/44880/python/api/datatypes.html


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2508206957

   Revision: 73b5813f39ff6a99bcf8ed1ae60b6981466e7abf
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-df9fb0630d](https://github.com/ursacomputing/crossbow/branches/all?query=actions-df9fb0630d)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![GitHub Actions](https://github.com/ursacomputing/crossbow/actions/workflows/crossbow.yml/badge.svg?branch=actions-df9fb0630d-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/12088878610/job/33713201517)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2526777771

   Thanks @msebbah!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "conbench-apache-arrow[bot] (via GitHub)" <gi...@apache.org>.
conbench-apache-arrow[bot] commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2527543494

   After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 5207f1ef57dbcd23bcafa3725a895d6ce7b676b9.
   
   There were no benchmark performance regressions. 🎉
   
   The [full Conbench report](https://github.com/apache/arrow/runs/34121763196) has more details. It also includes information about 10 possible false positives for unstable benchmarks that are known to sometimes produce them.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on code in PR #44880:
URL: https://github.com/apache/arrow/pull/44880#discussion_r1862891984


##########
docs/source/python/api/datatypes.rst:
##########
@@ -109,6 +115,12 @@ functions above.
    Field
    Schema
    RunEndEncodedType
+   ListViewType
+   LargeListViewType
+   FixedSizeListType
+   SparseUnionType
+   DenseUnionType
+   DurationType

Review Comment:
   Similar to my other two comments, could you please arrange these new entries in better places in the list? Thanks



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "msebbah (via GitHub)" <gi...@apache.org>.
msebbah commented on code in PR #44880:
URL: https://github.com/apache/arrow/pull/44880#discussion_r1863630618


##########
docs/source/python/api/datatypes.rst:
##########
@@ -109,6 +115,12 @@ functions above.
    Field
    Schema
    RunEndEncodedType
+   ListViewType
+   LargeListViewType
+   FixedSizeListType
+   SparseUnionType
+   DenseUnionType
+   DurationType

Review Comment:
   Sure, let me fix that



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #44880:
URL: https://github.com/apache/arrow/pull/44880#issuecomment-2508218078

   Revision: 73b5813f39ff6a99bcf8ed1ae60b6981466e7abf
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-08189ee106](https://github.com/ursacomputing/crossbow/branches/all?query=actions-08189ee106)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![GitHub Actions](https://github.com/ursacomputing/crossbow/actions/workflows/crossbow.yml/badge.svg?branch=actions-08189ee106-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/12088986518/job/33713514857)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs [arrow]

Posted by "ianmcook (via GitHub)" <gi...@apache.org>.
ianmcook commented on code in PR #44880:
URL: https://github.com/apache/arrow/pull/44880#discussion_r1862876147


##########
docs/source/python/api/arrays.rst:
##########
@@ -86,6 +86,10 @@ may expose data type-specific methods or properties.
    ExtensionArray
    FixedShapeTensorArray
    OpaqueArray
+   JsonArray
+   UuidArray
+   Bool8Array
+   Decimal256Array

Review Comment:
   JSON, UUID, and Bool8 are all canonical extension types, so those array classes belong here at the end of the list. But Decimal256 is a top-level Arrow type, so `Decimal256Array` belongs higher up in this list, immediately below `Decimal128Array`. Could you move it there please? Thanks



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org