~TiB6dZddlmZddlmZddlmZddlmZm Z m Z ddl m Z ddl mZmZddlmZdd lmZdd lmZerXdd lmZmZmZmZdd lmZdd lmZmZddlm Z ddl!m"Z"ddl#m$Z$ddl%m&Z&ddl'm(Z(ddl)m*Z*ddl+m,Z,ddl-m.Z.m/Z/m0Z0m1Z1m2Z2ddl3m4Z4ejje6Z7Gdde Z8idddddddd d!d"d#d$d%d&d'd(d)d*d+d,d-d,d.d,d/d0d1d2d3d4d5d6d7d8Z9Gd9d:Z:y;)dZ e d?dZ e d@dZ e dAdZ e dBdZ e dCdZ e dDdZ e dEdZ e dFdZ e dGdZ e dHd Z e dId!Z e dJd"Z dJd#Z dKd$Z d%d& dLd'Z d%d& dMd(Z y))N EventManagerzEvent manager for Sphinx.c||_tj|_t t |_d|_|j|_ y)Nr) _app core_eventscopyeventsrlist listenersnext_listener_idpdb_reraise_errors)selfapps r0__init__zEventManager.__init__Ks; !&&( 9DT9J !&)WWr/cp||jvrtd}t||zd|j|<y)zRegister a custom Sphinx event called *name*. This is needed to be able to emit the event. :param name: The name of the event. zEvent %r already presentr2N)r<r r )rBnamemsgs r0addzEventManager.addTs8 4;; /0C t, , Dr/c>ttdd|jS)NzEventManager.app) r)remove)r r*r9)rBs r0rCzEventManager.app`sX'9'Jyyr/cyNr.rBrFcallbackr)s r0connectzEventManager.connectg r/cyrMr.rNs r0rPzEventManager.connectorQr/cyrMr.rNs r0rPzEventManager.connectwr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrTr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrTr/cyrMr.rNs r0rPzEventManager.connect rQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connectrQr/cyrMr.rNs r0rPzEventManager.connect&rQr/cyrMr.rNs r0rPzEventManager.connect.rQr/cyrMr.rNs r0rPzEventManager.connect6rQr/cyrMr.rNs r0rPzEventManager.connect>rQr/cyrMr.rNs r0rPzEventManager.connectFrQr/cyrMr.rNs r0rPzEventManager.connectNrar/cyrMr.rNs r0rPzEventManager.connectYrQr/cyrMr.rNs r0rPzEventManager.connectcrQr/c||jvrtd}t||z|j}|xjdz c_|j|j t ||||S)aConnect a handler to specific event. Register *callback* to be called when the *name* event is emitted. See :ref:`event callbacks ` for details on available core events and the arguments of their corresponding callback functions. :param name: The name of the target event. :param callback: Callback function for the event. :param priority: The priority of the callback. The callbacks will be invoked in ascending order of *priority*. :return: A listener ID, for use with the :meth:`disconnect` method. .. versionchanged:: 3.0 Support *priority* zUnknown event name: %s)r<r r r?r>appendr$)rBrFrOr)rG listener_ids r0rPzEventManager.connectksl, t{{ "-.C t, ,++  " t##M+x$RSr/c|jjD]8}|jD]#}|j|k(s|j |%:y)zDisconnect the handler given by *listener_id*. :param listener_id: A listener_id previously returned by :meth:`connect`. N)r>valuesr;r&rK)rBrtr>listeners r0 disconnectzEventManager.disconnectsP ..0 /I%NN, /;;+-$$X. / /r/r.)allowed_exceptionsc t|}tjd||g}t |j |t d}|D]/} |j|j|jg|1|S#t$rYfwxYw#|$rt$rt$rR}|jrt|jdd} td} t| |j|fz|| |d}~wwxYw)afEmit a Sphinx event. This emits the *name* event and passes *args* to the handler functions. Return the return values of all handlers as a list. Do not emit core Sphinx events in extensions! :param name: The name of the event that will be emitted. :param args: The arguments for the event, to be passed to the handler functions. :param allowed_exceptions: The list of exceptions that are allowed in the handlers. .. versionchanged:: 3.1 Added *allowed_exceptions* to specify path-through exceptions z[app] emitting event: %r%sr))keyr+Nz*Handler %r for event %r threw an exception)modname)reprloggerdebug Exceptionsortedr>rrsr(r9r rArr r ) rBrFryargs repr_argsresultsr>rwexcr|rGs r0emitzEventManager.emits2 HT I LL5tY G4>>$/Z 5KL ! H /x// ADAB $3   &   ''&x'7'7tLEF$8++T22#  s* A?,B? B  B C7%A C22C7cF|j|g|d|iD]}||cSy)a]Emit a Sphinx event and return the first result. This emits the *name* event and passes *args* to the handler functions. The first non-None result is returned. :param name: The name of the event that will be emitted. :param args: The arguments for the event, to be passed to the handler functions. :param allowed_exceptions: The list of exceptions that are allowed in the handlers. .. versionadded:: 0.5 .. versionchanged:: 3.1 Added *allowed_exceptions* to specify path-through exceptions ryN)r)rBrFryrresults r0emit_firstresultzEventManager.emit_firstresults9. diiStS@RS F!  r/N)rCrreturnNone)rFstrrr)rr)rFzLiteral['config-inited']rOz Callable[[Sphinx, Config], None]r)r%rr%)rFzLiteral['builder-inited']rOzCallable[[Sphinx], None]r)r%rr%)rFzLiteral['env-get-outdated']rOzQCallable[[Sphinx, BuildEnvironment, Set[str], Set[str], Set[str]], Sequence[str]]r)r%rr%)rFzLiteral['env-before-read-docs']rOz5Callable[[Sphinx, BuildEnvironment, list[str]], None]r)r%rr%)rFzLiteral['env-purge-doc']rOz/Callable[[Sphinx, BuildEnvironment, str], None]r)r%rr%)rFzLiteral['source-read']rOz(Callable[[Sphinx, str, list[str]], None]r)r%rr%)rFzLiteral['include-read']rOz.Callable[[Sphinx, Path, str, list[str]], None]r)r%rr%)rFzLiteral['doctree-read']rOz(Callable[[Sphinx, nodes.document], None]r)r%rr%)rFzLiteral['env-merge-info']rOzFCallable[[Sphinx, BuildEnvironment, Set[str], BuildEnvironment], None]r)r%rr%)rFzLiteral['env-updated']rOz)Callable[[Sphinx, BuildEnvironment], str]r)r%rr%)rFzLiteral['env-get-updated']rOz3Callable[[Sphinx, BuildEnvironment], Iterable[str]]r)r%rr%)rFz Literal['env-check-consistency']rOz*Callable[[Sphinx, BuildEnvironment], None]r)r%rr%)rFzLiteral['write-started']rOz!Callable[[Sphinx, Builder], None]r)r%rr%)rFzLiteral['doctree-resolved']rOz-Callable[[Sphinx, nodes.document, str], None]r)r%rr%)rFzLiteral['missing-reference']rOzfCallable[[Sphinx, BuildEnvironment, addnodes.pending_xref, nodes.TextElement], nodes.reference | None]r)r%rr%)rFz!Literal['warn-missing-reference']rOz>Callable[[Sphinx, Domain, addnodes.pending_xref], bool | None]r)r%rr%)rFzLiteral['build-finished']rOz*Callable[[Sphinx, Exception | None], None]r)r%rr%)rFzLiteral['html-collect-pages']rOz=Callable[[Sphinx], Iterable[tuple[str, dict[str, Any], str]]]r)r%rr%)rFzLiteral['html-page-context']rOzHCallable[[Sphinx, str, str, dict[str, Any], nodes.document], str | None]r)r%rr%)rFz Literal['linkcheck-process-uri']rOz#Callable[[Sphinx, str], str | None]r)r%rr%)rFz'Literal['object-description-transform']rOz9Callable[[Sphinx, str, str, addnodes.desc_content], None]r)r%rr%)rFz$Literal['autodoc-process-docstring']rOrr)r%rr%)rFz+Literal['autodoc-before-process-signature']rOrr)r%rr%)rFz$Literal['autodoc-process-signature']rOr r)r%rr%)rFz Literal['autodoc-process-bases']rOrr)r%rr%)rFzLiteral['autodoc-skip-member']rOr!r)r%rr%)rFzLiteral['todo-defined']rOz#Callable[[Sphinx, todo_node], None]r)r%rr%)rFzLiteral['viewcode-find-source']rOzaCallable[[Sphinx, str], tuple[str, dict[str, tuple[Literal['class', 'def', 'other'], int, int]]]]r)r%rr%)rFz#Literal['viewcode-follow-imported']rOz(Callable[[Sphinx, str, str], str | None]r)r%rr%)rFrrOr'r)r%rr%)rtr%rr)rFrrrrytuple[type[Exception], ...]rz list[Any])rFrrrryrrr) r*r+r,__doc__rDrHpropertyrCrrPrxrrr.r/r0r7r7Hsb#-  &3  '+  )    -H  &B  $;  %A  %;  '    $<  (F  .=  &4  )@  *  /Q  '=  +P  *    .6  5L  23  99  23  ./  ,-  %6  -  1;  %  > /;= 4448 4  4t;= 8  r/r7N);r __future__r collectionsroperatorrtypingrrrsphinx.deprecationr sphinx.errorsr r sphinx.localer sphinx.utilr sphinx.util.inspectrcollections.abcrrrrpathlibrrrdocutilsrsphinxrsphinx.applicationrsphinx.buildersr sphinx.configrsphinx.domainsrsphinx.environmentr#sphinx.ext.autodoc._event_listenersrrrr r!sphinx.ext.todor" getLoggerr*r~r$r:r7r.r/r0rs_ ##6635,AA#)'$%3*   8 $JXb6O  ^  ) @6>5uUY*. n!"k# *]]r/