U +if3U@sdZddlmZddlZddlmZmZddlZddlZ ddl m Z ddl m mZddlmZddlZddlmZmZmZddlmZerddlmZejGd d d Zdd dZddZddZ ddZ!dS)z Module consolidating common testing functions for checking plotting. Currently all plotting tests are marked as slow via ``pytestmark = pytest.mark.slow`` at the module level. ) annotationsN) TYPE_CHECKINGSequence)cache_readonly) is_list_like) DataFrameSeries to_datetimeAxesc@seZdZdZddZddZeddZedd Zd9d d Z d:ddZ ddZ d;ddZ dd d!Zd?d#d$Zd@d%d&Zd'd(Zd)d*ZdAd,d-ZdBd.d/Zifd0d1ZdCd3d4Zd5d6Zd7d8Zd S)D TestPlotBasezE This is a common base class used for various plotting tests cCsTddl}ddlm}||_|d|_d|_||_||_||_| |_ d|_ d|_ d|_ d|_ d }td tjjd d g|d }tjjdddg|d }t||tjjdd|d tjjdd|d tjjd|d ttjj|j|j|tjdd|_W5QRXt|_ttjjdd tjjdd tdtjjdd d|_dS)Nr)compatlj+2ZlReZ)g@g333333@leftd*ZMaleZFemale)sizeABCB )rdtype)gender classroomheightweightcategorydatetime)rrr) matplotlibZpandas.plotting._matplotlibr Z rcdefaultsZstart_date_to_int64Zend_date_to_int64Z mpl_ge_2_2_3Z mpl_ge_3_0_0 mpl_ge_3_1_0Z mpl_ge_3_2_0Z bp_n_objectsZpolycollection_factordefault_figsizeZdefault_tick_positiontmZ RNGContextnprandomchoicernormalrandintr Zint64Zhist_dfZmakeTimeDataFrameZtdfuniformZarangeZ hexbin_df)selfmethodmplr nrrr1O/home/mars/bis/venv/lib/python3.8/site-packages/pandas/tests/plotting/common.py setup_method*sR         zTestPlotBase.setup_methodcCs tdSN)r&close)r-r.r1r1r2teardown_methodaszTestPlotBase.teardown_methodcCsddlm}|SNr)matplotlib.pyplotpyplot)r-pltr1r1r2r:ds zTestPlotBase.pltcCsddlm}|jSr7)Zmatplotlib.colorscolorsZcolorConverter)r-r;r1r1r2colorconverterjs zTestPlotBase.colorconverterNTcCsf|r|dkrtd||}|D]>}|rP|dk s:t|||q"|dks"tq"dS)aQ Check each axes has expected legend labels Parameters ---------- axes : matplotlib Axes object, or its list-like labels : list-like expected legend labels visible : bool expected legend visibility. labels are checked only when visible is True Nz-labels must be specified when visible is True) ValueError_flatten_visible get_legendAssertionError_check_text_labelsZ get_texts)r-axeslabelsvisibleaxr1r1r2_check_legend_labelsps  z!TestPlotBase._check_legend_labelscCsT|r|dkrtd|r@|\}}dd|D}||ksPtn|dksPtdS)aB Check ax has expected legend markers Parameters ---------- ax : matplotlib Axes object expected_markers : list-like expected legend markers visible : bool expected legend visibility. labels are checked only when visible is True Nz.Markers must be specified when visible is TruecSsg|] }|qSr1)Z get_marker).0handler1r1r2 sz5TestPlotBase._check_legend_marker..)r=Zget_legend_handles_labelsr@r?)r-rEZexpected_markersrDZhandles_markersr1r1r2_check_legend_markers  z!TestPlotBase._check_legend_markercsP|}|}ddt|t|ks,tfddt||DtdS)z Check each axes has identical lines Parameters ---------- xp : matplotlib Axes object rs : matplotlib Axes object cSs |}|}t||dSr4)Z get_xydatar&assert_almost_equal)xplrslZxpdataZrsdatar1r1r2 check_linesz,TestPlotBase._check_data..check_linecsg|]\}}||qSr1r1)rGrNrOrPr1r2rIsz,TestPlotBase._check_data..N) get_lineslenr@zipr&r5)r-ZxprsZxp_linesZrs_linesr1rQr2 _check_datas zTestPlotBase._check_datacCsBddlm}t||s$t|s$|g}|D]}||ks(tq(dS)a Check each artist is visible or not Parameters ---------- collections : matplotlib Artist or its list-like target Artist or its list or collection visible : bool expected visibility r) CollectionN)matplotlib.collectionsrW isinstancer get_visibler@)r- collectionsrDrWpatchr1r1r2_check_visibles zTestPlotBase._check_visiblezAxes | Sequence[Axes]boolNone)rBfilledreturncCs2||}|D]}|jD]}|j|kstqqdS)z Check for each artist whether it is filled or not Parameters ---------- axes : matplotlib Axes object, or its list-like filled : bool expected filling N)r>Zpatchesfillr@)r-rBr`rEr\r1r1r2_check_patches_all_filleds  z&TestPlotBase._check_patches_all_filledcs*|}tt||fdd|jDS)Ncsg|] }|qSr1r1rGvZmappedr1r2rIsz3TestPlotBase._get_colors_mapped..)uniquedictrTvalues)r-Zseriesr;rgr1rfr2_get_colors_mappedszTestPlotBase._get_colors_mappedcCsddlm}m}m}ddlm}|j} |dk r|dk rR|||}|dt|}t|t|ksft t ||D]d\} } t | |r| } | | } n(t | ||frt| d} n| } | | } | | kspt qp|dk r|dk r|||}|dt|}t|t|kst t ||D]Z\} } t | |rH| d} n| } t | tjrft| } | | } | | ks&t q&dS)a3 Check each artist has expected line colors and face colors Parameters ---------- collections : list-like list or collection of target artist linecolors : list-like which has the same length as collections list of expected line colors facecolors : list-like which has the same length as collections list of expected face colors mapping : Series Series used for color grouping key used for andrew_curves, parallel_coordinates, radviz test r)rWLineCollectionPolyCollection)Line2DN)rXrWrkrlZmatplotlib.linesrmr<rjrSr@rTrY get_colorZto_rgbatupleZ get_edgecolorZ get_facecolorr'Zndarray)r-r[Z linecolorsZ facecolorsmappingrWrkrlrmconvr\colorresultexpectedr1r1r2 _check_colorss<          zTestPlotBase._check_colorscCs`t|s||ks\tnBdd|D}t|t|ks.N)rrvr@rSrT)r-ZtextsrtrClabeler1r1r2rA s zTestPlotBase._check_text_labelsc Csddlm}||}|D]}|dk s.|dk rt|j|rH|}n||jdd}|D]4} |dk r|t| ||dk r`t| |q`|dk s|dk rt|j |r| }n| |j dd}|D]4} |dk rt| ||dk rt| |qqdS)a Check each axes has expected tick properties Parameters ---------- axes : matplotlib Axes object, or its list-like xlabelsize : number expected xticks font size xrot : number expected xticks rotation ylabelsize : number expected yticks font size yrot : number expected yticks rotation r) NullFormatterNT)minor) Zmatplotlib.tickerrzr>rYxaxisZget_minor_formatterZget_xticklabelsr&rMZ get_fontsizeZ get_rotationyaxisZget_yticklabels) r-rBZ xlabelsizeZxrotZ ylabelsizeZyrotrzrErCrxr1r1r2_check_ticks_props3s*    zTestPlotBase._check_ticks_propslinearcCs<||}|D](}|j|ks$t|j|kstqdS)a Check each axes has expected scales Parameters ---------- axes : matplotlib Axes object, or its list-like xaxis : {'linear', 'log'} expected xaxis scale yaxis : {'linear', 'log'} expected yaxis scale N)r>r|Z get_scaler@r})r-rBr|r}rEr1r1r2_check_ax_scalescs zTestPlotBase._check_ax_scalesc Csddlm}|dkr|j}||}|dk rZt||ksrSr@Z get_children_get_axes_layoutr&Zassert_numpy_array_equalfigureZget_size_inchesr'arrayZfloat64) r-rBZaxes_numZlayoutZfigsizerZ visible_axesrErsr1r1r2_check_axes_shapets    zTestPlotBase._check_axes_shapecCsVt}t}|D]4}|}||dd||ddqt|t|fS)Nr)setZ get_positionZ get_pointsaddrS)r-rBZx_setZy_setrEZpointsr1r1r2rs zTestPlotBase._get_axes_layoutcCs&ddlm}||}dd|D}|S)z Flatten axes, and filter only visible Parameters ---------- axes : matplotlib Axes object, or its list-like rrcSsg|]}|r|qSr1)rZ)rGrEr1r1r2rIsz1TestPlotBase._flatten_visible..)rr)r-rBrr1r1r2r>s zTestPlotBase._flatten_visiblerc Csx||}|D]d}|j}d}d}|D]4}t|dd} t|dd} | rL|d7}| r$|d7}q$||ksft||kstqdS)a Check axes has expected number of errorbars Parameters ---------- axes : matplotlib Axes object, or its list-like xerr : number expected number of x errorbar yerr : number expected number of y errorbar rhas_xerrFhas_yerrrN)r> containersgetattrr@) r-rBZxerrZyerrrErZ xerr_countZ yerr_countcrrr1r1r2_check_has_errorbarss     z!TestPlotBase._check_has_errorbarsc Csddlm}t|td}|dkrj|dkr,d}t|||s>t|dkrft|j|sVtt|jtsftn|dkr||D]}t||s|tq|dSt|t stt | t |kst| D]\}} t| ||st|dkr|r| |kstq|dkrD|r| j |kstt| j|s0tt| jts~tq|dkrz| dd} | j} |r~| |ks~tqtqdS) at Check box returned type is correct Parameters ---------- returned : object to be tested, returned from boxplot return_type : str return_type passed to boxplot expected_keys : list-like, optional group labels in subplot case. If not passed, the function checks assuming boxplot uses single ax check_ax_title : bool Whether to check the ax.title is the same as expected_key Intended to be checked by calling from ``boxplot``. Normal ``plot`` doesn't attach ``ax.title``, it must be disabled. rr )rhrBbothNrhrrBZmedians)matplotlib.axesr rhrorYr@rElinesr>rsortedkeysitemsZ get_titlerB) r-returned return_typeZ expected_keysZcheck_ax_titler typesrkeyvaluelinerBr1r1r2_check_box_return_types>     z#TestPlotBase._check_box_return_typecsfddl}fdd}d}|D]B}jddt|||d7}|jddd|jfd |i||rntjddt|||d7}|jdd d|jf|dd ||rt|d krjddt|||d7}|jdd d|jfd |i||stjddt|||d7}|jddd|jf|d d ||stqdS) Nrcszjj}jj}jrLtdd|D}tdd|D}n$tdd|D}tdd|D}|ov| S)Ncss|]}|j VqdSr4ZgridlinerZrGgr1r1r2 szHTestPlotBase._check_grid_settings..is_grid_on..css|]}|j VqdSr4rrr1r1r2rscss|]}|j VqdSr4ZgridOnrr1r1r2rscss|]}|j VqdSr4rrr1r1r2rs)r:Zgcar|Zget_major_ticksr}r$all)ZxticksZyticksZxoffZyoffr-r1r2 is_grid_on sz5TestPlotBase._check_grid_settings..is_grid_onrrrBF)gridkindT)rr)pieZhexbinZscatter)r#r:ZsubplotrSrcZplotr@)r-objkindskwsr/rZspndxrr1rr2_check_grid_settingss2     z!TestPlotBase._check_grid_settingsrrcsfdd|dDS)zT Auxiliary function for correctly unpacking cycler after MPL >= 1.5 csg|] }|qSr1r1rdfieldr1r2rI<sz/TestPlotBase._unpack_cycler..zaxes.prop_cycler1)r-ZrcParamsrr1rr2_unpack_cycler8szTestPlotBase._unpack_cyclercCs|jr|jdS|jS)Nx)r mpl_ge_3_5_0 _shared_axesZ_shared_x_axesr-rEr1r1r2 get_x_axis>szTestPlotBase.get_x_axiscCs|jr|jdS|jS)Ny)r rrZ_shared_y_axesrr1r1r2 get_y_axisAszTestPlotBase.get_y_axis)NT)NT)T)T)NNN)NNNN)rr)NNN)rr)NT)rr)__name__ __module__ __qualname____doc__r3r6rr:r<rFrLrVr]rcrjrurAr~rrrr>rrrrrrr1r1r1r2r $sH7      B 0  $   < 0 r alwaysFc Ksddlm}|rt}nt}d}tt|zz\| d| }| |||f|D]}t |q\tj dd}||W5QRXWn&tk r} z| W5d} ~ XYnXW5t|X|W5QRSQRXdS)aT Create plot and ensure that plot return object is valid. Parameters ---------- f : func Plotting function. filterwarnings : str Warnings filter. See https://docs.python.org/3/library/warnings.html#warning-filter default_axes : bool, optional If False (default): - If `ax` not in `kwargs`, then create subplot(211) and plot there - Create new subplot(212) and plot there as well - Mind special corner case for bootstrap_plot (see `_gen_two_subplots`) If True: - Simply run plotting function with kwargs provided - All required axes instances will be created automatically - It is recommended to use it when the plotting function creates multiple axes itself. It helps avoid warnings like 'UserWarning: To output multiple subplots, the figure containing the passed axes is being cleared' **kwargs Keyword arguments passed to the plotting function. Returns ------- Plot object returned by the last plotting. rNrT)Zreturn_filelike)r8r9_gen_default_plot_gen_two_subplotswarningscatch_warnings simplefilterr&r5getZgcfZclfZ"assert_is_valid_plot_return_objectZ ensure_cleanZsavefig Exception) ffilterwarningsZ default_axeskwargsr:Z gen_plotsretfigpatherrr1r1r2_check_plot_worksEs$     rcks|f|VdS)z' Create plot in a default way. Nr1rrrr1r1r2rsrcksVd|kr|d|f|V|tjjkr8d|ksFtn|d|d<|f|VdS)z9 Create plot on two subplots forcefully created. rEN)Z add_subplotpdZplottingZbootstrap_plotr@rr1r1r2rs   rcCstjtjt\}}|Sr4)osrsplitabspath__file__)pthrJr1r1r2curpathsr)rF)"r __future__rrtypingrrrnumpyr'Zpandas.util._decoratorsrZpandas.util._test_decoratorsutilZ_test_decoratorstdZpandas.core.dtypes.apirZpandasrrrr Zpandas._testingZ_testingr&rr Zskip_if_no_mplr rrrrr1r1r1r2s.     $ :