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

Rename internal batch_info variable to previous_batch_results #11056

Merged
merged 3 commits into from
Nov 27, 2024

Conversation

QMalcolm
Copy link
Contributor

Problem / Solution

We were using batch_info to store the information on previous batch execution (if available) at runtime. However this name is confusing. Thus, we're renaming it to something more applicable, previous_batch_results. This is a non-dangerous change because batch_info wasn't written out as part of any artifacts.

Checklist

  • I have read the contributing guide and understand what's expected of me.
  • I have run this code in development, and it appears to resolve the stated issue.
  • This PR includes tests, or tests are not required or relevant for this PR.
  • This PR has no interface changes (e.g., macros, CLI, logs, JSON artifacts, config files, adapter interface, etc.) or this PR has already received feedback and approval from Product or DX.
  • This PR includes type annotations for new and modified functions.

@cla-bot cla-bot bot added the cla:yes label Nov 26, 2024
@QMalcolm QMalcolm added Skip Changelog Skips GHA to check for changelog file and removed cla:yes labels Nov 26, 2024
Copy link
Contributor

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

@QMalcolm QMalcolm added the tidy_first "Tidy First" incremental cleanup changes label Nov 26, 2024
Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.17%. Comparing base (a42303c) to head (dd760a2).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11056      +/-   ##
==========================================
+ Coverage   89.15%   89.17%   +0.02%     
==========================================
  Files         183      183              
  Lines       23764    23767       +3     
==========================================
+ Hits        21186    21194       +8     
+ Misses       2578     2573       -5     
Flag Coverage Δ
integration 86.56% <100.00%> (+0.03%) ⬆️
unit 62.17% <37.50%> (+<0.01%) ⬆️

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

Components Coverage Δ
Unit Tests 62.17% <37.50%> (+<0.01%) ⬆️
Integration Tests 86.56% <100.00%> (+0.03%) ⬆️

In 4050e37 we began excluding
`previous_batch_results` from the serialized representation of the
ModelNode. As such, we no longer need to check for it in `test_manifest.py`.
@cla-bot cla-bot bot added the cla:yes label Nov 27, 2024
@QMalcolm QMalcolm marked this pull request as ready for review November 27, 2024 16:30
@QMalcolm QMalcolm requested a review from a team as a code owner November 27, 2024 16:30
@QMalcolm QMalcolm merged commit 0f084e1 into main Nov 27, 2024
62 of 63 checks passed
@QMalcolm QMalcolm deleted the qmalcolm--rename-batch-info branch November 27, 2024 16:46
github-actions bot pushed a commit that referenced this pull request Nov 27, 2024
…1056)

* Rename `batch_info` to `previous_batch_results`

* Exclude `previous_batch_results` from serialization of model node to avoid jinja context bloat

* Drop `previous_batch_results` key from `test_manifest.py` unit tests

In 4050e37 we began excluding
`previous_batch_results` from the serialized representation of the
ModelNode. As such, we no longer need to check for it in `test_manifest.py`.

(cherry picked from commit 0f084e1)
QMalcolm added a commit that referenced this pull request Nov 27, 2024
…1056) (#11062)

* Rename `batch_info` to `previous_batch_results`

* Exclude `previous_batch_results` from serialization of model node to avoid jinja context bloat

* Drop `previous_batch_results` key from `test_manifest.py` unit tests

In 4050e37 we began excluding
`previous_batch_results` from the serialized representation of the
ModelNode. As such, we no longer need to check for it in `test_manifest.py`.

(cherry picked from commit 0f084e1)

Co-authored-by: Quigley Malcolm <QMalcolm@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.9.latest cla:yes Skip Changelog Skips GHA to check for changelog file tidy_first "Tidy First" incremental cleanup changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants