| Path : /lib/mysqlsh/python-packages/mysqlsh/plugin_manager/__pycache__/ |
|
B-Con CMD Config cPanel C-Rdp D-Log Info Jump Mass Ransom Symlink vHost Zone-H |
| Current File : //lib/mysqlsh/python-packages/mysqlsh/plugin_manager/__pycache__/registrar.cpython-38.pyc |
U
�C�ex � @ s` d Z ddlZddlZddlmZmZ g Zdd� Zddd�ZG dd � d �Z dd
d �Z
ddd�Z dS )z6Plugin Manager used for simplified plugin registration� N)�wraps�partialc C s t �| � d S �N)�_registration_callbacks�append)�callback� r �D/usr/lib/mysqlsh/python-packages/mysqlsh/plugin_manager/registrar.py�add_registration_callback# s r
c
C s ddl }|jjj}tdd� |�� d �d�d �d�D ��}d}| dk rhtd d� | �d�D ��}||k}d}|dk r�td
d� |�d�D ��}||k}d } |r�|s�| dk r�|dk r�d | � d
|� d�} n*| dk r�d| � d�} n|dk r�d|� d�} t| �dk�rt| ��dS )zE
Validates the plugin Shell version requirements for plugin.
r Nc S s g | ] }t |��qS r ��int��.0�vr r r �
<listcomp>. s z*validate_shell_version.<locals>.<listcomp>� �-�.Tc S s g | ] }t |��qS r r r
r r r r 3 s c S s g | ] }t |��qS r r r
r r r r 8 s � z,This plugin requires Shell between versions z and z,This plugin requires at least Shell version z7This plugin does not work on Shell versions newer than )�mysqlsh�globals�shell�version�tuple�split�len� Exception)
�min�maxr Z raw_versionZ
shell_versionZmin_version_okZ min_versionZmax_version_okZ max_version�errorr r r �validate_shell_version' s*
* r c @ s� e Zd ZdZedd� �ZG dd� d�ZG dd� d�ZG dd � d �ZG d
d � d �Z d d
� Z
dd� Z ddd�Z dd� Z
d dd�Zdd� ZdS ) �PluginRegistrara Helper class to register a shell plugin.
It should be used by calling: register_object which requires:
- The object path as it should be seen in the shell.
- The python function that will be added as members of the object.
- The documentation for the object (brief and details).
Examples for object name:
- 'cloud': Would register the 'cloud' as a shell global object.
- 'cloud.os': Would register the 'os' object as a child of the 'cloud'
global object.
The name can have any number of parents in the chain, the conditions is
that such parent should be already registered.
For this reason, the caller may have to do something like:
register_object('myGlobal', [], {'brief':'...', 'details':[]})
register_object('myGlobal.myChild', [], {'brief':'...', 'details':[]})
Before calling:
register_object('myGlobal.myChild.myGrandChild',
[function1, function2], {'brief':'...', 'details':[]})
Any object that is already defined will NOT be re-defined.
c C s8 | dkr dS | dkrdS | dkr$dS | dkr0dS | S d S )
zZHelper function to translate the sphinx types into the types required by
the shell�str�stringr Zinteger�dict�
dictionary�listZarrayNr )�typer r r �sphinx_2shell_typeb s z"PluginRegistrar.sphinx_2shell_typec @ s e Zd ZdZdd� ZdS )zPluginRegistrar.ItemDocz> Simple container for brief and details of the different itemsc C s d| _ d | _d S �Nr ��brief�details��selfr r r �__init__t s z PluginRegistrar.ItemDoc.__init__N)�__name__�
__module__� __qualname__�__doc__r/ r r r r �ItemDocq s r4 c @ s e Zd ZdZdd� Zdd� ZdS )zPluginRegistrar.OptionDataa� Holds the documentation for a specific option.
This object is completely created from parsed docs for an option.
TODO: Does not support 'details' for option as sphinx doesn't seem to
have a way to specify that, so the details MUST be placed at the
function details section (which is OK considering that's what the
shell will do when rendering the help data)
c C s� t �� | _|d | _|�d�| _|d | j_g | _|�dd�| _d|krT|d | j_ d|kr||d D ]}| j�
t � |�� qdd | _ d S )N�namer' r+ �requiredFr, �options)
r! r4 �docsr5 �getr' r+ r7 r6 r, r �
OptionData�default)r. Z
option_def�optionr r r r/ � s
z#PluginRegistrar.OptionData.__init__c C s� | j | jjd�}| jr&t�| j�|d< | jjdk r>| jj|d< | jrLd|d< | jdk r`| j|d< d|� � kr�|d dkr�g }| j
D ]}|� |� � � q�||d < |S )
�<Translates the parameter definition to shell required format�r5 r+ r' Nr, Tr6 r; r% r7 )
r5 r8 r+ r' r! r( r, r6 r; �keysr7 r � format_info�r. �infor7 �or r r r@ � s" �
z&PluginRegistrar.OptionData.format_infoN)r0 r1 r2 r3 r/ r@ r r r r r: x s
r: c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) z PluginRegistrar.ParameterDataa� Holds the documentation for a specific argument.
This object is created part from document parsing and part from
inspection of the function definition.
The function definition provides parameter name, whether it is
optional or not and the default value.
The documentation provides type, brief and options (when applicable)
TODO: Does not support 'details' for option as sphinx doesn't seem to
have a way to specify that, so the details MUST be placed at the
function details section (which is OK considering that's what the
shell will do when rendering the help data)
c C s || _ t�� | _d| _g | _d S r) )�
definitionr! r4 r8 r' r7 )r. Z parameterr r r r/ � s
z&PluginRegistrar.ParameterData.__init__c C s� d|kr|d | _ |d | j_z|d | j_W n tk
rB Y nX z(|d }|D ]}| j�t�|�� qRW n tk
r� Y nX dS )z4Fills parameter details that come from documentationr' r+ r, r7 N) r' r8 r+ r, �KeyErrorr7 r r! r: )r. rB r7 r< r r r �set_info� s
z&PluginRegistrar.ParameterData.set_infoc C s� | j j| jjd�}| jr(t�| j�|d< | jjdk r@| jj|d< | j jt j
j krd| j j|d< d|d< d|� � kr�|d dkr�t
| j�r�g }| jD ]}|�|�� � q�||d < | j jt j
jkr�d|d< |S )
r= r> r' Nr, r; Fr6 r% r7 )rD r5 r8 r+ r' r! r( r, r; �inspectZ Parameter�emptyr? r r7 r r@ ZkindZ VAR_KEYWORDrA r r r r@ � s$ � "
z)PluginRegistrar.ParameterData.format_infoN)r0 r1 r2 r3 r/ rF r@ r r r r �
ParameterData� s rI c @ sb e Zd ZdZddd�Zdd� Zd d
� Zd d � Zd
d� Zdd� Z dd� Z
dd� Z dd� Z dd� Z
dS )z PluginRegistrar.FunctionDataa# Holds the documentation for the function.
This object is created part from document parsing and part from
inspection of the function definition.
The function definition provides parameter information.
The documentation provides brief and details.
NTFc
C s� d }|d k r |� d�}|d }|| _|| _|d kr8|jn|| _t�� | _|| _|| _ || _
t � |�}dd� |j
�� D �| _
t �|�} | r�| �| � d S )Nr ���c S s g | ]}t �|��qS r )r! rI )r �pr r r r s �z9PluginRegistrar.FunctionData.__init__.<locals>.<listcomp>)r �function�fully_qualified_namer0 r5 r! r4 r8 r �cli�webrG � signature�
parameters�valuesZgetdoc� _parse_docs)
r. rL rM r rN rO r5 � name_pathrP r8 r r r r/ s$
�
z%PluginRegistrar.FunctionData.__init__c C sV | j j| j jd�}t| j�rBg }| jD ]}|�|�� � q&||d< | jrR| j|d< |S )r= r* rQ rN )r8 r+ r, r rQ r r@ rN )r. rB Zparams�paramr r r r@ s
z(PluginRegistrar.FunctionData.format_infoc C sF z | j | W S tk
r@ g | j |< | j�|� | j | Y S X dS )z3Ensures the indicated section exists and returns itN)�
_doc_sectionsrE �_doc_section_listr �r. r5 r r r �_get_doc_section0 s
z-PluginRegistrar.FunctionData._get_doc_sectionc C s` d| _ dd� |�d�D �| _i | _g | _d}| �|�}d}| jD ]|}|�d�r^|}| �|�}q@|�d�s�t|�dks�|d dks�|�d�r�|� |� q@|d }d
�
|�}| �|�}|� |� q@| j� � D ]j\}}|}|r�t|d �dkr�|� d� q�|�rt|d �dk�r|� d � q�t|�dkr�t
d |� ���q�| �� | �� }|�rT| �|� | �� d
S )a� Main parser function.
Retrieves the documentation and splits it in sections, then
process the different sections such as: brief, parameters and
details.
There are different sections that are considered on the parsing:
- 'Args:': Contains the parameter definitions.
- 'Keyword Args:': Contains parameter definitions for keyword
arguments.
- 'Allowed options for <dictionary>:': Contains option definitions
for a dictionary parameter or option.
These options will be consumed during the parsing process.
r c S s g | ]}|�qS r r )r �liner r r r J s z<PluginRegistrar.FunctionData._parse_docs.<locals>.<listcomp>�
�global�:� �* r zglobal{}rJ z)Invalid format: section without content: N)Z
_doc_indexr Z
_doc_linesrV rW rY �endswith�
startswithr r �format�items�popr �_parse_function_brief� _parse_args�_set_parameter_docs�_parse_details)r. Z docstring� section_name�sectionZ global_countrZ r5 �arg_docsr r r rS 9 s<
,
z(PluginRegistrar.FunctionData._parse_docsc C s� g }| j d }|D ] }t|�r*|�|� q q0qt|�}|rJd�|�| j_|t| j d �k r|t| j d | �dkr||d }qJ| j d |d� | j d< dS )zpConstructs the function brief from the beginning of the docs and until
the first blank line is foundr\ r^ r r N)rV r r �joinr8 r+ )r. Z brief_lines�linesrZ �countr r r re w s
��
z2PluginRegistrar.FunctionData._parse_function_briefc C sl | j �dd�}g }t| j�r.|dkr.td��n:|dkrJt| j�rJtd��n |rht|�rh|�| �|�� qN|S )z�Parses the function arguments.
This function will ensure:
- All the parameters are documented
- No nonexisting parameters are documented
zArgs:Nz Missing arguments documentationz!Unexpected argument documentation)rV rd r rQ r r �_parse_parameter_doc)r. Z args_sectionrk r r r rf � s
z(PluginRegistrar.FunctionData._parse_argsc C s dS )z�Some day it will parse the return section
TODO: The shell extension objects do not do any handling of the
return value so it's documentation is embedded into the function
details (in an ugly way).
Nr r- r r r �_parse_return_value� s z0PluginRegistrar.FunctionData._parse_return_valuec C s� g }g }| j D ]�}| j�|d�}|r|�d�s@|�d| d � t|�d }|D ]r}|�� }t|�dkr�|�d�|�� |�� qP|�d�r�|t|�d kr�|||< |�|� dd
�� qP|�|� qPt|�r|�d�|�� |�� q|r�|| j
_ dS ) aZ Creates the details section of the function.
When this function is called, the remaining sections will be glued
together to create the function details.
This means, it is possible to define totally unrelated sections of
documentation and they will also be included on the shell docs.
Nr\ z<b>z</b>r r r^ r_ � z@li ) rW rV rd ra r r �striprl �clear�replacer8 r, )r. r, Z paragraphri rj Z
section_indexrZ Z
stripped_liner r r rh � s.
z+PluginRegistrar.FunctionData._parse_detailsc C s� |D ]J}d}| j D ]}|d |jjkr|}q|dkrDtd�|���q|�|� qg }| j D ]"}t|jj�dkrZ|� |jj� qZt|�r�td�d�
|����dS )zaFills all the parameter definitions with the information coming
from document parsingNr5 z/Parameter does not exist but is documented: {}.r z6Missing documentation for the following parameters: {}z, ) rQ rD r5 r rb rF r r8 r+ r rl )r. r8 �docZ target_paramrU ZmissingrK r r r rg � s,
��
��z0PluginRegistrar.FunctionData._set_parameter_docsc
C s� i }|� d�}|�� }g }t�d|�}|�rnd}|�d�|d< |�d�r`d|d< | j� d d�}np|�d
�r�|�d
��d �}t�|d �|d< t |�dkr�|d d kr�d
|d < |d dkr�| j� d�
|d �d�}|r�g |d< t |�r�|d � | � |�� q�|� |�d�� |�
|�} t |��r^t |d �| k�r^|d | d dk�r^|� |� d��� � �qd�|�|d< ntd�
|���|S )z�Parses the first parameter/option definition coming on the
section.
Once it is parsed it will be removed from the section, next call
will process the next definition.
r zE^(\*\*)?([a-z|A-Z|_][a-z|A-Z|0-9|_]*)(\s(\(([a-z|,|\s]+)\)))?:\s(.*)$Nrq r5 r r% r' z
Keyword Args:� �,r6 TzAllowed options for {}:r7 � r^ r+ z#Invalid parameter documentation: {})rd rr �re�match�grouprV r r! r( r rb r ro �findrl r )
r. rj rB Z
param_lineZ param_docr+ rz Zoptions_sectionZ
param_optionsZ
ident_sizer r r ro � sd
�
�
� ��
����z1PluginRegistrar.FunctionData._parse_parameter_doc)NTFF)r0 r1 r2 r3 r/ r@ rY rS re rf rp rh rg ro r r r r � FunctionData� s �
>, r} c C s d S r r r- r r r r/ 8 s zPluginRegistrar.__init__c C s d� dd� t�d|�D ��S )N�_c S s g | ]}|r|� � �qS r )�lower)r �xr r r r < s z4PluginRegistrar._get_python_name.<locals>.<listcomp>z([A-Z][a-z0-9_]*))rl ry r rX r r r �_get_python_name; s z PluginRegistrar._get_python_nameNc
C s� zP| � ||�}|d kr&td|� d���|d k rN|D ]}t�|�r2| �||� q2W n: tk
r� } z td|� dt|�� ���W 5 d }~X Y nX d S )NzPlugin object z was not found.zCould not register object '�
'.
ERROR: )�get_plugin_object�
ValueErrorrG Z
isfunction�register_functionr r" )r. r5 r8 Zmembers�
plugin_objZmember�er r r �register_object> s
�z PluginRegistrar.register_objectc
C sb ddl }|jj}|�d�}�zd}t|�dkr�|d }|j}|dd� D ]H} | }
||jkrd| �| �}
|
t|�kr|t||
�}qHtd|
� d|� ���qH| �|�} t|| d�}|s�|dkr�t d|� ���|�
� }|� ||||� n@zt|j|d�}W n, t k
�r |�
� }|�
|||� Y nX |W S tk
�r\ } z td |� d
t| �� ���W 5 d} ~ X Y nX dS ) a Get the leaf object in the object hierarchy defined in name.
If the leaf object does not exist, it will be created with the provided
documentation.
If any object in the middle of the chain does not exist, an error will
be raised.
r Nr r rJ zObject z not found in hierarchy: z$No docs specified for plugin object z Could not get plugin object 'r� )r r r r r r� �dir�getattrr r� Zcreate_extension_object�add_extension_object_memberrE Zregister_globalr" )
r. r5 r8 r � shell_objZ hierarchyr� � plugin_name�parentZh_nameZpy_nameZpy_plugin_namer� r r r r� M sR
�
� ��z!PluginRegistrar.get_plugin_objectTFc C s� ddl }|jj}|r |s td��tj|||||d�} z0|rP|�|| j|| �� � t D ] }
|
| � qTW nF tk
r� } z(td| j� d| �� � dt
| �� ���W 5 d} ~ X Y nX dS )z?Registers a new member into the provided shell extension objectr Nz4The CLI can only be enabled on registered functions.)r rM rN rO zCould not add function 'z' using z .
ERROR: ) r r r r r! r} r� r5 r@ r r" ) r. r� rL rM r rN rO r r� rD r r� r r r r� � s6 � �� �z!PluginRegistrar.register_functionc C s d S r r )r. �propertyr r r �register_property� s z!PluginRegistrar.register_property)N)NTFF)r0 r1 r2 r3 � staticmethodr( r4 r: rI r} r/ r� r� r� r� r� r r r r r! F s&
7F E
A �
(r! c
s� � dkrt t|||d�S z\t||� t� �|dkr8� jn |d � j }��|t�� ��� � ��fdd���� � W n: tk
r� } z t d�
� jt |��� � W 5 d}~X Y nX t � �� fdd��}|S dS ) ag Decorator to register a class as a Shell extension object
This decorator can be used to register a class structure as a Shell
extension object. After registering the class it self it will also scan for
inner classes and register them as nested extension objects.
Args:
cls (class): The class structure to register
Returns:
N)�shell_version_min�shell_version_maxr� r c sH dd� | j �� D �}|D ]$}� �|jt�|��� � �|� q| � dS )z�Register all inner classes as nested extension objects
Args:
cls (class): The class containing the subclasses to register
c S s g | ]}t �|�r|�qS r )rG Zisclass)r � inner_classr r r r � s
�z:plugin.<locals>.register_inner_classes.<locals>.<listcomp>N)�__dict__rR r� r2 r! r} r@ )�clsZ
inner_classesr� )�plugin_manager�register_inner_classesr r r� � s � �
z&plugin.<locals>.register_inner_classesz2Could not register plugin object '{0}'.
ERROR: {1}c s � | |�}|S r r ��args�kwargs�result)r� r r �wrapper� s
zplugin.<locals>.wrapper)
r �pluginr r! r0 r� r} r@ r �printrb r" r )r� r� r� r� Zobject_qualified_namer� r� r )r� r� r� r r� � s.
� ��r� TFc s � ����fdd�}|S )a� Decorator factory to register Shell plugins functions
Args:
fully_qualified_name (str): The fully qualified name of the function,
e.g. cloud.create.mysqlDbSystem
plugin_docs (dict): The documentation structure of the plugin. This
is only required for the first function that will be registered
cli (bool): Defines whether the function should be available in the CLI
Returns:
The decorator function
c s� zPt � }��d�}d�|dd� �}|d }|�|��}|j|� ����d� W nB tk
r� } z$td|� d|� dt|�� �� � W 5 d }~X Y nX t� �� fdd ��}|S )
Nr r rJ )rM r rN rO z Could not register function 'z' as a member of the z plugin object.
ERROR: c s � | |�}|S r r r� �rL r r r� 1 s
z3plugin_function.<locals>.decorator.<locals>.wrapper) r! r rl r� r� r r� r" r )rL r� rT r� Z
function_namer� r� r� �rN rM � plugin_docsr rO r� r � decorator s2
� �
�z"plugin_function.<locals>.decoratorr )rM r� r rN rO r� r r� r �plugin_function s (r� )NN)NNNN)NTFF) r3 rG ry � functoolsr r r r
r r! r� r� r r r r �<module> s"
u
K �