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

feat: Add support for key-value pair IR format serialization and deserialization. #86

Merged
merged 108 commits into from
Nov 16, 2024

Conversation

LinZhihao-723
Copy link
Member

@LinZhihao-723 LinZhihao-723 commented Nov 10, 2024

References

Description

This PR adds support for key-value pair IR format serialization and deserialization:

  • Serializer for IR serialization
  • Deserializer for IR deserialization
  • KeyValuePairLogEvent for storing deserialized log events

Validation performed

  • Add unit tests to cover newly introduced classes
  • Ensure workflow builds successfully
  • Run Debug build in Python 3.10 debug build + address sanitizer, ensure no errors/warnings caused by our implementation

":param buffer_size_limit: Threshold of how much serialized data to buffer before flushing"
" it to `output_stream`. Defaults to 64 KiB.\n"
":type buffer_size_limit: int\n"
":rtype: int\n"
Copy link
Member

Choose a reason for hiding this comment

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

Leaving a comment so I remember to check this.

src/clp_ffi_py/ir/native/PySerializer.cpp Outdated Show resolved Hide resolved
src/clp_ffi_py/ir/native/PySerializer.cpp Outdated Show resolved Hide resolved
":param allow_incomplete_stream: If set to `True`, an incomplete CLP IR stream is not"
" treated as an error.\n"
":type allow_incomplete_stream: bool\n"
":rtype: int\n"
Copy link
Member

Choose a reason for hiding this comment

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

Note to self

Copy link
Member

@kirkrodrigues kirkrodrigues left a comment

Choose a reason for hiding this comment

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

Approving only the docstrings for Serializer, Deserializer, and KeyValuePairLogEvent.

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.

2 participants