Python SDK: return details from stream, topic, and consumer group creation

オープン
#4,166 コメント 2 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@EthemKD がすでに取り組んでいます。

2026年9月14日 から。

評価

この issue はまだ評価されていません。

説明

good first issue python
Description

The Rust SDK returns the created resource details from these methods:

async fn create_stream(&self, name: &str)
    -> Result<StreamDetails, IggyError>;

async fn create_topic(
    &self,
    stream_id: &Identifier,
    name: &str,
    options: &TopicCreateOptions,
) -> Result<TopicDetails, IggyError>;

async fn create_consumer_group(
    &self,
    stream_id: &Identifier,
    topic_id: &Identifier,
    name: &str,
) -> Result<ConsumerGroupDetails, IggyError>;

The Python methods perform the creation successfully but discard these return values and resolve to None.

StreamDetails, TopicDetails, and ConsumerGroupDetails are already implemented and registered as Python classes, so no new wrapper types are required.

This covers B13, B17, and B21 of the Python SDK parity work tracked in #3893.

Affected area / component

Python SDK

Proposed solution
  • Change IggyClient.create_stream() to return StreamDetails.
  • Change IggyClient.create_topic() to return TopicDetails.
  • Change IggyClient.create_consumer_group() to return ConsumerGroupDetails.
  • Convert each Rust result through the existing From implementation instead of discarding it.
  • Update the method documentation and regenerate foreign/python/apache_iggy.pyi.
  • Extend the existing stream, topic, and consumer-group tests to assert that:
    • The returned type is the corresponding Details class.
    • The returned ID, name, and resource-specific fields match the created resource.
    • Fetching the resource afterward returns matching details.

This changes only successful return values; existing arguments and error behavior remain unchanged.

Alternatives considered

Keep returning None and require a second get_* request. This adds an unnecessary round trip and remains inconsistent with the Rust API.

Contribution
  • I'm willing to submit a pull request to implement this feature
Good first issue
  • I think this could be a good first issue for a new contributor
主要言語
Rust
スター
5.2k
フォーク
502
平均マージ
3日 4時間
マージ済み PR(30日)
157

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

apache/iggy のほかの issue

apache/iggy の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。