File: //usr/lib/python3/dist-packages/sphinx/ext/__pycache__/intersphinx.cpython-310.pyc
o
�$�a T � @ s� d Z ddlZddlZddlZddlZddlZddlmZ ddl m
Z
m Z m Z m
Z
mZmZ ddlmZmZ ddlmZ ddlmZmZ ddlmZ ddlZdd lm Z dd
l m Z dd l m Z dd l!m"Z" dd
l#m$Z$ ddl%m&Z& ddl'm(Z(m)Z) ddl*m+Z+m,Z, ddl-m.Z. ddl/m0Z0m1Z1 e+�2e3�Z4G dd� d�Z5de6de6fdd�Z7dQde6de"de
fdd�Z8de6de6fd d �Z9d e d e6d e de fd!d"�Z:d#e6d e6d$e d%e d e d&e;de<fd'd(�Z=d e ddfd)d*�Z>d+e$d,ee6 d-e1d.e d/edef d0d1�Z?d,ee6 d2e0d+e$d3e
e6 d4e6d.e d/edee fd5d6�Z@d7e&d,ee6 d2e0d8e<d+e$d3e
e6 d.e d/edee fd9d:�ZAd7e&d,ee6 d2e0d8e<d.e d/edee fd;d<�ZBd7e&d,e6de<fd=d>�ZCd7e&d,e6d.e d/edee f
d?d@�ZDd7e&d8e<d.e d/edee f
dAdB�ZEd7e&d.e d/edee fdCdD�ZFd e d7e&d.e d/edee f
dEdF�ZGd e de"ddfdGdH�ZHd e de e6e f fdIdJ�ZIdKe
e6 ddfdLdM�ZJe3dNk�r�ddl+ZKeK�L� eJejMdOd� dP� dS dS )Ra�
sphinx.ext.intersphinx
~~~~~~~~~~~~~~~~~~~~~~
Insert links to objects documented in remote Sphinx documentation.
This works as follows:
* Each Sphinx HTML build creates a file named "objects.inv" that contains a
mapping from object names to URIs relative to the HTML set's root.
* Projects using the Intersphinx extension can specify links to such mapping
files in the `intersphinx_mapping` config value. The mapping will then be
used to resolve otherwise missing references to objects into links to the
other documentation.
* By default, the mapping file is assumed to be at the same location as the
rest of the documentation; however, the location of the mapping file can
also be specified individually, e.g. if the docs should be buildable
without Internet access.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�path)�IO�Any�Dict�List�Optional�Tuple)�urlsplit�
urlunsplit)�nodes)�Element� TextElement)�
relative_path)� pending_xref)�Sphinx)�INVENTORY_FILENAME)�Config)�Domain)�BuildEnvironment)�_�__)�logging�requests)�
InventoryFile)� Inventory�
InventoryItemc @ s| e Zd ZdZdeddfdd�Zedeee ee
e f f fdd��Z ede fd d
��Z
edeee f fd d ��Zdd
d�ZdS )�InventoryAdapterz!Inventory adapter for environment�env�returnNc C s0 || _ t|d�si | j _i | j _i | j _d S d S )N�intersphinx_cache)r �hasattrr �intersphinx_inventory�intersphinx_named_inventory)�selfr � r$ �8/usr/lib/python3/dist-packages/sphinx/ext/intersphinx.py�__init__9 s
�zInventoryAdapter.__init__c C � | j jS �N)r r �r# r$ r$ r% �cacheA � zInventoryAdapter.cachec C r' r( )r r! r) r$ r$ r% �main_inventoryE r+ z InventoryAdapter.main_inventoryc C r' r( )r r" r) r$ r$ r% �named_inventoryI r+ z InventoryAdapter.named_inventoryc C s | j j�� | j j�� d S r( )r r! �clearr" r) r$ r$ r% r. M s zInventoryAdapter.clear)r N)�__name__�
__module__� __qualname__�__doc__r r& �propertyr �strr �intr r* r, r- r. r$ r$ r$ r% r 6 s "r �urlr c C s6 t t| ��}d|d v r|d �d�d |d< t|�S )a� Returns *url* with basic auth credentials removed. Also returns the
basic auth username and password if they're present in *url*.
E.g.: https://user:pass@example.com => https://example.com
*url* need not include basic auth credentials.
:param url: url which may or may not contain basic auth credentials
:type url: ``str``
:return: *url* with any basic auth creds removed
:rtype: ``str``
�@� )�listr �splitr
)r6 �fragsr$ r$ r% �_strip_basic_authR s r< �configc C sB t j| d||jd�}|�� |j|j_tj|jjdd�|j_|jS )u� Reads data from *url* with an HTTP *GET*.
This function supports fetching from resources which use basic HTTP auth as
laid out by RFC1738 § 3.1. See § 5 for grammar definitions for URLs.
.. seealso:
https://www.ietf.org/rfc/rfc1738.txt
:param url: URL of an HTTP resource
:type url: ``str``
:return: data read from resource described by *url*
:rtype: ``file``-like object
T)�streamr= �timeout)�decode_content) r �get�intersphinx_timeout�raise_for_statusr6 �raw� functools�partial�read)r6 r= �rr$ r$ r% �_read_from_urlg s
rI c C s` t | �}|jdu r | S t|�}|jr"d�|j|j|j�|d< t|�S d�|j|j�|d< t|�S )a5 Gets version of *url* with basic auth passwords obscured. This function
returns results suitable for printing and logging.
E.g.: https://user:12345@example.com => https://user@example.com
:param url: a url
:type url: ``str``
:return: *url* with password removed
:rtype: ``str``
Nz{}@{}:{}r8 z{}@{})r �usernamer9 �port�format�hostnamer
)r6 �partsr; r$ r$ r% �
_get_safe_url� s
�rO �app�uri�invc
C sp d|v}|s
t |�}zd|v rt|| jd�}n
tt�| j|�d�}W n ty9 } z d||jt |�f|_
� d}~ww zet |d�rd|j }||krdt
�td�||� ||t�|�t�|�d fv rdt�|�}|�/ z|rmtjntj}t�|||�}W n ty� } ztd | �| �d} ~ ww W d � W |S 1 s�w Y W |S ty� } z d
||jjt |�f|_
� d}~ww ) z6Fetch, parse and return an intersphinx inventory file.�://)r= �rbz4intersphinx inventory %r not fetchable due to %s: %sNr6 z)intersphinx inventory has moved: %s -> %s�/z,unknown or unsupported inventory version: %rz3intersphinx inventory %r not readable due to %s: %s)r< rI r= �openr �join�srcdir� Exception� __class__r4 �argsr r6 �logger�infor �dirname� posixpathr �load�
ValueErrorr/ )
rP rQ rR �localuri�f�err�newinvrW �invdata�excr$ r$ r% �fetch_inventory� sT � ���
��� � � ����rh �name�invsr* �nowc C s ||j jd }g }z�|D ]�}|st�|t�}d|vs'||vs'|| d |k r�t|�} t�td�| � zt |||�}
W n t
yS } z |� | j � W Y d } ~ q
d } ~ ww |
r�| ||
f||< W |g kred
S t
|�t
|�k r�t�td�� |D ]} tj| � qvd
S d�dd� |D ��}
t�td �d |
� d
S q
W |g kr�d S t
|�t
|�k r�t�td�� |D ]} tj| � q�d S d�dd� |D ��}
t�td �d |
� d S |g kr�w t
|�t
|�k r�t�td�� |D ]} tj| � q�w d�dd� |D ��}
t�td �d |
� w ) Ni�Q rS r8 z(loading intersphinx inventory from %s...zXencountered some issues with some of the inventories, but they had working alternatives:�
c S s g | ] }|d |dd� �qS )r r8 Nr$ ��.0rc r$ r$ r% �
<listcomp>� s z)fetch_inventory_group.<locals>.<listcomp>zAfailed to reach any of the inventories with the following issues:TF)r= �intersphinx_cache_limitr_ rW r rO r\ r] r rh rY �appendr[ �len�warning)ri rQ rj r* rP rk �
cache_time�failuresrR � safe_inv_urlrf rd �fail�issuesr$ r$ r% �fetch_inventory_group� sx �� �
�
��� �
�
�� �
��ry c
C s" t t�� �}t| jj�}tj�� �1}g }| jj �
� D ]\}\}}|� |� t
||||j| |�� qdd� tj�|�D �}W d � n1 sEw Y t|�r�|�� t|j�
� �} tdd� | D ��}
dd� | D �} |
| D ]!\}} }
|ry|
|j|< |
�� D ]\}}|j�|i ��|� q}qmdS dS )z3Load all intersphinx mappings into the environment.c S s g | ]}|� � �qS r$ )�resultrm r$ r$ r% ro � s z!load_mappings.<locals>.<listcomp>Nc s s � | ] }|d r|V qdS )r Nr$ �rn �vr$ r$ r% � <genexpr>� s � z load_mappings.<locals>.<genexpr>c S s g | ]}|d s|�qS )r r$ r{ r$ r$ r% ro � � )r5 �timer �builderr �
concurrent�futures�ThreadPoolExecutorr= �intersphinx_mapping�valuesrq �submitry r* � as_completed�anyr. r9 �sortedr- �itemsr, �
setdefault�update)rP rk � inventories�poolr� ri rQ rj �updated� cached_vals�
named_vals� unnamed_vals�_xrf �type�objectsr$ r$ r% �
load_mappings� s. � �
��
r� �domain�inv_name�data�node�contnodec C s |\}}}}d|vr|� d�rt�t|d d�|�}|r%td�||f } ntd�|f } tjddd|| d�}
|� d �rB|
�|� |
S |d
ksQ| jd kr�|d d
kr�|� � } |d ur{| �
|d �r{|
�|� | t |�d d � | t |�d d � �� |
S |
�|� |
S |
�|� ||�� |
S )NrS �refdoc�.z (in %s v%s)z(in %s)� F)�internal�refuri�reftitle� refexplicit�-�std�reftype�keyword�:r8 )
rA r rW r r r � referencerq ri �astext�
startswithrZ rr ) r� r� r� r� r� �proj�versionrQ �dispnamer� �newnode�titler$ r$ r% �_create_element_from_result s,
��
��r� � inventory�objtypes�targetc
s� |D ]A}||vr q||| v r|| | }n$|dkr9|� � � tt� fdd�|| �� ��} | r8|| | d }nqqt|| |||� S d S )Nzstd:termc s | � � � kS r( )�lower)�k�� target_lowerr$ r% �<lambda>4 s z8_resolve_reference_in_domain_by_target.<locals>.<lambda>r )r� r9 �filter�keysr� )
r� r� r� r� r� r� r� �objtyper� �insensitive_matchesr$ r� r% �&_resolve_reference_in_domain_by_target$ s
�r� r �honor_disabled_refsc
s� �j dkrd|v r|�d� �j dkr d|v r |�d� �fdd�|D �}|r4| jj� � fd d�|D �}t||�||d
||�}|d urF|S ��|�} | d u rQd S t||�|| ||�S ) Nr� � cmdoption�option�py� attribute�methodc s g | ] }d � � j|��qS )z{}:{})rL ri )rn �t)r� r$ r% ro S s z0_resolve_reference_in_domain.<locals>.<listcomp>c s g | ]}|� vr|�qS r$ r$ )rn �o)�disabledr$ r% ro X r~ � reftarget)ri rq r= � intersphinx_disabled_reftypesr� �get_full_qualified_name)
r r� r� r� r� r� r� r� �res�full_qualified_namer$ )r� r� r% � _resolve_reference_in_domainD s&
�
�r� c
C s� |o|d u }|rd| j jv rd S |d }|dkrG| j�� D ]'\}}|r,|d | j jv r,q t|j�} t| ||||| ||�}
|
d urD|
S q d S |�d�}|sPd S |r\|d | j jv r\d S | �|�}|� |�} | sjd S t| ||||| ||�S )N�*r� r� z:*� refdomain)
r= r� �domainsr� r9 � object_typesr� rA �
get_domain�objtypes_for_role) r r� r� r� r� r� �typ� domain_namer� r� r� r$ r$ r% �_resolve_referenceh sD
��
�r� c C s |t | �jv S r( )r r- )r r� r$ r$ r% �inventory_exists� s r� c C s* t | |�sJ �t| |t| �j| d||�S )z�Attempt to resolve a missing reference via intersphinx references.
Resolution is tried in the given inventory with the target as is.
Requires ``inventory_exists(env, inv_name)``.
F)r� r� r r- )r r� r� r� r$ r$ r% � resolve_reference_in_inventory� s
�r� c C s t | dt| �j|||�S )z�Attempt to resolve a missing reference via intersphinx references.
Resolution is tried with the target as is in any inventory.
N)r� r r, )r r� r� r� r$ r$ r% � resolve_reference_any_inventory� s �r� c C sn t | d||�}|dur
|S |d }d|vrdS |�dd�\}}t| |�s&dS ||d< t| |||�}||d< |S )ag Attempt to resolve a missing reference via intersphinx references.
Resolution is tried first with the target as is in any inventory.
If this does not succeed, then the target is split by the first ``:``,
to form ``inv_name:newtarget``. If ``inv_name`` is a named inventory, then resolution
is tried in that inventory with the new target.
TNr� r� r8 )r� r: r� r� )r r� r� r� r� r� � newtarget�res_invr$ r$ r% �"resolve_reference_detect_inventory� s
r� c C s t |||�S )zBAttempt to resolve a missing reference via intersphinx references.)r� )rP r r� r� r$ r$ r% �missing_reference� s r� c C s� |j �� �� D ]l\}}zGt|ttf�r0||}\}}t|t�s/t�t d�|� |j �
|� W qnd ||}}}t|t�sH|||fff|j |< n |||ff|j |< W q t ys } zt�t d�||� |j �
|� W Y d }~qd }~ww d S )Nz0intersphinx identifier %r is not string. Ignoredz3Failed to read intersphinx_mapping[%s], ignored: %r) r� �copyr� �
isinstancer9 �tupler4 r\ rs r �poprY )rP r= �key�valueri rQ rR rg r$ r$ r% � normalize_intersphinx_mapping� s,
� �
����r� c C sn | � di d� | � ddd� | � dd d� | � dg d� | jdtd d
� | �d t� | �d t� tjd
dd�S )Nr� Trp � FrB r� z
config-initedi )�priorityzbuilder-initedzmissing-referencer8 )r� � env_version�parallel_read_safe)�add_config_value�connectr� r� r� �sphinx�__display_version__)rP r$ r$ r% �setup� s �r� �argvc
s6 t | �dk rtdtjd� t�d� G dd� d�� G � fdd�d�}z?| d }t|� d |�}t|p2i �D ]*}t|� t|| �� �D ]\}}td
||d d krUd
|d nd |d f � qBq4W dS ty� } zt|j d |j dd� � W Y d}~dS d}~w t
y� } z
td| � W Y d}~dS d}~ww )z-Debug functionality to print out an inventoryr8 zXPrint out an inventory file.
Error: must specify local path or URL to an inventory file.��filec @ s" e Zd ZU dZeed< dZdZdS )z inspect_main.<locals>.MockConfigNrB F)r/ r0 r1 rB r5 �__annotations__�
tls_verify�
user_agentr$ r$ r$ r% �
MockConfig s
r� c s( e Zd ZdZ� � Zdeddfdd�ZdS )z inspect_main.<locals>.MockAppr� �msgr Nc S s t |tjd� d S )Nr� )�print�sys�stderr)r# r� r$ r$ r% �warn
s z"inspect_main.<locals>.MockApp.warn)r/ r0 r1 rX r= r4 r� r$ �r� r$ r% �MockApp s r� r r� z %-40s %s%s� r� z%-40s: � NzUnknown error: %r) rr r� r� r� �exitrh r� r� ra r[ rY )r� r� �filenamerf r� �entry�einforg r$ r� r% � inspect_main� s4 �
���*���r �__main__r8 )r� r( )Nr2 �concurrent.futuresr� rE r_ r� r �osr �typingr r r r r r � urllib.parser r
�docutilsr �docutils.nodesr r
�docutils.utilsr r� �sphinx.addnodesr �sphinx.applicationr �sphinx.builders.htmlr �
sphinx.configr �sphinx.domainsr �sphinx.environmentr �
sphinx.localer r � sphinx.utilr r �sphinx.util.inventoryr �sphinx.util.typingr r � getLoggerr/ r\ r r4 r< rI rO rh �float�boolry r� r� r� r� r� r� r� r� r� r� r� r� r �_logging� basicConfigr� r$ r$ r$ r% �<module> s
'������
�%!���
� �������
� �������
�$���
�)���
����
�
��
� �
�
#�