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

Abierto
  • ¿Algo no está bien?
#4,166 2 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@EthemKD ya está trabajando en esto.

Desde el 14/9/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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
Lenguaje dominante
Rust
Estrellas
5.2k
Forks
502
Merge medio
3 d 5 h
PR fusionados (30 d)
152

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apache/iggy

Todos los issues de apache/iggy

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.