OwlCyberSecurity - MANAGER
Edit File: decorators.cpython-38.pyc
U W6�^�L � @ s� d dl Z d dlmZ d dlZd dlZd dlZd dlmZ d dlZd dl Z d dl Z d dl Z d dl Z d dlZ d dlZ d dlZ d dl mZ d dl mZ d dl mZ d dl mZ dd lmZ dd lmZmZmZ dd l m Z e j d d � �Z G dd� de j �Z!e�"d�G dd� de#��Z$d9dd�Z%dd� Z&dd� Z'dd� Z(dd � Z)d d � Z*d d � Z+G d!d"� d"e#�Z,e�"d�G d#d$� d$e$e,��Z-d%d&� Z.d:d*d+�Z/d,d d-�d.d/�Z0d0d1� Z1ej"d2d3d4�d5d6� �Z2e�"d�d7d8� �Z3dS );� N�� StrictVersion)�Path)�cbook)�ft2font)�pyplot)�ticker� )�is_called_from_pytest)�comparable_formats�compare_images�make_test_filename)�ImageComparisonFailurec c sj t jj�� } z2t� � � t � � � d V W 5 Q R X W 5 Q R X W 5 t jj�� t jj�| � t�d� X d S )N�all) � matplotlibZunits�registry�copy�clear�update�plt�close�warnings�catch_warningsZ rc_context)Zorig_units_registry� r �?/usr/lib/python3/dist-packages/matplotlib/testing/decorators.py� _cleanup_cm s r c @ s( e Zd ZdZedd� �Zedd� �ZdS )�CleanupTestCasezAA wrapper for unittest.TestCase that includes cleanup operations.c C s t � �� | _d S �N)r � __enter__�_cm��clsr r r � setUpClass' s zCleanupTestCase.setUpClassc C s | j �d d d � d S r )r �__exit__r r r r � tearDownClass+ s z CleanupTestCase.tearDownClassN)�__name__� __module__� __qualname__�__doc__� classmethodr" r$ r r r r r % s r z3.0c @ s, e Zd Zeejj�Zeejj�Z dd� Z dS )� CleanupTestc C s | � � d S r )Z_func��selfr r r �test5 s zCleanupTest.testN) r% r& r' r) r r" �__func__� setup_classr$ �teardown_classr- r r r r r* 0 s r* c s. � fdd�}t � t�r|S |� �}d� |S dS )z� A decorator to ensure that any global state is reset before running a test. Parameters ---------- style : str, optional The name of the style to apply. c s@ t �� �r$t�� �� �fdd��}nt�� �� �fdd��}|S )Nc ? s> t � �. tj���� � | |�E d H W 5 Q R X W 5 Q R X d S r �r r �style�context��args�kwargs��funcr2 r r �wrapped_callableL s z7cleanup.<locals>.make_cleanup.<locals>.wrapped_callablec s8 t � �( tj���� � | |� W 5 Q R X W 5 Q R X d S r r1 r4 r7 r r r9 Q s )�inspectZisgeneratorfunction� functools�wraps)r8 r9 �r2 �r8 r � make_cleanupJ s z cleanup.<locals>.make_cleanup� _classic_testN)� isinstance�str)r2 r? �resultr r= r �cleanup9 s rD c C sV | d kr dS t | t�r | | f} dd� | D �} ttj�}| d | koP| d kS S )NTc S s g | ] }t |��qS r r )�.0�xr r r � <listcomp>g s z*check_freetype_version.<locals>.<listcomp>r r )rA rB r r �__freetype_version__)Zver�foundr r r �check_freetype_versiona s rJ c C s0 dd l }d| tjf }|jjt| � |tdd�S )Nr zAMismatched version of freetype. Test requires '%s', you have '%s'F)�reasonZraises�strict)�pytestr rH �markZxfailrJ r )Zrequired_freetype_versionrM rK r r r � _checked_on_freetype_versionm s � �rO c C s� | � d� t�� }| �� D ]p}|�d� |j�|� |j�|� |j�|� |j�|� z |j �|� |j �|� W q t k r� Y qX qd S )N� ) Zsuptitler Z NullFormatterZget_axesZ set_titleZxaxisZset_major_formatterZset_minor_formatterZyaxisZzaxis�AttributeError)�figureZnull_formatterZaxr r r �remove_ticks_and_titlesw s rS c C s^ d}t | ||dd�}tj�| �s,td| ��|rZdD ]}tj�|| �||< q4td| � d S )NT)Z in_decoratorzimage does not exist: %s)�actual�expectedz<images not close (RMS %(rms).3f): %(actual)s %(expected)s )r �os�path�existsr �relpath�print)rU rT �tol�__tracebackhide__�err�keyr r r �_raise_on_image_difference� s ��r_ c C s$ dd l }|jj| t� kd�| �d�S )Nr z&Cannot compare {} files on this system�rK )rM rN Zskipifr �format)� extensionrM r r r � _skip_if_format_is_uncomparable� s �rc c C s` dd l }t| t�r | }g }n,t| t�r8| j\}| j�}n| j\}| jg}|j||t |�f�d�S )Nr )�marks) rM rA rB �tuple�valuesrd r5 rN Zparamrc )rb rM �namerd r r r �$_mark_skip_if_format_is_uncomparable� s �rh c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd S ) �_ImageComparisonBasez� Image comparison base class This class provides *just* the comparison-related functionality and avoids any code that would be specific to any testing framework. c C s( d | _ | _| _|| _|| _|| _d S r )r8 � baseline_dir� result_dirr[ � remove_text�savefig_kwargs)r, r[ rl rm r r r �__init__� s z _ImageComparisonBase.__init__c C s, | j d kstd��|| _ t|�\| _| _d S )Nz'it looks like same decorator used twice)r8 �AssertionError�_image_directoriesrj rk �r, r8 r r r � delayed_init� s z!_ImageComparisonBase.delayed_initc C s� t j�| j|�}|d | }|dkr8t j�|�s8|d }tt j�| jt j�|��d�}t j�|�rpt� ||� nd� ||�}t |��|S )N�.Zepsz.pdfrU zBDo not have baseline image {} because this file does not exist: {}) rV rW �joinrj rX r rk �basename�shutilZcopyfilera r )r, �baselinerb Z baseline_pathZorig_expected_fname�expected_fnamerK r r r � copy_baseline� s$ �� �z"_ImageComparisonBase.copy_baselinec C s� d}t �� | }t �|�}| jr(t|� tj�| j|�d | }| j � � }|dkrf|� dd d d d�� |j |f|� | � ||�} t| || j� d S )NTrs �pdfZmetadata)ZCreatorZProducerZ CreationDate)r � get_fignumsrR rl rS rV rW rt rk rm r � setdefault�savefigry r_ r[ ) r, �idxrw rb r\ ZfignumZfigZ actual_fnamer6 rx r r r �compare� s" � �� z _ImageComparisonBase.compareN)r% r& r' r( rn rr ry r r r r r ri � s ri c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd S ) �ImageComparisonTestal Nose-based image comparison class This class generates tests for a nose-based testing framework. Ideally, this class would not be public, and the only publicly visible API would be the :func:`image_comparison` decorator. Unfortunately, there are existing downstream users of this class (e.g., pytest-mpl) so it cannot yet be removed. c C s, t �| |||� || _|| _|| _|| _d S r )ri rn �baseline_images� extensions�freetype_versionr2 )r, r� r� r[ r� rl rm r2 r r r rn � s z ImageComparisonTest.__init__c C s� | j }t�d� | �� zVtj�| j� tj�� |� t t� � �t | j �kslt d� t t� � �t | j ����W n | �� � Y nX d S )Nr �9Test generated {} images but there are {} baseline images)r8 r r r/ r r2 Zuse�testing� set_font_settings_for_testing�lenr{ r� ro ra r0 rq r r r �setup� s ��zImageComparisonTest.setupc C s | � � d S r )r0 r+ r r r �teardown s z ImageComparisonTest.teardownc # s^ | j � t| j�� �� � fdd�| jD �}t| j�D ]&\}}| jD ]}|| |||fV q@q2d S )Nc s i | ]}|t |�� ��qS r )rc )rE rb r> r r � <dictcomp> s � z3ImageComparisonTest.nose_runner.<locals>.<dictcomp>)r rO r� r� � enumerater� )r, Zfuncsr~ rw rb r r> r � nose_runner s � z ImageComparisonTest.nose_runnerc s> � � |� dd l}t�|�|j�� j� j�� fdd���}|S )Nr c 3 s � � � E d H d S r )r� r r+ r r �runner_wrapper s z4ImageComparisonTest.__call__.<locals>.runner_wrapper)rr Z nose.toolsr; r< ZtoolsZ with_setupr� r� )r, r8 Znoser� r r+ r �__call__ s z ImageComparisonTest.__call__N) r% r& r' r( rn r� r� r� r� r r r r r� � s r� c s0 ddl �tt���� �������fdd�}|S )ag Decorate function with image comparison for pytest. This function creates a decorator that wraps a figure-generating function with image comparison code. Pytest can become confused if we change the signature of the function, so we indirectly pass anything we need via the `mpl_image_comparison_parameters` fixture and extra markers. r Nc sd t �� ��j�d��j�d���j����j���t��t �� �� ���fdd��������}|S )NZ mpl_image_comparison_parametersrb c s� d}t ���d�}|�� � tj�� � | |� � j\}}tt�� �t|�ksjt d� tt�� �t|����t |�D ]\}}|� |||� qrd S )NT)r[ rl rm r� ) ri rr r r� r� � parametersr� r r{ ro ra r� r )r5 r6 r\ Zimgr� rb r~ rw )r8 rl rm r[ r r �wrapper5 s � ��z<_pytest_image_comparison.<locals>.decorator.<locals>.wrapper)r; r< rN Z usefixtures� parametrizer� r2 rO )r8 r� �r� r� r� rM rl rm r2 r[ r> r � decorator4 s z+_pytest_image_comparison.<locals>.decorator)rM �maprh )r� r� r[ r� rl rm r2 r� r r� r �_pytest_image_comparison% s !r� �/�$���?Fr@ c C sf |dkrdddg}|dkr t � }t� r<t| ||||||d�S | dkrLtd��t| ||||||d�S dS )aq Compare images generated by the test with those specified in *baseline_images*, which must correspond, else an `ImageComparisonFailure` exception will be raised. Parameters ---------- baseline_images : list or None A list of strings specifying the names of the images generated by calls to :meth:`matplotlib.figure.savefig`. If *None*, the test function must use the ``baseline_images`` fixture, either as a parameter or with `pytest.mark.usefixtures`. This value is only allowed when using pytest. extensions : None or list of str The list of extensions to test, e.g. ``['png', 'pdf']``. If *None*, defaults to all supported extensions: png, pdf, and svg. In order to keep the size of the test suite from ballooning, we only include the ``svg`` or ``pdf`` outputs if the test is explicitly exercising a feature dependent on that backend (see also the `check_figures_equal` decorator for that purpose). tol : float, optional, default: 0 The RMS threshold above which the test is considered failed. freetype_version : str or tuple The expected freetype version or range of versions for this test to pass. remove_text : bool Remove the title and tick text from the figure before comparison. This is useful to make the baseline images independent of variations in text rendering between different versions of FreeType. This does not remove other, more deliberate, text, such as legends and annotations. savefig_kwarg : dict Optional arguments that are passed to the savefig method. style : string Optional name for the base style to apply to the image test. The test itself can also apply additional styles if desired. Defaults to the '_classic_test' style. N�pngrz �svg)r� r� r[ r� rl rm r2 z!baseline_images must be specified)�dictr r� � ValueErrorr� )r� r� r[ r� rl Z savefig_kwargr2 r r r �image_comparisonX s2 6 � �r� )r� rz r� �r� r[ c s � �fdd�}|S )a� Decorator for test cases that generate and compare two figures. The decorated function must take two arguments, *fig_test* and *fig_ref*, and draw the test and reference images on them. After the function returns, the figures are saved and compared. This decorator should be preferred over `image_comparison` when possible in order to keep the size of the test suite from ballooning. Parameters ---------- extensions : list, default: ["png", "pdf", "svg"] The extensions to test. tol : float The RMS threshold above which the test is considered failed. Examples -------- Check that calling `Axes.plot` with a single argument plots it against ``[0, 1, 2, ...]``:: @check_figures_equal() def test_plot(fig_test, fig_ref): fig_test.subplots().plot([1, 3, 5]) fig_ref.subplots().plot([0, 1, 2], [1, 3, 5]) c s� dd l }ttt� ��\}�tt�� �j�dkrN|j� d��� ��fdd��}n2tt�� �j�dkr�|j� d��� ��fdd��}|S )Nr � �extc sp t �d�}t �d�}� ||� t�� jd | �}t�� jd | �}|�|� |�|� t||�d� d S �Nr- Z referencers z -expected.)r[ �r rR rB r% r} r_ )r� �fig_test�fig_ref�test_image_path�ref_image_path�r8 rk r[ r r r� � s �� �z7check_figures_equal.<locals>.decorator.<locals>.wrapper� c sr t �d�}t �d�}� | ||� t�� jd | �}t�� jd | �}|�|� |�|� t||�d� d S r� r� )r, r� r� r� r� r� r� r r r� � s �� �) rM r� r rp r� r: Z signaturer� rN r� )r8 rM �_r� r� )r8 rk r r� � s z&check_figures_equal.<locals>.decoratorr )r� r[ r� r r� r �check_figures_equal� s 'r� c C sT t tj| j j�}|jd |j }t � �� d |j }|jddd� t |�t |�fS )a= Compute the baseline and result image directories for testing *func*. For test module ``foo.bar.test_baz``, the baseline directory is at ``foo/bar/baseline_images/test_baz`` and the result directory at ``$(pwd)/result_images/test_baz``. The result directory is created if it doesn't exist. r� Z result_imagesT)�parents�exist_ok) r �sys�modulesr& �__file__�parentZstemZresolve�mkdirrB )r8 Z module_pathrj rk r r r rp � s rp z3.1zpytest.mark.backend)Z alternativec s � fdd�}|S )Nc s t �� ��� fdd��}|S )Nc s< z*t�� }tj�� t �� � �| |�W �S t �|� X d S r )r �switch_backend�mplZ get_backendr r� r� )r5 r6 Z prev_backend)�backendr8 r r �backend_switcher s zJswitch_backend.<locals>.switch_backend_decorator.<locals>.backend_switcher)r; r< )r8 r� �r� r> r �switch_backend_decorator� s z0switch_backend.<locals>.switch_backend_decoratorr )r� r� r r� r r� � s r� c C sT ddl m} z || � W n2 tk rJ ddl}|jjd| d d� Y S X dd� S )z� skips a test if a command is unavailable. Parameters ---------- cmd : list of str must be a complete command which should not return a non zero exit code, something like ["latex", "-version"] r )� check_outputNzmissing command: %sr` c S s | S r r )�fr r r �<lambda># � z-skip_if_command_unavailable.<locals>.<lambda>)� subprocessr� � ExceptionrM rN �skip)�cmdr� rM r r r �skip_if_command_unavailable s r� )N)Nr� NFNr@ )4� contextlibZdistutils.versionr r; r: rV �pathlibr rv r� Zunittestr r r� Zmatplotlib.styleZmatplotlib.unitsZmatplotlib.testingr r r r r rP r r r r r � exceptionsr �contextmanagerr ZTestCaser Z deprecated�objectr* rD rJ rO rS r_ rc rh ri r� r� r� r� rp r� r� r r r r �<module> s` ( 9:3 � MG