Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BEAM-12028] Add contact information to NotImplementedError #14967

Merged

Conversation

TheNeuralBit
Copy link
Member

We have contact information in pydoc for these operations, but we should also include it in the error message so users know what to do as soon as they run into it. Required plumbing the base type through not_implemented_method.

I also went ahead and fixed some links that I noticed are using the wrong format in their docstrings.

ValidatesRunner compliance status (on master branch)

Lang ULR Dataflow Flink Samza Spark Twister2
Go --- Build Status Build Status --- Build Status ---
Java Build Status Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Python --- Build Status
Build Status
Build Status
Build Status
Build Status
--- Build Status ---
XLang Build Status Build Status Build Status --- Build Status ---

Examples testing status on various runners

Lang ULR Dataflow Flink Samza Spark Twister2
Go --- --- --- --- --- --- ---
Java --- Build Status
Build Status
Build Status
--- --- --- --- ---
Python --- --- --- --- --- --- ---
XLang --- --- --- --- --- --- ---

Post-Commit SDK/Transform Integration Tests Status (on master branch)

Go Java Python
Build Status Build Status Build Status
Build Status
Build Status

Pre-Commit Tests Status (on master branch)

--- Java Python Go Website Whitespace Typescript
Non-portable Build Status
Build Status
Build Status
Build Status
Build Status
Build Status Build Status Build Status Build Status
Portable --- Build Status Build Status --- --- ---

See .test-infra/jenkins/README for trigger phrase, status and link of all Jenkins jobs.

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 TheNeuralBit force-pushed the not-implemented-error-message branch from fe3d8af to 5101c5f Compare June 8, 2021 20:50
@codecov
Copy link

codecov bot commented Jun 8, 2021

Codecov Report

Merging #14967 (7862c54) into master (1b83efb) will decrease coverage by 0.02%.
The diff coverage is 95.23%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #14967      +/-   ##
==========================================
- Coverage   83.75%   83.72%   -0.03%     
==========================================
  Files         436      438       +2     
  Lines       58492    58809     +317     
==========================================
+ Hits        48989    49240     +251     
- Misses       9503     9569      +66     
Impacted Files Coverage Δ
sdks/python/apache_beam/dataframe/frame_base.py 90.07% <92.30%> (ø)
sdks/python/apache_beam/dataframe/frames.py 94.19% <100.00%> (ø)
sdks/python/apache_beam/dataframe/io.py 92.09% <100.00%> (ø)
...pache_beam/dataframe/pandas_top_level_functions.py 93.68% <100.00%> (ø)
...ks/python/apache_beam/runners/worker/data_plane.py
.../srcs/sdks/python/apache_beam/internal/gcp/auth.py
...nners/direct/consumer_tracking_pipeline_visitor.py
...y38/build/srcs/sdks/python/apache_beam/pipeline.py
.../python/apache_beam/examples/windowed_wordcount.py
.../gcp/internal/clients/storage/storage_v1_client.py
... and 868 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 1b83efb...7862c54. Read the comment docs.

@TheNeuralBit
Copy link
Member Author

Run Python PreCommit

2 similar comments
@TheNeuralBit
Copy link
Member Author

Run Python PreCommit

@TheNeuralBit
Copy link
Member Author

Run Python PreCommit

@@ -358,25 +371,33 @@ def wrapper(*args, **kwargs):

wrapper.__name__ = name
wrapper.__doc__ = (
f":meth:`pandas.{base_type.__name__}.{name}` is not supported in the "
f"Beam DataFrame API {reason_data['explanation']}")
f":meth:`{_prettify_pandas_type(base_type)}.{name}` is not supported in "
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we say not yet supported, or otherwise give an indication that this is subject to change?

@TheNeuralBit TheNeuralBit merged commit a8a8b3a into apache:master Jun 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants