a
    õ£BeÅ/  ã                   @   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 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% 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,d.k�r(dd/l-m.Z. e.e/ƒ dS )0a:	  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)ÚPOSIX)ÚWINDOWS)ÚPY3)Úu)ÚAPPVEYOR)ÚASCII_FS)Ú
CI_TESTING)ÚHAS_CONNECTIONS_UNIX)ÚHAS_ENVIRON)ÚHAS_MEMORY_MAPS)ÚINVALID_UNICODE_SUFFIX)ÚPYPY©ÚTESTFN_PREFIX)ÚUNICODE_SUFFIX)ÚPsutilTestCase)Úbind_unix_socket)Úchdir)Úcopyload_shared_lib)Ú
create_exe)Ú
get_testfn)Ú
safe_mkdir©Úsafe_rmpath)Ú	serialrun)Úskip_on_access_denied)Úspawn_testproc)Ú	terminatec                 C   s6   ddl m} z
|| ƒW S  ty0   t ¡  Y n0 d S )Nr   r   )Úpsutil.testsr   ZWindowsErrorÚ	tracebackÚ	print_exc)ÚpathZrm© r$   ú\/home/yuhw/wc/wire-cell-python/wcpy/lib/python3.9/site-packages/psutil/tests/test_unicode.pyr   q   s
    
r   c              	   C   sØ   d}t | d�}zªz<t|ƒ t|ƒ t|gd�}t ||d ¡ t|d ƒ W n2 ttfy~   Y W |durrt|ƒ t|ƒ dS 0 W |dur’t|ƒ t|ƒ dS W |dur°t|ƒ t|ƒ n|durÊt|ƒ t|ƒ 0 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   ÚshutilÚcopyfileÚUnicodeEncodeErrorÚIOErrorr   )r'   ÚsprocZtestfnr$   r$   r%   Útry_unicodeƒ   s2    
úü
þr/   c                   @   s   e Zd ZdZdd„ ZdS )ÚBaseUnicodeTestNc                 C   s"   | j d urt| j ƒs|  d¡‚d S )Nzcan't handle unicode str)Úfunky_suffixr/   ÚskipTest©Úselfr$   r$   r%   ÚsetUp¡   s    

zBaseUnicodeTest.setUp)Ú__name__Ú
__module__Ú__qualname__r1   r5   r$   r$   r$   r%   r0   ž   s   r0   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   r1   Ú
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   s^   t | jtƒrdntdƒ}t ¡ �* t d¡ | jt |¡v W  d   ƒ S 1 sP0    Y  d S )NÚ.Úignore)	Ú
isinstancer:   Ústrr   ÚwarningsÚcatch_warningsÚsimplefilterÚosÚlistdir)r4   Ú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ÚassertIsInstancerC   rJ   ÚassertEqualrG   r#   Únormcase)r4   ÚsubpÚprO   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 rK   )r   r:   rL   rM   rN   ÚnamerP   rC   rJ   rQ   rG   r#   Úbasename)r4   rS   rV   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 rK   )
r   r:   rL   rM   rN   ÚcmdlinerP   rC   rJ   rQ   )r4   rS   rT   rY   Úpartr$   r$   r%   Útest_proc_cmdlineÒ   s    zTestFSAPIs.test_proc_cmdlinec                 C   s~   | j d }|  t|¡ t|ƒ t|ƒ�  t ¡ }| ¡ }W d   ƒ n1 sL0    Y  |  | ¡ t	¡ |  
¡ rz|  ||¡ d S ©NÚ2)r:   Ú
addCleanupr   r   r   rL   rM   ÚcwdrP   rC   rJ   rQ   )r4   ÚdnamerT   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 d   ƒ n1 sB0    Y  ||  ¡ j}|  |t	¡ t
rx|sx|  d¡S |  ¡ rž|  tj |¡tj | j¡¡ d S )NÚrbzopen_files on BSD is broken)rL   rM   ÚsetZ
open_filesÚopenr:   Úpopr#   rP   rC   r   r2   rJ   rQ   rG   rR   )r4   rT   Ú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y>   tr0‚ n
t d¡‚Y n0 t|ƒ�> t 	¡  
d¡d }|  |jt¡ |  |j|¡ W d   ƒ n1 sŒ0    Y  d S )Nr&   únot supportedÚunixr   )r   r1   r   r,   r   ÚunittestÚSkipTestr   rL   rM   ÚconnectionsrP   ÚladdrrC   rQ   )r4   rV   Ú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yF   tr8‚ n
t d¡‚Y n0 t|ƒ�@ tj	dd�}||ƒ}|  
|jt¡ |  |j|¡ W d   ƒ n1 s–0    Y  d S )Nc                 S   s2   | D ] }t j |j¡ t¡r|  S qtdƒ‚d S )Nzconnection not found)rG   r#   rW   rn   Ú
startswithr   Ú
ValueError)Úconsrp   r$   r$   r%   Ú	find_sock  s    
z2TestFSAPIs.test_net_connections.<locals>.find_sockr&   ri   rj   )Úkind)r   r1   r   r,   r   rk   rl   r   rL   Znet_connectionsrP   rn   rC   rQ   )r4   ru   rV   ro   rt   rp   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   rL   Ú
disk_usage)r4   r`   r$   r$   r%   Útest_disk_usage  s    
zTestFSAPIs.test_disk_usageri   z&ctypes does not support unicode on PY2zunstable on PYPYc                    s†   t | jd��f}dd„ ‰ ‡ fdd„t ¡  ¡ D ƒ}dd„ |D ƒ}|  ˆ |ƒ|¡ |D ]}|  |t¡ qRW d   ƒ n1 sx0    Y  d S )Nr&   c                 S   s   t j t j | ¡¡S r>   )rG   r#   ÚrealpathrR   )rT   r$   r$   r%   Únormpath)  s    z-TestFSAPIs.test_memory_maps.<locals>.normpathc                    s   g | ]}ˆ |j ƒ‘qS r$   )r#   ©Ú.0Úx©r{   r$   r%   Ú
<listcomp>+  s   ÿz/TestFSAPIs.test_memory_maps.<locals>.<listcomp>c                 S   s   g | ]}t |v r|‘qS r$   r   r|   r$   r$   r%   r€   .  ó    )r   r1   rL   rM   Zmemory_mapsZassertInrP   rC   )r4   Z
funky_pathZlibpathsr#   r$   r   r%   Útest_memory_maps"  s    

ÿzTestFSAPIs.test_memory_mapsN)r6   r7   r8   Ú__doc__r   r1   Úclassmethodr=   r?   rJ   rU   rX   r[   ra   rk   ÚskipIfr   r   rh   r   rq   r   r   rw   ry   r   r   r‚   r$   r$   r$   r%   r9   §   s0   


		


r9   zunreliable on CIc                   @   s   e Zd ZdZeZdd„ ZdS )ÚTestFSAPIsWithInvalidPathz-Test FS APIs with a funky, invalid path name.c                 C   s   dS )NTr$   r3   r$   r$   r%   rJ   :  s    z1TestFSAPIsWithInvalidPath.expect_exact_path_matchN)r6   r7   r8   rƒ   r   r1   rJ   r$   r$   r$   r%   r†   4  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.õ   Ã¨ri   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)rG   ÚenvironÚcopyr1   r   rL   rM   rN   ÚitemsrP   rC   rQ   )r4   r‰   r.   rT   ÚkÚvr$   r$   r%   Útest_proc_environI  s    

zTestNonFSAPIS.test_proc_environN)r6   r7   r8   rƒ   r   r   r1   rk   r…   r   r   r   r�   r$   r$   r$   r%   r‡   D  s
   r‡   Ú__main__)Úrun_from_name)0rƒ   rG   r*   r!   rk   rD   Ú
contextlibr   rL   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/   r0   r…   r9   r†   r‡   r6   Zpsutil.tests.runnerr‘   Ú__file__r$   r$   r$   r%   Ú<module>   sb   C	
 

