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 2023/01/11 09:07:03 UTC
[GitHub] [arrow] AlenkaF opened a new pull request, #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
AlenkaF opened a new pull request, #33609:
URL: https://github.com/apache/arrow/pull/33609
# Which issue does this PR close?
Closes #31506
# Rationale for this change
Ensure docstrings for [Streams and File Access](https://arrow.apache.org/docs/python/api/files.html) - Factory Functions - have an Examples section:
# What changes are included in this PR?
Added docstring examples for:
- `pyarrow.input_stream`
- `pyarrow.output_stream`
- `pyarrow.memory_map`
- `pyarrow.create_memory_map`
Also pytest argument ` --disable-warnings` for `pytest-cython` is added, see https://github.com/lgpage/pytest-cython/issues/3:
```python
=============================== warnings summary ===============================
opt/conda/envs/arrow/lib/python3.9/site-packages/pytest_cython/plugin.py:57
/opt/conda/envs/arrow/lib/python3.9/site-packages/pytest_cython/plugin.py:57: PytestRemovedIn8Warning: The (fspath: py.path.local) argument to DoctestModule is deprecated. Please use the (path: pathlib.Path) argument instead.
See https://docs.pytest.org/en/latest/deprecations.html#fspath-argument-for-node-constructors-replaced-with-pathlib-path
return DoctestModule.from_parent(parent, fspath=path)
```
# Are these changes tested?
Yes, locally with `pytest --doctest-cython --disable-warnings pyarrow` and on the CI with `Python / AMD64 Conda Python 3.9 Sphinx & Numpydoc ` build.
# Are there any user-facing changes?
No.
--
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 #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1383630124
> It seems that this is [lgpage/pytest-cython#24](https://github.com/lgpage/pytest-cython/issues/24) not [lgpage/pytest-cython#3](https://github.com/lgpage/pytest-cython/issues/3) . There is a patch in [lgpage/pytest-cython#24](https://github.com/lgpage/pytest-cython/issues/24) but it's not pull request. How about making the patch a pull request for easy to merge by pytest-cython maintainer?
The PR with the patch for `pytest-cython` just submitted: https://github.com/lgpage/pytest-cython/pull/26
--
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 #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1380319647
> It seems that this is [lgpage/pytest-cython#24](https://github.com/lgpage/pytest-cython/issues/24) not [lgpage/pytest-cython#3](https://github.com/lgpage/pytest-cython/issues/3) . There is a patch in [lgpage/pytest-cython#24](https://github.com/lgpage/pytest-cython/issues/24) but it's not pull request. How about making the patch a pull request for easy to merge by pytest-cython maintainer?
Correct! WIll do.
> Could you also add the issue as a comment of `--disable-warnings`? We'll remove `--disable-warnings` when the issue is resolved.
Do I understand correctly that I should make a new issue to remove `--disable-warnings` once the patch is included in a new release of pytest-cython?
--
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] kou commented on pull request #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
kou commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1379473363
> Also pytest argument `--disable-warnings` for `pytest-cython` is added, see https://github.com/lgpage/pytest-cython/issues/3:
It seems that this is https://github.com/lgpage/pytest-cython/issues/24 not https://github.com/lgpage/pytest-cython/issues/3 .
There is a patch in https://github.com/lgpage/pytest-cython/issues/24 but it's not pull request? How about make the patch a pull request for easy to merge by pytest-cython maintainer?
Could you also add the issue as a comment of `--disable-warnings`? We'll remove `--disable-warnings` when the issue is resolved.
--
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 #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1381416577
That makes sense, thank you for explaining! Will do.
--
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] kou commented on pull request #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
kou commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1384569502
Thanks!
Could you rebase on master to fix lint error?
--
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] kou commented on pull request #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
kou commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1380994171
> Do I understand correctly that I should make a new issue to remove `--disable-warnings` once the patch is included in a new release of pytest-cython?
Sorry. I wanted to say that I want you to add a comment something like the following:
```diff
diff --git a/docker-compose.yml b/docker-compose.yml
index 3774d55868..7cc10743e7 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1101,7 +1101,10 @@ services:
LANG: "C.UTF-8"
BUILD_DOCS_CPP: "ON"
BUILD_DOCS_PYTHON: "ON"
- PYTEST_ARGS: "--doctest-modules --doctest-cython"
+ # GH-31506/GH-33609: Remove --disable-warnings once
+ # https://github.com/lgpage/pytest-cython/issues/24 is resolved
+ # and released a new version that includes the fix.
+ PYTEST_ARGS: "--doctest-modules --doctest-cython --disable-warnings"
volumes: *conda-volumes
command:
["/arrow/ci/scripts/cpp_build.sh /arrow /build &&
```
But creating a new issue for the removal as you said is a good idea!
--
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 #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1383678377
> Could you also add the issue as a comment of `--disable-warnings`? We'll remove `--disable-warnings` when the issue is resolved.
I have added a comment as suggested in the [last commit](https://github.com/apache/arrow/pull/33609/commits/25004a9b09daf107b49b22c3bd9a1e83f667f6ea) and will create a GitHub issue when to remove `--disable-warnings` after this PR is merged.
--
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] kou merged pull request #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
kou merged PR #33609:
URL: https://github.com/apache/arrow/pull/33609
--
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 #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
ursabot commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1386944490
Benchmark runs are scheduled for baseline = 5580f27f946f06fc54eb7728b673eb9b40958034 and contender = ef98a9774dbac7705df5369f86948c3af367e73f. ef98a9774dbac7705df5369f86948c3af367e73f 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/0d60b7225d854620a8ad1d0fb058a72a...ae9d40a049da4f52b08193bc79e7a469/)
[Failed :arrow_down:3.39% :arrow_up:0.09%] [test-mac-arm](https://conbench.ursa.dev/compare/runs/d46fdce08fc14e3eb137ee1d9606e25c...b0481b213b064990b951053b87e78660/)
[Finished :arrow_down:0.51% :arrow_up:1.53%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/a3e441ee2c544f79914f5c25913aadfe...8015f41859d84682916cdcff25bfe360/)
[Failed] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/d5f03f1b0750418296fad593e9c1d256...fd55f8952d664ae88ea0c6c5cac3d5fd/)
Buildkite builds:
[Finished] [`ef98a977` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2206)
[Failed] [`ef98a977` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/2232)
[Finished] [`ef98a977` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2202)
[Failed] [`ef98a977` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2225)
[Finished] [`5580f27f` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2205)
[Failed] [`5580f27f` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/2229)
[Finished] [`5580f27f` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2201)
[Finished] [`5580f27f` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2224)
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] github-actions[bot] commented on pull request #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1378436593
* Closes: #31506
--
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 #33609: GH-31506: [Python] Address docstrings in Streams and File Access (Factory Functions)
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on PR #33609:
URL: https://github.com/apache/arrow/pull/33609#issuecomment-1384997474
Thank you @kou!
I have created new issue to remove `--disable-warnings` with new release of pytest-cython:
https://github.com/apache/arrow/issues/33715
--
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