Skip to content

Conversation

@TheNeuralBit
Copy link
Member

Fixes #21845

This pushes the cutout for apache_beam.dataframe warnings earlier, so that they don't even show up in the log.

I confirmed that this will still catch errors by introducing an indentation issue and verifying that the resulting warning caused tox -e py38-docs to fail.

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests

See CI.md for more information about GitHub Actions CI.

@TheNeuralBit
Copy link
Member Author

R: @AnandInguva


# Fail if there are errors or warnings in docs
! grep -q "ERROR:" target/docs/sphinx-build.warnings.log || exit 1
(! grep -v 'apache_beam.dataframe' target/docs/sphinx-build.warnings.log | grep -q "WARNING:") || exit 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why apache_beam.dataframe was specified specially here? Just curious

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a comment above to explain it. The issue is that for the DataFrame API we copy docstrings verbatim from the equivalent pandas methods, and these have various issues that raise warnings in sphinx

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. Thanks

@AnandInguva
Copy link
Contributor

AnandInguva commented Jun 14, 2022

LGTM!

@codecov
Copy link

codecov bot commented Jun 14, 2022

Codecov Report

Merging #21861 (a4c9ded) into master (ecea6de) will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #21861      +/-   ##
==========================================
- Coverage   74.07%   74.05%   -0.03%     
==========================================
  Files         698      698              
  Lines       92574    92595      +21     
==========================================
- Hits        68577    68571       -6     
- Misses      22742    22769      +27     
  Partials     1255     1255              
Flag Coverage Δ
python 83.72% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
.../python/apache_beam/testing/test_stream_service.py 88.09% <0.00%> (-4.77%) ⬇️
.../python/apache_beam/transforms/periodicsequence.py 96.77% <0.00%> (-1.59%) ⬇️
sdks/python/apache_beam/io/source_test_utils.py 88.01% <0.00%> (-1.39%) ⬇️
...che_beam/runners/interactive/interactive_runner.py 90.06% <0.00%> (-1.33%) ⬇️
...eam/runners/portability/fn_api_runner/execution.py 92.44% <0.00%> (-0.65%) ⬇️
...ks/python/apache_beam/runners/worker/sdk_worker.py 88.94% <0.00%> (-0.16%) ⬇️
sdks/python/apache_beam/io/hadoopfilesystem.py 97.28% <0.00%> (ø)
...thon/apache_beam/ml/inference/pytorch_inference.py 0.00% <0.00%> (ø)
sdks/python/apache_beam/transforms/core.py 92.39% <0.00%> (+0.01%) ⬆️
sdks/python/apache_beam/pvalue.py 91.44% <0.00%> (+0.06%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ecea6de...a4c9ded. Read the comment docs.

@TheNeuralBit TheNeuralBit merged commit 079d3e9 into apache:master Jun 16, 2022
bullet03 pushed a commit to akvelon/beam that referenced this pull request Jun 20, 2022
prodriguezdefino pushed a commit to prodriguezdefino/beam-pabs that referenced this pull request Jun 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task]: Remove DataFrame cruft from Python Docs precommit

2 participants