`Stream`

class tweepy.Stream(consumer_key, consumer_secret, access_token, access_token_secret, chunk_size=512, daemon=False, max_retries=inf, proxy=None, verify=True)

Filter realtime Tweets with Twitter API v1.1

Niezalecane od wersji 4.13: The Twitter API v1.1 streaming statuses/filter endpoint that Stream uses has a formal deprecation date of March 9, 2023.

Informacja

New Twitter Developer Apps created on or after April 29, 2022 will not be able to gain access to v1.1 statuses/filter, the Twitter API v1.1 endpoint that Stream uses. Twitter API v2 can be used instead with StreamingClient.

Zmienione w wersji 4.13: Removed sample, on_delete, on_scrub_geo, on_status_withheld, and on_user_withheld methods, as the Twitter API v1.1 statuses/sample endpoint and compliance messages on the Twitter API v1.1 statuses/filter endpoint have been retired

Parametry

consumer_key (str) – Twitter API Consumer Secret
consumer_secret (str) – Twitter API Consumer Secret
access_token (str) – Twitter API Access Token
access_token_secret (str) – Twitter API Access Token Secret
chunk_size (int) – Domyślny rozmiar socket.read. Domyślnie 512, mniej niż połowa rozmiaru Tweeta, tak aby odczytywać Tweety z minimalnym opóźnieniem 2 odczytów na Tweeta. Wartości wyższe niż ~1kb zwiększą opóźnienie przez oczekiwanie na więcej danych, ale mogą również zwiększyć przepustowość przez wykonanie mniejszej ilości wywołań socket read.
daemon (bool) – Czy używać wątku demona, gdy używany jest wątek do uruchomienia strumienia, czy nie
max_retries (int) – Maksymalna liczba ponownych prób połączenia strumienia
proxy (str | None) – URL proxy, który ma być użyty przy połączeniu do strumienia
verify (bool | str) – Albo boolean, kontrolujący czy zweryfikować certyfikat TLS serwera, albo string, w którym to przypadku musi to być ścieżka do pakietu CA, który ma zostać użyty.

running

Czy aktualnie działa strumień czy nie

Type: bool

session

Sesja Request używana do łączenia się ze strumieniem

Type: requests.Session

thread

Wątek używany do uruchomienia strumienia

Type: threading.Thread | None

user_agent

User agent używany podczas łączenia się ze strumieniem

Type: str

filter(*, follow=None, track=None, locations=None, filter_level=None, languages=None, stall_warnings=False, threaded=False)

Filtrowanie Tweetów w czasie rzeczywistym

Niezalecane od wersji 4.9: The delivery of compliance messages through the Twitter API v1.1 endpoint this method uses has been deprecated, and they will stop being delivered beginning October 29, 2022. Twitter API v2 can be used instead with StreamingClient.filter() and/or Client batch compliance methods.

Parametry

follow (list[int | str] | None) – ID użytkowników, wskazujące tych, dla których mają być zwracane statusy w strumieniu
track (list[str] | None) – Słowa kluczowe do śledzenia
locations (list[float] | None) – Określa zestaw ram ograniczających do śledzenia
filter_level (str | None) – Ustawienie tego parametru na jedną z wartości none, low lub medium ustawi minimalną wartość atrybutu filter_level Tweet wymaganą do uwzględnienia w strumieniu. Domyślną wartością jest none, która zawiera wszystkie dostępne Tweety. W przypadku wyświetlania strumienia Tweetów użytkownikom końcowym (np. dashboardy lub transmisje na żywo podczas prezentacji lub konferencji) sugerowane jest ustawienie tej wartości na medium.
languages (list[str] | None) – Ustawienie tego parametru na oddzieloną przecinkami listę identyfikatorów języków BCP 47 odpowiadających dowolnemu z języków wymienionych na stronie advanced search Twittera spowoduje zwrócenie tylko tweetów, które zostały wykryte jako napisane w podanych językach. Na przykład, połączenie z language=en spowoduje wyświetlenie tylko tweetów wykrytych jako napisane w języku angielskim.
stall_warnings (bool) – Określa, czy powinny być dostarczane ostrzeżenia o przeciągnięciu czy nie
threaded (bool) – Czy użyć wątku do uruchomienia strumienia czy nie

Wyrzuca

TweepyException – When the stream is already connected or when the number of location coordinates is not a multiple of 4

Zwraca

Wątek, jeśli threaded jest ustawiony na True, w przeciwnym razie None

Typ zwracany

threading.Thread | None

Odniesienia

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/filter-realtime/api-reference/post-statuses-filter

on_data(raw_data)

Metoda ta jest wywoływana, gdy ze strumienia są odbierane surowe dane. Zajmuje się ona wysyłaniem danych do innych metod w oparciu o typ wiadomości.

Parametry: raw_data (JSON) – Surowe danie z strumienia

Odniesienia

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/filter-realtime/guides/streaming-message-types

on_status(status)

Wywołane w momencie otrzymania statusu.

Parametry: status (Status) – Otrzymany status

on_disconnect_message(message)

Wywoływane, gdy zostanie odebrana wiadomość o rozłączeniu.

Parametry: message (JSON) – Wiadomość o rozłączeniu

on_limit(track)

Wywoływane w przypadku otrzymania zawiadomienia o przekroczeniu limitu.

Parametry: track (int) – Całkowita liczba niedostarczonych Tweetów od momentu otwarcia połączenia

on_warning(warning)

Wywoływane po otrzymaniu komunikatu ostrzegającego o utknięciu w martwym punkcie.

Parametry: warning (JSON) – Ostrzeżenie o utknięciu w martwym punkcie

disconnect(): Zamykanie strumienia

on_closed(response)

Jest to wywoływane, gdy strumień został zamknięty przez Twittera.``, else None.

Parametry: response (requests.Response) – Odpowiedź z Twittera

on_connect(): Wywoływane po pomyślnym połączeniu się z API strumieniowym.

on_connection_error(): Wywoływane, gdy połączenie strumieniowe ulegnie błędowi lub zostanie przerwane.

on_disconnect(): Wywoływane, gdy strumień się rozłączy.

on_exception(exception)

Jest to wywoływane, gdy wystąpi nieobsługiwany wyjątek.

Parametry: exception (Exception) – Nieobsługiwany wyjątek

on_keep_alive(): Wywoływane, gdy odbierany jest sygnał keep-alive.

on_request_error(status_code)

Wywoływane, gdy napotkany zostanie kod statusu HTTP inny niż-200.

Parametry: status_code (int) – Napotkany kod statusu HTTP

Stream

`Stream`