make api more consistent with other clients #175
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit is an attempt to make the api of this client more closely match the api of nats clients in other languages. Below is a non exhaustive list of the changes made. - Return subscriptions from `subscribe()` instead of a subscription id - Allow iterating over messages in subscription with `async for`. To use, don't specify a callback when subscribing - Move `unsubscribe()` and `drain(sid=sid)` to the subscription class - Remove `publish_request()`, `publish()` now has a `reply` kwarg - Remove `auto_unsubscribe()`, `subscribe()` already had a kwarg for this - Remove support for executing synchronous callbacks - Remove `subscribe_async()` - Remove `is_async` kwarg from `subscribe()` - Remove support for executing callbacks as tasks - Remove multiple response functionality from `request()` - Remove `timed_request()`, name is very misleading as all requests are timed. This was really old style requests, moved to a kwarg of `request()` called `old_style` - Made connection context manager async - Various internal code reoganizations - Various doc cleanups - Cleaned up example code
wallyqs
approved these changes
Sep 22, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a lot of breaking changes, so let me know if you're opposed to any of them.
This commit is an attempt to make the api of this client more closely
match the api of nats clients in other languages. Below is a non
exhaustive list of the changes made.
subscribe()instead of a subscription idasync for. To use, don't specify a callback when subscribingunsubscribe()anddrain(sid=sid)to the subscription classpublish_request(),publish()now has areplykwargauto_unsubscribe(),subscribe()already had a kwarg for thissubscribe_async()is_asynckwarg fromsubscribe()request()timed_request(), name is very misleading as all requests are timed. This was really old style requests, moved to a kwarg ofrequest()calledold_style@wallyqs @charliestrawn