File: //usr/lib/python3/dist-packages/pip/_internal/__pycache__/configuration.cpython-310.pyc
o
@%Nes3 � @ sB d Z ddlZddlZddlZddlZddlmZmZmZm Z m
Z
m Z m Z ddl
mZmZ ddlmZ ddlmZ ddlmZ ddlmZmZ ejZe
d e�ZerRd
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'dedefdd�Z(dede e fdd�Z)deee e f fdd�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$ �=/usr/lib/python3/dist-packages/pip/_internal/configuration.py�_normalize_name2 s
r& c C s& d| vr
d� | �}t|��| �dd�S )N�.zbKey does not contain dot separated section and key. Perhaps you wanted to use 'global.{}' instead?� )�formatr �split)r �
error_messager$ r$ r% �_disassemble_key: s � 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>E s �z+get_configuration_files.<locals>.<listcomp>�pip�~z.pip)r �site_config_dirsr- r. r/ �sys�prefixr0 �
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 ZdZd7dedee ddf� fdd�
Zd8dd �Zdee fd
d �Z
de e e e
f fd d
�Zde de
fdd�Zde de
ddfdd�Zde ddfdd�Zd8dd�Zd8dd�Zedee e
f fdd��Zd8d d �Zd ed e defd d!�Zd e defd"d#�Zd8d$d%�Zd&e d'e e e e
f dee e
f fd(d)�Z de e e e f fd*d+�Z de e ee e f fd,d-�Z d edee e
f fd.d/�Z de e ef fd0d1�Z!d e d2eddfd3d4�Z"de fd5d6�Z#� Z$S )9�
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 ur|tvrtd�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$ �r1 �variantr$ r$ r% �
<dictcomp>r � �z*Configuration.__init__.<locals>.<dictcomp>c S s i | ]}|i �qS r$ r$ rC r$ r$ r% rE u rF )�super�__init__�VALID_LOAD_ONLYr r) r/ �map�reprrA rB �OVERRIDE_ORDER�_parsers�_config�_modified_parsers)�selfrA rB �� __class__r$ r% rH e s
����
zConfiguration.__init__c C s | � � | js
| �� dS dS )z<Loads configuration from configuration files and environmentN)�_load_config_filesrA �_load_environment_vars�rP r$ r$ r% �loadz s �zConfiguration.loadc C s6 | j dus J d��z| �� d W S ty Y dS w )z7Returns the file with highest priority in configurationNz)Need to be specified a file to be editingr )rB �_get_parser_to_modify�
IndexErrorrU 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�itemsrU r$ r$ r% r[ � s
zConfiguration.items�keyc C s* z| j | W S ty td|� ���w )z#Get a value from the configuration.�No such key - )rZ �KeyErrorr )rP r\ r$ r$ r% � get_value� s
�zConfiguration.get_value�valuec C st | � � | js J �| �� \}}|dur*t|�\}}|�|�s#|�|� |�|||� || j| j |< | �||� dS )z$Modify a value in the configuration.N) �_ensure_have_load_onlyrB rW r, � has_section� add_section�setrN �_mark_as_modified)rP r\ r` �fname�parser�sectionr r$ r$ r% � set_value� s
zConfiguration.set_valuec C s� | � � | js J �|| j| j vrtd|� ���| �� \}}|durGt|�\}}|�|�r3|�||�s7td��|�|�sA|� |� | �
||� | j| j |= dS )z#Unset a value in the configuration.r] Nz4Fatal Internal error [id=1]. Please report as a bug.) ra rB rN r rW r, rb �
remove_optionr[ �remove_sectionre )rP r\ rf rg rh r r$ r$ r% � unset_value� s$
�
��
zConfiguration.unset_valuec C sl | � � | jD ],\}}t�d|� ttj�|�� t|d��
}|� |� W d � n1 s.w Y qdS )z!Save the current in-memory state.z
Writing to %s�wN)
ra rO �logger�infor r- r. �dirname�open�write)rP rf rg �fr$ r$ r% �save� s ���zConfiguration.savec C s$ | j d u r td��t�d| j � d S )Nz'Needed a specific file to be modifying.z$Will be working with %s variant only)rB r rn �debugrU r$ r$ r% ra � s
z$Configuration._ensure_have_load_onlyc C s" i }t D ]
}|�| j| � q|S )z3A dictionary representing the loaded configuration.)rL �updaterN )rP �retvalrD r$ r$ r% rZ � s zConfiguration._dictionaryc C s� t | �� �}|tj dd� tjgkrt�d� dS |�� D ]+\}}|D ]$}| j dur8|| j kr8t�d||� q$| �
||�}| j | � ||f� q$q 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_filesr: r r- �devnullrn ru r[ rB �
_load_filerM �append)rP � config_filesrD �filesrf rg r$ r$ r% rS � s � ��z Configuration._load_config_filesrD rf c C sL t �d||� | �|�}|�� D ]}|�|�}| j| �| �||�� q|S )Nz'For variant '%s', will try loading '%s')rn �verbose�_construct_parser�sectionsr[ rN rv �_normalized_keys)rP rD rf rg rh r[ r$ r$ r% r{ � s
zConfiguration._load_filec
C s| t �� }tj�|�r<t�d�}z
|j||d� W |S ty* t d|� d�|d�� t j
y; } zt |d��d }~ww |S )NF)�encodingzcontains invalid z characters)�reasonrf )�error) � configparser�RawConfigParserr- r. �exists�locale�getpreferredencoding�read�UnicodeDecodeErrorr
�Error)rP rf rg �locale_encodingr� r$ r$ r% r� s
�
�
��z Configuration._construct_parserc C s" | j tj �| �d| �� �� dS )z.Loads configuration from environment variablesz:env:N)rN r: r rv r� �get_environ_varsrU r$ r$ r% rT s �z$Configuration._load_environment_varsrh r[ c C s. i }|D ]\}}|d t |� }|||< q|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& )rP rh r[ �
normalizedr �valr\ r$ r$ r% r� ! s
z Configuration._normalized_keysc c sF � t j�� D ]\}}|�d�r |dd� �� }|tvr ||fV qdS )z@Returns a generator with all environmental vars with prefix PIP_�PIP_� N)r- �environr[ r# r! �ENV_NAMES_IGNORED)rP r\ r� r r$ r$ r% r� / s �
��z Configuration.get_environ_varsc c s� � t j�dd�}|durtj|gfV ntjg fV t� }tj|tj fV | j o2|o1t j� |� }|r>tj
|tj
fV tj |tj fV dS )zYields variant and configuration files associated with it.
This should be treated like items of a dictionary.
�PIP_CONFIG_FILEN) r- r� �getr: r r? r rA r. r� r r )rP � config_filer} �should_load_user_configr$ r$ r% ry 8 s � �z Configuration.iter_config_filesc C s
| j | S )z#Get values present in a config file)rN )rP rD r$ r$ r% �get_values_in_configV s
z"Configuration.get_values_in_configc C s* | j sJ �| j| j }|std��|d S )Nz4Fatal Internal error [id=2]. Please report as a bug.���)rB rM r )rP �parsersr$ r$ r% rW Z s
�z#Configuration._get_parser_to_modifyrg c C s& ||f}|| j vr| j �|� d S d S �N)rO r| )rP rf rg �file_parser_tupler$ r$ r% re h s
�z Configuration._mark_as_modifiedc C s | j j� d| j�d�S )N�(�))rR �__name__rZ rU r$ r$ r% �__repr__m s zConfiguration.__repr__r� )r N)%r� �
__module__� __qualname__�__doc__�boolr r rH rV �strrY r r r r[ r_ ri rl rt ra �propertyr rZ rS r� r{ r� rT r� r� r ry r� rW re r� �
__classcell__r$ r$ rQ r% r@ W s<
��
� r@ ),r� r� r� r- r6 �typingr r r r r r r �pip._internal.exceptionsr r
�pip._internal.utilsr �pip._internal.utils.compatr �pip._internal.utils.loggingr
�pip._internal.utils.miscr r r� r� r r0 r� r: r r r r r rL rI r� rn r& r, r? r@ r$ r$ r$ r% �<module> s:
$
�