U
    
Ha5                     @   s  d Z ddlZddlZddlZddlZddlZddlmZmZm	Z	m
Z
mZmZmZ ddlmZmZ ddlmZ ddlmZ ddlmZmZ ejZedeZerd	nd
ZdZeddddddZejejej ej!ej"fZ#ejejej fZ$e%e&Z'dd Z(dd Z)dd Z*G dd dZ+dS )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)
ensure_direnumKindzpip.inizpip.conf)versionhelpuserglobalsiteenvzenv-var)USERGLOBALSITEENVENV_VARc                 C   s*   |   dd} | dr&| dd } | S )zFMake a name consistent regardless of source (environment or file)
    _-z--   N)lowerreplace
startswith)name r"   ?/tmp/pip-unpacked-wheel-tx790h60/pip/_internal/configuration.py_normalize_name2   s    
r$   c                 C   s&   d| krd | }t|| dd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   dd t dD } tjtjt}tjtjdt	r<dndt}tjt 
dt}tj| tj|gtj||giS )Nc                 S   s   g | ]}t j|tqS r"   )ospathjoinCONFIG_BASENAME).0r,   r"   r"   r#   
<listcomp>I   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_filesG   s(    

    r=   c                       s   e Zd ZdZd- fdd	Zdd Zdd Zd	d
 Zdd Zdd Z	dd Z
dd Zdd Zedd Zdd Zdd Zdd Zdd Zdd  Zd!d" Zd#d$ Zd%d& Zd'd( Zd)d* Zd+d, Z  ZS ).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.
    Nc                    sj   t    |d k	r4|tkr4tddttt|| _|| _	dd t
D | _dd t
D | _g | _d S )Nz5Got invalid value for load_only - should be one of {}z, c                 S   s   i | ]
}|g qS r"   r"   r/   variantr"   r"   r#   
<dictcomp>z   s     z*Configuration.__init__.<locals>.<dictcomp>c                 S   s   i | ]
}|i qS r"   r"   r?   r"   r"   r#   rA   }   s     )super__init__VALID_LOAD_ONLYr	   r'   r-   mapreprisolated	load_onlyOVERRIDE_ORDER_parsers_config_modified_parsers)selfrG   rH   	__class__r"   r#   rC   l   s     
zConfiguration.__init__c                 C   s   |    | js|   dS )zELoads configuration from configuration files and environment
        N)_load_config_filesrG   _load_environment_varsrM   r"   r"   r#   load   s    zConfiguration.loadc                 C   s<   | j dk	stdz|  d W S  tk
r6   Y dS X dS )z@Returns the file with highest priority in configuration
        Nz)Need to be specified a file to be editingr   )rH   AssertionError_get_parser_to_modify
IndexErrorrR   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itemsrR   r"   r"   r#   rY      s    zConfiguration.itemsc                 C   s4   z| j | W S  tk
r.   td| Y nX dS )z,Get a value from the configuration.
        No such key - N)rX   KeyErrorr	   )rM   keyr"   r"   r#   	get_value   s    zConfiguration.get_valuec                 C   st   |    | jst|  \}}|dk	rTt|\}}||sF|| |||| || j| j |< | 	|| dS )z-Modify a value in the configuration.
        N)
_ensure_have_load_onlyrH   rT   rU   r*   has_sectionadd_sectionsetrK   _mark_as_modified)rM   r\   valuefnameparsersectionr!   r"   r"   r#   	set_value   s    


zConfiguration.set_valuec                 C   s   |    | jst|| j| j kr0td| |  \}}|dk	rt|\}}||rf|||sntd|	|s|
| | || | j| j |= dS )z#Unset a value in the configuration.rZ   Nz4Fatal Internal error [id=1]. Please report as a bug.)r^   rH   rT   rK   r	   rU   r*   r_   remove_optionrY   remove_sectionrb   )rM   r\   rd   re   rf   r!   r"   r"   r#   unset_value   s"    




zConfiguration.unset_valuec              
   C   sX   |    | jD ]D\}}td| ttj| t|d}|	| W 5 Q R X qdS )z*Save the current in-memory state.
        zWriting to %swN)
r^   rL   loggerinfor   r+   r,   dirnameopenwrite)rM   rd   re   fr"   r"   r#   save   s    zConfiguration.savec                 C   s$   | j d krtdtd| j  d S )Nz'Needed a specific file to be modifying.z$Will be working with %s variant only)rH   r	   rl   debugrR   r"   r"   r#   r^      s    
z$Configuration._ensure_have_load_onlyc                 C   s"   i }t D ]}|| j|  q|S )z<A dictionary representing the loaded configuration.
        )rI   updaterK   )rM   retvalr@   r"   r"   r#   rX      s    zConfiguration._dictionaryc                 C   s   t |  }|tj dd tjgkr4td dS | D ]V\}}|D ]H}| j	dk	rp|| j	krptd|| qH| 
||}| j| ||f qHq<dS )z5Loads configuration from configuration files
        r   r&   zZSkipping loading configuration files due to environment's PIP_CONFIG_FILE being os.devnullNz Skipping file '%s' (variant: %s))dictiter_config_filesr8   r   r+   devnullrl   rs   rY   rH   
_load_filerJ   append)rM   config_filesr@   filesrd   re   r"   r"   r#   rP      s"      z Configuration._load_config_filesc                 C   sL   t d|| | |}| D ]&}||}| j| | || q |S )Nz'For variant '%s', will try loading '%s')rl   rs   _construct_parsersectionsrY   rK   rt   _normalized_keys)rM   r@   rd   re   rf   rY   r"   r"   r#   ry     s    

zConfiguration._load_filec              
   C   s   t  }tj|r|z|| W nX tk
rN   tdt	
d|dY n. t jk
rz } zt|dW 5 d }~X Y nX |S )Nzcontains invalid {} charactersF)reasonrd   )error)configparserRawConfigParserr+   r,   existsreadUnicodeDecodeErrorr
   r'   localegetpreferredencodingError)rM   rd   re   r   r"   r"   r#   r}   "  s    
zConfiguration._construct_parserc                 C   s"   | j tj | d|   dS )z7Loads configuration from environment variables
        z:env:N)rK   r8   r   rt   r   get_environ_varsrR   r"   r"   r#   rQ   9  s    z$Configuration._load_environment_varsc                 C   s.   i }|D ] \}}|d t | }|||< q|S )zNormalizes 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$   )rM   rf   rY   
normalizedr!   valr\   r"   r"   r#   r   A  s
    
zConfiguration._normalized_keysc                 c   sD   t j D ]4\}}|dr
|dd  }|tkr
||fV  q
dS )z@Returns a generator with all environmental vars with prefix PIP_PIP_   N)r+   environrY   r    r   ENV_NAMES_IGNORED)rM   r\   r   r!   r"   r"   r#   r   N  s
    
zConfiguration.get_environ_varsc                 c   s   t jdd}|dk	r&tj|gfV  ntjg fV  t }tj|tj fV  | j ob|o`t j	| }|rztj
|tj
 fV  tj|tj fV  dS )zYields variant and configuration files associated with it.

        This should be treated like items of a dictionary.
        PIP_CONFIG_FILEN)r+   r   getr8   r   r=   r   rG   r,   r   r   r   )rM   config_filer{   should_load_user_configr"   r"   r#   rw   X  s    	zConfiguration.iter_config_filesc                 C   s
   | j | S )z#Get values present in a config file)rK   )rM   r@   r"   r"   r#   get_values_in_configw  s    z"Configuration.get_values_in_configc                 C   s*   | j s
t| j| j  }|s"td|d S )Nz4Fatal Internal error [id=2]. Please report as a bug.)rH   rT   rJ   r	   )rM   parsersr"   r"   r#   rU   |  s    
z#Configuration._get_parser_to_modifyc                 C   s"   ||f}|| j kr| j | d S )N)rL   rz   )rM   rd   re   file_parser_tupler"   r"   r#   rb     s    
zConfiguration._mark_as_modifiedc                 C   s   | j j d| jdS )N())rO   __name__rX   rR   r"   r"   r#   __repr__  s    zConfiguration.__repr__)N)r   
__module____qualname____doc__rC   rS   rW   rY   r]   rg   rj   rr   r^   propertyrX   rP   ry   r}   rQ   r   r   rw   r   rU   rb   r   __classcell__r"   r"   rN   r#   r>   ^   s.   	

r>   ),r   r   r   loggingr+   r4   typingr   r   r   r   r   r   r   pip._internal.exceptionsr	   r
   Zpip._internal.utilsr   pip._internal.utils.compatr   pip._internal.utils.miscr   r   r   strr   r.   r   r8   r   r   r   r   r   rI   rD   	getLoggerr   rl   r$   r*   r=   r>   r"   r"   r"   r#   <module>   s8   $


