o
    ~îjO@  ã                   @  s*  d Z ddlmZ ddlZddlZddlZddlmZ ddlm	Z	 ddl
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 ddlmZ ejZerOdndZdZG dd„ dee	ƒ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d„Z&d!dd„Z'd"dd„Z(G dd„ dejƒ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
é    )ÚannotationsN)ÚIterable)ÚEnum)ÚAny)ÚConfigurationErrorÚ!ConfigurationFileCouldNotBeLoaded)Úappdirs)Ú	getLogger)ÚWINDOWSÚget_locale_encoding)Ú
ensure_dirzpip.inizpip.conf)ÚversionÚhelpc                   @  s0   e Zd ZdZdZdZdZdZdZe	j
Z
e	jZdS )ÚKindzAConfiguration sources, including files and environment variables.ÚuserÚglobalÚsiteÚenvzenv-varN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__ÚUSERÚGLOBALÚSITEÚENVÚENV_VARÚstrÚ__str__Ú__repr__© r    r    úe/raid/bulk_storage/M2HATS/real-image-venv/lib/python3.10/site-packages/pip/_internal/configuration.pyr   (   s    
r   Únamer   Úreturnc                 C  s   |   ¡  dd¡} |  d¡} | S )zAMake a name consistent regardless of source (environment or file)Ú_ú-z--)ÚlowerÚreplaceÚremoveprefix)r"   r    r    r!   Ú_normalize_name<   s   
r)   ú	list[str]c                 C  s(   d| vrd| › d�}t |ƒ‚|  dd¡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_keyC   s   ÿÿr/   údict[Kind, list[str]]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)Ú.0r2   r    r    r!   Ú
<listcomp>N   s    ÿz+get_configuration_files.<locals>.<listcomp>Úpipú~z.pip)r   Úsite_config_dirsr1   r2   r3   ÚsysÚprefixr4   Ú
expanduserr
   Úuser_config_dirr   r   r   r   )Úglobal_config_filesÚsite_config_fileÚlegacy_config_fileÚnew_config_filer    r    r!   Úget_configuration_filesM   s   ÿ

ý
ýrB   c                   @  s   e Zd ZdZddd„ZdS )	Ú_RawConfigParserz*RawConfigParser with normalized key names.Ú	optionstrr   r#   c                 C  s   t |ƒS ©N©r)   )ÚselfrD   r    r    r!   Úoptionxformc   s   z_RawConfigParser.optionxformN)rD   r   r#   r   )r   r   r   r   rH   r    r    r    r!   rC   `   s    rC   c                      sô   e Zd ZdZdEdF‡ fd	d
„ZdGdd„ZdHdd„ZdIdd„ZdJdd„ZdKdd„Z	dLdd„Z
dGdd„ZdGdd „ZedMd"d#„ƒZdGd$d%„ZdNd*d+„ZdOd,d-„ZdGd.d/„ZdPd3d4„ZdQd6d7„ZdRd9d:„ZdSd;d<„Z	dEdTd>d?„ZdUdAdB„ZdVdCdD„Z‡  ZS )WÚ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ÚboolÚ	load_onlyúKind | Noner#   ÚNonec                   sp   t ƒ  ¡  |d ur|tvrtd d tttƒ¡¡ƒ‚|| _|| _	dd„ t
D ƒ| _dd„ t
D ƒ| _g | _d| _d S )Nz5Got invalid value for load_only - should be one of {}z, c                 S  s   i | ]}|g “qS r    r    ©r5   Úvariantr    r    r!   Ú
<dictcomp>‚   ó    ÿz*Configuration.__init__.<locals>.<dictcomp>c                 S  s   i | ]}|i “qS r    r    rO   r    r    r!   rQ   …   rR   F)ÚsuperÚ__init__ÚVALID_LOAD_ONLYr   Úformatr3   ÚmapÚreprrJ   rL   ÚOVERRIDE_ORDERÚ_parsersÚ_configÚ_modified_parsersÚ_use_env)rG   rJ   rL   ©Ú	__class__r    r!   rT   u   s"   
ÿÿÿÿ
zConfiguration.__init__c                 C  s   |   ¡  | js|  ¡  dS dS )z<Loads configuration from configuration files and environmentN)Ú_load_config_filesrJ   Ú_load_environment_vars©rG   r    r    r!   Úload‹   s   ÿzConfiguration.loadú
str | Nonec                 C  s6   | j dus	J dƒ‚z|  ¡ d W S  ty   Y dS w )z7Returns the file with highest priority in configurationNz)Need to be specified a file to be editingr   )rL   Ú_get_parser_to_modifyr   rb   r    r    r!   Úget_file_to_edit‘   s   ÿzConfiguration.get_file_to_editúIterable[tuple[str, Any]]c                 C  s
   | j  ¡ S )z`Returns key-value pairs like dict.items() representing the loaded
        configuration
        )Ú_dictionaryÚitemsrb   r    r    r!   ri   š   s   
zConfiguration.itemsÚkeyr   r   c                 C  sZ   |}t |ƒ}zi }| j ¡ D ]}| |¡ q|| W S  ty,   t|ƒ td|› �ƒ‚w )z#Get a value from the configuration.úNo such key - )r)   rh   ÚvaluesÚupdateÚKeyErrorr/   r   )rG   rj   Úorig_keyÚclean_configÚfile_valuesr    r    r!   Ú	get_value    s   
üzConfiguration.get_valueÚvaluec                 C  s”   t |ƒ}|  ¡  | jsJ ‚|  ¡ \}}|dur.t|ƒ\}}| |¡s'| |¡ | |||¡ | j| j  	|i ¡ || j| j | |< |  
||¡ dS )z$Modify a value in the configuration.N)r)   Ú_ensure_have_load_onlyrL   re   r/   Úhas_sectionÚadd_sectionÚsetr[   Ú
setdefaultÚ_mark_as_modified)rG   rj   rs   ÚfnameÚparserÚsectionr"   r    r    r!   Ú	set_value¯   s   


zConfiguration.set_valuec           	      C  sð   |}t |ƒ}|  ¡  | jsJ ‚|  |¡\}}| jrtjn| j}| j|  |i ¡}||vr3t	d|› �ƒ‚|dur\t
|ƒ\}}| |¡rH| ||¡sLt	dƒ‚| |¡sV| |¡ |  ||¡ z| j| | |= W dS  tyw   | j| |= Y dS w )z#Unset a value in the configuration.rk   Nz4Fatal Internal error [id=1]. Please report as a bug.)r)   rt   rL   re   r]   r   r   r[   Úgetr   r/   ru   Úremove_optionri   Úremove_sectionry   rn   )	rG   rj   ro   rz   r{   Úload_configÚfile_configr|   r"   r    r    r!   Úunset_valueÃ   s4   
ÿ
ÿÿ

ÿzConfiguration.unset_valuec                 C  sœ   |   ¡  | jD ]D\}}t d|¡ ttj |¡ƒ zt|dƒ�}| 	|¡ W d  ƒ n1 s/w   Y  W q t
yK } z
td|› d|› �ƒ‚d}~ww dS )z!Save the current in-memory state.zWriting to %sÚwNz:An error occurred while writing to the configuration file z: )rt   r\   ÚloggerÚinfor   r1   r2   ÚdirnameÚopenÚwriteÚOSErrorr   )rG   rz   r{   ÚfÚerrorr    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)rL   r   r…   Údebugrb   r    r    r!   rt   û   s   
z$Configuration._ensure_have_load_onlyúdict[str, dict[str, Any]]c                 C  s"   i }t D ]
}| | j| ¡ q|S )z3A dictionary representing the loaded configuration.)rY   rm   r[   )rG   ÚretvalrP   r    r    r!   rh      s   zConfiguration._dictionaryc                 C  sÆ   t |  ¡ ƒ}|tj dd… tjgkrt d¡ dS tj 	d¡}| 
¡ D ]<\}}|D ]5}| jdurO|| jkrO|tjkoD||koD| jtjk}|sOt d||¡ q*|  ||¡}| j|  ||f¡ q*q$dS )z,Loads configuration from configuration filesr   r,   zZSkipping loading configuration files due to environment's PIP_CONFIG_FILE being os.devnullNÚPIP_CONFIG_FILEz Skipping file '%s' (variant: %s))ÚdictÚiter_config_filesr   r   r1   Údevnullr…   rŽ   Úenvironr~   ri   rL   r   Ú
_load_filerZ   Úappend)rG   Úconfig_filesÚenv_config_filerP   Úfilesrz   Úis_env_redirectr{   r    r    r!   r`     s,   ÿ
ÿ
ýðÿz Configuration._load_config_filesrP   r   rz   ÚRawConfigParserc                 C  sb   t  d||¡ |  |¡}| j|  |i ¡ | ¡ D ]}| |¡}| j| |  |  ||¡¡ q|S )Nz'For variant '%s', will try loading '%s')	r…   ÚverboseÚ_construct_parserr[   rx   Úsectionsri   rm   Ú_normalized_keys)rG   rP   rz   r{   r|   ri   r    r    r!   r–   *  s   

zConfiguration._load_filec              
   C  s‚   t ƒ }tj |¡r?tjjrdntƒ }z
|j||d� W |S  t	y-   t
d|› d�|d�‚ tjy> } zt
|d�‚d }~ww |S )Nzutf-8)Úencodingzcontains invalid z characters)Úreasonrz   )rŒ   )rC   r1   r2   Úexistsr:   ÚflagsÚ	utf8_moder   ÚreadÚUnicodeDecodeErrorr   ÚconfigparserÚError)rG   rz   r{   r¡   rŒ   r    r    r!   rž   5  s    
÷
þ
€þzConfiguration._construct_parserc                 C  s:   | j tj  di ¡ | j tj d  |  d|  ¡ ¡¡ dS )z.Loads configuration from environment variablesz:env:N)r[   r   r   rx   rm   r    Úget_environ_varsrb   r    r    r!   ra   J  s   ÿz$Configuration._load_environment_varsr|   ri   údict[str, Any]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+   rF   )rG   r|   ri   Ú
normalizedr"   Úvalrj   r    r    r!   r    Q  s
   
zConfiguration._normalized_keysúIterable[tuple[str, str]]c                 c  sF   � t j ¡ D ]\}}| 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)r1   r•   ri   Ú
startswithr&   ÚENV_NAMES_IGNORED)rG   rj   r­   r"   r    r    r!   rª   _  s   €

€üzConfiguration.get_environ_varsú Iterable[tuple[Kind, list[str]]]c                 c  s”   � t j dd¡}tƒ }tj|tj fV  | j o |ot j |¡ }|r,tj	|tj	 fV  tj
|tj
 fV  |durBtj|gfV  dS tjg fV  dS )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 ergonomic to display
        things in the same order as OVERRIDE_ORDER
        r‘   N)r1   r•   r~   rB   r   r   rJ   r2   r£   r   r   r   )rG   r™   r˜   Úshould_load_user_configr    r    r!   r“   h  s   €ÿzConfiguration.iter_config_filesc                 C  s
   | j | S )z#Get values present in a config file)r[   )rG   rP   r    r    r!   Úget_values_in_configˆ  s   
z"Configuration.get_values_in_configútuple[str, RawConfigParser]c                 C  sò   | j sJ ‚| j| j  }|sMtj d¡}|tjkrtd|› �ƒ‚|rI| j tjtj	fv rI|  
|¡}| j| j   ||f¡ d| _t d|| j ¡ ||fS tdƒ‚|d u rU|d S t|ƒ\}}t|ƒD ]\}}| |¡rt| ||¡rt||f  S q_|d S )Nr‘   z3Cannot write to PIP_CONFIG_VALUE when it is set to Tz€Because PIP_CONFIG_FILE is set, changes will be applied to '%s', not to '%s'. To restore normal behavior, unset PIP_CONFIG_FILE.z4Fatal Internal error [id=2]. Please report as a bug.éÿÿÿÿ)rL   rZ   r1   r•   r~   r”   r   r   r   r   rž   r—   r]   r…   Úwarningr/   Úreversedru   Ú
has_option)rG   rj   Úparsersr™   r{   r|   r"   rz   r    r    r!   re   Œ  s>   

ÿÿ
ûÿ€z#Configuration._get_parser_to_modifyr{   c                 C  s&   ||f}|| j vr| j  |¡ d S d S rE   )r\   r—   )rG   rz   r{   Úfile_parser_tupler    r    r!   ry   ¶  s   
ÿzConfiguration._mark_as_modifiedc                 C  s   | j j› d| j›d�S )Nú(ú))r_   r   rh   rb   r    r    r!   r   »  s   zConfiguration.__repr__rE   )rJ   rK   rL   rM   r#   rN   )r#   rN   )r#   rd   )r#   rg   )rj   r   r#   r   )rj   r   rs   r   r#   rN   )rj   r   r#   rN   )r#   r�   )rP   r   rz   r   r#   rœ   )rz   r   r#   rœ   )r|   r   ri   rg   r#   r«   )r#   r®   )r#   r³   )rP   r   r#   r«   )rj   rd   r#   r¶   )rz   r   r{   rœ   r#   rN   )r#   r   )r   r   r   r   rT   rc   rf   ri   rr   r}   rƒ   r�   rt   Úpropertyrh   r`   r–   rž   ra   r    rª   r“   rµ   re   ry   r   Ú__classcell__r    r    r^   r!   rI   g   s2    


	



 







	
 ÿ
*rI   )r"   r   r#   r   )r"   r   r#   r*   )r#   r0   )+r   Ú
__future__r   r¨   r1   r:   Úcollections.abcr   Úenumr   Útypingr   Úpip._internal.exceptionsr   r   Úpip._internal.utilsr   Úpip._internal.utils._logr	   Úpip._internal.utils.compatr
   r   Úpip._internal.utils.miscr   rœ   r4   r²   r   r   r   r   r   r   r   rY   rU   r   r…   r)   r/   rB   rC   rI   r    r    r    r!   Ú<module>   s2    



