File: //usr/lib/python3/dist-packages/sphinx/writers/__pycache__/manpage.cpython-310.pyc
o
�$�a�= � @ s� d Z ddlmZmZmZmZ ddlmZ ddlm Z m
Z
m Z ddl m
Z ddl mZ ddlmZ ddlmZ dd lmZmZ dd
lmZ dd lmZ dd lm Z dd
l m Z e� e �Z!G dd� de�Z"G dd� d�Z#G dd� dee�Z$dS )z�
sphinx.writers.manpage
~~~~~~~~~~~~~~~~~~~~~~
Manual page writer, extended for Sphinx custom nodes.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� )�Any�Dict�Iterable�cast)�nodes)�Element�Node� TextElement)�
Translator)�Writer)�addnodes)�Builder)�_�admonitionlabels)�logging)�SphinxTranslator)� format_date)� NodeMatcherc s0 e Zd Zdeddf� fdd� Zddd�Z� ZS ) �ManualPageWriter�builder�returnNc s t � �� || _d S �N)�super�__init__r )�selfr �� __class__� �8/usr/lib/python3/dist-packages/sphinx/writers/manpage.pyr s
zManualPageWriter.__init__c C sL t | j�}|�� | j�| j| j�}tt|�| _| j�|� | j� � | _
d S r ) �NestedInlineTransform�document�applyr �create_translatorr �ManualPageTranslator�visitor� walkabout�astext�output)r � transformr$ r r r � translate" s
zManualPageWriter.translate)r N)�__name__�
__module__� __qualname__r
r r) �
__classcell__r r r r r s r c @ s6 e Zd ZdZdejddfdd�Zdeddfdd �ZdS )
r a
Flatten nested inline nodes:
Before:
<strong>foo=<emphasis>1</emphasis>
&bar=<emphasis>2</emphasis></strong>
After:
<strong>foo=</strong><emphasis>var</emphasis>
<strong>&bar=</strong><emphasis>2</emphasis>
r r Nc C s
|| _ d S r )r )r r r r r r 6 �
z NestedInlineTransform.__init__�kwargsc s� t tjtjtj�� t| j�� ��D ]N}t� fdd�|D ��r_|j �
|�}t t|��D ]*}|� |� � |�r?|j �
|d |� q*|jdd|fi |j��}|j �
|d |� q*t|�s_|j � |� qd S )Nc 3 s � | ]}� |�V qd S r r )�.0�subnode��matcherr r � <genexpr>< � � z.NestedInlineTransform.apply.<locals>.<genexpr>� � )r r �literal�emphasis�strong�listr �traverse�any�parent�index�reversed�remove�insertr �
attributes�len)r r/ �node�posr1 �newnoder r2 r r! 9 s
��zNestedInlineTransform.apply) r* r+ r, �__doc__r r r r r! r r r r r + s
r c s e Zd ZU dZi Zeeef ed< de j
de ddf� fdd� Z defd d
�Z
d eddfd d
�Zd eddfdd�Zd eddfdd�Zd eddfdd�Zd eddfdd�Zd eddfdd�Zd eddfdd�Zd eddfdd�Zd eddfd d �Zd eddfd d �Zd eddfd d!�Zd eddfd"d#�Zd eddfd$d%�Zd eddfd&d'�Z d eddfd(d)�Z d eddfd*d+�Z d eddfd,d-�Z d eddfd.d/�Z d eddfd0d1�Z!d eddfd2d3�Z"d eddfd4d5�Z#d eddfd6d7�Z$d eddfd8d9�Z%d eddfd:d;�Z&d eddfd<d=�Z'd eddfd>d?�Z(d eddfd@dA�Z)d eddfdBdC�Z*d eddfdDdE�Z+d eddfdFdG�Z,d eddf� fdHdI� Z-d eddfdJdK�Z.d eddf� fdLdM� Z/d eddfdNdO�Z0d eddfdPdQ�Z1d eddfdRdS�Z2d eddfdTdU�Z3d eddfdVdW�Z4d eddfdXdY�Z5d eddfdZd[�Z6d eddfd\d]�Z7d eddfd^d_�Z8d eddfd`da�Z9d eddfdbdc�Z:d eddfddde�Z;d eddfdfdg�Z<d eddfdhdi�Z=d eddfdjdk�Z>d eddfdldm�Z?d eddfdndo�Z@d eddfdpdq�ZAd eddfdrds�ZBd eddfdtdu�ZCd eddfdvdw�ZDd eddfdxdy�ZEd eddfdzd{�ZFd eddfd|d}�ZGd eddfd~d�ZHd eddfd�d��ZId eddfd�d��ZJd eddfd�d��ZKd eddfd�d��ZLd eddfd�d��ZMd eddfd�d��ZNd eddfd�d��ZOd eddfd�d��ZPd eddfd�d��ZQd eddf� fd�d�� ZRd eddf� fd�d�� ZSd eddf� fd�d�� ZTd eddf� fd�d�� ZUd eddfd�d��ZVd eddfd�d��ZWd eddfd�d��ZXd eddfd�d��ZYd eddfd�d��ZZd eddfd�d��Z[d eddfd�d��Z\d eddfd�d��Z]d e^ddfd�d��Z_� Z`S )�r# z%
Custom man page translator.
�_docinfor r r Nc s� t � �||� d| _d| _| jj| jd< | jj| jd< | jjr&| jj| jd< | jj | jd< | jd �
� | jd< | j j rC| j j | jd< nt
| j jpKtd �| j jd
�| jd< | j j| jd < | j j| jd < | j j| jd
< t�� D ]
\}}| �|�| jj|< qmd S )Nr ����title�subtitle�author�manual_section� title_upper�datez %b %d, %Y)�language� copyright�version� manual_group)r r �in_productionlist�
section_level�settingsrK rI rL �authors�section�upper�config�todayr � today_fmtr rQ rR rS �projectr �items� deunicode�labels)r r r �label� translationr r r r Q s( ��z ManualPageTranslator.__init__c C s d}| j d r |d7 }|| j S )NzW.TH "%(title_upper)s" "%(manual_section)s" "%(date)s" "%(version)s" "%(manual_group)s"
rL z#.SH NAME
%(title)s \- %(subtitle)s
)rI )r �tmplr r r �headerq s
zManualPageTranslator.headerrE c C � d S r r �r rE r r r �visit_start_of_filey � z(ManualPageTranslator.visit_start_of_filec C rf r r rg r r r �depart_start_of_file| ri z)ManualPageTranslator.depart_start_of_filec C � | � |� d S r )�visit_definition_listrg r r r �
visit_desc� � z ManualPageTranslator.visit_descc C rk r )�depart_definition_listrg r r r � depart_desc� rn z ManualPageTranslator.depart_descc C s | � |� | �|� d S r )�visit_definition_list_item�
visit_termrg r r r �visit_desc_signature� s
z)ManualPageTranslator.visit_desc_signaturec C rk r )� depart_termrg r r r �depart_desc_signature� rn z*ManualPageTranslator.depart_desc_signaturec C rf r r rg r r r �visit_desc_signature_line� ri z.ManualPageTranslator.visit_desc_signature_linec C � | j �d� d S )N� ��body�appendrg r r r �depart_desc_signature_line� � z/ManualPageTranslator.depart_desc_signature_linec C rk r )�visit_definitionrg r r r �visit_desc_content� rn z'ManualPageTranslator.visit_desc_contentc C rk r )�depart_definitionrg r r r �depart_desc_content� rn z(ManualPageTranslator.depart_desc_contentc C rf r r rg r r r �visit_desc_inline� ri z&ManualPageTranslator.visit_desc_inlinec C rf r r rg r r r �depart_desc_inline� ri z'ManualPageTranslator.depart_desc_inlinec C rf r r rg r r r �visit_desc_name� ri z$ManualPageTranslator.visit_desc_namec C rf r r rg r r r �depart_desc_name� ri z%ManualPageTranslator.depart_desc_namec C rf r r rg r r r �visit_desc_addname� ri z'ManualPageTranslator.visit_desc_addnamec C rf r r rg r r r �depart_desc_addname� ri z(ManualPageTranslator.depart_desc_addnamec C rf r r rg r r r �visit_desc_type� ri z$ManualPageTranslator.visit_desc_typec C rf r r rg r r r �depart_desc_type� ri z%ManualPageTranslator.depart_desc_typec C rw )Nz -> ry rg r r r �visit_desc_returns� r} z'ManualPageTranslator.visit_desc_returnsc C rf r r rg r r r �depart_desc_returns� ri z(ManualPageTranslator.depart_desc_returnsc C s | j �d� d| _d S )N�(r6 )rz r{ � first_paramrg r r r �visit_desc_parameterlist� s
z-ManualPageTranslator.visit_desc_parameterlistc C rw )N�)ry rg r r r �depart_desc_parameterlist� r} z.ManualPageTranslator.depart_desc_parameterlistc C s | j s | j�d� d S d| _ d S )N�, r )r� rz r{ rg r r r �visit_desc_parameter� s
z)ManualPageTranslator.visit_desc_parameterc C rf r r rg r r r �depart_desc_parameter� ri z*ManualPageTranslator.depart_desc_parameterc C rw )N�[ry rg r r r �visit_desc_optional� r} z(ManualPageTranslator.visit_desc_optionalc C rw )N�]ry rg r r r �depart_desc_optional� r} z)ManualPageTranslator.depart_desc_optionalc C rf r r rg r r r �visit_desc_annotation� ri z*ManualPageTranslator.visit_desc_annotationc C rf r r rg r r r �depart_desc_annotation� ri z+ManualPageTranslator.depart_desc_annotationc C rk r )�visit_paragraphrg r r r �visit_versionmodified� rn z*ManualPageTranslator.visit_versionmodifiedc C rk r )�depart_paragraphrg r r r �depart_versionmodified� rn z+ManualPageTranslator.depart_versionmodifiedc s0 t |�tj��r| j�d� d S t� �|� d S �N�
)r; r< r r: rz r{ r rr rg r r r rr � s z ManualPageTranslator.visit_termc C � t j�r �r �SkipNoderg r r r �
visit_comment� � z"ManualPageTranslator.visit_commentc s | � � t� �|� d S r )�
ensure_eolr �visit_footnoterg r r r r� � � z#ManualPageTranslator.visit_footnotec C s` | � � t|�dkr(|�� dtd�fv r(| j�d| �|�� ��� d � tj �| j�d� d S )Nr6 � Footnotesz.SH r� �.sp
)
r� rD r& r rz r{ r` rZ r r� rg r r r � visit_rubric� s
"z!ManualPageTranslator.visit_rubricc C rw r� ry rg r r r �
depart_rubric� r} z"ManualPageTranslator.depart_rubricc C s | � |d� d S )N�seealso)�visit_admonitionrg r r r �
visit_seealso r} z"ManualPageTranslator.visit_seealsoc C rk r )�depart_admonitionrg r r r �depart_seealso rn z#ManualPageTranslator.depart_seealsoc C s& | � � g }| jd7 _| j�d� tttj |�}|D ] }|�|d � q tdd� |D ��}d }|D ]N}|d rg|d � |�}| j�| j
d d � | j�| � |�� | j�| j
d d � | j�d� n|d urw| j�d d
t |� � |�
| � | j�d � q4| j�d � | jd8 _tj�)
Nr6 z.sp
.nf
� tokennamec s s � | ]}t |�V qd S r )rD )r0 �namer r r r4 r5 z<ManualPageTranslator.visit_productionlist.<locals>.<genexpr>r: r z ::= z%s rx r� z
.fi
)r� rU rz r{ r r r �
production�max�ljust�defsr` rD r% r r� )r rE �names�productionlistr� �maxlen�lastnamer r r �visit_productionlist s.
z)ManualPageTranslator.visit_productionlistc C rf r r rg r r r �visit_production ri z%ManualPageTranslator.visit_productionc C rf r r rg r r r �depart_production" ri z&ManualPageTranslator.depart_productionc C s@ d|j v r| j�td�|d d � | j�td�d � tj�)N�altz [image: %s]r� z[image])rC rz r{ r r r� rg r r r � visit_image& s
z ManualPageTranslator.visit_imagec C s� | j �| jd d � | �|� | j �| jd d � |�dd�}|�d�s5|�d�s5|�d�s5|�d �r_| jjr_|�� |kr_|�d�rJ|d
d � }| j � d | jd d || jd d d
g� t
j �)N� referencer r6 �refurir7 zmailto:zhttp:zhttps:zftp:� z <r: �>) rz r{ r� �
visit_Text�get�
startswithr[ �
man_show_urlsr& �extendr r� )r rE �urir r r �visit_reference- s$
��
�z$ManualPageTranslator.visit_referencec C s" t �|�dd��}| �|� t j�)NrK �#)r �Textr� r� r� )r rE �textr r r �visit_number_referenceA s
z+ManualPageTranslator.visit_number_referencec C s | � � | j�d� d S )Nz.sp
.ce
)r� rz r{ rg r r r �visit_centeredF r� z#ManualPageTranslator.visit_centeredc C rw )Nz
.ce 0
ry rg r r r �depart_centeredJ r} z$ManualPageTranslator.depart_centeredc C rf r r rg r r r �visit_compact_paragraphM ri z,ManualPageTranslator.visit_compact_paragraphc C rf r r rg r r r �depart_compact_paragraphP ri z-ManualPageTranslator.depart_compact_paragraphc C rf r r rg r r r �visit_download_referenceS ri z-ManualPageTranslator.visit_download_referencec C rf r r rg r r r �depart_download_referenceV ri z.ManualPageTranslator.depart_download_referencec C r� r r� rg r r r �
visit_toctreeY r� z"ManualPageTranslator.visit_toctreec C r� r r� rg r r r � visit_index\ r� z ManualPageTranslator.visit_indexc C r� r r� rg r r r �visit_tabular_col_spec_ r� z+ManualPageTranslator.visit_tabular_col_specc C rf r r rg r r r �visit_glossaryb ri z#ManualPageTranslator.visit_glossaryc C rf r r rg r r r �depart_glossarye ri z$ManualPageTranslator.depart_glossaryc C sz t tj|d �}t ttj |�}| �� t tj|d �}t ttj |�}| j�d�dd� |D ��d � | j�d� tj �)Nr r� c s s � | ]}|� � V qd S r )r& )r0 �nr r r r4 n r5 z2ManualPageTranslator.visit_acks.<locals>.<genexpr>�.r� )
r r � bullet_listr � list_itemr� rz r{ �joinr� )r rE r� �
list_itemsr r r �
visit_acksh s z ManualPageTranslator.visit_acksc C rk r )�visit_bullet_listrg r r r � visit_hlistr rn z ManualPageTranslator.visit_hlistc C rk r )�depart_bullet_listrg r r r � depart_hlistu rn z!ManualPageTranslator.depart_hlistc C rf r r rg r r r �visit_hlistcolx ri z#ManualPageTranslator.visit_hlistcolc C rf r r rg r r r �depart_hlistcol{ ri z$ManualPageTranslator.depart_hlistcolc C �
| � |�S r )�visit_emphasisrg r r r �visit_literal_emphasis~ r. z+ManualPageTranslator.visit_literal_emphasisc C r� r )�depart_emphasisrg r r r �depart_literal_emphasis� r. z,ManualPageTranslator.depart_literal_emphasisc C r� r �� visit_strongrg r r r �visit_literal_strong� r. z)ManualPageTranslator.visit_literal_strongc C r� r ��
depart_strongrg r r r �depart_literal_strong� r. z*ManualPageTranslator.depart_literal_strongc C rf r r rg r r r �visit_abbreviation� ri z'ManualPageTranslator.visit_abbreviationc C rf r r rg r r r �depart_abbreviation� ri z(ManualPageTranslator.depart_abbreviationc C r� r r� rg r r r �
visit_manpage� r. z"ManualPageTranslator.visit_manpagec C r� r r� rg r r r �depart_manpage� r. z#ManualPageTranslator.depart_manpagec �: t |jtj�r|j�d�r| j�d� d S t� �|� d S )N�
literal_blockr� ) �
isinstancer> r � containerr� rz r{ r �
visit_captionrg r r r r� � � z"ManualPageTranslator.visit_captionc r� )Nr� r� ) r� r> r r� r� rz r{ r �depart_captionrg r r r r� � r� z#ManualPageTranslator.depart_captionc sv t |jtj�r| j�d� d S t |jtj�r5| jdkr tj �| jdkr5| j�d| �
|� � � � � � tj �t
� �|�S )Nz.IP "r r6 z.SH %s
)r� r> r r� rz r{ r rY rV r� r` r& rZ r � visit_titlerg r r r r� � s
� z ManualPageTranslator.visit_titlec s* t |jtj�r| j�d� d S t� �|�S )Nz"
)r� r> r r� rz r{ r � depart_titlerg r r r r� � s z!ManualPageTranslator.depart_titlec C s* d|� dd��� v r| j�|�� � tj�)N�manpage�formatr7 )r� �splitrz r{ r& r r� rg r r r � visit_raw� s z ManualPageTranslator.visit_rawc C r� r r� rg r r r �
visit_meta� r� z ManualPageTranslator.visit_metac C rf r r rg r r r � visit_inline� ri z!ManualPageTranslator.visit_inlinec C rf r r rg r r r �
depart_inline� ri z"ManualPageTranslator.depart_inlinec C rf r r rg r r r �
visit_math� ri z ManualPageTranslator.visit_mathc C rf r r rg r r r � depart_math� ri z ManualPageTranslator.depart_mathc C rk r )r� rg r r r �visit_math_block� rn z%ManualPageTranslator.visit_math_blockc C rk r )r� rg r r r �depart_math_block� rn z&ManualPageTranslator.depart_math_blockc C s t d|jj ��)NzUnknown node: )�NotImplementedErrorr r* rg r r r �
unknown_visit� r} z"ManualPageTranslator.unknown_visit)ar* r+ r, rH rI r �strr �__annotations__r r r
r re r rh rj rm rp rs ru rv r| r r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rr r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r r r r r r r- r r r r r# J s�
r# N)%rH �typingr r r r �docutilsr �docutils.nodesr r r �docutils.writers.manpager
�BaseTranslatorr �sphinxr �sphinx.buildersr
�
sphinx.localer r � sphinx.utilr �sphinx.util.docutilsr �sphinx.util.i18nr �sphinx.util.nodesr � getLoggerr* �loggerr r r# r r r r �<module> s"