File: //usr/lib/python3/dist-packages/sphinx/ext/__pycache__/inheritance_diagram.cpython-310.pyc
o
�$�a!C � @ s d Z ddlZddlZddlZddlmZ ddlmZmZm Z m
Z
m Z m Z ddl
mZ ddlmZ ddlmZ ddlZddlmZ dd lmZ dd
lmZ dd lmZmZm Z m Z m Z dd l m Z dd
l!m"Z" ddl#m$Z$ ddl%m&Z& ddl'm(Z( ddl)m*Z* e�+dej,�Z-dd� e.e��/� D �Z0de1defdd�Z2de1de1defdd �Z3G d d � d e4�Z5G d d � d �Z6G d!d"� d"e�Z7G d#d$� d$e"�Z8d%e7de1fd&d'�Z9d(e&d%e7ddfd)d*�Z:d(e(d%e7ddfd+d,�Z;d(e*d%e7ddfd-d.�Z<d(ej=d%e7ddfd/d0�Z>d1edee1ef fd2d3�Z?dS )4a[
sphinx.ext.inheritance_diagram
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Defines a docutils directive for inserting inheritance diagrams.
Provide the directive with one or more classes or modules (separated
by whitespace). For modules, all of the classes in that module will
be used.
Example::
Given the following classes:
class A: pass
class B(A): pass
class C(A): pass
class D(B, C): pass
class E(B): pass
.. inheritance-diagram: D E
Produces a graph like the following:
A
/ \
B C
/ \ /
E D
The graph is inserted as a PNG+image map into HTML and a PDF in
LaTeX.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�
import_module)�Any�Dict�Iterable�List�Tuple�cast)�nodes)�Node)�
directives)�addnodes)�Sphinx)�BuildEnvironment)�figure_wrapper�graphviz�render_dot_html�render_dot_latex�render_dot_texinfo)�md5)�SphinxDirective)�
OptionSpec)�HTMLTranslator)�LaTeXTranslator)�TexinfoTranslatorz�^(?:([\w.]*)\.)? # module names
(\w+) \s* $ # class/final module name
c C s g | ] }t �|�r|�qS � )�inspect�isclass)�.0�objr r �@/usr/lib/python3/dist-packages/sphinx/ext/inheritance_diagram.py�
<listcomp>B s
�r �objname�returnc C s� zt | �W S ty Y dS tyE t�| �}|s Y dS |�� \}}|du r,Y dS z
t |�}t||d�W Y S tyD Y Y dS w w )z�Import a object or module using *name* and *currentmodule*.
*name* should be a relative name from *currentmodule* or
a fully-qualified name.
Returns imported object or module. If failed, returns None value.
N)r � TypeError� ImportError�
module_sig_re�match�groups�getattr)r! �matched�modname�attrname�moduler r r �
try_importF s$
��r- �name�
currmodulec C s� d}|r t |d | �}|du rt | �}|du r td| ��t�|�r&|gS t�|�rGg }|j�� D ]}t�|�rD|j|jkrD|� |� q2|S td| ��)z0Import a class using its fully-qualified *name*.N�.zECould not import class or module %r specified for inheritance diagramz=%r specified for inheritance diagram is not a class or module)
r- �InheritanceExceptionr r �ismodule�__dict__�values�
__module__�__name__�append)r. r/ �target�classes�clsr r r �import_classesc s. ��
��r; c @ s e Zd ZdS )r1 N)r6 r5 � __qualname__r r r r r1 � s r1 c @ sr e Zd ZdZddddg fdee dededed ed
eeef d ee d dfd
d�Z
dee ded ee fdd�Z dee deded ed
eeef d ee d ee eeee ef fdd�Z
d4de d ed
eeef d efdd�Zd ee fdd�Zdddd �Zd d d d d!d"d#�Zd$d%d&�Zd'ed efd(d)�Zd'ed efd*d+�Zi di i i fd,ed-ed.ed/ed0ed1ed efd2d3�ZdS )5�InheritanceGraphz�
Given a list of classes, determines the set of classes that they inherit
from all the way to the root "object", and then is able to generate a
graphviz dot graph from them.
Fr N� class_namesr/ �
show_builtins�
private_bases�parts�aliases� top_classesr" c C s: || _ | �||�}| �||||||�| _| jstd��dS )z�*class_names* is a list of child classes to show bases from.
If *show_builtins* is True, then Python builtins will be shown
in the graph.
z(No classes found for inheritance diagramN)r> �_import_classes� _class_info�
class_infor1 ) �selfr> r/ r? r@ rA rB rC r9 r r r �__init__� s ��zInheritanceGraph.__init__c C s" g }|D ]
}|� t||�� q|S )zImport a list of classes.)�extendr; )rG r> r/ r9 r. r r r rD � s z InheritanceGraph._import_classesr9 c sF i �dt ddf� �������fdd� �|D ]}�|� qt��� �S )a� Return name and bases for all classes that are ancestors of
*classes*.
*parts* gives the number of dotted name parts to include in the
displayed node names, from right to left. If given as a negative, the
number of parts to drop from the left. A value of 0 displays the full
dotted name. E.g. ``sphinx.ext.inheritance_diagram.InheritanceGraph``
with ``parts=2`` or ``parts=-2`` gets displayed as
``inheritance_diagram.InheritanceGraph``, and as
``ext.inheritance_diagram.InheritanceGraph`` with ``parts=3`` or
``parts=-1``.
*top_classes* gives the name(s) of the top most ancestor class to
traverse to. Multiple names can be specified separated by comma.
r: r" Nc s� �s| t v rd S �s| j�d�rd S ��| �� �}��| d� �}d }z| jr:| j�� �d�d }|r:d|�dd� }W n tyD Y nw g }||||f�| < |�v rUd S | j D ]$}�sa|t v raqX�sj|j�d�rjqX|�
��|�� �� |�vr|�|� qXd S )N�_r �
�"%s"�"z\") � py_builtinsr6 �
startswith�
class_name�__doc__�strip�split�replace� Exception� __bases__r7 )r: �nodename�fullname�tooltip�doc�baselist�base�rB � all_classesrA r@ �recurserG r? rC r r r_ � s< � �
��z-InheritanceGraph._class_info.<locals>.recurse)r �listr4 )rG r9 r? r@ rA rB rC r: r r] r rE � s
$"
z InheritanceGraph._class_infor: c C sl |j }|dv r |j}nd||jf }|dkr|}n|�d�}d�|| d� �}|dur4||v r4|| S |S )z�Given a class object, return a fully-qualified name.
This works for things I've tested in matplotlib so far, but may not be
completely general.
)� __builtin__�builtinsz%s.%sr r0 N)r5 r6 r< rS �join)rG r: rA rB r, rX �result�
name_partsr r r rP � s
zInheritanceGraph.class_namec C s dd� | j D �S )z1Get all of the class names involved in the graph.c S s g | ]\}}}}|�qS r r )r rJ rX r r r r � s z8InheritanceGraph.get_all_class_names.<locals>.<listcomp>)rF )rG r r r �get_all_class_names� s z$InheritanceGraph.get_all_class_names�LRz "8.0, 12.0"� transparent)�rankdir�size�bgcolor�box�
g �?zA"Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans"z"setlinewidth(0.5),filled"�white)�shape�fontsize�height�fontname�style� fillcolorg �?z"setlinewidth(0.5)")� arrowsizers �attrsc C � d� dd� t|�� �D ��S )N�,c S � g | ]}d | �qS )z%s=%sr �r �xr r r r � z7InheritanceGraph._format_node_attrs.<locals>.<listcomp>�rc �sorted�items�rG rv r r r �_format_node_attrs
� z#InheritanceGraph._format_node_attrsc C rw )N� c S ry )z%s=%s;
r rz r r r r r| z8InheritanceGraph._format_graph_attrs.<locals>.<listcomp>r} r� r r r �_format_graph_attrs
r� z$InheritanceGraph._format_graph_attrsr. �urls�env� graph_attrs�
node_attrs�
edge_attrsc
C s( | j �� }| j�� }| j�� } |�|� |�|� | �|� |r5|�|jj� |�|jj� | �|jj� g }
|
� d| � |
� | �
|�� t | j �D ]>\}} } }
|�� }| |v red|| |d< d|d< |
rk|
|d< |
� d|| �
|�f � | D ]}|
� d||| �
| �f � qyqK|
� d � d
�|
�S ) aV Generate a graphviz dot graph from the classes that were passed in
to __init__.
*name* is the name of the graph.
*urls* is a dictionary mapping class names to HTTP URLs.
*graph_attrs*, *node_attrs*, *edge_attrs* are dictionaries containing
key/value pairs to pass on as graphviz properties.
z
digraph %s {
rL �URLz"_top"r8 rY z
"%s" [%s];
z "%s" -> "%s" [%s];
z}
r� )�default_graph_attrs�copy�default_node_attrs�default_edge_attrs�update�config�inheritance_graph_attrs�inheritance_node_attrs�inheritance_edge_attrsr7 r� r~ rF r� rc )rG r. r� r� r� r� r� �g_attrs�n_attrs�e_attrs�resrX �basesrY �this_node_attrs� base_namer r r � generate_dot s@
����
z InheritanceGraph.generate_dot)r N)r6 r5 r< rQ r �str�bool�intr r rH rD r rE rP rf r� r� r� r� r� r r� r r r r r= � sn ���
��
� �
��
�$;��
������r= c @ s e Zd ZdZdS )�inheritance_diagramzN
A docutils node to use as a placeholder for the inheritance diagram.
N)r6 r5 r< rQ r r r r r� @ s r� c @ sP e Zd ZU dZdZdZdZdZee j
e j e j d�Z
eed< dee fd d
�Zd S ) �InheritanceDiagramzJ
Run when the inheritance_diagram directive is first encountered.
F� r T)rA �
private-bases�caption� top-classes� option_specr" c
C sr t � }| jj|_| jd �� }| j�d��d�}| j� dd�|d< d�
|�|d< g |d< | j� dd��d �D ]}|� � }|rE|d � |� q6zt
|| jj� d
�|d d | jv | jj|d d �}W n ty} } z|jjj|| jd
�gW Y d }~S d }~ww |�� D ]}|dd| |d| j�\}} |�|� q�||d< d| jvr�| �|� |gS t| || jd �}
| �|
� |
gS )Nr �py�classrA z, �contentr� r� rx z py:moduler� )rA r@ rB rC )�linez :class:`%s`�graphr� )r� �state�document� argumentsrS r� �
get_domain�role�options�getrc rR r7 r= � ref_contextr� �inheritance_aliasr1 �reporter�warning�linenorf rI �add_namer ) rG �noder> �
class_roler: r� �errr. �refnodesr{ �figurer r r �runV sH
�
�"�� �
zInheritanceDiagram.runN)r6 r5 r< rQ � has_content�required_arguments�optional_arguments�final_argument_whitespacer� r �flag� unchanged�unchanged_requiredr� r �__annotations__r r
r� r r r r r� G s
�r� r� c C s, | d t | d � �� }t|��� dd � S )Nr� rA i����)r� �encoder � hexdigest)r� �encodedr r r �get_graph_hash� s r� rG c
C s |d }t |�}d| }| jjjj�� }| jj| jj }i }tt t
j |�}|D ]I} | � d�durK|dkrAd| � d� || d < q(| � d�|| d < q(| � d�durq|dkrfd| d | � d� || d < q(d | � d� || d < q(|j
||| jjd
�}
t| ||
i d d d |d
d� tj�)zZ
Output the graph for HTML. This will insert a PNG with clickable
image map.
r� �
inheritance%s�refuriN�SVGz../�reftitle�refid�#)r� � inheritancezInheritance diagram of r� )�alt)r� �builderr� r� �graphviz_output_format�upper�current_docname�
out_suffixr r r � pending_xrefr� r� r r �SkipNode) rG r� r� �
graph_hashr. r� �current_filenamer� �
pending_xrefs�child�dotcoder r r � html_visit_inheritance_diagram� s, �
�r� c C �F |d }t |�}d| }|j|| jjddid�}t| ||i d� tj�)z>
Output the graph for LaTeX. This will insert a PDF.
r� r� rj � "6.0,6.0"�r� r� r� )r� r� r� r� r r r� �rG r� r� r� r. r� r r r � latex_visit_inheritance_diagram� s �r� c C r� )z@
Output the graph for Texinfo. This will insert a PNG.
r� r� rj r� r� r� )r� r� r� r� r r r� r� r r r �!texinfo_visit_inheritance_diagram� s �r� c C s t j�)N)r r� )rG r� r r r �skip� s r� �appc C s� | � d� | jttd ftd ftd ftd ftd fd� | �dt� | � di d� | � di d� | � di d� | � di d� t
j d d
�S ) Nzsphinx.ext.graphviz)�latex�html�text�man�texinfozinheritance-diagramr� Fr� r� r� T)�version�parallel_read_safe) �setup_extension�add_noder� r� r� r� r� �
add_directiver� �add_config_value�sphinx�__display_version__)r� r r r �setup� s
� r� )@rQ rb r �re� importlibr �typingr r r r r r �docutilsr �docutils.nodesr
�docutils.parsers.rstr r� r �sphinx.applicationr
�sphinx.environmentr �sphinx.ext.graphvizr r r r r � sphinx.utilr �sphinx.util.docutilsr �sphinx.util.typingr �sphinx.writers.htmlr �sphinx.writers.latexr �sphinx.writers.texinfor �compile�VERBOSEr% �varsr4 rN r� r- r; rU r1 r= r� r� r� r� r� r� � NodeVisitorr� r� r r r r �<module> sN % � ;=!
�