python: Add metadata to log() #232
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gasmith
reviewed
Feb 21, 2025
Comment on lines
+77
to
+79
| log_time: Optional[int] = None, | ||
| publish_time: Optional[int] = None, | ||
| sequence: Optional[int] = None, |
There was a problem hiding this comment.
For typed channels, we have log(bytes) and log_with_meta(bytes, PartialMetadata). We should be consistent.
FWIW, I prefer the style in this PR, or passing in metadata as optional kwargs. We could get rid of PartialMetadata from the python API.
There was a problem hiding this comment.
We can either merge it into your branch, or merge it to main separately, or even discard it, as folks prefer.
There was a problem hiding this comment.
Passing a metadata struct works in Rust, because it's a zero-cost abstraction. In Python it's clunky and it involves an allocation.
gasmith
approved these changes
Feb 21, 2025
This is built on top of @amacneil's #232, and we can either merge it into that PR branch, or merge it to main separately. The idea is to make typed channels consistent with raw channels by removing `log_with_meta` and adding keyword-only arguments to `log` for timestamps and sequence. Fixes: FG-10468
amacneil
changed the title
amacneil
changed the title
amacneil
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog
None
Docs
None
Description
Added
log()kwargs to acceptlog_time,publish_time,sequence(python: Use kwargs for metadata on typed channels #234)Remove
log_with_meta()from python API in favor oflog()