File: //usr/local/lib/python3.7/site-packages/pip/_internal/__pycache__/configuration.cpython-37.pyc
B
L��g�6 � @ s> d Z ddlZddlZddlZddlZddlmZmZmZm Z m
Z
m Z m Z ddl
mZmZ ddlmZ ddlmZ ddlmZ ddlmZmZ ejZe
d e�Zer�d
nd Z d Z ed
ddddd�Z e j e j e j!e j"e j#fZ$e j e j e j!fZ%ee&�Z'eed�dd�Z(ee e d�dd�Z)eee e f d�dd�Z*G dd � d �Z+dS ) a Configuration management setup
Some terminology:
- name
As written in config files.
- value
Value associated with a name
- key
Name combined with it's section (section.name)
- variant
A single word describing where the configuration key-value pair came from
� N)�Any�Dict�Iterable�List�NewType�Optional�Tuple)�ConfigurationError�!ConfigurationFileCouldNotBeLoaded)�appdirs)�WINDOWS)� getLogger)�
ensure_dir�enum�Kindzpip.inizpip.conf)�version�help�user�global�site�envzenv-var)�USER�GLOBAL�SITE�ENV�ENV_VAR)�name�returnc C s* | � � �dd�} | �d�r&| dd� } | S )zAMake a name consistent regardless of source (environment or file)�_�-z--� N)�lower�replace�
startswith)r � r$ �?/tmp/pip-unpacked-wheel-hv55ucu3/pip/_internal/configuration.py�_normalize_name2 s
r& c C s( d| kr d| � d�}t |��| �dd�S )N�.zVKey does not contain dot separated section and key. Perhaps you wanted to use 'global.z
' instead?� )r �split)r �
error_messager$ r$ r% �_disassemble_key: s r+ )r c C st dd� t �d�D �} tj�tjt�}tj�tj�d�t r<dndt�}tj�t �
d�t�}t j | t j
|gt j||giS )Nc S s g | ]}t j�|t��qS r$ )�os�path�join�CONFIG_BASENAME)�.0r- r$ r$ r% �
<listcomp>F s z+get_configuration_files.<locals>.<listcomp>�pip�~z.pip)r �site_config_dirsr, r- r. �sys�prefixr/ �
expanduserr �user_config_dir�kindsr r r )�global_config_files�site_config_file�legacy_config_file�new_config_filer$ r$ r% �get_configuration_filesD s
r> c s� e Zd ZdZd6eee dd�� fdd�
Zdd�dd�Zee d�d d
�Z
e e e e
f d�d d �Ze e
d
�dd�Ze e
dd�dd�Ze dd
�dd�Zdd�dd�Zdd�dd�Zeee e
f d�dd��Zdd�dd �Zee ed �d d �Ze ed �d!d"�Zdd�d#d$�Ze e e e e
f ee e
f d%�d&d'�Z e e e e f d�d(d)�Z e e ee e f d�d*d+�Z eee e
f d,�d-d.�Z e e ef d�d/d0�Z!e edd1�d2d3�Z"e d�d4d5�Z#� Z$S )7�
Configurationa� Handles management of configuration.
Provides an interface to accessing and managing configuration files.
This class converts provides an API that takes "section.key-name" style
keys and stores the value associated with it as "key-name" under the
section "section".
This allows for a clean interface wherein the both the section and the
key-name are preserved in an easy to manage form in the configuration files
and the data stored is also nice.
N)�isolated� load_onlyr c sj t � �� |d k r4|tkr4td�d�ttt�����|| _|| _ dd� t
D �| _ dd� t
D �| _ g | _
d S )Nz5Got invalid value for load_only - should be one of {}z, c S s i | ]
}g |�qS r$ r$ )r0 �variantr$ r$ r% �
<dictcomp>r s z*Configuration.__init__.<locals>.<dictcomp>c S s i | ]
}i |�qS r$ r$ )r0 rB r$ r$ r% rC u s )�super�__init__�VALID_LOAD_ONLYr �formatr. �map�reprr@ rA �OVERRIDE_ORDER�_parsers�_config�_modified_parsers)�selfr@ rA )� __class__r$ r% rE e s
zConfiguration.__init__)r c C s | � � | js| �� dS )z<Loads configuration from configuration files and environmentN)�_load_config_filesr@ �_load_environment_vars)rN r$ r$ r% �loadz s zConfiguration.loadc C s8 | j dk std��y | �� d S tk
r2 dS X dS )z7Returns the file with highest priority in configurationNz)Need to be specified a file to be editingr )rA �AssertionError�_get_parser_to_modify�
IndexError)rN r$ r$ r% �get_file_to_edit� s
z Configuration.get_file_to_editc C s
| j �� S )z`Returns key-value pairs like dict.items() representing the loaded
configuration
)� _dictionary�items)rN r$ r$ r% rX � s zConfiguration.items)�keyr c C sF |}t |�}y
| j| S tk
r@ t|� td|� ���Y nX dS )z#Get a value from the configuration.zNo such key - N)r& rW �KeyErrorr+ r )rN rY �orig_keyr$ r$ r% � get_value� s
zConfiguration.get_value)rY �valuer c C s| t |�}| �� | jst�| �� \}}|dk r\t|�\}}|�|�sN|�|� |�|||� || j | j |< | �
||� dS )z$Modify a value in the configuration.N) r& �_ensure_have_load_onlyrA rS rT r+ � has_section� add_section�setrL �_mark_as_modified)rN rY r] �fname�parser�sectionr r$ r$ r% � set_value� s
zConfiguration.set_valuec C s� |}t |�}| �� | js t�|| j| j kr<td|� ���| �� \}}|dk r�t|�\}}|�|�rr|� ||�sztd��|�
|�s�|� |� | � ||� | j| j |= dS )z#Unset a value in the configuration.zNo such key - Nz4Fatal Internal error [id=1]. Please report as a bug.)
r& r^ rA rS rL r rT r+ r_ �
remove_optionrX �remove_sectionrb )rN rY r[ rc rd re r r$ r$ r% � unset_value� s
zConfiguration.unset_valuec C s� | � � x�| jD ]�\}}t�d|� ttj�|�� y$t|d��}|� |� W dQ R X W q t
k
r� } zt d|� d|� ���W dd}~X Y qX qW dS )z!Save the current in-memory state.z
Writing to %s�wNz:An error occurred while writing to the configuration file z: ) r^ rM �logger�infor r, r- �dirname�open�write�OSErrorr )rN rc rd �f�errorr$ r$ r% �save� s zConfiguration.savec C s$ | j d krtd��t�d| j � d S )Nz'Needed a specific file to be modifying.z$Will be working with %s variant only)rA r rk �debug)rN r$ r$ r% r^ � s
z$Configuration._ensure_have_load_onlyc C s& i }x t D ]}|�| j| � q
W |S )z3A dictionary representing the loaded configuration.)rJ �updaterL )rN �retvalrB r$ r$ r% rW � s
zConfiguration._dictionaryc C s� t | �� �}|tj dd� tjgkr4t�d� dS xf|�� D ]Z\}}xP|D ]H}| j dk rt|| j krtt�d||� qL| �
||�}| j | � ||f� qLW q>W dS )z,Loads configuration from configuration filesr r( zZSkipping loading configuration files due to environment's PIP_CONFIG_FILE being os.devnullNz Skipping file '%s' (variant: %s))
�dict�iter_config_filesr9 r r, �devnullrk rt rX rA �
_load_filerK �append)rN � config_filesrB �filesrc rd r$ r$ r% rP � s
z Configuration._load_config_files)rB rc r c C sP t �d||� | �|�}x2|�� D ]&}|�|�}| j| �| �||�� q"W |S )Nz'For variant '%s', will try loading '%s')rk �verbose�_construct_parser�sectionsrX rL ru �_normalized_keys)rN rB rc rd re rX r$ r$ r% rz s
zConfiguration._load_file)rc r c
C s� t �� }tj�|�r�t�d�}y|j||d� W nT tk
rX t d|� d�|d��Y n. t j
k
r� } zt |d��W d d }~X Y nX |S )NF)�encodingzcontains invalid z characters)�reasonrc )rr ) � configparser�RawConfigParserr, r- �exists�locale�getpreferredencoding�read�UnicodeDecodeErrorr
�Error)rN rc rd Zlocale_encodingrr r$ r$ r% r s
z Configuration._construct_parserc C s" | j tj �| �d| �� �� dS )z.Loads configuration from environment variablesz:env:N)rL r9 r ru r� �get_environ_vars)rN r$ r$ r% rQ * s z$Configuration._load_environment_vars)re rX r c C s2 i }x(|D ] \}}|d t |� }|||< q
W |S )z�Normalizes items to construct a dictionary with normalized keys.
This routine is where the names become keys and are made the same
regardless of source - configuration files or environment.
r' )r& )rN re rX �
normalizedr �valrY r$ r$ r% r� 0 s
z Configuration._normalized_keysc c sH xBt j�� D ]4\}}|�d�r |dd� �� }|tkr ||fV q W dS )z@Returns a generator with all environmental vars with prefix PIP_�PIP_� N)r, �environrX r# r! �ENV_NAMES_IGNORED)rN rY r� r r$ r$ r% r� > s
z Configuration.get_environ_varsc c s� t j�dd�}t� }tj|tj fV | j o>|o<t j�|� }|rVtj |tj fV tj
|tj
fV |dk r�tj |gfV n tj g fV dS )a� Yields variant and configuration files associated with it.
This should be treated like items of a dictionary. The order
here doesn't affect what gets overridden. That is controlled
by OVERRIDE_ORDER. However this does control the order they are
displayed to the user. It's probably most ergononmic to display
things in the same order as OVERRIDE_ORDER
�PIP_CONFIG_FILEN) r, r� �getr> r9 r r@ r- r� r r r )rN Zenv_config_filer| �should_load_user_configr$ r$ r% rx G s z Configuration.iter_config_files)rB r c C s
| j | S )z#Get values present in a config file)rL )rN rB r$ r$ r% �get_values_in_configg s z"Configuration.get_values_in_configc C s* | j s
t�| j| j }|s"td��|d S )Nz4Fatal Internal error [id=2]. Please report as a bug.���)rA rS rK r )rN �parsersr$ r$ r% rT k s
z#Configuration._get_parser_to_modify)rc rd r c C s" ||f}|| j kr | j �|� d S )N)rM r{ )rN rc rd �file_parser_tupler$ r$ r% rb y s
z Configuration._mark_as_modifiedc C s | j j� d| j�d�S )N�(�))rO �__name__rW )rN r$ r$ r% �__repr__~ s zConfiguration.__repr__)N)%r� �
__module__� __qualname__�__doc__�boolr r rE rR �strrV r r r rX r\ rf ri rs r^ �propertyr rW rP r� rz r rQ r� r� r rx r� rT rb r� �
__classcell__r$ r$ )rO r% r? W s0
r? ),r� r� r� r, r5 �typingr r r r r r r �pip._internal.exceptionsr r
Zpip._internal.utilsr �pip._internal.utils.compatr �pip._internal.utils.loggingr
�pip._internal.utils.miscr r r� r� r r/ r� r9 r r r r r rJ rF r� rk r& r+ r> r? r$ r$ r$ r% �<module> s6 $