a
    hbòfs3  ã                   @   s>  d 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 ddlmZmZ ejZe
d	eƒZer¤d
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'eedœdd„Z(ee	e dœdd„Z)eee	e f dœ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)Ú	getLogger)Ú
ensure_dirÚenumÚKindzpip.inizpip.conf)ÚversionÚhelpÚuserÚglobalÚsiteÚenvzenv-var)ÚUSERÚGLOBALÚSITEÚENVÚENV_VAR)ÚnameÚreturnc                 C   s*   |   ¡  dd¡} |  d¡r&| dd… } | S )zAMake a name consistent regardless of source (environment or file)Ú_ú-z--é   N)ÚlowerÚreplaceÚ
startswith)r   © r$   úX/home/httpd/docs/test/DocsMgr/lib/python3.9/site-packages/pip/_internal/configuration.pyÚ_normalize_name2   s    
r&   c                 C   s&   d| v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,   ©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>E   s   z+get_configuration_files.<locals>.<listcomp>Úpipú~z.pip)r   Úsite_config_dirsr.   r/   r0   ÚsysÚprefixr1   Ú
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 Zd ZdZd6eee ddœ‡ fdd„Zddœdd„Zee	 dœd	d
„Z
eee	ef  dœdd„Ze	edœdd„Ze	eddœdd„Ze	ddœdd„Zddœdd„Zddœdd„Zeee	ef dœdd„ƒZddœdd„Zee	edœdd„Ze	ed œd!d"„Zddœd#d$„Ze	eee	ef  ee	ef d%œd&d'„Zeee	e	f  dœd(d)„Zeeeee	 f  dœd*d+„Zeee	ef d,œd-d.„Z ee	ef dœd/d0„Z!e	edd1œ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 ur4|tv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$   ©r2   Úvariantr$   r$   r%   Ú
<dictcomp>r   s   z*Configuration.__init__.<locals>.<dictcomp>c                 S   s   i | ]
}|i “qS r$   r$   rD   r$   r$   r%   rF   u   s   )ÚsuperÚ__init__ÚVALID_LOAD_ONLYr	   r)   r0   ÚmapÚreprrB   rC   ÚOVERRIDE_ORDERÚ_parsersÚ_configÚ_modified_parsers)ÚselfrB   rC   ©Ú	__class__r$   r%   rH   e   s     
ÿÿÿÿzConfiguration.__init__r-   c                 C   s   |   ¡  | js|  ¡  dS )z<Loads configuration from configuration files and environmentN)Ú_load_config_filesrB   Ú_load_environment_vars©rP   r$   r$   r%   Úloadz   s    zConfiguration.loadc                 C   s:   | j dusJ dƒ‚z|  ¡ d W S  ty4   Y dS 0 dS )z7Returns the file with highest priority in configurationNz)Need to be specified a file to be editingr   )rC   Ú_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    zConfiguration.items)Úkeyr   c                 C   s2   z| j | W S  ty,   td|› �ƒ‚Y n0 dS )z#Get a value from the configuration.úNo such key - N)rZ   ÚKeyErrorr	   )rP   r\   r$   r$   r%   Ú	get_value�   s    zConfiguration.get_value)r\   Úvaluer   c                 C   st   |   ¡  | jsJ ‚|  ¡ \}}|durTt|ƒ\}}| |¡sF| |¡ | |||¡ || j| j |< |  ||¡ dS )z$Modify a value in the configuration.N)	Ú_ensure_have_load_onlyrC   rW   r,   Úhas_sectionÚadd_sectionÚsetrN   Ú_mark_as_modified)rP   r\   r`   ÚfnameÚparserÚsectionr   r$   r$   r%   Ú	set_value–   s    


zConfiguration.set_valuec                 C   s    |   ¡  | jsJ ‚|| j| j vr0td|› �ƒ‚|  ¡ \}}|durŽt|ƒ\}}| |¡rf| ||¡sntdƒ‚| |¡s‚| 	|¡ |  
||¡ | j| j |= dS )z#Unset a value in the configuration.r]   Nz4Fatal Internal error [id=1]. Please report as a bug.)ra   rC   rN   r	   rW   r,   rb   Úremove_optionr[   Úremove_sectionre   )rP   r\   rf   rg   rh   r   r$   r$   r%   Úunset_value¨   s$    
ÿ
ÿÿ

zConfiguration.unset_valuec              	   C   sl   |   ¡  | jD ]X\}}t d|¡ ttj |¡ƒ t|dƒ�}| 	|¡ W d  ƒ q1 s\0    Y  qdS )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    zConfiguration.savec                 C   s$   | j d u rtdƒ‚t d| j ¡ d S )Nz'Needed a specific file to be modifying.z$Will be working with %s variant only)rC   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   ÚretvalrE   r$   r$   r%   rZ   Ù   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urp|| j	krpt d||¡ qH|  
||¡}| j|  ||f¡ qHq<dS )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[   rC   Ú
_load_filerM   Úappend)rP   Úconfig_filesrE   Úfilesrf   rg   r$   r$   r%   rS   å   s    ÿz Configuration._load_config_files)rE   rf   r   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   rE   rf   rg   rh   r[   r$   r$   r%   r{   ü   s    

zConfiguration._load_file)rf   r   c              
   C   sŠ   t  ¡ }tj |¡r†t d¡}z|j||d� W nT tyV   t	d|› d�|d�‚Y n0 t j
y„ } zt	|d�‚W Y d }~n
d }~0 0 |S )NF)Úencodingzcontains 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 tj  |  d|  ¡ ¡¡ dS )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_vars)rh   r[   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   sD   t j ¡ D ]4\}}| d¡r
|dd…  ¡ }|tvr
||fV  q
dS )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 dd¡}|du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”   Úgetr;   r   r@   r   rB   r/   rˆ   r   r   )rP   Úconfig_filer}   Úshould_load_user_configr$   r$   r%   ry   8  s    ÿzConfiguration.iter_config_files)rE   r   c                 C   s
   | j | S )z#Get values present in a config file)rN   )rP   rE   r$   r$   r%   Úget_values_in_configV  s    z"Configuration.get_values_in_configc                 C   s*   | j s
J ‚| j| j  }|s"tdƒ‚|d S )Nz4Fatal Internal error [id=2]. Please report as a bug.éÿÿÿÿ)rC   rM   r	   )rP   Úparsersr$   r$   r%   rW   Z  s    
ÿz#Configuration._get_parser_to_modify)rf   rg   r   c                 C   s"   ||f}|| j vr| j  |¡ 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    zConfiguration.__repr__)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%   rA   W   s2   	

þ	rA   ),r¤   r†   r‰   r.   r7   Útypingr   r   r   r   r   r   r   Úpip._internal.exceptionsr	   r
   Zpip._internal.utilsr   Úpip._internal.utils.compatr   Úpip._internal.utils.loggingr   Úpip._internal.utils.miscr   r   r‡   r¦   r   r1   r•   r;   r   r   r   r   r   rL   rI   r    rn   r&   r,   r@   rA   r$   r$   r$   r%   Ú<module>   s8   $
û
