EventManager API

class sphinx.events.EventManager(app: Sphinx)[Quelle]

Event-Manager für Sphinx.

add(name: str) → None[Quelle]

Registriert ein benutzerdefiniertes Sphinx-Event namens name.

Dies ist notwendig, um das Event auslösen zu können.

Parameter:

name – Der Name des Events.

connect(name: Literal['config-inited'], callback: Callable[[Sphinx, Config], None], priority: int) → int[Quelle]
connect(name: Literal['builder-inited'], callback: Callable[[Sphinx], None], priority: int) → int
connect(name: Literal['env-get-outdated'], callback: Callable[[Sphinx, BuildEnvironment, Set[str], Set[str], Set[str]], Sequence[str]], priority: int) → int
connect(name: Literal['env-before-read-docs'], callback: Callable[[Sphinx, BuildEnvironment, list[str]], None], priority: int) → int
connect(name: Literal['env-purge-doc'], callback: Callable[[Sphinx, BuildEnvironment, str], None], priority: int) → int
connect(name: Literal['source-read'], callback: Callable[[Sphinx, str, list[str]], None], priority: int) → int
connect(name: Literal['include-read'], callback: Callable[[Sphinx, Path, str, list[str]], None], priority: int) → int
connect(name: Literal['doctree-read'], callback: Callable[[Sphinx, nodes.document], None], priority: int) → int
connect(name: Literal['env-merge-info'], callback: Callable[[Sphinx, BuildEnvironment, Set[str], BuildEnvironment], None], priority: int) → int
connect(name: Literal['env-updated'], callback: Callable[[Sphinx, BuildEnvironment], str], priority: int) → int
connect(name: Literal['env-get-updated'], callback: Callable[[Sphinx, BuildEnvironment], Iterable[str]], priority: int) → int
connect(name: Literal['env-check-consistency'], callback: Callable[[Sphinx, BuildEnvironment], None], priority: int) → int
connect(name: Literal['write-started'], callback: Callable[[Sphinx, Builder], None], priority: int) → int
connect(name: Literal['doctree-resolved'], callback: Callable[[Sphinx, nodes.document, str], None], priority: int) → int
connect(name: Literal['missing-reference'], callback: Callable[[Sphinx, BuildEnvironment, addnodes.pending_xref, nodes.TextElement], nodes.reference | None], priority: int) → int
connect(name: Literal['warn-missing-reference'], callback: Callable[[Sphinx, Domain, addnodes.pending_xref], bool | None], priority: int) → int
connect(name: Literal['build-finished'], callback: Callable[[Sphinx, Exception | None], None], priority: int) → int
connect(name: Literal['html-collect-pages'], callback: Callable[[Sphinx], Iterable[tuple[str, dict[str, Any], str]]], priority: int) → int
connect(name: Literal['html-page-context'], callback: Callable[[Sphinx, str, str, dict[str, Any], nodes.document], str | None], priority: int) → int
connect(name: Literal['linkcheck-process-uri'], callback: Callable[[Sphinx, str], str | None], priority: int) → int
connect(name: Literal['object-description-transform'], callback: Callable[[Sphinx, str, str, addnodes.desc_content], None], priority: int) → int
connect(name: Literal['autodoc-process-docstring'], callback: _AutodocProcessDocstringListener, priority: int) → int
connect(name: Literal['autodoc-before-process-signature'], callback: _AutodocBeforeProcessSignatureListener, priority: int) → int
connect(name: Literal['autodoc-process-signature'], callback: _AutodocProcessSignatureListener, priority: int) → int
connect(name: Literal['autodoc-process-bases'], callback: _AutodocProcessBasesListener, priority: int) → int
connect(name: Literal['autodoc-skip-member'], callback: _AutodocSkipMemberListener, priority: int) → int
connect(name: Literal['todo-defined'], callback: Callable[[Sphinx, todo_node], None], priority: int) → int
connect(name: Literal['viewcode-find-source'], callback: Callable[[Sphinx, str], tuple[str, dict[str, tuple[Literal['class', 'def', 'other'], int, int]]]], priority: int) → int
connect(name: Literal['viewcode-follow-imported'], callback: Callable[[Sphinx, str, str], str | None], priority: int) → int
connect(name: str, callback: Callable[..., Any], priority: int) → int

Verbindet einen Handler mit einem bestimmten Ereignis.

Registriert die callback-Funktion, die aufgerufen werden soll, wenn das Ereignis name ausgelöst wird.

Siehe Ereignis-Callbacks für Details zu verfügbaren Kernereignissen und den Argumenten ihrer entsprechenden Callback-Funktionen.

Parameter:

  • name – Der Name des Zielereignisses.

  • callback – Callback-Funktion für das Ereignis.

  • priority – Die Priorität des Callbacks. Die Callbacks werden in aufsteigender Reihenfolge der priority aufgerufen.

Gibt zurück:

Eine Listener-ID zur Verwendung mit der Methode disconnect().

Geändert in Version 3.0: Unterstützung für priority

disconnect(listener_id: int) → None[source]

Trennt den durch listener_id gegebenen Handler.

Parameter:

listener_id – Eine Listener-ID, die zuvor von connect() zurückgegeben wurde.

emit(name: str, *args: Any, allowed_exceptions: tuple[type[Exception], ...] = ()) → list[Any][source]

Löst ein Sphinx-Ereignis aus.

Dies löst das Ereignis name aus und übergibt args an die Handler-Funktionen. Die Rückgabewerte aller Handler werden als Liste zurückgegeben. Lösen Sie keine Kern-Sphinx-Ereignisse in Erweiterungen aus!

Parameter:

  • name – Der Name des auszulösenden Ereignisses.

  • args – Die Argumente für das Ereignis, die an die Handler-Funktionen übergeben werden.

  • allowed_exceptions – Die Liste der Ausnahmen, die in den Handlern zulässig sind.

Geändert in Version 3.1: Hinzugefügt: allowed_exceptions zur Angabe von durchlaufenden Ausnahmen

emit_firstresult(name: str, *args: Any, allowed_exceptions: tuple[type[Exception], ...] = ()) → Any[source]

Löst ein Sphinx-Ereignis aus und gibt das erste Ergebnis zurück.

Dies löst das Ereignis name aus und übergibt args an die Handler-Funktionen. Das erste Nicht-None-Ergebnis wird zurückgegeben.

Parameter:

  • name – Der Name des auszulösenden Ereignisses.

  • args – Die Argumente für das Ereignis, die an die Handler-Funktionen übergeben werden.

  • allowed_exceptions – Die Liste der Ausnahmen, die in den Handlern zulässig sind.

Hinzugefügt in Version 0.5.

Geändert in Version 3.1: Hinzugefügt: allowed_exceptions zur Angabe von durchlaufenden Ausnahmen