pywykop3.api module

exception pywykop3.api.ApiException(code: int, api_msg: str)

This exception is raised by WykopAPI when code of request is other than 2xx. Exception has 2 additional attributes:

• stacode - response code of request

• api_msg - message

class pywykop3.api.WykopAPI(connector: WykopConnector | None = None, key: str | None = None, secret: str | None = None, refresh_token: str | None = None)

Main interface to communicate with Wykop You need to provide

• connector

OR

• key

• secret

OR

• refresh token

If you pass key and secret, Wykop will provide information as for non-logged in users. If you refresh_token, Wykop will provide information as for logged in users.

Parameters:

• connector (WykopConnector | None, optional) – Connector object. Can be safely ignored. Defaults to None.

• key (str | None, optional) – Key. Defaults to None.

• secret (str | None, optional) – Secret. Defaults to None.

• refresh_token (str | None, optional) – Refresh token. To obtain it, see connect() method. Defaults to None.

connect() → str

Istnieje możliwość zalogowania użytkownika przy użyciu WykopConnect. Aplikacja która próbuje zalogować użytkownika powinna posiadać odpowiednie uprawnienia nadane przez administratora.

delete_entry_by_id(entry_id: int) → None

Usuwanie wpisu. Autor może zawsze usunąć własny wpis.

Parameters:

entry_id (int) – Identyfikator wpisu

delete_entry_comment(entry_id: int, comment_id: int) → None

Usuwanie komentarza Autor komentarza może go usunąć 15 minut od daty dodania lub autor wpisu przez cały czas.

Parameters:

• entry_id (int) – Identyfikator wpisu

• comment_id (int) – Identyfikator komentarza

delete_entry_comment_vote(entry_id: int, comment_id: int) → None

Cofnięcie głosu na komentarz

Parameters:

• entry_id (int) – Identyfikator wpisu

• comment_id (int) – Identyfikator komentarza

delete_entry_vote(entry_id: str) → None

Cofnięcie głosu na wpis

Parameters:

entry_id (str) – Identyfikator wpisu

delete_media_photo(photo_key: str) → None

Usunięcie pliku Właściciel pliku posiada możliwość jego usunięcia z serwera.

Parameters:

photo_key (str) – Identyfikator pliku

delete_tag_user(tag_name: str, username: str) → None

Usuwanie współautora tagu (głównego dodaje moderator)

Parameters:

• tag_name (str) – Nazwa tagu

• username (str) – Nazwa użytkownika

get_entries(sort: str = 'hot', last_update: int = 12, page_count: int = 1, page: int | str | None = None, category: str | None = None, bucket: str | None = None) → List[Entry]

Zwraca wpisy z mikrobloga. UWAGA: Parametr page przyjmuje dla użytkowników niezalogowanych int z numerem strony, a dla zalogowanych hash strony. UWAGA2: Standardowa paginacja jest dostępna tylko dla użytkowników niezalogowanych. Paginacja dla użytkowników zalogowanych będzie zwracać hash next dla następnej strony i prev dla poprzedniej.

Parameters:

• sort (str, optional) – Rodzaj sortowania. Available values : newest, active, hot. Defaults to “hot”.

• last_update (int, optional) – Pokaż wyniki z ostatnich godzin [1, 2, 3, 6, 12, 24]. Filtr dostępny tylko wraz z filtrem gorące. Defaults to 12.

• page_count (int, optional) – Liczba stron do pobrania. Podaj -1, żeby pobrać wszystko. Defaults to 1.

• page (int | str | None, optional) – Numer strony do pobrania. Defaults to None.

• category (str | None, optional) – Kategoria. Defaults to None.

• bucket (str | None, optional) – Hash kategorii użytkownika. Defaults to None.

Returns:

Wpisy z mikrobloga.

Return type:

List

get_entries_newer(entry_id: int, category: str | None = None) → int

Zwraca liczbę nowszych wpisów.

Parameters:

• entry_id (int) – Identyfikator wpisu

• category (str | None, optional) – Kategoria. Defaults to None.

Returns:

Liczba nowszych wpisów.

Return type:

int

get_entry_by_id(entry_id: int) → Entry

Zwraca wpisz z mikrobloga.

Parameters:

entry_id (int) – Identyfikator wpisu

Returns:

Wpis z mikrobloga

Return type:

Dict

get_entry_comment(entry_id: int, comment_id: int) → Comment

Zwraca komentarz z mikroblogu.

Parameters:

• entry_id (int) – Identyfikator wpisu

• comment_id (int) – Identyfikator komentarza

Returns:

Komentarz z mikroblogu

Return type:

Comment

get_entry_comment_votes(entry_id: int, comment_id: int) → List[User]

Pobiera użytkowników którzy głosowali na komentarz z mikroblogu.

Parameters:

• entry_id (int) – Identyfikator wpisu

• comment_id (int) – Identyfikator komentarza

Returns:

Lista głosujących użytkowników

Return type:

List[User]

get_entry_comments(entry_id: int, page: int = 1, page_count: int = 1) → List[Comment]

Lista komentarzy do wpisu z mikrobloga

Parameters:

• entry_id (int) – Identyfikator wpisu

• page (int, optional) – Numer strony do pobrania. Defaults to 1.

• page_count (int, optional) – Liczba stron do pobrania. Podaj -1, żeby pobrać wszystko. Defaults to 1.

Returns:

_description_

Return type:

List[Comment]

get_entry_votes(entry_id: int) → List[User]

Pobiera nazwy użytkowników którzy głosowali na wpis z mikrobloga.

Parameters:

entry_id (int) – Identyfikator wpisu

Returns:

Lista użytkowników, który oddali głos.

Return type:

List

get_tag(tag_name: str) → Dict

get_tag_newer(tag_name: str, type_of_content: str = 'all', sort: str = 'best', date: datetime | None = None, obj_id: str | None = None) → int

Zwraca informację, czy są wpisy, linki w tagu

Parameters:

• tag_name (str) – Nazwa tagu

• type_of_content (str, optional) – Rodzaj. Available values : “all”,

• "author"

• "link"

• "all". ("entry". Defaults to)

• sort (str, optional) – Rodzaj sortowania. Available values : “all”,

• "best". ("best". Defaults to)

• date (datetime | None, optional) – Data, od której sprawdzamy, czy

• None. (wpisu lub znaleziska. Defaults to)

• obj_id (str | None, optional) – Identyfikator ostatniego widzianego

• None.

Returns:

Licznik nowych obiektów

Return type:

int

get_tag_stream(tag_name: str, page: int | str | None = None, sort: str = 'best', type_of_content: str = 'all', year: int | None = None, month: int | None = None, page_count: int = 1) → List

Zwraca pełną liste wpisów i znalezisk z konkretnego tagu

UWAGA: Parametr page przyjmuje dla użytkowników niezalogowanych int z numerem strony, a dla zalogowanych hash strony.

UWAGA2: Standardowa paginacja jest dostępna tylko dla użytkowników niezalogowanych. Paginacja dla użytkowników zalogowanych będzie zwracać hash next dla następnej strony i prev dla poprzedniej.

Parameters:

• tag_name (str) – Nazwa tagu

• page (int | str| None) – Numer strony do pobrania. Defaults to None.

• sort (str, optional) – Rodzaj sortowania. Available values : “all”,

• "best". ("best". Defaults to)

• type_of_content (str, optional) – Rodzaj. Available values : “all”,

• "author"

• "link"

• "all". ("entry". Defaults to)

• year (int | None, optional) – Rok. Defaults to None.

• month (int | None, optional) – Miesiąc. Defaults to None.

• page_count (int, optional) – Liczba stron do pobrania.

• -1 (Podaj)

• 1. (żeby pobrać wszystko. Defaults to)

Returns:

Lista wpisów i znalezisk

Return type:

List

get_tag_users(tag_name: str) → List

Lista autorów tagu autorskiego

Parameters:

tag_name (str) – Nazwa tagu

Returns:

Kolekcja autorów tagu (short profile)

Return type:

List

get_tags_autocomplete(query: str) → List

Podpowiada tagi.

Parameters:

query (str) – Zapytanie

Returns:

Kolekcja wyszukanych tagów (max do 10 wyników)

Return type:

List

get_tags_popular() → List

Zwraca listę popularnych tagów.

Returns:

Lista tagów

Return type:

List

get_tags_popular_user_tags() → List

Zwraca listę popularnych tagów autorskich.

Returns:

Kolekcja popularnych tagów autorskich (max do 10 wyników)

Return type:

List

get_tags_related(tag_name: str) → List

Powiązane tagi

Parameters:

tag_name (str) – Nazwa tagu

Returns:

Kolekcja powiązanych tagów (max do 10 wyników)

Return type:

List

get_users_autocomplete(query: str) → List

Podpowiada użytkowników po nickname

Parameters:

query (str) – Zapytanie

Returns:

Kolekcja wyszukanych użytkowników

Return type:

List

post_entry(content: str, photo: str | None = None, embed: str | None = None, survey: str | None = None, adult: bool = False) → Entry

Dodawanie nowego wpisu na mikroblogu

Parameters:

• content (str) – Treść własna użytkownika.

• photo (str | None, optional) – Załącznik użytkownika. W celu dodania należy podać “key” pliku z media/photo. Akceptowane są tylko pliki przesłane jako typ comments. Defaults to None.

• embed (str | None, optional) – Unikatowy identyfikator embed. Defaults to None.

• survey (str | None, optional) – Ankieta użytkownika. W celu dodania należy podać Indentyfikator. Defaults to None.

• adult (bool, optional) – Wpis tylko dla dorosłych. Defaults to False.

Returns:

Dodany wpis

Return type:

Dict

post_entry_comment(entry_id: int, content: str, embed: str | None = None, photo: str | None = None, adult: bool = False) → Comment

Dodawanie nowego komentarza do wpisu na mikroblogu

Parameters:

• entry_id (int) – Identyfikator wpisu

• content (str) – Treść własna użytkownika. Treść może być pusta w przypadku dodania innych multimediów. W przypadku samej treści musi zawierać min. 5 znaków.

• embed (str | None, optional) – Unikatowy identyfikator pliku. Defaults to None.

• photo (str | None, optional) – Załącznik użytkownika. W celu dodania należy podać “key” pliku z media/photo. Akceptowane są tylko pliki przesłane jako typ comments. Defaults to None.

• adult (bool, optional) – Komentarz tylko dla dorosłych. Defaults to False.

Returns:

Dodany komentarz

Return type:

Comment

post_entry_comment_vote(entry_id: int, comment_id: int) → None

Głosowanie na wpis

Parameters:

• entry_id (int) – Identyfikator wpisu

• comment_id (int) – Identyfikator komentarza

post_entry_vote(entry_id: int) → None

Głosowanie na wpis

Parameters:

entry_id (int) – Identyfikator wpisu

post_media_photo(media_type: str, photo: bytes, photo_name: str, photo_type: str) → Photo

Wgrywanie nowego pliku na serwer Dozwolone jest wgrywanie multimedialnych plików o następujących mimetype: ‘image/jpeg’, ‘image/jpg’, ‘image/pjpeg’, ‘image/gif’, ‘image/png’, ‘image/x-png’. Maksymalny rozmiar pliku to 10 MB.

Parameters:

• media_type (str) – Nazwa obszaru z plikami na serwerze [settings, comments, links, content]

• photo (bytes) – Plik do wysłania

• photo_name (str) – Nazwa pliku

• photo_type (str) – mimetype

post_media_photo_by_url(media_type: str, photo_url: str) → Photo

Wgrywanie wskazanego pliku przez URL na serwer Dozwolone jest wgrywanie multimedialnych plików o następujących mimetype: ‘image/jpeg’, ‘image/jpg’, ‘image/pjpeg’, ‘image/gif’, ‘image/png’, ‘image/x-png’. Maksymalny rozmiar pliku to 10 MB.

Parameters:

• media_type (str) – Nazwa obszaru z plikami na serwerze [settings, comments, links, content]

• photo_url (str) – Adres na jakim znajduję się obrazek

post_tag_user(tag_name: str, username: str) → None

Dodanie nowego współautora tagu (głównego dodaje moderator)

Parameters:

• tag_name (str) – Nazwa tagu

• username (str) – Nazwa użytkownika

put_entry(entry_id: int, content: str, photo: str | None = None, embed: str | None = None, survey: str | None = None, adult: bool = False) → Entry

Edycja wpisu na mikroblogu. Można modyfikwać tylko własne wpisy. Autor może modyfikować wpis przez 15 minut od daty dodania.

Parameters:

• entry_id (int) – Identyfikator wpisu

• content (str) – Treść własna użytkownika.

• photo (str | None, optional) – Załącznik użytkownika. W celu dodania należy podać “key” pliku z media/photo. Akceptowane są tylko pliki przesłane jako typ comments. Defaults to None.

• embed (str | None, optional) – Unikatowy identyfikator embed. Defaults to None.

• survey (str | None, optional) – Ankieta użytkownika. W celu dodania należy podać Indentyfikator. Defaults to None.

• adult (bool, optional) – Wpis tylko dla dorosłych. Defaults to False.

Returns:

Dodany wpis

Return type:

Dict

put_entry_comment(entry_id: int, comment_id: int, content: str, embed: str | None = None, photo: str | None = None, adult: bool = False) → Comment

Dodawanie nowego komentarza do wpisu na mikroblogu. Można modyfikwać tylko własne komentarze. Autor może modyfikować komentarz 15 minut od daty dodania.

Parameters:

• entry_id (int) – Identyfikator wpisu

• comment_id (int) – Identyfikator komentarza

• content (str) – Treść własna użytkownika. Treść może być pusta w przypadku dodania innych multimediów. W przypadku samej treści musi zawierać min. 5 znaków.

• embed (str | None, optional) – Unikatowy identyfikator pliku. Defaults to None.

• photo (str | None, optional) – Załącznik użytkownika. W celu dodania należy podać “key” pliku z media/photo. Akceptowane są tylko pliki przesłane jako typ comments. Defaults to None.

• adult (bool, optional) – Komentarz tylko dla dorosłych. Defaults to False.

Returns:

Zmodyfikowany komentarz

Return type:

Comment

put_tag(tag_name: str, data: Dict) → None

raise_error_if_needed(res: WykopResponse, error_dict: Dict | None = None) → None