File: //kunden/lib/python3/dist-packages/breezy/__pycache__/plugin.cpython-39.pyc
a
�*�^�] � @ s� d Z ddlmZ ddlZddlZddlZddlZddlmZ ddl m Z e e
� d� ddlm Z d Z d
srej
d krxd Znd
ZdPdd�ZdQdd�Zdd� Zdd� Zdd� ZG dd� de�Zdd� ZdRd d �ZdSd d!�ZdTd#d$�Zd%d&� Zd'd(� Zd)d*� Z d+d,� Z d-d.� Z d/d0� Z d1d2� Z dUd4d5�Z!d6d7� Z"d8d9� Z#d:d;� Z$d<d=� Z%d>d?� Z&d@dA� Z'dBdC� Z(dVdDdE�Z)G dFdG� dGe*�Z+G dHdI� dIe*�Z,G dJdK� dKe*�Z-G dLdM� dMe*�Z.G dNdO� dOe*�Z/dS )Wa� Breezy plugin support.
Which plugins to load can be configured by setting these environment variables:
- BRZ_PLUGIN_PATH: Paths to look for plugins in.
- BRZ_DISABLE_PLUGINS: Plugin names to block from being loaded.
- BRZ_PLUGINS_AT: Name and paths for plugins to load from specific locations.
The interfaces this module exports include:
- disable_plugins: Load no plugins and stop future automatic loading.
- load_plugins: Load all plugins that can be found in configuration.
- describe_plugins: Generate text for each loaded (or failed) plugin.
- extend_path: Mechanism by which the plugins package path is set.
- plugin_name: Gives unprefixed name of a plugin module.
See the plugin-api developer documentation for information about writing
plugins.
� )�absolute_importN� )�osutils)� lazy_importz�
import imp
from importlib import util as importlib_util
from breezy import (
bedding,
debug,
help_topics,
trace,
)
)�errorszbreezy.plugins.T)� z.pycz.pyoc C s | du rt �� } i | _dS )z�Disable loading plugins.
Future calls to load_plugins() will be ignored.
:param state: The library state object that records loaded plugins.
N)�breezy�get_global_state�plugins)�state� r �//usr/lib/python3/dist-packages/breezy/plugin.py�disable_pluginsH s r c C sf |du rt �� }t|dd�dur$dS | du r8ddlm} i |_t|| � dt� v rZt|� t � |_ dS )a� Load breezy plugins.
The environment variable BRZ_PLUGIN_PATH is considered a delimited
set of paths to look through. Each entry is searched for `*.py`
files (and whatever other extensions are used in the platform,
such as `*.pyd`).
:param path: The list of paths to search for plugins. By default,
it is populated from the __path__ of the breezy.plugins package.
:param state: The library state object that records loaded plugins.
Nr
r )�__path__)N� entrypoints)
r r �getattrZbreezy.pluginsr �plugin_warnings�_load_plugins_from_path�_env_plugin_path� _load_plugins_from_entrypointsr
)�pathr r r r
� load_pluginsT s
r c C sX z dd l }W n ty Y n60 |�d�D ](}t|j }|tjv rDq*|�� tj|< q*d S )Nr z
breezy.plugin)�
pkg_resources� ImportErrorZiter_entry_points�_MODULE_PREFIX�name�sys�modules�load)r r Zep�fullnamer r r
r q s
r c C s, | � t�r(| �d�}t|�dkr(|d S dS )z/Gives unprefixed name from module_name or None.�.� N)�
startswithr �split�len)Z module_name�partsr r r
� plugin_name s
r& c C s6 t � }t|� t� }t|� tt� | �}t||||�S )aE Helper so breezy.plugins can be a sort of namespace package.
To be used in similar fashion to pkgutil.extend_path:
from breezy.plugins import extend_path
__path__ = extend_path(__path__, __name__)
Inspects the BRZ_PLUGIN* envvars, sys.path, and the filesystem to find
plugins. May mutate sys.modules in order to block plugin loading, and may
append a new meta path finder to sys.meta_path for plugins@ loading.
Returns a list of paths to import from, as an enhanced object that also
contains details of the other configuration used.
)�_env_disable_plugins�_block_plugins�_env_plugins_at�_install_importer_if_needed�_iter_plugin_pathsr �_Path)r r Zblocks�
extra_details�pathsr r r
� extend_path� s r/ c s( e Zd ZdZ� fdd�Zdd� Z� ZS )r, z�List type to use as __path__ but containing additional details.
Python 3 allows any iterable for __path__ but Python 2 is more fussy.
c s& t t| ��|� || _|| _|| _d S �N)�superr, �__init__� package_name�
blocked_namesr- )�selfr3 ZblockedZextrar. �� __class__r r
r2 � s z_Path.__init__c C s" d| j j| j| j| jt�| �f S )Nz%s(%r, %r, %r, %s))r7 �__name__r3 r4 r- �list�__repr__�r5 r r r
r: � s �z_Path.__repr__)r8 �
__module__� __qualname__�__doc__r2 r: �
__classcell__r r r6 r
r, � s r, c C s, t �d| �du r$t�d| ||� dS t| �S )a Validate given name from envvar is usable as a Python identifier.
Returns the name as a native str, or None if it was invalid.
Per PEP 3131 this is no longer strictly correct for Python 3, but as MvL
didn't include a neat way to check except eval, this enforces ascii.
z^[A-Za-z_][A-Za-z0-9_]*$Nz Invalid name '%s' in %s='%s')�re�match�trace�warning�str)r Zenv_keyZ env_valuer r r
�_expect_identifier� s rE �BRZ_DISABLE_PLUGINSc C sF g }t �| �}|rB|�tj�D ]"}t|| |�}|dur |�|� q |S )z<Gives list of names for plugins to disable from environ key.N)r �path_from_environr# �os�pathseprE �append)�keyZdisabled_names�envr r r r
r' � s
r' �BRZ_PLUGINS_ATc C s~ g }t �| �}|rz|�tj�D ]Z}d|v r<|�dd�\}}n|}t �|��dd�d }t|| |�}|dur |�||f� q |S )zCGives list of names and paths of specific plugins from environ key.�@r r r N)r rG r# rH rI �basenamerE rJ )rK �plugin_detailsrL Zpairr r r r r
r) � s
r) �BRZ_PLUGIN_PATHc C s� g }t �| �}| dddd�}|r�|�tj�D ]h}|dd� |dd� }}|dv r�||v r�|dkr~|| dur~|�d|f� d||< q.|�|df� q.d D ]}|| r�|�d|f� q�|S )
z�Gives list of paths and contexts for plugins from environ key.
Each entry is either a specific path to load plugins from and the value
'path', or None and one of the values 'user', 'core', 'entrypoints', 'site'.
TF)�user�core�siter Nr )�+�-rU r )rR rS r rT )r rG r# rH rI rJ )rK Z path_detailsrL �defaults�p�flagr r r r
r � s&
�
r c c s� | D ]�\}}|dkr |V q|dkr>t � }tj�|�r�|V q|dkr\t|�D ]
}|V qNq|dkrttj�D ]}tj�|�rn|V qnqdS )z3Generate paths using paths_from_env and core_paths.r rR rS rT N)�get_user_plugin_pathrH r �isdir�_get_core_plugin_paths�_get_site_plugin_pathsr )Zpaths_from_envZ
core_pathsr �contextr r r
r+ s
r+ c C s | r t t| �}tj�d|� dS )z;Install a meta path finder to handle plugin_details if any.r! N)�_PluginsAtFinderr r � meta_path�insert)rP �finderr r r
r* s
r* c C sT t � }t|�D ]@\}}||vrt||�}|durD| j�|g ��|� |�|� qdS )z(Do the importing all plugins from paths.N)�set�_iter_possible_plugins�_load_plugin_moduler �
setdefaultrJ �add)r r. Zimported_namesr r �msgr r r
r s
r c C s< | D ]2}t | }tj�|�dur,t�d|� dtj|< qdS )z1Add names to sys.modules to block future imports.Nz!Blocked plugin %s already loaded.)r r r �getrB �mutter)�namesr r3 r r r
r( & s
r( c C s@ t �| d�}tj�|�r |S |dd� t }tj�|�r<|S dS )zEGet path of __init__ file from package_path or None if not a package.z __init__.pyN���)r �pathjoinrH r �exists� COMPILED_EXT)� package_path� init_pathr r r
�_get_package_init/ s rr c c sl t | dd�D ]\}}||fV q | D ]B}tj�|�rJ|�d�rft�d� q$t|�D ]\}}||fV qRq$dS )z?Generate names and paths of possible plugins from plugin_paths.r- r z.zipz+Don't yet support loading plugins from zip.N)r rH r �isfile�endswithrB rj �
_walk_modules)Z plugin_pathsr r r r r
rd : s
rd c c s� t �| �D ]�\}}}|�� |D ]8}|dd� dkr |�dtf�r |�dd�d |fV q |�� |D ]:}|dd� dkrft�||�}t|�}|durf||fV qf|dd�= q
dS )z7Generate name and path of modules and packages on path.Nr! �__�.pyr r r ) rH �walk�sortrt ro �rsplitr rm rr )r �root�dirs�files�f�dZ package_dir�fullpathr r r
ru I s ru Fc c s� |du rt �� }t|di �}tt|dg ��}tt|�� ��|��}|D ]�}||v r�|| }|j}|dkrld}d||f V |jj }|r�|�
d�d } nd } d
| V | r�d |� � V n
d | V ||j v r�|j | D ]}
d
|
d V q�dV qFdS )a Generate text description of plugins.
Includes both those that have loaded, and those that failed to load.
:param show_paths: If true, include the plugin path.
:param state: The library state object to inspect.
:returns: Iterator of text lines (including newlines.)
Nr
r �unknown� z%s %s
�
r z(no description)z %s
z %s
z%s (failed to load)
z ** )
r r r rc �sorted�keys�union� __version__�moduler> r# r r ) Z
show_pathsr Zloaded_pluginsr Z all_namesr Zplugin�versionr �doc�liner r r
�describe_plugins\ s0
r� c c s< t tdd�r(t�t�t�t�d��V n| D ]
}|V q,dS )z@Generate possible locations for plugins based on existing_paths.�frozenFz../../../pluginsN)r r r �abspathrm �dirname�__file__)Zexisting_pathsr r r r
r\ � s
�
r\ c c s. | D ]$}t j�|�dv rt�|dd�V qdS )z=Generate possible locations for plugins from given sys_paths.)z
dist-packagesz
site-packagesr r
N)rH r rO r rm )Z sys_pathsr r r r
r] � s r] c C s t �t�� d�S )Nr
)r rm ZbeddingZ
config_dirr r r r
rZ � s rZ c C s t �| � | S r0 )rB rj )�warning_messager r r
�record_plugin_warning� s
r� c
C s t | tjv rdS ztt | � W � n� tjyj } z,d| |jj|j|j f }t
|�W Y d}~S d}~0 t �y } z�t �
� dtjv r�t �t�� tj� t�d| �r�t�dd| �}|�d�r�|td�d� }t �d| ||f � n t
d | ||f �W Y d}~S W Y d}~n
d}~0 0 dS )
z�Load plugin by name.
:param name: The plugin name in the breezy.plugins namespace.
:param dir: The directory the plugin is loaded from for error messages.
NzRUnable to load plugin %r. It supports %s versions %r but the current version is %s�errorz\.|-| z[-. ]�_Zbrz_zkUnable to load %r in %r as a plugin because the file path isn't a valid module name; try renaming it to %r.z$Unable to load plugin %r from %r: %s)r r r �
__import__r ZIncompatibleVersionZapir8 ZwantedZcurrentr� � ExceptionrB �log_exception_quietly�debugZ debug_flags�print_exception�exc_info�stderrr@ �search�subr" r$ rC )r �dir�er� Zsanitised_namer r r
re � s0 ��
� �re c C sX i } t jD ]H}|�t�r
|tt�d� }d|vr
t j| dur
t|t j| �| |< q
| S )z]Return a dictionary of the plugins.
Each item in the dictionary is a PlugIn object.
Nr )r r r" r r$ �PlugIn)�resultr r r r r
r
� s
r
c C s> zt jt| }W n ty& Y dS 0 |du r4dS t| |�S )z[Retrieve an already loaded plugin.
Returns None if there is no such plugin loaded
N)r r r �KeyErrorr� �r r� r r r
�get_loaded_plugin� s r� c C sP | du rt �� } g }tt| di ��� �D ] \}}|�d||jf � q(d�|�S )zIReturn a string holding a concise list of plugins and their version.
Nr
z%s[%s]z, )r r r� r �itemsrJ r� �join)r r� r Za_pluginr r r
�format_concise_plugin_list� s �r� c @ s e Zd ZdZdd� Zdd� ZdS )�PluginsHelpIndexz2A help index that returns help topics for plugins.c C s
d| _ d S )Nzplugins/��prefixr; r r r
r2 � s zPluginsHelpIndex.__init__c C sb |sg S |� | j�r&|t| j�d� }t| }ztj| }W n tyR g Y S 0 t|�gS dS )z�Search for topic in the loaded plugins.
This will not trigger loading of new plugins.
:param topic: A topic to search for.
:return: A list which is either empty or contains a single
RegisteredTopic entry.
N)r" r� r$ r r r r� �ModuleHelpTopic)r5 ZtopicZplugin_module_namer� r r r
�
get_topics� s
zPluginsHelpIndex.get_topicsN)r8 r< r= r> r2 r� r r r r
r� � s r� c @ s* e Zd ZdZdd� Zd
dd�Zdd � ZdS ) r� z6A help topic which returns the docstring for a module.c C s
|| _ dS )z\Constructor.
:param module: The module for which help should be generated.
N)r� )r5 r� r r r
r2 s zModuleHelpTopic.__init__NTc C sD | j jsd| j j }n| j j}|d dkr2|d7 }|t�|�7 }|S )z�Return a string with the help for this topic.
:param additional_see_also: Additional help topics to be
cross-referenced.
z Plugin '%s' has no docstring.
���r� )r� r> r8 Z help_topicsZ_format_see_also)r5 Zadditional_see_also�verboser� r r r
�
get_help_text s z ModuleHelpTopic.get_help_textc C s | j jtt�d� S )z+Return the module help topic: its basename.N)r� r8 r$ r r; r r r
�get_help_topic$ s z ModuleHelpTopic.get_help_topic)NT)r8 r< r= r> r2 r� r� r r r r
r� s
r� c @ sL e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z e
dd� �Z dS )r� zvThe breezy representation of a plugin.
The PlugIn object provides a way to manipulate a given plugin module.
c C s || _ || _dS )z Construct a plugin for module.Nr� )r5 r r� r r r
r2 / s zPlugIn.__init__c C s� t | jdd�dur&tj�| jjd �S t | jdd�dur|tj�| jj�}|dd� tkrx|dd� d }tj�|�rx|}|S t | j�S dS )z.Get the path that this plugin was loaded from.r Nr r� ���rw )
r r� rH r r� r r� ro rs �repr)r5 r Zpypathr r r
r 4 s z PlugIn.pathc C s d| j j| j j| j| jf S )Nz<%s.%s name=%s, module=%s>)r7 r< r8 r r� r; r r r
r: B s �zPlugIn.__repr__c C s$ t | jdd�dur | j�� S dS dS )z Return the plugin's test suite.�
test_suiteN)r r� r� r; r r r
r� G s
zPlugIn.test_suitec C s& t | jdd�dur |�| j�S dS dS )z�Return the adapted plugin's test suite.
:param loader: The custom loader that should be used to load additional
tests.
Z
load_testsN)r r� ZloadTestsFromModule)r5 �loaderr r r
�load_plugin_testsN s zPlugIn.load_plugin_testsc C sn t | jdd�}|durjz2t|t�r.|�d�}nt|�dkrFt|�d }W n tyh t� � |f}Y n0 |S )z5Return the plugin's version_tuple or None if unknown.� version_infoNr r )�finalr )
r r� �
isinstancerD r# r$ �tuple� TypeErrorrB r� )r5 r� r r r
r� Y s
zPlugIn.version_infoc
C sd | � � }|d u s t|�dkr dS zt�|�}W n0 tttfy^ t�� d� t
t |��}Y n0 |S )Nr r� r ) r� r$ r Z_format_version_tuple�
ValueErrorr� �
IndexErrorrB r� r� �maprD )r5 r� Zversion_stringr r r
r� h s zPlugIn.__version__N) r8 r< r= r> r2 r r: r� r� r� �propertyr� r r r r
r� ) s r� c @ s2 e Zd ZdZdd� Zdd� Zd dd�Zd d
� ZdS ) r_ z9Meta path finder to support BRZ_PLUGINS_AT configuration.c s" � | _ t� fdd�|D ��| _d S )Nc 3 s | ]\}}� | |fV qd S r0 r )�.0�nrX r� r r
� <genexpr>{ � z,_PluginsAtFinder.__init__.<locals>.<genexpr>)r� �dict�
names_to_path)r5 r� Znames_and_pathsr r� r
r2 y s z_PluginsAtFinder.__init__c C s d| j j| jf S �Nz<%s %r>)r7 r8 r� r; r r r
r: } s z_PluginsAtFinder.__repr__Nc C sP || j vrdS | j | }tj�|�rDt|�}|du rDtd||f ��t�||�S )z&New module spec returning find method.Nz&Not loading namespace package %s as %s)r� rH r r[ rr r Zimportlib_util�spec_from_file_location)r5 r r. �targetr r r r
� find_spec� s
�z_PluginsAtFinder.find_specc C s || j vrdS t| j | �S )z+Old PEP 302 import hook find_module method.N)r� �
_LegacyLoader)r5 r r r r r
� find_module� s
z _PluginsAtFinder.find_module)N)r8 r< r= r> r2 r: r� r� r r r r
r_ v s
r_ c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) r� zCSource loader implementation for Python versions without importlib.c C s
|| _ d S r0 )�filepath)r5 r� r r r
r2 � s z_LegacyLoader.__init__c C s d| j j| jf S r� )r7 r8 r� r; r r r
r: � s z_LegacyLoader.__repr__c
C s� | j }d}tj�|�r:t|�}|dur`|}d}d}tj}n&t�� D ] \}}}|�|�rB|} q`qB|du rxt d||f ��|tju r�d}n
t
||�}z4t� ||||||f�} || _ | W |dur�|�
� S n|dur�|�
� 0 dS )z2Load a plugin from a specific directory (or file).Nr� z%s cannot be loaded from %s)r� rH r r[ rr �imp�
PKG_DIRECTORYZ get_suffixesrt r �open� load_module� __package__�close)
r5 r Z plugin_pathZ loading_pathrq �suffix�mode�kindr~ �modr r r
r� � sB
�
�� �z_LegacyLoader.load_moduleN)r8 r< r= r> r2 r: r� r r r r
r� � s r� )N)NN)rF )rM )rQ )FN)N)0r> Z
__future__r rH r@ r r r� r r �globalsr r r� ro r r r r& r/ r9 r, rE r' r) r r+ r* r r( rr rd ru r� r\ r] rZ r� re r
r� r� �objectr� r� r� r_ r� r r r r
�<module> sX
!
%"
M