o
    e 1                     @   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rdd  Z!d!d" Z&G d#d$ d$eZ'e"e(ed%e(eoe 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 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   s4   ddl m} z|| W S  ty   t  Y d S w )Nr   r   )psutil.testsr   WindowsError	traceback	print_exc)pathZrm r%   ID:\Projects\ConvertPro\env\Lib\site-packages\psutil/tests/test_unicode.pyr   r   s   
r   c              	   C   s   d}t | d}zGzt| t| t|gd}t||d  t|d  W n ttfy?   Y W |dur9t| t| dS w W |durIt| t| dS |durWt| t| w )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   s*   

r0   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 d S )Nzcan't handle unicode str)funky_suffixr0   skipTestselfr%   r%   r&   setUp   s
   


zBaseUnicodeTest.setUp)__name__
__module____qualname__r2   r6   r%   r%   r%   r&   r1      s    r1   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o-e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   r2   
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 s(w   Y  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   s^   | j | jgd}t|j}| }| |t |  r-| 	t
j|t
j| j d S 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   sR   | j | jgd}t|j }| |t |  r'| 	|t
j| j d S 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   sZ   | j | jgd}t|j}| }|D ]}| |t q|  r+| 	|| jg d S 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   s   | j d }| t| t| t| t }| }W d    n1 s&w   Y  | | t	 | 
 r?| || d S 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 d    n1 s!w   Y  ||  j}| |t	 t
r<|s<| dS |  rQ| tj|tj| j d S d S )Nrbzopen_files on BSD is broken)rM   rN   setZ
open_filesopenr;   popr$   rQ   rD   r   r3   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y   tr tdw t|  t	 
dd }| |jt | |j| W d    d S 1 sDw   Y  d S )Nr'   not supportedunixr   )r   r2   r   r-   r   unittestSkipTestr   rM   rN   connectionsrQ   laddrrD   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y    tr tdw t|! tj	dd}||}| 
|jt | |j| W d    d S 1 sIw   Y  d S )Nc                 S   s.   | D ]}t j|jtr|  S qtd)Nzconnection not found)rH   r$   rX   ro   
startswithr   
ValueError)consrq   r%   r%   r&   	find_sock	  s
   z2TestFSAPIs.test_net_connections.<locals>.find_sockr'   rj   rk   )kind)r   r2   r   r-   r   rl   rm   r   rM   Znet_connectionsrQ   ro   rD   rR   )r5   rv   rW   rp   ru   rq   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                    s   t | jd4}dd   fddt  D }dd |D }|  || |D ]}| |t q)W d    d S 1 s=w   Y  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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   /  s    )r   r2   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   r2   classmethodr>   r@   rK   rV   rY   r\   rb   rl   skipIfr   r   ri   r   rr   r   r   rx   rz   r   r   r   r%   r%   r%   r&   r:      s2    


		


r:   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%   r4   r%   r%   r&   rK   :  s   z1TestFSAPIsWithInvalidPath.expect_exact_path_matchN)r7   r8   r9   r   r   r2   rK   r%   r%   r%   r&   r   5  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copyr2   r   rM   rN   rO   itemsrQ   rD   rR   )r5   r   r/   rU   kvr%   r%   r&   test_proc_environH  s   

zTestNonFSAPIS.test_proc_environN)r7   r8   r9   r   r   r   r2   rl   r   r   r   r   r   r%   r%   r%   r&   r   D  s    r   __main__)run_from_name)0r   rH   r+   r"   rl   rE   
contextlibr   rM   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   r0   r1   r   r:   r   r   r7   Zpsutil.tests.runnerr   __file__r%   r%   r%   r&   <module>   sf   D	
 

