D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
lib
/
python3.9
/
site-packages
/
ipalib
/
__pycache__
/
Filename :
plugable.cpython-39.opt-1.pyc
back
Copy
a � �ili � @ st d Z ddlmZ ddlZddlZddlZddlZddlZddlZddlm Z ddl Z ddl Z ddl Z ddl Z ddlmZ ddlmZ ddlmZ ddlmZ dd lmZmZmZ dd lmZ dd l m Z m Z dd l m Z m!Z! dd l"m#Z#m$Z$ ddl%m&Z&m'Z'm(Z( e j)�r e*Z+e�,e-�Z.dZ/dd� Z0G dd� d�Z1G dd� de�Z2G dd� de�Z3G dd� de�Z4G dd� de!�Z5dS ) z� Plugin framework. The classes in this module make heavy use of Python container emulation. If you are unfamiliar with this Python feature, see http://docs.python.org/ref/sequence-types.html � )�MappingN)�path)�errors)�Env)�_)� classproperty)�ReadOnly�lock�islocked)�DEFAULT_CONFIG)�ipa_log_manager�ipautil)�IPAOptionParser� IPAFormatter)�LOGGING_FORMAT_FILE�LOGGING_FORMAT_STDERR)�VERSION� API_VERSION�DEFAULT_PLUGINSz%s: need a %r; got a %r: %rc c s� t j�| �| kr t j�| �s dS t j�| �r0dS d}tt �| ��D ]N}|�|�sRqBt j�| |�}t j� |�snqB|dt |� � }|dkr�qB|V qBdS )z< Iterate through module names found in ``src_dir``. Nz.py�__init__) �osr �abspath�isdir�islink�sorted�listdir�endswith�join�isfile�len)Zsrc_dir�suffix�nameZpyfile�module� r# �3/usr/lib/python3.9/site-packages/ipalib/plugable.py�find_modules_in_dirA s r% c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �Registrya A decorator that makes plugins available to the API Usage:: register = Registry() @register() class obj_mod(...): ... For forward compatibility, make sure that the module-level instance of this object is named "register". c C s t �� | _d S �N)� collections� OrderedDict�_Registry__registry��selfr# r# r$ r d s zRegistry.__init__c s � �fdd�}|S )Nc s@ t | �std| ��| �jv r*tj| d��t� | d��j| < | S )z� Register the plugin ``plugin``. :param plugin: A subclass of `Plugin` to attempt to register. � plugin must be callable; got %r��plugin)�callable� TypeErrorr* r ZPluginDuplicateError�dictr. ��kwargsr, r# r$ �registerh s z#Registry.__call__.<locals>.registerr# )r, r4 r5 r# r3 r$ �__call__g s zRegistry.__call__c C s t | j�� �S r' )�iterr* �valuesr+ r# r# r$ �__iter__| s zRegistry.__iter__N)�__name__� __module__� __qualname__�__doc__r r6 r9 r# r# r# r$ r& V s r& c @ s� e Zd ZdZdZdd� Zedd� �Zee�Z edd� �Z ee �Z ed d � �Z ee �Z ed d � �Zee�Zed d� �Zee�Zedd� �Zedd� �Zedd� �Zedd� �Zdd� Zdd� Zdd � ZG d d � d �Zd d � Zd!S )"�Pluginz% Base class for all plugins. �1c C s || _ d| _d| _t�� | _d S )NF)� _Plugin__api�_Plugin__finalize_called�_Plugin__finalized� threading�RLock�_Plugin__finalize_lock)r, �apir# r# r$ r � s zPlugin.__init__c C s | j S r' �r: ��clsr# r# r$ Z __name_getter� s zPlugin.__name_getterc C s d� | j| j�S )Nz{}/{})�formatr! �versionrH r# r# r$ Z__full_name_getter� s zPlugin.__full_name_getterc C s | j S r' )� __bases__rH r# r# r$ Z__bases_getter� s zPlugin.__bases_getterc C s | j S r' )r= rH r# r# r$ Z __doc_getter� s zPlugin.__doc_getterc C s< | j }t|�js d| j| jf S t|��dd�d �� S d S )Nz<%s.%s>z � r )�docr �msgr; r: �unicode�split�strip)rI rN r# r# r$ Z__summary_getter� s zPlugin.__summary_getterc C s | j S )z? Return `API` instance passed to `__init__()`. )r@ r+ r# r# r$ rF � s z Plugin.apic C s | j jS r' )r@ �envr+ r# r# r$ rS � s z Plugin.envc C s | j jS r' )r@ �Backendr+ r# r# r$ rT � s zPlugin.Backendc C s | j jS r' )r@ �Commandr+ r# r# r$ rU � s zPlugin.Commandc C sf | j �L | jr W d � dS d| _| �� d| _| j�� sDt| � W d � n1 sX0 Y dS )z� Finalize plugin initialization. This method calls `_on_finalize()` and locks the plugin object. Subclasses should not override this method. Custom finalization is done in `_on_finalize()`. NT)rE rA � _on_finalizerB r@ �is_production_moder r+ r# r# r$ �finalize� s zPlugin.finalizec C s dS )z� Do custom finalization. This method is called from `finalize()`. Subclasses can override this method in order to add custom finalization. Nr# r+ r# r# r$ rV � s zPlugin._on_finalizec C s8 | j � | js| �� W d � n1 s*0 Y dS )zR Finalize plugin initialization if it has not yet been finalized. N)rE rB rX r+ r# r# r$ �ensure_finalized� s zPlugin.ensure_finalizedc @ s& e Zd ZdZdZddd�Zdd� ZdS ) zPlugin.finalize_attra/ Create a stub object for plugin attribute that isn't set until the finalization of the plugin initialization. When the stub object is accessed, it calls `ensure_finalized()` to make sure the plugin initialization is finalized. The stub object is expected to be replaced with the actual attribute value during the finalization (preferably in `_on_finalize()`), otherwise an `AttributeError` is raised. This is used to implement on-demand finalization of plugin initialization. �r! �valueNc C s || _ || _d S r' rZ )r, r! r[ r# r# r$ r � s z Plugin.finalize_attr.__init__c C sZ |d u s|j d u r| jS |�� zt|| j�W S tyT td| j|jf ��Y n0 d S )Nz7attribute '%s' of plugin '%s' was not set in finalize())rF r[ rY �getattrr! � RuntimeError�AttributeError)r, �objrI r# r# r$ �__get__� s �z Plugin.finalize_attr.__get__)N)r: r; r< r= � __slots__r r` r# r# r# r$ � finalize_attr� s rb c C s d| j j| j jf S )z� Return 'module_name.class_name()' representation. This representation could be used to instantiate this Plugin instance given the appropriate environment. z%s.%s())� __class__r; r: r+ r# r# r$ �__repr__ s �zPlugin.__repr__N) r: r; r< r= rK r � classmethodZ_Plugin__name_getterr r! Z_Plugin__full_name_getter� full_nameZ_Plugin__bases_getter�basesZ_Plugin__doc_getterrN Z_Plugin__summary_getterZsummary�propertyrF rS rT rU rX rV rY rb rd r# r# r# r$ r> � s> $r> c sd e Zd Zdd� Zdd� Zdd� Zdd� Zd d � Z� fd d �Zd d� Z dd� Z dd� Z dd� Z � Z S )� APINameSpacec C s || _ || _d | _d | _d S r' )�_APINameSpace__api�_APINameSpace__base�_APINameSpace__plugins� _APINameSpace__plugins_by_key)r, rF �baser# r# r$ r s zAPINameSpace.__init__c s� � j d ur� jd urd S � jj}t� }i }� _� jjD ]h}t� fdd�|jD ��sVq8|�|� |||< |||j |j f< |||j < |j |� |j d�kr8|||j < q8t |t�d�d�� _ d S )Nc 3 s | ]}t |� j�V qd S r' )� issubclassrk ��.0�br+ r# r$ � <genexpr>, � z+APINameSpace.__enumerate.<locals>.<genexpr>r? rf )�key)rl rm rj �_API__default_map�set� _API__plugins�anyrg �addr! rK rf �getr �operator� attrgetter)r, Z default_mapZpluginsZkey_dictr/ r# r+ r$ Z __enumerate# s zAPINameSpace.__enumeratec C s | � � t| j�S r' )�_APINameSpace__enumerater rl r+ r# r# r$ �__len__7 s zAPINameSpace.__len__c C s | � � || jv S r' �r~ rm �r, ru r# r# r$ � __contains__; s zAPINameSpace.__contains__c C s | � � t| j�S r' )r~ r7 rl r+ r# r# r$ r9 ? s zAPINameSpace.__iter__c s2 | � � t� �� }|�dd� | D �� |�� |S )Nc s s | ] }|j V qd S r' �r! )rq �pr# r# r$ rs G rt z'APINameSpace.__dir__.<locals>.<genexpr>)r~ �super�__dir__�extend�sort)r, �names�rc r# r$ r� C s zAPINameSpace.__dir__c C s | � � | j| S r' r� r� r# r# r$ � get_pluginK s zAPINameSpace.get_pluginc C s | � |�}| j�|�S r' )r� rj �_get)r, ru r/ r# r# r$ � __getitem__O s zAPINameSpace.__getitem__c C s t �| �S r' )�six� itervaluesr+ r# r# r$ r6 S s zAPINameSpace.__call__c C s* z | | W S t y$ t|��Y n0 d S r' )�KeyErrorr^ r� r# r# r$ � __getattr__V s zAPINameSpace.__getattr__)r: r; r< r r~ r r� r9 r� r� r� r6 r� � __classcell__r# r# r� r$ ri s ri c s� e Zd ZdZ� fdd�Zedd� �Zedd� �Zdd � Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� Zd0dd �Zd1d d �Zd2d d �Zd!d"� Zd#d$� Zd%d&� Zd3d(d)�Zd*d+� Zd,d-� Zd.d/� Z� ZS )4�APIzK Dynamic API object through which `Plugin` instances are accessed. c sB t t| ��� t� | _i | _i | _i | _i | _t� | _ t � | _ d S r' ) r� r� r rw rx �_API__plugins_by_keyrv �_API__instances� _API__next� _API__doner rS r+ r� r# r$ r b s z API.__init__c C s t �d S r' ��NotImplementedErrorr+ r# r# r$ rg l s z API.basesc C s t �d S r' r� r+ r# r# r$ �packagesp s z API.packagesc C s t | j�S )zL Return the number of plugin namespaces in this API object. )r rg r+ r# r# r$ r t s z API.__len__c C s dd� | j D �S )zN Iterate (in ascending order) through plugin namespace names. c s s | ] }|j V qd S r' rG )rq rn r# r# r$ rs ~ rt z API.__iter__.<locals>.<genexpr>)rg r+ r# r# r$ r9 z s z API.__iter__c C s |t | �v S )z� Return True if this API object contains plugin namespace ``name``. :param name: The plugin namespace name to test for membership. )rw �r, r! r# r# r$ r� � s zAPI.__contains__c C s4 || v r(z t | |�W S ty& Y n0 t|��dS )z� Return the plugin namespace corresponding to ``name``. :param name: The name of the plugin namespace you wish to retrieve. N�r\ r^ r� r� r# r# r$ r� � s zAPI.__getitem__c c s: | D ]0}zt | |�V W q ty2 t|��Y q0 qdS )zQ Iterate (in ascending order by name) through plugin namespaces. Nr� r� r# r# r$ r6 � s z API.__call__c C s t | jdd�dkS )z� If the object has self.env.mode defined and that mode is production return True, otherwise return False. �modeNZ production)r\ rS r+ r# r# r$ rW � s zAPI.is_production_modec C s. || j v r td| jj|f ��| j �|� d S )Nz%s.%s() already called)r� � Exceptionrc r: rz r� r# r# r$ Z__doing� s �z API.__doingc C s || j vrt| |�� d S r' )r� r\ r� r# r# r$ Z__do_if_not_done� s zAPI.__do_if_not_donec C s || j v S r' )r� r� r# r# r$ �isdone� s z API.isdoneNc K sv | � d� | jjf i |�� | jjf i tt��� |s>| �� }|| _t� � }|j sZ| jj r^dS | jj rntj }ntj}|�|� | jD ]Z}t�d|�}|s�q�t�|�d��}t| j|�}t�d|�}|D ]} |�t�| |�� q�q�tj}| jj r�tj }n*| jjdk�r | jjdk�rtj}ntj}t� � } | �|� | � t� t �� |� | � t!�"� } | �#� dv�rnt$j%| d ��| jj&d v �r�dS | jj'du �r�dS t(�)| jj'�} t(�*| ��s�zt+�,| � W n" t-�y� t.�/d | � Y dS 0 tj}| jj �r�tj }| jj'du�rrzt�0| jj'�} W n8 t1�yL } z t.�/d | jj'| � W Y d} ~ n.d} ~ 0 0 | �|� | � t� t2�� |� | � dS ) z? Initialize environment variables and logging. � bootstrapNz?^log_logger_level_(debug|info|warn|warning|error|critical|\d+)$rM z\s*,\s*�clir > �utf8zutf-8)�encoding�ZdummyZ unit_testzCould not create log_dir %rzCannot open log file %r: %s)3� _API__doingrS � _bootstrapZ_finalize_corer2 r �build_global_parser�parser�logging� getLogger�handlers� validate_api�debug�DEBUG�INFOZsetLevel�re�matchr Zconvert_log_level�groupr\ rQ Z addFilterZFilter�context�verboseZWARNINGZ StreamHandlerZ setFormatterZ Formatterr Z addHandler�sys�getfilesystemencoding�lowerr ZSystemEncodingErrorr� �logr �dirnamer r �makedirs�OSError�logger�errorZ FileHandler�IOErrorr )r, r� � overridesZ root_logger�level�attrr� r[ ZregexpsZregexpZhandlerZfseZlog_dir�er# r# r$ r� � s| � ( �z API.bootstrapc C s� dd� }|du rRt dt� dddttf d�g d ��d �}|�� |jd d d dd� |jdddddd� |jdddd|ddd � |jd d d d d� |jd!d d"d� |jd#d$d%d&d� |d'kr�|jd(d)d d*d� |jd+d,d-d.d/d0� |jd1d2d-d3d4d0� |S )5zD Add global options to an IPAOptionParser instance. c S s0 t j�|�s$|�td�t|d� � ||j_d S )Nz %(filename)s: file not found)�filename)r r r r� r r2 r8 �conf)�option�optr[ r� r# r# r$ �config_file_callback s �z5API.build_global_parser.<locals>.config_file_callbackNFz0%prog [global-options] COMMAND [command-options]zManage an IPA domainz VERSION: %s, API_VERSION: %s� )z0See "ipa help topics" for available help topics.z@See "ipa help <TOPIC>" for more information on a specific topic.z6See "ipa help commands" for the full list of commands.zFSee "ipa <COMMAND> --help" for more information on a specific command.)Zadd_help_option� formatter�usage� descriptionrK �epilogz-hz--help�helpz Show this help message and exit)�actionr� z-erS zKEY=VAL�appendz#Set environment variable KEY to VAL)�dest�metavarr� r� z-cr� �FILE�callback�stringz Load configuration from FILE.)r� r� r� r� �typer� z-dz--debug� store_truez Produce full debuging outputz --delegatez"Delegate the TGT to the IPA serverz-vz --verbose�countzEProduce more verbose output. A second -v displays the XML-RPC requestr� z-az --prompt-allz(Prompt for ALL values (even if optional)z-nz --no-prompt� store_false� interactivez'Prompt for NO values (even if required))r� r� r� z-fz --no-fallback�fallbackz7Only use the server configured in /etc/ipa/default.conf)r �IPAHelpFormatterr r r Zdisable_interspersed_argsZ add_option)r, r� r� r� r# r# r$ r� sZ � � � � � �� � � � �zAPI.build_global_parserc C s� | � ||�}|�� \}}i }|jd ur�|jD ]h}z|�dd�}W n tyR Y n0 t|�dkr~|\}} | �� |t|�� �< q,t� t dj |d����q,dD ] }t ||d �} | d ur�| ||< q�t |d�r�|j|d< |d ur�||d < | j|fi |�� ||fS ) N�=rM � z Unable to parse option {item})�item)r� r� r� Z prompt_allr� r� Zdelegate�prodZ webui_prodr� )r� � parse_argsrS rQ � ValueErrorr rR �strr Z OptionErrorr rJ r\ �hasattrr� r� ) r, r� r� �options�argsr� r� r8 ru r[ r# r# r$ � bootstrap_with_global_optionsM s2 � z!API.bootstrap_with_global_optionsc C s> | � d� | �d� | jjdv r$dS | jD ]}| �|� q*dS )z� Load plugins from all standard locations. `API.bootstrap` will automatically be called if it hasn't been already. � load_pluginsr� r� N)r� �_API__do_if_not_donerS r� r� � add_package)r, �packager# r# r$ r� m s zAPI.load_pluginsc sd |j � |j}t�t�|��}tj� �d�d }t�t�|j��}||krXtj � |d��t � d� � t |dt |��}� fdd�|D �}|D ]�}t � d|� zt�|�}W np tjy� } z(t � d || j� W Y d } ~ q�W Y d } ~ n8d } ~ 0 t�y | jj} | �rt �d |� � Y n0 z| �|� W q� tj�y\ } zt � d | � W Y d } ~ q�d } ~ 0 0 q�d S ) zx Add plugin modules from the ``package``. :param package: A package from which to add modules. �.r )r! �filez%importing all plugin modules in %s...�modulesc s g | ]}d � � |f��qS )r� )r )rq Zmname�Z package_namer# r$ � <listcomp>� rt z#API.add_package.<locals>.<listcomp>zimporting plugin module %sz skipping plugin module %s: %sNz could not load plugin module %sz%s)r: �__file__r r� r r� r� � rpartitionr ZPluginsPackageErrorr� r� r\ r% � importlib� import_moduleZSkipPluginModule�reasonr� rS Zstartup_traceback� exception� add_module�PluginModuleError) r, r� Z package_fileZ package_dir�parentZ parent_dirr� r! r" r� �tbr# r� r$ r� | s8 � zAPI.add_packagec C sX z |j }W n ty Y n*0 t|t�rF|D ]}| jf i |�� q,dS tj|jd��dS )zn Add plugins from the ``module``. :param module: A module from which to add plugins. Nr� )r5 r^ � isinstancer& � add_pluginr r� r: )r, r" r5 r4 r# r# r$ r� � s zAPI.add_moduleFc C s� t |�std| ��|jD ]}t|| j�r q@qtj|| jd��| j�|j�}|r�|sr|r^dS tj |j |j |d��| j � |� || j|< n |r�|r�dS tj|j |j |d��| j �|� || j|j< dS )z� Add the plugin ``plugin``. :param plugin: A subclass of `Plugin` to attempt to add. :param override: If true, override an already added plugin. r- )r/ rg N)rn r! r/ )r0 r1 rg ro r ZPluginSubclassErrorr� r{ rf ZPluginOverrideErrorr: r! rx �remover� ZPluginMissingOverrideErrorrz )r, r/ �overrideZno_failrn �prevr# r# r$ r� � s> �� � zAPI.add_pluginc sb | � d� | �d� | jjdur@| jj| jjkr@t�d| jj� | jD ]l}| jjs`|j t vr�qFnDz| j |j }W n t y� Y n"0 t�|j�}t�|�}||k r�qF|j| j |j < qF| �� }| jD ]Z� | jD ]0}t� fdd�|jD ��s�q�| jjs�| �|� q̈ j}|�s t| |t| � �� q�t�| j�D ]$}|�s4| jj�s*|� � |�s*�q*|�s^t | � dS )z� Finalize the registration, instantiate the plugins. `API.bootstrap` will automatically be called if it hasn't been already. rX r� Nz%IPA_CONFDIR env sets confdir to '%s'.c 3 s | ]}t |� �V qd S r' )ro rp �rn r# r$ rs rt z API.finalize.<locals>.<genexpr>) r� r� rS Z env_confdirZconfdirr� �inforx r� rf r rv r! r� r Z APIVersionrK rW rg ry Zplugins_on_demandr� r: �setattrri r� r� r� rY r )r, r/ Zdefault_versionrK Zproduction_moder! �instancer# r� r$ rX � sL � z API.finalizec C s^ t |�std| ��|| jvr&t|��z| j| }W n$ tyX || � }| j|< Y n0 |S �Nr- )r0 r1 rx r� r� )r, r/ r r# r# r$ r� $ s zAPI._getc C s t |�std| ��| j| S r )r0 r1 r� )r, r/ r# r# r$ �get_plugin_next1 s zAPI.get_plugin_next)N)NN)NN)FF) r: r; r< r= r rh rg r� r r9 r� r� r6 rW r� r� r� r� r� r� r� r� r� r� rX r� r r� r# r# r� r$ r� ] s2 Z > ' 4; r� c @ s e Zd Zdd� ZdS )r� c s@ | j | j �d| j � |�� }d�� �fdd�|D ��}d| S )N� r� c 3 s | ]}t j|�� � d �V qdS ))�initial_indent�subsequent_indentN)�textwrap�fill)rq �line��indent� text_widthr# r$ rs = s � �z1IPAHelpFormatter.format_epilog.<locals>.<genexpr>z %s )�width�current_indent� splitlinesr )r, r� �lines�resultr# r r$ � format_epilog9 s �z IPAHelpFormatter.format_epilogN)r: r; r< r r# r# r# r$ r� 8 s r� )6r= �collections.abcr r� r| r� r� rC r r r r( r� r� Zipalibr Z ipalib.configr Z ipalib.textr Z ipalib.utilr Z ipalib.baser r r Zipalib.constantsr Z ipapythonr r Zipapython.configr r Zipapython.ipa_log_managerr r Zipapython.versionr r r ZPY3r� rP r� r: r� Z TYPE_ERRORr% r& r> ri r� r� r# r# r# r$ �<module> sH * A ^