Skip to content

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

Description

@jiengup

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

good first issueGood for newcomerspythonPull requests that update Python code

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions