3
ÀÞL]ü6  ã               @   s  d Z ddlZddlZddlZddlZddlmZ ddlmZm	Z	 ddl
mZ ddlmZmZ ddlmZmZ ddlmZ er°dd	lmZmZmZmZmZmZmZ ejZed
eƒZeje ƒZ!dd„ Z"dd„ Z#edddddd�Z$erädndZ%dd„ Z&G dd„ de'ƒ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)Úconfigparser)ÚConfigurationErrorÚ!ConfigurationFileCouldNotBeLoaded)Úappdirs)ÚWINDOWSÚ
expanduser)Ú
ensure_dirÚenum)ÚMYPY_CHECK_RUNNING)ÚAnyÚDictÚIterableÚListÚNewTypeÚOptionalÚTupleÚKindc             C   s*   | j ƒ jddƒ} | jdƒr&| dd… } | S )zFMake a name consistent regardless of source (environment or file)
    Ú_ú-z--é   N)ÚlowerÚreplaceÚ
startswith)Úname© r   ú:/tmp/pip-build-69lrc5qx/pip/pip/_internal/configuration.pyÚ_normalize_name)   s    
r   c             C   s&   d| krdj | ƒ}t|ƒ‚| j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_key3   s
    r"   ÚuserÚglobalÚsiteÚenvzenv-var)ÚUSERÚGLOBALÚSITEÚENVÚENV_VARzpip.inizpip.confc              C   sp   dd„ t jdƒD ƒ} tjjtjtƒ}tjjtdƒt	r8dndtƒ}tjjt j
dƒtƒ}tj| tj|gtj||giS )Nc             S   s   g | ]}t jj|tƒ‘qS r   )ÚosÚpathÚjoinÚCONFIG_BASENAME)Ú.0r-   r   r   r   ú
<listcomp>M   s   z+get_configuration_files.<locals>.<listcomp>Úpipú~z.pip)r   Úsite_config_dirsr,   r-   r.   ÚsysÚprefixr/   r   r   Úuser_config_dirÚkindsr(   r)   r'   )Zglobal_config_filesZsite_config_fileÚlegacy_config_fileZnew_config_filer   r   r   Úget_configuration_filesK   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‡  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                s¨   t t| ƒjƒ  tjtjtjd g}||krJtdjdj	t
t|d d	… ƒƒƒƒ‚|| _|| _tjtjtjtjtjg| _ddg| _dd„ | jD ƒ| _dd„ | jD ƒ| _g | _d S )
Nz5Got invalid value for load_only - should be one of {}z, r   ÚversionÚhelpc             S   s   i | ]
}g |“qS r   r   )r0   Úvariantr   r   r   ú
<dictcomp>…   s   z*Configuration.__init__.<locals>.<dictcomp>c             S   s   i | ]
}i |“qS r   r   )r0   r>   r   r   r   r?   ˆ   s   éÿÿÿÿ)Úsuperr;   Ú__init__r8   r'   r(   r)   r   r   r.   ÚmapÚreprÚisolatedÚ	load_onlyr*   r+   Ú_override_orderÚ_ignore_env_namesÚ_parsersÚ_configÚ_modified_parsers)ÚselfrE   rF   Z_valid_load_only)Ú	__class__r   r   rB   o   s    
zConfiguration.__init__c             C   s   | j ƒ  | js| jƒ  dS )zELoads configuration from configuration files and environment
        N)Ú_load_config_filesrE   Ú_load_environment_vars)rL   r   r   r   Úload�   s    zConfiguration.loadc             C   s8   | j dk	stdƒ‚y| jƒ d S  tk
r2   dS X dS )z@Returns the file with highest priority in configuration
        Nz)Need to be specified a file to be editingr   )rF   ÚAssertionErrorÚ_get_parser_to_modifyÚ
IndexError)rL   r   r   r   Úget_file_to_edit•   s    zConfiguration.get_file_to_editc             C   s
   | j jƒ S )z`Returns key-value pairs like dict.items() representing the loaded
        configuration
        )Ú_dictionaryÚitems)rL   r   r   r   rV   ¡   s    zConfiguration.itemsc             C   s2   y
| j | S  tk
r,   tdj|ƒƒ‚Y nX dS )z,Get a value from the configuration.
        zNo such key - {}N)rU   ÚKeyErrorr   r   )rL   Úkeyr   r   r   Ú	get_value¨   s    
zConfiguration.get_valuec             C   sj   | j ƒ  | jƒ \}}|dk	rJt|ƒ\}}|j|ƒs<|j|ƒ |j|||ƒ || j| j |< | j||ƒ dS )z-Modify a value in the configuration.
        N)	Ú_ensure_have_load_onlyrR   r"   Úhas_sectionÚadd_sectionÚsetrJ   rF   Ú_mark_as_modified)rL   rX   ÚvalueÚfnameÚparserÚsectionr   r   r   r   Ú	set_value±   s    

zConfiguration.set_valuec       	      C   sÒ   | j ƒ  || j| j kr&tdj|ƒƒ‚| jƒ \}}|dk	rÀt|ƒ\}}d}|j|ƒr`|j||ƒ}|r¸t	|j
|ƒƒ}yt|ƒ}W n tk
r–   d}Y nX |dkrª|j|ƒ | j||ƒ ntdƒ‚| j| j |= dS )z,Unset a value in the configuration.
        zNo such key - {}NFz4Fatal Internal error [id=1]. Please report as a bug.)rZ   rJ   rF   r   r   rR   r"   r[   Úremove_optionÚiterrV   ÚnextÚStopIterationÚremove_sectionr^   )	rL   rX   r`   ra   rb   r   Zmodified_somethingZsection_iterÚvalr   r   r   Úunset_valueÄ   s*    


zConfiguration.unset_valuec          
   C   s\   | j ƒ  xN| jD ]D\}}tjd|ƒ ttjj|ƒƒ t|dƒ�}|j	|ƒ W dQ R X qW dS )z*Save the current in-memory state.
        zWriting to %sÚwN)
rZ   rK   ÚloggerÚinfor   r,   r-   ÚdirnameÚopenÚwrite)rL   r`   ra   Úfr   r   r   Úsaveë   s    zConfiguration.savec             C   s$   | j d krtdƒ‚tjd| j ƒ d S )Nz'Needed a specific file to be modifying.z$Will be working with %s variant only)rF   r   rl   Údebug)rL   r   r   r   rZ   þ   s    
z$Configuration._ensure_have_load_onlyc             C   s(   i }x| j D ]}|j| j| ƒ qW |S )z<A dictionary representing the loaded configuration.
        )rG   ÚupdaterJ   )rL   Úretvalr>   r   r   r   rU     s    zConfiguration._dictionaryc             C   s    t | jƒ ƒ}|tj dd… tjgkr4tjdƒ dS xf|jƒ D ]Z\}}xP|D ]H}| j	dk	rt|| j	krttjd||ƒ qL| j
||ƒ}| j| j||fƒ qLW q>W 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   rV   rF   Ú
_load_filerI   Úappend)rL   Úconfig_filesr>   Úfilesr`   ra   r   r   r   rN     s    

z Configuration._load_config_filesc             C   sP   t jd||ƒ | j|ƒ}x2|jƒ D ]&}|j|ƒ}| j| j| j||ƒƒ q"W |S )Nz'For variant '%s', will try loading '%s')rl   rs   Ú_construct_parserÚsectionsrV   rJ   rt   Ú_normalized_keys)rL   r>   r`   ra   rb   rV   r   r   r   ry   -  s    

zConfiguration._load_filec             C   s€   t jƒ }tjj|ƒr|y|j|ƒ W nX tk
rN   tdjt	j
dƒƒ|d�‚Y n. t jk
rz } zt|d�‚W Y d d }~X nX |S )Nzcontains invalid {} charactersF)Úreasonr`   )Úerror)r   ÚRawConfigParserr,   r-   ÚexistsÚreadÚUnicodeDecodeErrorr   r   ÚlocaleÚgetpreferredencodingÚError)rL   r`   ra   r�   r   r   r   r}   8  s    
zConfiguration._construct_parserc             C   s"   | j tj j| jd| jƒ ƒƒ dS )z7Loads configuration from environment variables
        z:env:N)rJ   r8   r+   rt   r   Ú_get_environ_vars)rL   r   r   r   rO   O  s    z$Configuration._load_environment_varsc             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   )rL   rb   rV   Ú
normalizedr   ri   rX   r   r   r   r   W  s
    zConfiguration._normalized_keysc             c   sV   xPt jjƒ D ]B\}}|jdƒo2|dd… jƒ | jk}|r|dd… jƒ |fV  qW dS )z@Returns a generator with all environmental vars with prefix PIP_ZPIP_é   N)r,   ÚenvironrV   r   r   rH   )rL   rX   ri   Zshould_be_yieldedr   r   r   r‰   d  s
    
zConfiguration._get_environ_varsc             c   s�   t j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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(   rE   r-   rƒ   r'   r)   )rL   Úconfig_filer{   Zshould_load_user_configr   r   r   rw   p  s    	z Configuration._iter_config_filesc             C   s    | j | j }|stdƒ‚|d S )Nz4Fatal Internal error [id=2]. Please report as a bug.r   r@   )rI   rF   r   )rL   Úparsersr   r   r   rR   �  s
    z#Configuration._get_parser_to_modifyc             C   s"   ||f}|| j kr| j j|ƒ d S )N)rK   rz   )rL   r`   ra   Zfile_parser_tupler   r   r   r^   �  s    
zConfiguration._mark_as_modified)N)Ú__name__Ú
__module__Ú__qualname__Ú__doc__rB   rP   rT   rV   rY   rc   rj   rr   rZ   ÚpropertyrU   rN   ry   r}   rO   r   r‰   rw   rR   r^   Ú__classcell__r   r   )rM   r   r;   a   s(   	'r;   ))r”   r†   Úloggingr,   r5   Zpip._vendor.six.movesr   Zpip._internal.exceptionsr   r   Zpip._internal.utilsr   Zpip._internal.utils.compatr   r   Zpip._internal.utils.miscr   r	   Zpip._internal.utils.typingr
   Útypingr   r   r   r   r   r   r   r‚   Ústrr   Ú	getLoggerr‘   rl   r   r"   r8   r/   r:   Úobjectr;   r   r   r   r   Ú<module>   s4   $


