💡 Add overload for of method to support generator streams

[garlontas]

This pull request adds context for how generators are handled by default in streams. Parallel streams with infinite generators are not supported.

Enhancements to stream creation:

• pystreamapi/__stream.py: Added an overloaded static method of(source: Generator[_K, Any, Any]) -> NumericBaseStream to allow creating numeric streams from generators. This provides a more specialized and sequential stream implementation for generator-based sources.

Summary by Sourcery

New Features:

• Add overloaded Stream.of() to accept generators and produce NumericBaseStream for sequential processing.

[sourcery-ai]

Reviewer's Guide

Introduces a new overloaded static of method to support generator-based numeric streams with sequential behavior, clarifying that parallel streams with infinite generators are unsupported.

Sequence Diagram: Stream Creation using Stream.of() with a Generator

sequenceDiagram
    actor Developer
    participant StreamClass as "Stream"

    Developer->>StreamClass: of(myGenerator: Generator)
    activate StreamClass
    StreamClass-->>Developer: new NumericBaseStream
    deactivate StreamClass

Loading

Class Diagram: New Stream.of() Overload for Generators

classDiagram
  class Stream {
    +of(source: Iterable~_K~): BaseStream~_K~$
    +of(source: Generator~_K, Any, Any~): NumericBaseStream$
  }

Loading

File-Level Changes

Change	Details	Files
Add overloaded of method for generator sources returning NumericBaseStream	Added @overload decorator on the new static of method Defined method signature of(source: Generator[_K, Any, Any]) -> NumericBaseStream Included docstring explaining sequential stream implementation and usage notes Noted lack of support for parallel streams with infinite generators	pystreamapi/__stream.py

Possibly linked issues

• #123: The PR adds an overload for Stream.of for generators, fixing the eager consumption issue.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @garlontas - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

• Overload stub needs a body placeholder (link)

Here's what I looked at during the review

• 🔴 General issues: 1 blocking issue
• 🟢 Testing: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}