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

Add type hint to CounterCell #27522

Merged
merged 3 commits into from
Aug 23, 2023
Merged

Conversation

jrmccluskey
Copy link
Contributor

@jrmccluskey jrmccluskey commented Jul 17, 2023

Experiment with adding an explicit int type hint to CounterCell's update method. This should avoid an accidental aggregation of non-ints that is only caught when trying to serialize the metric.

Should prevent #27469 in the future


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

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

@codecov
Copy link

codecov bot commented Jul 17, 2023

Codecov Report

Merging #27522 (087222f) into master (41e6628) will decrease coverage by 0.21%.
Report is 421 commits behind head on master.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #27522      +/-   ##
==========================================
- Coverage   71.16%   70.96%   -0.21%     
==========================================
  Files         861      865       +4     
  Lines      104547   105453     +906     
==========================================
+ Hits        74401    74834     +433     
- Misses      28597    29070     +473     
  Partials     1549     1549              
Flag Coverage Δ
python 79.94% <ø> (-0.43%) ⬇️

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

Files Changed Coverage Δ
sdks/python/apache_beam/metrics/cells.py 82.11% <ø> (ø)

... and 48 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@jrmccluskey jrmccluskey changed the title [DO NOT MERGE] Add type hint to CounterCell Add type hint to CounterCell Aug 22, 2023
@jrmccluskey jrmccluskey marked this pull request as ready for review August 22, 2023 19:25
@jrmccluskey
Copy link
Contributor Author

PyDoc failure is as a result of #28104

@github-actions
Copy link
Contributor

Assigning reviewers. If you would like to opt out of this review, comment assign to next reviewer:

R: @tvalentyn for label python.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

@jrmccluskey
Copy link
Contributor Author

Run PythonDocs PreCommit

@tvalentyn
Copy link
Contributor

The assessment in #27469 is that the issue is in TFX code - is that incorrect?

@jrmccluskey
Copy link
Contributor Author

It is, this just also adds a type hint to the metric counter that should give a more clear type check error rather than the error only coming when the metric is serialized.

@tvalentyn
Copy link
Contributor

gotcha, nice, thanks!

@jrmccluskey
Copy link
Contributor Author

retest this please

@jrmccluskey jrmccluskey merged commit 52275eb into apache:master Aug 23, 2023
76 checks passed
lostluck pushed a commit to lostluck/beam that referenced this pull request Aug 30, 2023
* [DO NOT MERGE] Add type hint to CounterCell

* Tryt alt type hint format

* Call out integer type in docstring
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants