Zum Inhalt

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:

Services

Geschäftslogik und Kernfunktionalität:

Befehle

CLI-Befehlsimplementierungen:

UI-Komponenten

Terminal-Benutzeroberflächenelemente:

  • Menü: Interaktives Menüsystem
  • Prompt: Benutzereingabe-Prompts
  • Header: Anwendungsheader-Anzeige

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

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.