Skip to content

[Python] Document the import-time default of PeriodicImpulse start_timestamp - #40599

Merged
tvalentyn merged 1 commit into
apache:masterfrom
raams95:docs-default-start-timestamp-import-time
Oct 16, 2026
Merged

tvalentyn merged 1 commit into
apache:masterfrom
raams95:docs-default-start-timestamp-import-time

Conversation

@raams95

@raams95 raams95 commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

Fixes #40564

As discussed in #40565, the default start_timestamp of PeriodicImpulse (and MatchContinuously, which passes it through) stays as is, but the docstrings didn't say that the default is evaluated once at module import time. This updates both docstrings to say so, and points to passing an explicit timestamp or using rebase to start relative to pipeline execution.

Docstring-only change, so no CHANGES.md entry.


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 or fixes #456).
  • Update CHANGES.md with noteworthy changes. (Not needed, docstring-only.)
  • If this contribution is large, please file an Apache Individual Contributor License Agreement. (Not needed, small change.)

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

…mestamp

The default start_timestamp of PeriodicImpulse and MatchContinuously is
evaluated once, when the module is imported. As discussed in apache#40565 the
default stays as is, so document it and point to an explicit timestamp
or rebase for starting relative to pipeline execution.

Fixes apache#40564

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📋 Review Summary

This PR updates the docstrings for PeriodicImpulse and MatchContinuously to clarify that the default start_timestamp (Timestamp.now()) is evaluated once at module import time rather than when the transform is instantiated or the pipeline starts. It also guides users toward passing an explicit timestamp or using rebase when relative execution timing is desired.

🔍 General Feedback

  • The documentation additions are clear, accurate, and adhere to the formatting conventions and line lengths of both files.

💡 Tip: Comment /gemini review on this pull request to trigger a new Gemini code review.

@codecov

codecov Bot commented Oct 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.90%. Comparing base (76f6e6d) to head (594846d).
⚠️ Report is 178 commits behind head on master.

Additional details and impacted files
@@              Coverage Diff              @@
##             master   #40599       +/-   ##
=============================================
+ Coverage     56.16%   79.90%   +23.73%     
=============================================
  Files          1124      488      -636     
  Lines        178336    82384    -95952     
  Branches       1489        0     -1489     
=============================================
- Hits         100170    65830    -34340     
+ Misses        75645    16554    -59091     
+ Partials       2521        0     -2521     
Flag Coverage Δ
go ?
java ?
python 79.90% <ø> (+0.34%) ⬆️

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

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @tvalentyn for label python.
Backup reviewer: shunping (if the main reviewer is unresponsive, you can escalate to them by tagging their username)

This pull request likely touches a core component ("core" label). Please review with scrutiny.

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

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).

@tvalentyn
tvalentyn merged commit 964d15b into apache:master Oct 16, 2026
85 of 86 checks passed
@tvalentyn

Copy link
Copy Markdown
Contributor

thanks!

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.

[Bug]: PeriodicImpulse and MatchContinuously default start_timestamp is the module import time

2 participants