3 ƽhUB@sZdZddlZddlZddlZddlmZddlZddlZddlZddl Z ddl m Z m Z ddl ZddlmZddlZddlmZddlmZdd gZd d Zd d Zd.ddZejdddZejdjZddZGddde Z!GdddZ"Gddde"Z#Gddde"Z$d d!Z%iZ&e%d"d Z'd#d$Z(d%d&Z)d'd(Z*d/d*dZ+d+d,Z,dS)0z( Utilities for comparing image results. N)Path)TemporaryDirectory TemporaryFile)Image)cbook)ImageComparisonFailurecompare_imagescomparable_formatscCstjj|\}}d|||fS)zQ Make a new filename by inserting *purpose* before the file's extension. z%s-%s%s)ospathsplitext)fnamepurposebaseextr@/tmp/pip-build-7iwl8md4/matplotlib/matplotlib/testing/compare.pymake_test_filenamesrcCs$ttjd}|jdddt|S)NZ test_cacheT)parentsexist_ok)rmplZ get_cachedirmkdirstr) cache_dirrrr get_cache_dir!src Cstj}t|d&}x|j|}|s&P|j|qWWdQRXt|jdkrj|jttj dj j dn*t|jdkr|jttj dj j d|j S)Nrbz.pdfgszutf-8z.svginkscape) hashlibmd5openreadupdatersuffixrr_get_executable_infoversionencode hexdigest)r block_sizer!fddatarrr get_file_hash's   r-z3.3csfdd}|S)Ncs||}tj|dtjtjd}|j\}}|j}tjj| sF|r|ddj|}|rd|d|7}|rt|d|7}t |dS)NT)universal_newlinesstdoutstderrzConversion command failed: %s  zStandard output: %s zStandard error: %s ) subprocessPopenPIPE communicatewaitr r existsjoinIOError)oldnewZcmdlinepiper/r0errcodemsg)cmdrrconvert<s    z1make_external_conversion_command..convertr)r?r@r)r?r make_external_conversion_command:s rAs[^a-zA-Z0-9_@%+=:,./-]cCs$t|dkr|Sd|jdddS)N's'"'"')_find_unsafe_bytesreplace)brrr_shlex_quote_bytesQsrFc@s eZdZdS)_ConverterErrorN)__name__ __module__ __qualname__rrrrrGVsrGc@s$eZdZddZddZddZdS) _ConvertercCsd|_tj|jdS)N)_procatexitregister__del__)selfrrr__init__[sz_Converter.__init__cCsR|jrN|jj|jjx,td|jj|jj|jjgD] }|jq8Wd|_dS)N)rLkillr6filterstdinr/r0close)rPstreamrrrrOcs    z_Converter.__del__cCsPt}xD|jjjd}|st|j||j|rt|dt| SqWdS)z!Read until the prompt is reached.N) bytearrayrLr/r#rGextendendswithbyteslen)rP terminatorbufcrrr _read_untilms  z_Converter._read_untilN)rHrIrJrQrOr`rrrrrKZs rKc@seZdZddZdS) _GSConvertercCs|jshtjtjdjdddgtjtjd|_y|jdWn,tk rf}zt d|WYdd}~XnXdd }|jj j d ||d ||d |jj j |jd }|jd}|st jj| r|rt|ddnd}|jj j d|t|d |djtjddS)Nrz -dNOSAFERz -dNOPAUSEz-sDEVICE=png16m)rTr/s GSzFailed to start GhostscriptcSs"tj|jddjddjddS)N\s\\(s\()s\))r fsencoderD)namerrrencode_and_escapes z0_GSConverter.__call__..encode_and_escapes<< /OutputFile (s) >> setpagedevice (s ) run flush sGS>rWrspop rD)rLr2r3rr& executabler4r`rGOSErrorrTwriteflushr r r7intrdecodesysgetfilesystemencoding)rPorigdesterrrgstack stack_sizerrr__call__zs*    z_GSConverter.__call__N)rHrIrJrvrrrrraysracs$eZdZddZfddZZS) _SVGConverterc 'Cstjdjdk}|rdnd}t|ds.t|_|j sD|jjdk rtj dtj d}t }t j |rnddd gndd gt jt j|||jjd |_||j_y|j|Wn,tk r}ztd |WYdd}~XnXt|jjtjd }t|jjtjd } y|jt|jWn"tk r2tj||YnX|jjj|rFdnd|jjjy|j|WnPtk r}z2|jjjdt|jjjj t!j"d|WYdd}~XnXtj#|tj$| |dS)Nr1s >s> _tmpdir)ZDISPLAYZINKSCAPE_PROFILE_DIRz --without-guiz--shell)rTr/r0envcwdz,Failed to start Inkscape in interactive modesf.svgsf.pngsf.svg --export-png=f.png s;file-open:f.svg;export-filename:f.png;export-do;file-close rrD)%rr&r'hasattrrryrLpollr environdevnullrr2r3r4rfr0r`rGrjrfsdecodeZ symlink_toresolveshutilcopyfilerTrkrlseekrr#rnrorpremovemove) rPrqrrZ old_inkscaper]r{r0rsZ inkscape_origZ inkscape_destrrrrvsP       " z_SVGConverter.__call__cs"tjt|dr|jjdS)Nry)superrOr}rycleanup)rP) __class__rrrOs  z_SVGConverter.__del__)rHrIrJrvrO __classcell__rr)rrrws>rwcCslytjdWntjk r$YnXttd<td<ytjdWntjk r\Yn Xttd<dS)Nrpdfepsrsvg)rr&ZExecutableNotFoundErrorra converterrwrrrr_update_convertersrcCsdtS)z Return the list of file formats that `.compare_images` can compare on this system. Returns ------- list of str E.g. ``['png', 'pdf', 'svg', 'eps']``. png)r)rrrrrr s cCst|}|jst|d|jddtkrLddl}|jd|jd|j|jd|jddd}|j s|j j |j j kr|rtt nd}|dk rt |}|||j}|jrt j||t|St|jdd|||dk rt j||t|S) at Convert the named file to png; return the name of the created file. If *cache* is True, the result of the conversion is cached in `matplotlib.get_cachedir() + '/test_cache/'`. The caching is based on a hash of the exact contents of the input file. There is no limit on the size of the cache, so it may need to be manually cleared periodically. z does not existrWNrzDon't know how to convert z files to png_z.png)rr7r9r%rpytestskipparentZstemstatst_mtimerr-rrr)filenamecacher rnewpathrZ hash_valueZ cached_pathrrrr@ s& "    r@c Cs|dddkr|dd dkr|j\}}}|j\}}} |t|d|dt|d|dt|d|dt|d|df}||fS) Nrrriir)shaperm) Z actual_path actual_imageZ expected_pathexpected_imageZawZahadewehZedrrr crop_to_same.s    >rcCs<|j|jkr tdj|j|jtj||jtdjS)zR Calculate the per-pixel errors, then compute the root mean square error. z9Image sizes do not match expected size: {} actual size {}r)rrformatnpsqrtastypefloatZmean)rrrrr calculate_rms9s  rFc sztj|}tjj|s"td|tj|jdkr>td|tj|}tjj|s`td||jdd}|dkrt |dd }t |d d }t j t j |j d }t j t j |j d }t||||\}}t|d }|dkrt j||rd S|jt j}|jt j}t||}||krd St|||t|t|t|t||d|svddddddg} djfdd| DS)a+ Compare two "image" files checking differences within a tolerance. The two given filenames may point to files which are convertible to PNG via the `.converter` dictionary. The underlying RMS is calculated with the `.calculate_rms` function. Parameters ---------- expected : str The filename of the expected image. actual : str The filename of the actual image. tol : float The tolerance (a color value difference, where 255 is the maximal difference). The test fails if the average pixel difference is greater than this value. in_decorator : bool Determines the output format. If called from image_comparison decorator, this should be True. (default=False) Returns ------- None or dict or str Return *None* if the images are equal within the given tolerance. If the images differ, the return value depends on *in_decorator*. If *in_decorator* is true, a dict with the following entries is returned: - *rms*: The RMS of the image difference. - *expected*: The filename of the expected image. - *actual*: The filename of the actual image. - *diff_image*: The filename of the difference image. - *tol*: The comparison tolerance. Otherwise, a human-readable multi-line string representation of this information is returned. Examples -------- :: img1 = "./baseline/plot.png" img2 = "./output/plot.png" compare_images(img1, img2, 0.001) zOutput image %s does not exist.rzOutput image file %s is empty.z!Baseline image %r does not exist..rWrF)rTRGBz failed-diffN)rmsexpectedactualZdifftolz!Error: Image files did not match.zRMS Value: {rms}zExpected: {expected}zActual: {actual}zDifference: {diff}zTolerance: {tol}z csg|]}|jfqSr)r).0line)resultsrr sz"compare_images..)r fspathr r7 Exceptionrst_sizer9splitr@rasarrayrr"rrZ array_equalrZint16rsave_diff_imagedictrr8) rrrZ in_decorator extensionrrZ diff_imagertemplater)rrrIsJ1                 c Cs tjtj|jd}tjtj|jd}t||||\}}tj|jt}tj|jt}|j |j kr~t dj |j |j tj ||}|d 9}tj |ddjtj}|j \}}} | dkrtj||dftjd} || d d d d ddf<| }d|d d d d df<tj|j|d d d S) z Parameters ---------- expected : str File path of expected image. actual : str File path of actual image. output : str File path to save difference image to. rz9Image sizes do not match expected size: {} actual size {} rr)ZdtypeNr)ri )rrrr"r@rarrayrrrrrabsZclipZuint8emptyZ fromarraysave) rroutputrrZabs_diff_imageZ save_image_npheightwidthdepthZ with_alpharrrrs(   r)r)F)-__doc__rMr r Zpathlibrrerr2rotempfilerrnumpyrZPILrZ matplotlibrrZmatplotlib.testing.exceptionsr__all__rrr-Z deprecatedrAcompilesearchrCrFrrGrKrarwrrr r@rrrrrrrrsD      &E%  h