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

Aperta
  • Qualcosa non va?
#4,166 2 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@EthemKD ci sta già lavorando.

Dal 14/9/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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
Lingua principale
Rust
Stelle
5.2k
Fork
502
Merge medio
3g 8h
PR unite (30g)
146

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di apache/iggy

Tutte le issue di apache/iggy

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.