API-Referenz-Übersicht¶
Willkommen zur Weeb CLI API-Referenzdokumentation. Dieser Abschnitt bietet detaillierte Dokumentation für alle Module, Klassen und Funktionen in der Codebasis.
Organisation¶
Die API-Dokumentation ist nach Paketen organisiert:
Kern-Module¶
Wesentliche Module, die grundlegende Funktionalität bieten:
- Config: Konfigurationsverwaltungssystem
- I18n: Internationalisierung und Lokalisierung
- Exceptions: Benutzerdefinierte Exception-Hierarchie
Provider¶
Anime-Quellen-Provider-Implementierungen:
- Basis-Provider: Abstrakte Basisklasse und Datenstrukturen
- Registry: Provider-Erkennung und -Verwaltung
- Türkische Provider: Animecix, Turkanime, Anizle, Weeb
- Englische Provider: HiAnime, AllAnime
- Deutsche Provider: AniWorld
- Polnische Provider: Docchi
Services¶
Geschäftslogik und Kernfunktionalität:
- Database: SQLite-Datenbankverwaltung
- Downloader: Warteschlangenbasiertes Download-System
- Tracker: AniList-, MAL-, Kitsu-Integration
- Player: MPV-Player-Integration
- Cache: Caching-System
- Local Library: Lokale Anime-Verwaltung
Befehle¶
CLI-Befehlsimplementierungen:
- API-Befehle: Nicht-interaktive JSON-API
- Suche: Anime-Suchfunktionalität
- Downloads: Download-Verwaltung
- Watchlist: Wiedergabeverlauf und Fortschritt
UI-Komponenten¶
Terminal-Benutzeroberflächenelemente:
Schnelllinks¶
Häufige Aufgaben¶
Typ-Hinweise¶
Alle Module verwenden umfassende Typ-Hinweise für bessere IDE-Unterstützung und Code-Klarheit:
from typing import List, Optional, Dict
def search(query: str) -> List[AnimeResult]:
"""Suche mit vollständigen Typ-Informationen."""
pass
Docstring-Stil¶
Wir verwenden durchgehend Google-Stil-Docstrings:
def function(param: str) -> bool:
"""Kurze Beschreibung.
Args:
param: Parameter-Beschreibung.
Returns:
Rückgabewert-Beschreibung.
Example:
>>> function("test")
True
"""
pass
Navigation¶
Verwenden Sie die Seitenleiste, um durch die API-Dokumentation zu navigieren. Jede Seite enthält:
- Modul-Übersicht
- Klassen- und Funktionssignaturen
- Detaillierte Beschreibungen
- Verwendungsbeispiele
- Typ-Informationen
Beitragen¶
Problem mit der Dokumentation gefunden? Bitte öffnen Sie ein Issue oder reichen Sie einen Pull Request ein.