
Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­Â�Â­
<!DOCTYPE html>
<html>
U
    Œ=Ý_«0  ã                   @   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 ddlm	Z	 ddlm
Z
 ddlmZ ddlmZ dd	lmZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z  ddlm!Z! ddlm"Z" ddlm#Z# ddlm$Z$ ddlm%Z% dd lm&Z& ddlZe�r¢d!d"„ Zd#d$„ Z'G d%d&„ d&eƒZ(e e& )ed'¡e& )e�oÔe d(¡G d)d*„ d*e(ƒƒƒƒZ*e& )ed+¡G d,d-„ d-e*ƒƒZ+G d.d/„ d/e(ƒZ,e-d0k�r8dd1l.m/Z/ e/e0ƒ dS )2a:	  
Notes about unicode handling in psutil
======================================

Starting from version 5.3.0 psutil adds unicode support, see:
https://github.com/giampaolo/psutil/issues/1040
The notes below apply to *any* API returning a string such as
process exe(), cwd() or username():

* all strings are encoded by using the OS filesystem encoding
  (sys.getfilesystemencoding()) which varies depending on the platform
  (e.g. "UTF-8" on macOS, "mbcs" on Win)
* no API call is supposed to crash with UnicodeDecodeError
* instead, in case of badly encoded data returned by the OS, the
  following error handlers are used to replace the corrupted characters in
  the string:
    * Python 3: sys.getfilesystemencodeerrors() (PY 3.6+) or
      "surrogatescape" on POSIX and "replace" on Windows
    * Python 2: "replace"
* on Python 2 all APIs return bytes (str type), never unicode
* on Python 2, you can go back to unicode by doing:

    >>> unicode(p.exe(), sys.getdefaultencoding(), errors="replace")

For a detailed explanation of how psutil handles unicode see #1040.

Tests
=====

List of APIs returning or dealing with a string:
('not tested' means they are not tested to deal with non-ASCII strings):

* Process.cmdline()
* Process.connections('unix')
* Process.cwd()
* Process.environ()
* Process.exe()
* Process.memory_maps()
* Process.name()
* Process.open_files()
* Process.username()             (not tested)

* disk_io_counters()             (not tested)
* disk_partitions()              (not tested)
* disk_usage(str)
* net_connections('unix')
* net_if_addrs()                 (not tested)
* net_if_stats()                 (not tested)
* net_io_counters()              (not tested)
* sensors_fans()                 (not tested)
* sensors_temperatures()         (not tested)
* users()                        (not tested)

* WindowsService.binpath()       (not tested)
* WindowsService.description()   (not tested)
* WindowsService.display_name()  (not tested)
* WindowsService.name()          (not tested)
* WindowsService.status()        (not tested)
* WindowsService.username()      (not tested)

In here we create a unicode path with a funky non-ASCII name and (where
possible) make psutil return it back (e.g. on name(), exe(), open_files(),
etc.) and make sure that:

* psutil never crashes with UnicodeDecodeError
* the returned path matches
é    N)Úclosing)ÚBSD)ÚOPENBSD)ÚPOSIX)ÚWINDOWS)ÚPY3)Úu)ÚAPPVEYOR)ÚASCII_FS)Úbind_unix_socket)Úchdir)Ú
CI_TESTING)Úcopyload_shared_lib)Ú
create_exe)Ú
get_testfn)ÚHAS_CONNECTIONS_UNIX)ÚHAS_ENVIRON)ÚHAS_MEMORY_MAPS)ÚINVALID_UNICODE_SUFFIX)ÚPsutilTestCase)ÚPYPY)Ú
safe_mkdir©Úsafe_rmpath)Ú	serialrun)Úskip_on_access_denied)Úspawn_testproc)Ú	terminate©ÚTESTFN_PREFIX)ÚUNICODE_SUFFIX)Úunittestc                 C   s8   ddl m} z
|| ƒW S  tk
r2   t ¡  Y nX d S )Nr   r   )Úpsutil.testsr   ZWindowsErrorÚ	tracebackÚ	print_exc)ÚpathZrm© r&   úL/opt/alt/python38/lib64/python3.8/site-packages/psutil/tests/test_unicode.pyr   s   s
    
r   c              	   C   s–   d}t | d�}zhz<t|ƒ t|ƒ t|gd�}t ||d ¡ t|d ƒ W n ttfk
rj   Y W ¢dS X W ¢dS W 5 |dk	rˆt|ƒ t|ƒ X dS )z`Return True if both the fs and the subprocess module can
    deal with a unicode file name.
    N©Úsuffix©Úcmdz-2FT)	r   r   r   r   r   ÚshutilÚcopyfileÚUnicodeEncodeErrorÚIOError)r)   ÚsprocZtestfnr&   r&   r'   Útry_unicode…   s    
r1   c                   @   s   e Zd ZdZdd„ ZdS )ÚBaseUnicodeTestNc                 C   s"   | j d k	rt| j ƒs|  d¡‚d S )Nzcan't handle unicode str)Úfunky_suffixr1   ÚskipTest)Úselfr&   r&   r'   ÚsetUp£   s    

zBaseUnicodeTest.setUp)Ú__name__Ú
__module__Ú__qualname__r3   r6   r&   r&   r&   r'   r2       s   r2   zASCII fsztoo much trouble on PYPY2c                   @   sä   e Zd ZdZeZedd„ ƒZedd„ ƒZdd„ Z	dd	„ Z
d
d„ Zdd„ Zdd„ Ze eoZed¡dd„ ƒZe e d¡dd„ ƒZe e d¡e e d¡eƒ dd„ ƒƒƒZdd„ Ze e d¡e e d¡e ed¡dd„ ƒƒƒZd S )!Ú
TestFSAPIsz1Test FS APIs with a funky, valid, UTF8 path name.c                 C   s   t | jd�| _t| jƒ d S )Nr(   )r   r3   Ú
funky_namer   ©Úclsr&   r&   r'   Ú
setUpClass±   s    zTestFSAPIs.setUpClassc                 C   s   t | jƒ d S ©N)r   r;   r<   r&   r&   r'   ÚtearDownClass¶   s    zTestFSAPIs.tearDownClassc              
   C   sR   t | jtƒrdntdƒ}t ¡ �( t d¡ | jt |¡kW  5 Q R £ S Q R X d S )NÚ.Úignore)	Ú
isinstancer;   Ústrr   ÚwarningsÚcatch_warningsÚsimplefilterÚosÚlistdir)r5   Úherer&   r&   r'   Úexpect_exact_path_matchº   s    

z"TestFSAPIs.expect_exact_path_matchc                 C   sZ   | j | jgd�}t |j¡}| ¡ }|  |t¡ |  ¡ rV|  	t
j |¡t
j | j¡¡ d S ©Nr*   )r   r;   ÚpsutilÚProcessÚpidÚexeÚassertIsInstancerD   rK   ÚassertEqualrH   r%   Únormcase)r5   ÚsubpÚprP   r&   r&   r'   Útest_proc_exeÄ   s    ÿzTestFSAPIs.test_proc_exec                 C   sN   | j | jgd�}t |j¡ ¡ }|  |t¡ |  ¡ rJ|  	|t
j | j¡¡ d S rL   )r   r;   rM   rN   rO   ÚnamerQ   rD   rK   rR   rH   r%   Úbasename)r5   rT   rW   r&   r&   r'   Útest_proc_nameÍ   s
    zTestFSAPIs.test_proc_namec                 C   sV   | j | jgd�}t |j¡}| ¡ }|D ]}|  |t¡ q(|  ¡ rR|  	|| jg¡ d S rL   )
r   r;   rM   rN   rO   ÚcmdlinerQ   rD   rK   rR   )r5   rT   rU   rZ   Úpartr&   r&   r'   Útest_proc_cmdlineÔ   s    zTestFSAPIs.test_proc_cmdlinec              	   C   sj   | j d }|  t|¡ t|ƒ t|ƒ� t ¡ }| ¡ }W 5 Q R X |  | ¡ t	¡ |  
¡ rf|  ||¡ d S ©NÚ2)r;   Ú
addCleanupr   r   r   rM   rN   ÚcwdrQ   rD   rK   rR   )r5   ÚdnamerU   r`   r&   r&   r'   Útest_proc_cwdÝ   s    

zTestFSAPIs.test_proc_cwdzfails on PYPY + WINDOWSc              	   C   sŽ   t  ¡ }t| ¡ ƒ}t| jdƒ� t| ¡ ƒ}W 5 Q R X ||  ¡ j}|  |t	¡ t
rd|sd|  d¡S |  ¡ rŠ|  tj |¡tj | j¡¡ d S )NÚrbzopen_files on BSD is broken)rM   rN   ÚsetZ
open_filesÚopenr;   Úpopr%   rQ   rD   r   r4   rK   rR   rH   rS   )r5   rU   ÚstartÚnewr%   r&   r&   r'   Útest_proc_open_filesè   s    
ÿzTestFSAPIs.test_proc_open_filesz
POSIX onlyc              	   C   sŒ   | j | jd�}zt|ƒ}W n& tk
r@   tr2‚ n
t d¡‚Y nX t|ƒ�8 t 	¡  
d¡d }|  |jt¡ ts~|  |j|¡ W 5 Q R X d S )Nr(   únot supportedÚunixr   )r   r3   r   r.   r   r!   ÚSkipTestr   rM   rN   ZconnectionsrQ   ÚladdrrD   r   rR   )r5   rW   ÚsockÚconnr&   r&   r'   Útest_proc_connections÷   s    
z TestFSAPIs.test_proc_connectionszcan't list UNIX socketsc              	   C   s–   dd„ }| j | jd�}zt|ƒ}W n& tk
rH   tr:‚ n
t d¡‚Y nX t|ƒ�: tj	dd�}t
sˆ||ƒ}|  |jt¡ |  |j|¡ W 5 Q R X d S )Nc                 S   s2   | D ] }t j |j¡ t¡r|  S qtdƒ‚d S )Nzconnection not found)rH   r%   rX   rm   Ú
startswithr   Ú
ValueError)Úconsro   r&   r&   r'   Ú	find_sock  s    
z2TestFSAPIs.test_net_connections.<locals>.find_sockr(   rj   rk   )Úkind)r   r3   r   r.   r   r!   rl   r   rM   Znet_connectionsr   rQ   rm   rD   rR   )r5   rt   rW   rn   rs   ro   r&   r&   r'   Útest_net_connections  s    
zTestFSAPIs.test_net_connectionsc                 C   s,   | j d }|  t|¡ t|ƒ t |¡ d S r]   )r;   r_   r   r   rM   Ú
disk_usage)r5   ra   r&   r&   r'   Útest_disk_usage"  s    
zTestFSAPIs.test_disk_usagerj   z&ctypes does not support unicode on PY2zunstable on PYPYc              	      sr   t | jd��\}dd„ ‰ ‡ fdd„t ¡  ¡ D ƒ}dd„ |D ƒ}|  ˆ |ƒ|¡ |D ]}|  |t¡ qRW 5 Q R X d S )Nr(   c                 S   s   t j t j | ¡¡S r?   )rH   r%   ÚrealpathrS   )rU   r&   r&   r'   Únormpath/  s    z-TestFSAPIs.test_memory_maps.<locals>.normpathc                    s   g | ]}ˆ |j ƒ‘qS r&   )r%   ©Ú.0Úx©rz   r&   r'   Ú
<listcomp>1  s   ÿz/TestFSAPIs.test_memory_maps.<locals>.<listcomp>c                 S   s   g | ]}t |kr|‘qS r&   r   r{   r&   r&   r'   r   4  s      )r   r3   rM   rN   Zmemory_mapsZassertInrQ   rD   )r5   Z
funky_pathZlibpathsr%   r&   r~   r'   Útest_memory_maps(  s    

ÿzTestFSAPIs.test_memory_mapsN)r7   r8   r9   Ú__doc__r    r3   Úclassmethodr>   r@   rK   rV   rY   r\   rb   r!   ÚskipIfr   r   ri   r   rp   r   r   rv   rx   r   r   r€   r&   r&   r&   r'   r:   ©   s0   


		


r:   zunreliable on CIc                   @   s    e Zd ZdZeZedd„ ƒZdS )ÚTestFSAPIsWithInvalidPathz-Test FS APIs with a funky, invalid path name.c                 C   s   dS )NTr&   r<   r&   r&   r'   rK   ?  s    z1TestFSAPIsWithInvalidPath.expect_exact_path_matchN)r7   r8   r9   r�   r   r3   r‚   rK   r&   r&   r&   r'   r„   :  s   r„   c                   @   sB   e Zd ZdZerendZe e	 d¡e e
o.ed¡dd„ ƒƒZdS )ÚTestNonFSAPISz&Unicode tests for non fs-related APIs.õ   Ã¨rj   zsegfaults on PYPY + WINDOWSc                 C   st   t j ¡ }| j|d< | j|d�}t |j¡}| ¡ }| ¡ D ] \}}|  	|t
¡ |  	|t
¡ q<|  |d | j¡ d S )NZ	FUNNY_ARG)Úenv)rH   ÚenvironÚcopyr3   r   rM   rN   rO   ÚitemsrQ   rD   rR   )r5   r‡   r0   rU   ÚkÚvr&   r&   r'   Útest_proc_environN  s    

zTestNonFSAPIS.test_proc_environN)r7   r8   r9   r�   r   r    r3   r!   rƒ   r   r   r   r�   r&   r&   r&   r'   r…   J  s
   r…   Ú__main__)Úrun_from_name)1r�   rH   r,   r#   rE   Ú
contextlibr   rM   r   r   r   r   Zpsutil._compatr   r   r"   r	   r
   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r    r!   r1   r2   rƒ   r:   r„   r…   r7   Zpsutil.tests.runnerr�   Ú__file__r&   r&   r&   r'   Ú<module>   sd   D	
 

