API de gerenciador de eventos

class sphinx.events.EventManager(app: Sphinx)[código-fonte]

Gerenciador de eventos para o Sphinx.

add(name: str) → None[código-fonte]

Registra um evento personalizado do Sphinx chamado name.

Isso é necessário para ser capaz de emitir o evento.

Parâmetros:

name – O nome do evento.

connect(name: Literal['config-inited'], callback: Callable[[Sphinx, Config], None], priority: int) → int[código-fonte]
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

Conecta um manipulador para um evento específico.

Registra callback para ser chamado quando o evento name for emitido.

Consulta retorno de chamada de eventos para obter detalhes sobre os eventos principais disponíveis e os argumentos de suas respectivas funções de retorno de chamada.

Parâmetros:

  • name – O nome do evento alvo.

  • callback – Função de retorno de chamada para o evento.

  • priority – A prioridade da função de retorno de chamada. As funções de retorno de chamada serão invocadas em ordem crescente de priority.

Retorna:

Um ID de ouvinte, para uso com o método disconnect().

Alterado na versão 3.0: Suporte a priority

disconnect(listener_id: int) → None[código-fonte]

Desconecta o manipulador fornecido por listener_id.

Parâmetros:

listener_id – Um listener_id retornado anteriormente por connect().

emit(name: str, *args: Any, allowed_exceptions: tuple[type[Exception], ...] = ()) → list[Any][código-fonte]

Emite um evento Sphinx.

Isso emite o evento name e passa arguments para as funções de tratamento. Retorna os valores de retorno de todos os manipuladores como uma lista. Não emite eventos principais do Sphinx em extensões!

Parâmetros:

  • name – O nome do evento que será emitido.

  • args – Os argumentos do evento, a serem passados ​​para as funções manipulações.

  • allowed_exceptions – Lista de exceções permitidas nos manipuladores.

Alterado na versão 3.1: Adicionado o parâmetro allowed_exceptions para especificar exceções de caminho direto

emit_firstresult(name: str, *args: Any, allowed_exceptions: tuple[type[Exception], ...] = ()) → Any[código-fonte]

Emite um evento Sphinx e retorna o primeiro resultado.

Isso emite o evento name e passa arguments para as funções manipuladoras. O primeiro resultado diferente de None é retornado.

Parâmetros:

  • name – O nome do evento que será emitido.

  • args – Os argumentos do evento, a serem passados ​​para as funções manipulações.

  • allowed_exceptions – Lista de exceções permitidas nos manipuladores.

Adicionado na versão 0.5.

Alterado na versão 3.1: Adicionado o parâmetro allowed_exceptions para especificar exceções de caminho direto