← Back
Editing: disco.cpython-38.pyc
U �]�' � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl m Z ddl mZ e�e�ZG dd� de�ZG d d � d ej�ZdS ) z.Utilities for plugins discovery and selection.� N)�Dict)� constants)�errors)� interfacesc @ s� e Zd ZdZdddddddd d d d d dddddgZdZdd� Zedd� �Ze dd� �Z e dd� �Z e d d � �Z e d d � �Z d d!� Ze d"d#� �Zd6d$d%�Zd&d'� Ze d(d)� �Zd*d+� Ze d,d-� �Ze d.d/� �Ze d0d1� �Zd2d3� Zd4d5� ZdS )7�PluginEntryPointzPlugin entry point.�certbotzcertbot-apachezcertbot-dns-cloudflarezcertbot-dns-cloudxnszcertbot-dns-digitaloceanzcertbot-dns-dnsimplezcertbot-dns-dnsmadeeasyzcertbot-dns-gehirnzcertbot-dns-googlezcertbot-dns-linodezcertbot-dns-luadnszcertbot-dns-nsonezcertbot-dns-ovhzcertbot-dns-rfc2136zcertbot-dns-route53zcertbot-dns-sakuracloudz certbot-nginxNc C s, | � |�| _|�� | _|| _d | _d | _d S �N)�entry_point_to_plugin_name�name�load� plugin_cls� entry_point� _initialized� _prepared)�selfr � r �7/usr/lib/python3/dist-packages/certbot/plugins/disco.py�__init__0 s zPluginEntryPoint.__init__c C s& |j j| jkr|jS |j jd |j S )z)Unique plugin name for an ``entry_point``�:)Zdist�key�PREFIX_FREE_DISTRIBUTIONSr )�clsr r r r r 7 s z+PluginEntryPoint.entry_point_to_plugin_namec C s | j jS )zDescription of the plugin.)r � description�r r r r r > s z PluginEntryPoint.descriptionc C s d� | j| j�S )z$Description with name. Handy for UI.z {0} ({1}))�formatr r r r r r �description_with_nameC s z&PluginEntryPoint.description_with_namec C s* z | j jW S tk r$ | j Y S X dS )z Long description of the plugin.N)r �long_description�AttributeErrorr r r r r r H s z!PluginEntryPoint.long_descriptionc C s t | jdd�S )z%Should this plugin be hidden from UI?�hiddenF)�getattrr r r r r r P s zPluginEntryPoint.hiddenc s | pt � fdd�|D ��S )z2Does plugin implements specified interface groups?c 3 s$ | ] }t � fd d�|D ��V qdS )c 3 s | ]}|� � j�V qd S r )� implementedByr ��.0�ifacer r r � <genexpr>X s �z4PluginEntryPoint.ifaces.<locals>.<genexpr>.<genexpr>N)�all)r" �ifacesr r r r$ W s � �z*PluginEntryPoint.ifaces.<locals>.<genexpr>)�any�r � ifaces_groupsr r r r& U s �zPluginEntryPoint.ifacesc C s | j dk S )z(Has the plugin been initialized already?N)r r r r r � initialized\ s z PluginEntryPoint.initializedc C s& | j s | j�� | �|| j�| _| jS )z Memoized plugin initialization.)r* r Zrequirer r r �r �configr r r �inita s zPluginEntryPoint.initc C s� | j s t�|D ]r}ztjj�|| �� � W q tjjjk r~ } z0|� | j �rft j d| j |j |dd� W Y � dS d}~X Y qX qdS )z<Verify that the plugin conforms to the specified interfaces.z/%s implements %s but object does not verify: %sT��exc_infoFN)r* �AssertionError�zope� interface�verifyZ verifyObjectr- � exceptionsZBrokenImplementationr r �logger�debug�__name__)r r& r# �errorr r r r3 h s � zPluginEntryPoint.verifyc C s | j st�d| � | jdk S )z%Has the plugin been prepared already?z$.prepared called on uninitialized %rN)r* r5 r6 r r r r r �preparedv s zPluginEntryPoint.preparedc C s� | j s t�| jdkr�z| j�� W n� tjk r^ } z tjd| |dd� || _W 5 d}~X Y n| tj k r� } z tjd| |dd� || _W 5 d}~X Y nB tj k r� } z tjd| |dd� || _W 5 d}~X Y nX d| _| jS )z Memoized plugin preparation.NzMisconfigured %r: %sTr. zNo installation (%r): %szOther error:(%r): %s) r* r0 r r �preparer �MisconfigurationErrorr5 r6 ZNoInstallationErrorZ PluginError)r r8 r r r r: } s( �zPluginEntryPoint.preparec C s t | jtj�S )zIs plugin misconfigured?)� isinstancer r r; r r r r � misconfigured� s z PluginEntryPoint.misconfiguredc C s t | jt�r| jS dS )zGReturn the Exception raised during plugin setup, or None if all is wellN)r< r � Exceptionr r r r �problem� s zPluginEntryPoint.problemc C s | j dkp| jS )z4Is plugin available, i.e. prepared or misconfigured?T)r r= r r r r � available� s zPluginEntryPoint.availablec C s d� | j�S )NzPluginEntryPoint#{0})r r r r r r �__repr__� s zPluginEntryPoint.__repr__c C s� d� | j�d� | jj�d� d�dd� tj�| j�D ���d� | j�g}| j rz|� d� | � � �� | j rz|� d � | � � �� d �|�S ) Nz* {0}zDescription: {0}zInterfaces: {0}z, c s s | ] }|j V qd S r )r7 r! r r r r$ � s z+PluginEntryPoint.__str__.<locals>.<genexpr>zEntry point: {0}zInitialized: {0}z Prep: {0}� )r r r r �joinr1 r2 r r r* �appendr- r9 r: )r �linesr r r �__str__� s �� � zPluginEntryPoint.__str__)N)r7 � __module__� __qualname__�__doc__r �__hash__r � classmethodr �propertyr r r r r& r* r- r3 r9 r: r= r? r@ rA rF r r r r r s^ � r c @ s� e Zd ZdZdd� Zedd� �Zdd� Zdd � Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd S )!�PluginsRegistryzPlugins registry.c C s t �tt�|���| _d S r )� collections� OrderedDict�sorted�six� iteritems�_plugins)r �pluginsr r r r � s zPluginsRegistry.__init__c C sr i }t �t�tj�t�tj��}|D ]D}t|�}|j|ksBt d��t j � |j �r\|||j< q$t�d|� q$| |�S )z+Find plugins using setuptools entry points.z#PREFIX_FREE_DISTRIBUTIONS messed upz,%r does not provide IPluginFactory, skipping)� itertools�chain� pkg_resourcesZiter_entry_pointsr Z SETUPTOOLS_PLUGINS_ENTRY_POINTZ"OLD_SETUPTOOLS_PLUGINS_ENTRY_POINTr r r0 r ZIPluginFactoryZ providedByr r5 Zwarning)r rT Z entry_pointsr � plugin_epr r r �find_all� s* ��� � �zPluginsRegistry.find_allc C s | j | S r )rS )r r r r r � __getitem__� s zPluginsRegistry.__getitem__c C s t | j�S r )�iterrS r r r r �__iter__� s zPluginsRegistry.__iter__c C s t | j�S r )�lenrS r r r r �__len__� s zPluginsRegistry.__len__c s � fdd�t �| j�D �S )z'Initialize all plugins in the registry.c s g | ]}|� � ��qS r )r- �r" rX �r, r r � <listcomp>� s z(PluginsRegistry.init.<locals>.<listcomp>�rQ � itervaluesrS r+ r r` r r- � s �zPluginsRegistry.initc s& t | �t� fdd�t�| j�D ���S )z"Filter plugins based on predicate.c 3 s" | ]\}}� |�r||fV qd S r r )r" r rX ��predr r r$ � s �z)PluginsRegistry.filter.<locals>.<genexpr>)�type�dictrQ rR rS )r re r rd r �filter� s �zPluginsRegistry.filterc C s | � dd� �S )z#Filter plugins based on visibility.c S s | j S r )r )rX r r r �<lambda>� � z)PluginsRegistry.visible.<locals>.<lambda>�rh r r r r �visible� s zPluginsRegistry.visiblec s | � � fdd��S )z#Filter plugins based on interfaces.c s | j � � S r �r& ��p_ep�r) r r ri � rj z(PluginsRegistry.ifaces.<locals>.<lambda>rk r( r rp r r& � s zPluginsRegistry.ifacesc s | � � fdd��S )z%Filter plugins based on verification.c s | � � �S r )r3 rn rm r r ri � rj z(PluginsRegistry.verify.<locals>.<lambda>rk )r r& r rm r r3 � s zPluginsRegistry.verifyc C s dd� t �| j�D �S )z$Prepare all plugins in the registry.c S s g | ] }|� � �qS r )r: r_ r r r ra � s z+PluginsRegistry.prepare.<locals>.<listcomp>rb r r r r r: � s zPluginsRegistry.preparec C s | � dd� �S )z%Filter plugins based on availability.c S s | j S r )r@ rn r r r ri rj z+PluginsRegistry.available.<locals>.<lambda>rk r r r r r@ � s zPluginsRegistry.availablec s: � fdd�t �| j�D �}t|�dks*t�|r6|d S dS )a� Find an initialized plugin. This is particularly useful for finding a name for the plugin (although `.IPluginFactory.__call__` takes ``name`` as one of the arguments, ``IPlugin.name`` is not part of the interface):: # plugin is an instance providing IPlugin, initialized # somewhere else in the code plugin_registry.find_init(plugin).name Returns ``None`` if ``plugin`` is not found in the registry. c s" g | ]}|j r|�� � kr|�qS r )r* r- r_ ��pluginr r ra s �z-PluginsRegistry.find_init.<locals>.<listcomp>� r N)rQ rc rS r] r0 )r rr Z candidatesr rq r � find_init s zPluginsRegistry.find_initc C s( d� | jjd�dd� t�| j�D ���S )Nz{0}({1})�,c s s | ]}t |�V qd S r )�repr�r" ro r r r r$ s z+PluginsRegistry.__repr__.<locals>.<genexpr>)r � __class__r7 rC rQ rc rS r r r r rA s ��zPluginsRegistry.__repr__c C s& | j s dS d�dd� t�| j �D ��S )Nz No pluginsz c s s | ]}t |�V qd S r )�strrw r r r r$ ! s z*PluginsRegistry.__str__.<locals>.<genexpr>)rS rC rQ rc r r r r rF s zPluginsRegistry.__str__N)r7 rG rH rI r rK rY rZ r\ r^ r- rh rl r& r3 r: r@ rt rA rF r r r r rM � s" rM )rI rN rU ZloggingrW rQ Zzope.interfacer1 Zzope.interface.verifyZacme.magic_typingr r r r r Z getLoggerr7 r5 �objectr �MappingrM r r r r �<module> s #
Save File
Cancel