Add support for asyncio

[wrobell]

It would be great if Tweepy integrated with asyncio. For example, to get data using a stream we would use something like

stream = AsyncStream(auth_handler)
...
data = await stream.filter(track=['python', 'tweepy', 'asyncio'])  # or "yield from"

[Harmon758]

The blocking issue for this has been Python 2 support, and with #1253, I'd like to plan to integrate support for asyncio in v4.0, especially for streams.

[Harmon758]

I've created an async-streaming branch and draft PR #1491 that adds support for asynchronous streaming with asyncio.
Any testing and/or feedback would be appreciated.

[Harmon758]

The async-streaming branch / pull request #1491 should be complete now.
Any feedback or review would be appreciated.

[Harmon758]

The documentation for streaming can be found at https://docs.tweepy.org/en/v3.10.0/streaming_how_to.html for v3.10.
For the latest development version on the master branch, it can be found at https://docs.tweepy.org/en/latest/stream.html and https://docs.tweepy.org/en/latest/asyncstream.html.

AsyncStream is asynchronous. This means that AsyncStream.filter will not block, so that is as intended.

As for it not actually streaming, you need to have a running event loop for the task to execute. I don't think this will be changed, as adding handling for the event loop within AsyncStream.filter and AsyncStream.sample adds unnecessary complexity that is more likely to cause unexpected behavior than provide useful functionality. I'm not really sure what you mean by "with tweepy pro that needed it to be asynchronous" and what your use case is, but in place of the code you've shown as is, you can simply use a normal (non-asynchronous) Stream. Otherwise, it's not too complicated to manage the event loop yourself.

Also, once support for Python 3.6 is dropped and bd0b403 is reverted, this should raise a RuntimeError, saying "no running event loop".

For code block usage, see https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks.

[Harmon758]

Like I said, I'm not really sure what "tweepy pro" is referring to here.
If you're referring to the tweepy.asynchronous subpackage added with #1491, that's now been merged into the latest development version on the master branch.

[Harmon758]

I'm going to push non-streaming support for asyncio (for API and Client) back to a v4.x release.
I want to get v4.0 out already, as there's already a ton of changes, including support for Twitter API v2.

[Harmon758]

v4.0.0 (#1666) has now been released with support for asynchronous streaming 🎉

[Harmon758]

asynchronous.AsyncClient has been added with 0aadd53.

[Harmon758]

asynchronous.AsyncStreamingClient has been added with 9051ba6.

[JDJGInc]

👍

[Harmon758]

v4.10.0 (#1901) has now been released with asynchronous support for Twitter API v2 🎉

I don't have a clear plan for an asynchronous version of API yet, as the non-asynchronous version still uses a good deal of legacy cruft (mainly in the way of models) that I'd prefer not to have to mimic in a new interface.

[JDJGInc]

it seems to work from where I have used it, thank you for having it :)

[BjoernPetersen]

Is there already a Paginator class to use with the AsyncClient? I guess that may deserve a separate issue...

[Harmon758]

asynchronous.AsyncPaginator has been added with 33e444a.

[ghost]

Is there still a plan around an Async API?