[PR]
StreamingClient
- class tweepy.StreamingClient(bearer_token, *, return_type=Response, wait_on_rate_limit=False, chunk_size=512, daemon=False, max_retries=inf, proxy=None, verify=True)
Filter and sample realtime Tweets with Twitter API v2
バージョン 4.6 で追加.
- パラメータ:
bearer_token (str) -- Twitter API Bearer Token
return_type (type[dict | requests.Response | Response]) -- Type to return from requests to the API
wait_on_rate_limit (bool) -- Whether or not to wait before retrying when a rate limit is encountered. This applies to requests besides those that connect to a stream (see
max_retries).chunk_size (int) -- The default socket.read size. Default to 512, less than half the size of a Tweet so that it reads Tweets with the minimal latency of 2 reads per Tweet. Values higher than ~1kb will increase latency by waiting for more data to arrive but may also increase throughput by doing fewer socket read calls.
daemon (bool) -- Whether or not to use a daemon thread when using a thread to run the stream
max_retries (int) -- Max number of times to retry connecting the stream
proxy (str | None) -- URL of the proxy to use when connecting to the stream
verify (bool | str) -- Either a boolean, in which case it controls whether to verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use.
- session
Requests Session used to connect to the stream
- Type:
- thread
Thread used to run the stream
- Type:
threading.Thread| None
- add_rules(add, *, dry_run)
Add rules to filtered stream.
- パラメータ:
add (list[StreamRule] | StreamRule) -- Specifies the operation you want to perform on the rules.
dry_run (bool) -- Set to true to test the syntax of your rule without submitting it. This is useful if you want to check the syntax of a rule before removing one or more of your existing rules.
- 戻り値の型:
参照
- delete_rules(ids, *, dry_run)
Delete rules from filtered stream.
- パラメータ:
ids (int | str | list[int | str | StreamRule] | StreamRule) -- Array of rule IDs, each one representing a rule already active in your stream. IDs must be submitted as strings.
dry_run (bool) -- Set to true to test the syntax of your rule without submitting it. This is useful if you want to check the syntax of a rule before removing one or more of your existing rules.
- 戻り値の型:
参照
- filter(*, backfill_minutes=None, expansions=None, media_fields=None, place_fields=None, poll_fields=None, tweet_fields=None, user_fields=None, threaded=False)
Streams Tweets in real-time based on a specific set of filter rules.
If you are using the academic research product track, you can connect up to two redundant connections to maximize your streaming up-time.
The Tweets returned by this endpoint count towards the Project-level Tweet cap.
- パラメータ:
backfill_minutes (int | None) --
By passing this parameter, you can request up to five (5) minutes worth of streaming data that you might have missed during a disconnection to be delivered to you upon reconnection. The backfilled Tweets will automatically flow through the reconnected stream, with older Tweets generally being delivered before any newly matching Tweets. You must include a whole number between 1 and 5 as the value to this parameter.
This feature will deliver duplicate Tweets, meaning that if you were disconnected for 90 seconds, and you requested two minutes of backfill, you will receive 30 seconds worth of duplicate Tweets. Due to this, you should make sure your system is tolerant of duplicate data.
This feature is currently only available to the Academic Research product track.
expansions (list[str] | str) -- expansions
media_fields (list[str] | str) -- media_fields
place_fields (list[str] | str) -- place_fields
poll_fields (list[str] | str) -- poll_fields
tweet_fields (list[str] | str) -- tweet_fields
user_fields (list[str] | str) -- user_fields
threaded (bool) -- Whether or not to use a thread to run the stream
- 例外:
TweepyException -- When the stream is already connected
- 戻り値:
The thread if
threadedis set toTrue, elseNone- 戻り値の型:
threading.Thread | None
参照
- get_rules(*, ids)
Return a list of rules currently active on the streaming endpoint, either as a list or individually.
- パラメータ:
ids (list[str] | str) -- Comma-separated list of rule IDs. If omitted, all rules are returned.
- 戻り値の型:
参照
- sample(*, backfill_minutes=None, expansions=None, media_fields=None, place_fields=None, poll_fields=None, tweet_fields=None, user_fields=None, threaded=False)
Streams about 1% of all Tweets in real-time.
If you are using the academic research product track, you can connect up to two redundant connections to maximize your streaming up-time.
- パラメータ:
backfill_minutes (int | None) --
By passing this parameter, you can request up to five (5) minutes worth of streaming data that you might have missed during a disconnection to be delivered to you upon reconnection. The backfilled Tweets will automatically flow through the reconnected stream, with older Tweets generally being delivered before any newly matching Tweets. You must include a whole number between 1 and 5 as the value to this parameter.
This feature will deliver duplicate Tweets, meaning that if you were disconnected for 90 seconds, and you requested two minutes of backfill, you will receive 30 seconds worth of duplicate Tweets. Due to this, you should make sure your system is tolerant of duplicate data.
This feature is currently only available to the Academic Research product track.
expansions (list[str] | str) -- expansions
media_fields (list[str] | str) -- media_fields
place_fields (list[str] | str) -- place_fields
poll_fields (list[str] | str) -- poll_fields
tweet_fields (list[str] | str) -- tweet_fields
user_fields (list[str] | str) -- user_fields
threaded (bool) -- Whether or not to use a thread to run the stream
- 例外:
TweepyException -- When the stream is already connected
- 戻り値:
The thread if
threadedis set toTrue, elseNone- 戻り値の型:
threading.Thread | None
参照
- on_data(raw_data)
This is called when raw data is received from the stream. This method handles sending the data to other methods.
- パラメータ:
raw_data (JSON) -- The raw data from the stream
参照
- on_tweet(tweet)
This is called when a Tweet is received.
- パラメータ:
tweet (Tweet) -- The Tweet received
- on_includes(includes)
This is called when includes are received.
- パラメータ:
includes (dict) -- The includes received
- on_errors(errors)
This is called when errors are received.
- パラメータ:
errors (dict) -- The errors received
- on_matching_rules(matching_rules)
This is called when matching rules are received.
- パラメータ:
matching_rules (list[StreamRule]) -- The matching rules received
- on_response(response)
This is called when a response is received.
- パラメータ:
response (StreamResponse) -- The response received
- disconnect()
Disconnect the stream
- on_closed(response)
This is called when the stream has been closed by Twitter.
- パラメータ:
response (requests.Response) -- The Response from Twitter
- on_connect()
This is called after successfully connecting to the streaming API.
- on_connection_error()
This is called when the stream connection errors or times out.
- on_disconnect()
This is called when the stream has disconnected.
- on_exception(exception)
This is called when an unhandled exception occurs.
- パラメータ:
exception (Exception) -- The unhandled exception
- on_keep_alive()
This is called when a keep-alive signal is received.