tweepy.Stream — Odniesienia do przesyłania strumieniowego

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

Filtrowanie i samplowanie Tweetów w czasie rzeczywistym

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 (Optional[str]) – URL proxy, który ma być użyty przy połączeniu do strumienia

  • verify (Union[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

Opcjonalna[requests.Session]

thread

Wątek używany do uruchomienia strumienia

Type

Opcjonalna[threading.Thread]

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

Parametry

  • follow (Optional[List[Union[int, str]]]) – ID użytkowników, wskazujące tych, dla których mają być zwracane statusy w strumieniu

  • track (Optional[List[str]]) – Słowa kluczowe do śledzenia

  • locations (Optional[List[float]]) – Określa zestaw ram ograniczających do śledzenia

  • filter_level (Optional[str]) – 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 (Optional[List[str]]) – 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 – Gdy liczba współrzędnych lokalizacji nie jest wielokrotnością 4

Zwraca

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

Typ zwracany

Optional[threading.Thread]

Odniesienia

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

sample(*, languages=None, stall_warnings=False, threaded=False)

Samplowanie Tweetów w czasie rzeczywistym

Parametry

  • languages (Optional[List[str]]) – 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

Zwraca

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

Typ zwracany

Optional[threading.Thread]

Odniesienia

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

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

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_delete(status_id, user_id)

Wywoływane w przypadku otrzymania powiadomienia o usunięciu statusu.

Parametry

  • status_id (int) – ID usuniętego Tweeta

  • user_id (int) – ID autora usuniętego Tweeta

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_scrub_geo(notice)

Wywoływana w przypadku otrzymania powiadomienia o usunięciu lokalizacji.

Parametry

notice (JSON) – Informacja o usunięciu lokacji

on_status_withheld(notice)

Wywoływane w przypadku otrzymania powiadomienia o treści wstrzymanej.

Parametry

notice (JSON) – Status wstrzymania zawiadomienia o treści

on_user_withheld(notice)

Wywoływane po otrzymaniu powiadomienia o wstrzymaniu zawartości przez użytkownika.

Parametry

notice (JSON) – Wstrzymanie zawartości przez użytkownika

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