Skip to content

Python examples to use IObase IOs sinks in streaming (and batch) - #35811

Merged
damccorm merged 11 commits into
apache:masterfrom
razvanculea:iobase_sinks_examples
Oct 6, 2025
Merged

Python examples to use IObase IOs sinks in streaming (and batch)#35811
damccorm merged 11 commits into
apache:masterfrom
razvanculea:iobase_sinks_examples

Conversation

@razvanculea

Copy link
Copy Markdown
Contributor

IObased IOs now support streaming.
Some examples to use TextIO, AvroIO, ParquetIO, TFRecordsIO in streaming with TestStream or PeriodicImpulse as source.

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 or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist gemini-code-assist 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.

Summary of Changes

Hello @razvanculea, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've reviewed this pull request, which introduces new Python examples to demonstrate the use of IObase IO sinks for both streaming and batch data processing within Apache Beam. The examples showcase how to write data to various formats like TextIO, AvroIO, ParquetIO, and TFRecordsIO, utilizing TestStream and PeriodicImpulse as data sources for the streaming scenarios.

Highlights

  • Streaming IO Examples: Added new Python examples demonstrating how to write unbounded PCollections to various IObase IO sinks (TextIO, FileIO, ParquetIO, AvroIO, TFRecordIO) in streaming mode.
  • Batch IO Examples: Included new Python examples for writing bounded PCollections to TextIO, FileIO, and ParquetIO in batch processing mode.
  • Data Generation: Introduced generate_event.py to create a GenerateEvent PTransform using TestStream for simulating unbounded data streams, and test_periodicimpulse.py for using PeriodicImpulse as a source.
  • IO Sink Coverage: Provided comprehensive examples covering WriteToText, WriteToFiles, WriteToParquet (including batched and windowed writes), WriteToAvro, and WriteToTFRecord for different processing paradigms.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions

github-actions Bot commented Aug 7, 2025

Copy link
Copy Markdown
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@github-actions

github-actions Bot commented Aug 8, 2025

Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @claudevdm for label python.

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

@razvanculea

Copy link
Copy Markdown
Contributor Author

assign to @shunping

@github-actions

Copy link
Copy Markdown
Contributor

Reminder, please take a look at this pr: @claudevdm

@github-actions

Copy link
Copy Markdown
Contributor

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @damccorm 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)

@damccorm damccorm 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.

Thanks - mostly LGTM, just had some doc suggestions

Comment thread sdks/python/apache_beam/examples/iobase_sinks/__init__.py
Comment thread sdks/python/apache_beam/examples/iobase_sinks/generate_event.py
Comment thread sdks/python/apache_beam/examples/iobase_sinks/test_write_bounded.py Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Reminder, please take a look at this pr: @damccorm

@damccorm

Copy link
Copy Markdown
Contributor

waiting on author

…or users).

add folder README
add mode comments per damccorm comments.

class GenerateEvent(beam.PTransform):
"""This class simulates streaming data.
It leverages [TestStream](https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/testing/TestStream.html),

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.

line to long

@stankiewicz

Copy link
Copy Markdown
Contributor

Running pylint...
************* Module apache_beam.examples.sinks.generate_event
apache_beam/examples/sinks/generate_event.py:27:0: C0301: Line too long (122/80) (line-too-long)

@razvanculea

Copy link
Copy Markdown
Contributor Author

@damccorm only unrelated tests are flaky, this can be merged

@damccorm damccorm 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.

Thanks!

@damccorm
damccorm merged commit 09aa10c into apache:master Oct 6, 2025
95 of 100 checks passed
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.

3 participants