Przegląd dokumentacji API¶

Witamy w dokumentacji referencyjnej API Weeb CLI. Ta sekcja zapewnia szczegółową dokumentację dla wszystkich modułów, klas i funkcji w bazie kodu.

Organizacja¶

Dokumentacja API jest zorganizowana według pakietów:

Moduły podstawowe¶

Podstawowe moduły zapewniające fundamentalną funkcjonalność:

Config: System zarządzania konfiguracją
I18n: Internacjonalizacja i lokalizacja
Exceptions: Niestandardowa hierarchia wyjątków

Dostawcy¶

Implementacje dostawców źródeł anime:

Dostawca bazowy: Abstrakcyjna klasa bazowa i struktury danych
Rejestr: Wykrywanie i zarządzanie dostawcami
Dostawcy tureccy: Animecix, Turkanime, Anizle, Weeb
Dostawcy angielscy: HiAnime, AllAnime
Dostawcy niemieccy: AniWorld
Dostawcy polscy: Docchi

Serwisy¶

Logika biznesowa i podstawowa funkcjonalność:

Database: Zarządzanie bazą danych SQLite
Downloader: System pobierania oparty na kolejce
Tracker: Integracja AniList, MAL, Kitsu
Player: Integracja odtwarzacza MPV
Cache: System buforowania
Local Library: Zarządzanie lokalnym anime

Polecenia¶

Implementacje poleceń CLI:

Polecenia API: Nieinteraktywne API JSON
Wyszukiwanie: Funkcjonalność wyszukiwania anime
Pobieranie: Zarządzanie pobieraniem
Lista oglądania: Historia oglądania i postęp

Komponenty UI¶

Elementy interfejsu użytkownika terminala:

Menu: Interaktywny system menu
Prompt: Monity wprowadzania użytkownika
Header: Wyświetlanie nagłówka aplikacji

Szybkie linki¶

Typowe zadania¶

Wskazówki typu¶

Wszystkie moduły używają kompleksowych wskazówek typu dla lepszego wsparcia IDE i przejrzystości kodu:

from typing import List, Optional, Dict

def search(query: str) -> List[AnimeResult]:
    """Wyszukiwanie z pełnymi informacjami o typie."""
    pass

Styl docstring¶

Używamy docstringów w stylu Google wszędzie:

def function(param: str) -> bool:
    """Krótki opis.

    Args:
        param: Opis parametru.

    Returns:
        Opis wartości zwracanej.

    Example:
        >>> function("test")
        True
    """
    pass

Nawigacja¶

Użyj paska bocznego, aby nawigować przez dokumentację API. Każda strona zawiera:

Przegląd modułu
Sygnatury klas i funkcji
Szczegółowe opisy
Przykłady użycia
Informacje o typach

Wkład¶

Znalazłeś problem z dokumentacją? Proszę otwórz problem lub prześlij pull request.