O
d Z ddlZddlZddlZddlZddlmZ ddlmZ ddlm Z ddlm
Z
ddlm Z ddl m
Z
dd l mZ dd
lmZ dd lmZ dd lmZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm Z ddlm Z ddlm Z ddlm Z ddlm!Z! dd lm"Z" dd lm#Z# dd lm$Z$ dd lm%Z% dd lm&Z& ddlZerd! Z d" Z' G d# d$e Z(e e&j) ed% e&j) e oe
d& G d' d(e( Z* e&j) ed) G d* d+e* Z+ G d, d-e( Z,e-d.k rdd/l.m/Z/ e/e0 dS dS )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)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 n ddl m} || S # t $ r t j Y d S w xY w)Nr r ) psutil.testsr WindowsError traceback print_exc)pathrms {/builddir/build/BUILD/imunify360-venv-2.6.2/opt/imunify360/venv/lib64/python3.11/site-packages/psutil/tests/test_unicode.pyr r s s[ 322222 "2d88O " " " ! ! ! ! ! ! "s
44c d}t | } t | t | t |g }t j ||dz t |dz |t
| t | dS # t t f$ r$ Y |t
| t | dS w xY w# |t
| t | w xY w)z`Return True if both the fs and the subprocess module can
deal with a unicode file name.
Nsuffixcmdz-2TF) r r r r shutilcopyfiler UnicodeEncodeErrorIOError)r- sproctestfns r* try_unicoder6 s
E
v
&
&
&F
F6 F8,,,
...FTM""" e F
( e F
e Fs$ AB C!C CC "C*c e Zd ZdZd ZdS )BaseUnicodeTestNc j | j )t | j s| d d S d S )Nzcan't handle unicode str) funky_suffixr6 skipTest)selfs r* setUpzBaseUnicodeTest.setUp sF ( t 011
@mm$>??? ) (
@
@ )__name__
__module__ __qualname__r: r= r> r* r8 r8 s- L@ @ @ @ @r> r8 zASCII fsztoo much trouble on PYPY2c e Zd ZdZeZed Zed Zd Z d Z
d Z d Z d Z
ej eoed d
Z ej e d d Z ej e d ej e d
e d Zd Z ej e d ej e d ej ed d ZdS )
TestFSAPIsz1Test FS APIs with a funky, valid, UTF8 path name.c b t | j | _ t | j d S )Nr, )r r:
funky_namer clss r*
setUpClasszTestFSAPIs.setUpClass s- #3+;<<<3>"""""r> c . t | j d S N)r rF rG s r*
tearDownClasszTestFSAPIs.tearDownClass s CN#####r> c t | j t rdnt d }t j 5 t j d | j t j | v cd d d S # 1 swxY w Y d S )N.ignore)
isinstancerF strr warningscatch_warnings simplefilteroslistdir)r< heres r* expect_exact_path_matchz"TestFSAPIs.expect_exact_path_match s ! #66BssAcFF
$
&
& 7 7 !( + + +?bj&6&66 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7s /A;;A?A?c | | j g }t j |j }| }| |t | rW| t j | t j | j d S d S Nr. )
r rF psutilProcesspidexeassertIsInstancerQ rX assertEqualrU r( normcase)r< subppr^ s r*
test_proc_exezTestFSAPIs.test_proc_exe s ""'8"99 N48 $ $eegg c3''' ' ' ) ) @ RW - -c 2 2 W - -do > >
@
@
@
@
@ @ @r> c f | | j g }t j |j }| |t | r:| |t j | j d S d S rZ )
r rF r[ r\ r] namer_ rQ rX r` rU r( basename)r< rb rf s r* test_proc_namezTestFSAPIs.test_proc_name s ""'8"99~dh'',,.. dC((( ' ' ) ) F T27#3#3DO#D#D E E E E E F Fr> c < | | j g }t j |j }| }|D ] }| |t | r | || j g d S d S rZ )
r rF r[ r\ r] cmdliner_ rQ rX r` )r< rb rc rj parts r* test_proc_cmdlinez TestFSAPIs.test_proc_cmdline s ""'8"99 N48 $ $))++ - -D ! !$ , , , , ' ' ) ) 9 Wt&7 8 8 8 8 8 9 9r> c | j dz }| t | t | t | 5 t j }| }d d d n # 1 swxY w Y | | t |
r| || d S d S N2) rF
addCleanupr r r
r[ r\ cwdr_ rQ rX r` )r< dnamerc rq s r*
test_proc_cwdzTestFSAPIs.test_proc_cwd s #% U+++5
5\\ A%%''C
aeeggs+++ ' ' ) ) ) S% ( ( ( ( ( ) )s (A88A<?A<zfails on PYPY + WINDOWSc t j }t | }t | j d 5 t | }d d d n # 1 swxY w Y ||z
j }| |t t r|s| d S | rW|
t j | t j | j d S d S )Nrbzopen_files on BSD is broken)r[ r\ set
open_filesopenrF popr( r_ rQ r r; rX r` rU ra )r< rc startnewr( s r* test_proc_open_filesz TestFSAPIs.test_proc_open_files sa N ALLNN##
$/4
(
( & &allnn%%C & & & & & & & & & & & & & & &e ""' dC((( @t @==!>?? ? ' ' ) ) @ RW - -d 3 3 W - -do > >
@
@
@
@
@ @ @s
"A88A<?A<z
POSIX onlyc | | j } t | }n*# t $ r t r t j d w xY wt | 5 t j
d d }| |j t t s| |j | d d d d S # 1 swxY w Y d S )Nr,
not supportedunixr )r r: r r2 r r" SkipTestr r[ r\ connectionsr_ laddrrQ r r` )r< rf sockconns r* test_proc_connectionsz TestFSAPIs.test_proc_connections s- d&788 9#D))DD! 9 9 9
9 '888 9
T]] 3 3>##//77:D ! !$*c 2 2 2
3 T222 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3s - 'A&A/C""C&)C&zcan't list UNIX socketsc d }| | j } t | }n*# t $ r t r t j d w xY wt | 5 t j d }t sF || }| |j t | |j | d d d d S # 1 swxY w Y d S )Nc | D ]B}t j |j t
r|c S Ct
d )Nzconnection not found)rU r( rg r
startswithr
ValueError)consr s r* find_sockz2TestFSAPIs.test_net_connections..find_sock sV
7##DJ//::=II KKK 344 4r> r, r~ r )kind)r r: r r2 r r" r r r[ net_connectionsr r_ r rQ r` )r< r rf r r r s r* test_net_connectionsz TestFSAPIs.test_net_connections s> 5 5 5 d&788 9#D))DD! 9 9 9
9 '888 9
T]] 3 3)v666D
3 y%%dj#666 T222
3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3s 0 'A)A#CC C c | j dz }| t | t | t j | d S rn )rF rp r r r[
disk_usage)r< rr s r* test_disk_usagezTestFSAPIs.test_disk_usage" sG #% U+++5% r> r~ z&ctypes does not support unicode on PY2zunstable on PYPYc d t | j 5 }d fdt j D }d |D }| | | |D ] }| |t d d d d S # 1 swxY w Y d S )Nr, c z t j t j | S rK )rU r( realpathra )rc s r* normpathz-TestFSAPIs.test_memory_maps..normpath/ s( w''(8(8(;(;<< c 0 g | ]} |j S rB )r( ).0xr s r*
z/TestFSAPIs.test_memory_maps..1 s; A A A !(( A A Ar> c $ g | ]
}t |v |S rB r )r r s r* r z/TestFSAPIs.test_memory_maps..4 s" BBBa}/A/A/A/A/Ar> )r r: r[ r\ memory_mapsassertInr_ rQ )r<
funky_pathlibpathsr( r s @r* test_memory_mapszTestFSAPIs.test_memory_maps( s- !(9
:
:
: 1j
=
=
=A A A A!' !1!1!=!=!?!?A A AH CB8BBBH MM((:.. 9 9 9
1
1%%dC0000
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1s B B%%B),B)N) r? r@ rA __doc__r! r: classmethodrI rL rX rd rh rl rs r" skipIfr r r| r r r r r r r r r rB r> r* rD rD s <;!L# # [# $ $ [$7 7 7@ @ @F F F9 9 9 ) ) ) X_T%g'@AA @ @ BA @ X_Y --3 3 .-3 X_Y --X_--/HII 3 3 JI .-3.! ! ! X_ (/::X_W FGGX_T-.. 1 1 /. HG ;: 1 1 1r> rD zunreliable on CIc , e Zd ZdZeZed ZdS )TestFSAPIsWithInvalidPathz-Test FS APIs with a funky, invalid path name.c dS )NTrB rG s r* rX z1TestFSAPIsWithInvalidPath.expect_exact_path_match? s tr> N)r? r@ rA r r r: r rX rB r> r* r r : s8 77)L [ r> r c e Zd ZdZerendZ ej e d ej e
oe d d Z dS )
TestNonFSAPISz&Unicode tests for non fs-related APIs. èr~ zsegfaults on PYPY + WINDOWSc t j }| j |d< | | }t j |j }| }| D ];\ }}| |t | |t <| |d | j d S )N FUNNY_ARG)env) rU environcopyr: r r[ r\ r] itemsr_ rQ r` )r< r r4 rc kvs r* test_proc_environz TestNonFSAPIS.test_proc_environN s joo ,K###,, N59 % %iikkIIKK * *DAq ! !!S ) ) ) ! !!S ) ) ) ) [)4+<=====r> N)
r? r@ rA r r r! r: r" r r r r r rB r> r* r r J sr 00%(2>>dLX__o66X_T%g'DEE> > FE 76> > >r> r __main__)
run_from_name)1r rU r0 r& rR
contextlibr r[ r r r r 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" r6 r8 r rD r r r? psutil.tests.runnerr __file__rB r> r* r s B BH
! ! ! ! ! ! ! ! ! ! ! ! ) ) ) ) ) ) # # # # # # , , , , , , # # # # # # # # # # # # - - - - - - $ $ $ $ $ $ ( ( ( ( ( ( / / / / / / ' ' ' ' ' ' # # # # # # $ $ $ $ $ $ " " " " " " . . . . . . ' ' ' ' ' ' " " " " " " & & & & & & ' ' ' ' ' ' ! ! ! ! ! !
"" " "$ 6@ @ @ @ @n @ @ @ :&& !c'#>??K1 K1 K1 K1 K1 K1 K1 @? '& K1\ /00
10 > > > > >O > > >. z111111M( r>