File: //usr/lib/python3/dist-packages/sphinx/environment/collectors/__pycache__/__init__.cpython-310.pyc
o
�$�a� � @ sZ d Z ddlmZmZmZmZmZ ddlmZ ddl m
Z
er$ddl m Z G dd� d�Z
dS ) z�
sphinx.environment.collectors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The data collector components for sphinx.environment.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� )�
TYPE_CHECKING�Dict�List�Optional�Set)�nodes)�BuildEnvironment)�Sphinxc
@ s� e Zd ZU dZdZeeeef e d< d dd�Z
d d d
�Z ddd e d eddfd
d�Z
ddd e dee de ddf
dd�Zdddejddfdd�Zddd e dee fdd�Zddd e dee dee dee dee f dd �ZdS ) �EnvironmentCollectoraC An EnvironmentCollector is a specific data collector from each document.
It gathers data and stores :py:class:`BuildEnvironment
<sphinx.environment.BuildEnvironment>` as a database. Examples of specific
data would be images, download files, section titles, metadatas, index
entries and toctrees, etc.
N� listener_ids�appr �returnc C sV | j d u sJ �|�d| j�|�d| j�|�d| j�|�d| j�|�d| j�d�| _ d S )N� doctree-read�env-merge-info�
env-purge-doc�env-get-updated�env-get-outdated)r r r r r )r �connect� process_doc� merge_other� clear_doc�get_updated_docs�get_outdated_docs)�selfr � r �H/usr/lib/python3/dist-packages/sphinx/environment/collectors/__init__.py�enable s �zEnvironmentCollector.enablec C s2 | j d usJ �| j �� D ]}|�|� q d | _ d S )N)r �values�
disconnect)r r � listener_idr r r �disable* s
z EnvironmentCollector.disable�env�docnamec C � t �)zcRemove specified data of a document.
This method is called on the removal of the document.��NotImplementedError)r r r! r" r r r r 0 � z EnvironmentCollector.clear_doc�docnames�otherc C r# )z�Merge in specified data regarding docnames from a different `BuildEnvironment`
object which coming from a subprocess in parallel builds.r$ )r r r! r' r( r r r r 6 r& z EnvironmentCollector.merge_other�doctreec C r# )zoProcess a document and gather specific data from it.
This method is called after the document is read.r$ )r r r) r r r r < r& z EnvironmentCollector.process_docc C � g S )z�Return a list of docnames to re-read.
This methods is called after reading the whole of documents (experimental).
r )r r r! r r r r B s z%EnvironmentCollector.get_updated_docs�added�changed�removedc C r* )zlReturn a list of docnames to re-read.
This methods is called before reading the documents.
r )r r r! r+ r, r- r r r r I s z&EnvironmentCollector.get_outdated_docs)r r r
N)�__name__�
__module__� __qualname__�__doc__r r r �str�int�__annotations__r r r r r r r �documentr r r r r r r r r
s0
��
�
����r
N)r1 �typingr r r r r �docutilsr �sphinx.environmentr �sphinx.applicationr r
r r r r �<module> s