You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/04/05 08:06:42 UTC
[GitHub] [arrow] AlenkaF opened a new pull request, #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata
AlenkaF opened a new pull request, #12796:
URL: https://github.com/apache/arrow/pull/12796
This PR is adding docstring examples to:
- `pyarrow.parquet.read_metadata`
- `pyarrow.parquet.read_schema`
`pyarrow.parquet.write_metadata` is addressed in https://github.com/apache/arrow/pull/12704.
--
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
[GitHub] [arrow] github-actions[bot] commented on pull request #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #12796:
URL: https://github.com/apache/arrow/pull/12796#issuecomment-1088396694
https://issues.apache.org/jira/browse/ARROW-16079
--
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
[GitHub] [arrow] github-actions[bot] commented on pull request #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #12796:
URL: https://github.com/apache/arrow/pull/12796#issuecomment-1088396715
:warning: Ticket **has not been started in JIRA**, please click 'Start Progress'.
--
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
[GitHub] [arrow] AlenkaF commented on a diff in pull request #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on code in PR #12796:
URL: https://github.com/apache/arrow/pull/12796#discussion_r842762929
##########
python/pyarrow/parquet.py:
##########
@@ -2412,6 +2412,23 @@ def read_metadata(where, memory_map=False, decryption_properties=None):
Returns
-------
metadata : FileMetadata
+
+ Examples
+ --------
+ >>> import pyarrow as pa
+ >>> import pyarrow.parquet as pq
+ >>> table = pa.table({'n_legs': [4, 5, 100],
+ ... 'animal': ["Dog", "Brittle stars", "Centipede"]})
+ >>> pq.write_table(table, 'example.parquet')
+
+ >>> pq.read_metadata('example.parquet')
+ <pyarrow._parquet.FileMetaData object at ...>
+ created_by: parquet-cpp-arrow version 8.0.0-SNAPSHOT
Review Comment:
Will correct, 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
[GitHub] [arrow] AlenkaF commented on pull request #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on PR #12796:
URL: https://github.com/apache/arrow/pull/12796#issuecomment-1089910376
The failing test (`tests/test_dataset.py::test_write_dataset_s3`) seems unrelated.
--
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
[GitHub] [arrow] ursabot commented on pull request #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata
Posted by GitBox <gi...@apache.org>.
ursabot commented on PR #12796:
URL: https://github.com/apache/arrow/pull/12796#issuecomment-1092173507
Benchmark runs are scheduled for baseline = dabb80df6e8fc28c5de16f4a856b0c7c2b5f90cd and contender = 77db0cfdd689d69f0090b5153cb1cbaeaf8a7496. 77db0cfdd689d69f0090b5153cb1cbaeaf8a7496 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/c43dafbf8e1c4c0baf1ccc1f8f7db291...c30e79cc3ca54ccdabb2086efb783086/)
[Finished :arrow_down:0.13% :arrow_up:0.0%] [test-mac-arm](https://conbench.ursa.dev/compare/runs/7030c0605b2045739f6e267c2d364ccb...ae08463e1f24457da0efd0039b98e9a5/)
[Failed :arrow_down:0.0% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/922f9212d30943f7a69dc953a54df522...392c99fedcf04b4cb4f3914b81397378/)
[Finished :arrow_down:0.09% :arrow_up:0.04%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/7f490442f0b443e89f29118ebf2f2b7f...04e1cd769ff4422ea86ad155c0927a48/)
Buildkite builds:
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/462| `77db0cfd` ec2-t3-xlarge-us-east-2>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/447| `77db0cfd` test-mac-arm>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/448| `77db0cfd` ursa-i9-9960x>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/457| `77db0cfd` ursa-thinkcentre-m75q>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/461| `dabb80df` ec2-t3-xlarge-us-east-2>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/446| `dabb80df` test-mac-arm>
[Failed] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/447| `dabb80df` ursa-i9-9960x>
[Finished] <https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/456| `dabb80df` ursa-thinkcentre-m75q>
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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
[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata
Posted by GitBox <gi...@apache.org>.
jorisvandenbossche commented on code in PR #12796:
URL: https://github.com/apache/arrow/pull/12796#discussion_r842747553
##########
python/pyarrow/parquet.py:
##########
@@ -2412,6 +2412,23 @@ def read_metadata(where, memory_map=False, decryption_properties=None):
Returns
-------
metadata : FileMetadata
+
+ Examples
+ --------
+ >>> import pyarrow as pa
+ >>> import pyarrow.parquet as pq
+ >>> table = pa.table({'n_legs': [4, 5, 100],
+ ... 'animal': ["Dog", "Brittle stars", "Centipede"]})
+ >>> pq.write_table(table, 'example.parquet')
+
+ >>> pq.read_metadata('example.parquet')
+ <pyarrow._parquet.FileMetaData object at ...>
+ created_by: parquet-cpp-arrow version 8.0.0-SNAPSHOT
Review Comment:
The `8.0.0-SNAPSHOT` is probably also something we will need to replace with "..." at some point
--
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
[GitHub] [arrow] amol- closed pull request #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata
Posted by GitBox <gi...@apache.org>.
amol- closed pull request #12796: ARROW-16079: [Python] Address docstrings in Parquet schema and metadata
URL: https://github.com/apache/arrow/pull/12796
--
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