Skip to content

Conversation

@cesarcoatl
Copy link
Member

@cesarcoatl cesarcoatl commented Jan 21, 2026

part of the kafka module

Summary by Sourcery

Extend Kafka polling APIs to support optional limits on record count and poll duration.

New Features:

  • Add optional sizeCutoff and timeoutMs parameters to pollPartition to control maximum records and poll timeout.
  • Add optional sizeCutoff and timeoutMs parameters to pollTopic to control maximum records and poll timeout.

Enhancements:

  • Update Kafka typings/stubs to reflect the new optional polling parameters for partition and topic consumers.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 21, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Extends the Kafka polling APIs to accept optional size and timeout controls, updating both the runtime implementations and their type stubs to keep signatures aligned for static checking and callers.

Class diagram for updated Kafka polling functions

classDiagram
    class kafka {
        +List~Any~ pollPartition(connector, topic, partition, offset, options, sizeCutoff, timeoutMs)
        +List~Any~ pollTopic(connector, topic, groupId, options, sizeCutoff, timeoutMs)
    }

    class pollPartitionParams {
        +connector: Union~str, unicode~
        +topic: Union~str, unicode~
        +partition: int
        +offset: Union~str, unicode~
        +options: Optional~Dict~Union~str, unicode~, Any~~
        +sizeCutoff: Optional~int~
        +timeoutMs: Optional~long~
    }

    class pollTopicParams {
        +connector: Union~str, unicode~
        +topic: Union~str, unicode~
        +groupId: Union~str, unicode~
        +options: Optional~Dict~Union~str, unicode~, Any~~
        +sizeCutoff: Optional~int~
        +timeoutMs: Optional~long~
    }

    kafka ..> pollPartitionParams : uses
    kafka ..> pollTopicParams : uses
Loading

File-Level Changes

Change Details Files
Extend pollPartition and pollTopic to accept optional size and timeout parameters and propagate them through the current placeholder implementations.
  • Add sizeCutoff and timeoutMs optional parameters to pollPartition and document their behavior in the docstring
  • Update the pollPartition body to include the new parameters in the debug print call
  • Add sizeCutoff and timeoutMs optional parameters to pollTopic and document their behavior in the docstring
  • Update the pollTopic body to include the new parameters in the debug print call
  • Mirror the new parameters and defaults in the kafka.pyi stub declarations for both pollPartition and pollTopic
src/system/kafka.py
stubs/stubs/system/kafka.pyi

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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@cesarcoatl cesarcoatl changed the title refactor(system): add arguments to pollPartition and pollTopic functions refactor(system): add arguments to pollPartition and pollTopic Jan 21, 2026
@cesarcoatl cesarcoatl enabled auto-merge (squash) January 21, 2026 01:23
@cesarcoatl cesarcoatl merged commit f0792f1 into 8.3 Jan 21, 2026
5 checks passed
@cesarcoatl cesarcoatl deleted the feat/system/kafka-pollPartition-pollTopic-add-args branch January 21, 2026 01:23
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