U sVcL@sdZddlmZddlmZmZddlZddlZddl m Z ddl m m ZddlmZddlZddlmZddlmZerddlmZejGd d d Zdd dZddZddZdS)zF Module consolidating common testing functions for checking plotting. ) annotations) TYPE_CHECKINGSequenceN)cache_readonly) is_list_like)SeriesAxesc@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 cCsddl}|dSNr) matplotlibZ rcdefaults)selfmplr@/tmp/pip-unpacked-wheel-xj8nt62q/pandas/tests/plotting/common.py setup_method"szTestPlotBase.setup_methodcCs tdSN)tmcloser rrrteardown_method'szTestPlotBase.teardown_methodcCsddlm}|Sr )matplotlib.pyplotpyplot)r pltrrrr*s zTestPlotBase.pltcCsddlm}|jSr )Zmatplotlib.colorscolorsZcolorConverter)r rrrrcolorconverter0s 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 axeslabelsvisibleaxrrr_check_legend_labels6s  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|] }|qSr)Z get_marker).0handlerrr ^sz5TestPlotBase._check_legend_marker..)rZget_legend_handles_labelsrr)r r$Zexpected_markersr#Zhandles_markersrrr_check_legend_markerMs  z!TestPlotBase._check_legend_markerc Cs`|}|}t|t|ks$tt||D]$\}}|}|}t||q.tdS)z Check each axes has identical lines Parameters ---------- xp : matplotlib Axes object rs : matplotlib Axes object N) get_lineslenrzipZ get_xydatarassert_almost_equalr) r ZxprsZxp_linesZrs_linesZxplZrslZxpdataZrsdatarrr _check_datacs 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.collectionsr2 isinstancer get_visibler)r collectionsr#r2patchrrr_check_visiblews zTestPlotBase._check_visiblezAxes | Sequence[Axes]boolNone)r!filledreturncCs2||}|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)rZpatchesfillr)r r!r;r$r7rrr_check_patches_all_filleds  z&TestPlotBase._check_patches_all_filledcs*|}tt||fdd|jDS)Ncsg|] }|qSrrr&vZmappedrrr(sz3TestPlotBase._get_colors_mapped..)uniquedictr.values)r ZseriesrrBrrAr_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)r2LineCollectionPolyCollection)Line2DN)r3r2rFrGZmatplotlib.linesrHrrEr-rr.r4Z get_colorZto_rgbatupleZ get_edgecolorZ get_facecolornpZndarray)r r6Z linecolorsZ facecolorsmappingr2rFrGrHconvr7colorresultexpectedrrr _check_colorss<          zTestPlotBase._check_colorscCs`t|s||ks\tnBdd|D}t|t|ks.N)rrQrr-r.)r ZtextsrOr"labelerrrr 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.tickerrUrr4xaxisZget_minor_formatterZget_xticklabelsrr/Z get_fontsizeZ get_rotationyaxisZget_yticklabels) r r!Z xlabelsizeZxrotZ ylabelsizeZyrotrUr$r"rSrrr_check_ticks_propss*    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)rrWZ get_scalerrX)r r!rWrXr$rrr_check_ax_scales(s zTestPlotBase._check_ax_scalesc Csddlm}|dkrd}||}|dk rXt||ks:t|D]}t|dks>tq>|dk rz|||}||ksztt|dj t j |t j ddS)a Check expected number of axes is drawn in expected layout Parameters ---------- axes : matplotlib Axes object, or its list-like axes_num : number expected number of axes. Unnecessary axes should be set to invisible. layout : tuple expected layout, (expected number of rows , columns) figsize : tuple expected figsize. default is matplotlib default r flatten_axesN)g@g333333@)Zdtype)!pandas.plotting._matplotlib.toolsr]rr-rZ get_children_get_axes_layoutrZassert_numpy_array_equalfigureZget_size_inchesrJarrayZfloat64) r r!Zaxes_numZlayoutZfigsizer]Z visible_axesr$rNrrr_check_axes_shape9s    zTestPlotBase._check_axes_shapecCsVt}t}|D]4}|}||dd||ddqt|t|fS)Nr)set get_positionZ get_pointsaddr-)r r!Zx_setZy_setr$Zpointsrrrr_]s zTestPlotBase._get_axes_layoutcCs&ddlm}||}dd|D}|S)z Flatten axes, and filter only visible Parameters ---------- axes : matplotlib Axes object, or its list-like rr\cSsg|]}|r|qSr)r5)r&r$rrrr(ssz1TestPlotBase._flatten_visible..)r^r])r r!r]rrrrgs 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_yerrrcN)r containersgetattrr) r r!ZxerrZyerrr$riZ xerr_countZ yerr_countcrgrhrrr_check_has_errorbarsvs     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)rCr!bothNrCrmr!Zmedians)matplotlib.axesr rCrIr4rr$linesrrsortedkeysitemsZ get_titler!) r Zreturned return_typeZ expected_keysZcheck_ax_titler typesrkeyvalueliner!rrr_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) NrcsNjj}jj}tdd|D}tdd|D}|oJ| S)Ncss|]}|j VqdSrZgridliner5r&grrr szHTestPlotBase._check_grid_settings..is_grid_on..css|]}|j VqdSrrzr{rrrr}s)rZgcarWZget_major_ticksrXall)ZxticksZyticksZxoffZyoffrrr is_grid_ons z5TestPlotBase._check_grid_settings..is_grid_onrcr!F)gridkindT)rr)ZpieZhexbinZscatter)r rZsubplotr-rcZplotr)r objkindskwsrrZspndxrrrr_check_grid_settingss2     z!TestPlotBase._check_grid_settingsrMcsfdd|dDS)zT Auxiliary function for correctly unpacking cycler after MPL >= 1.5 csg|] }|qSrrr?fieldrrr(sz/TestPlotBase._unpack_cycler..zaxes.prop_cycler)r ZrcParamsrrrr_unpack_cyclerszTestPlotBase._unpack_cyclercCs"ddlm}|r|jdS|jS)Nr mpl_ge_3_5_0x)"pandas.plotting._matplotlib.compatr _shared_axesZ_shared_x_axesr r$rrrr get_x_axiss  zTestPlotBase.get_x_axiscCs"ddlm}|r|jdS|jS)Nrry)rrrZ_shared_y_axesrrrr get_y_axiss  zTestPlotBase.get_y_axis)NT)NT)T)T)NNN)NNNN)rZrZ)NNN)rr)NT)rM)__name__ __module__ __qualname____doc__rrrrrr%r+r1r8r>rErPr rYr[rbr_rrlryrrrrrrrrr sH      B 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. rNr`T)Zreturn_filelike)rr_gen_default_plot_gen_two_subplotswarningscatch_warnings simplefilterrrgetZgcfZclfZ"assert_is_valid_plot_return_objectZ ensure_cleanZsavefig Exception) ffilterwarningsZ default_axeskwargsrZ gen_plotsretfigpatherrrrr_check_plot_works s$     rcks|f|VdS)z' Create plot in a default way. NrrrrrrrrEsrcksVd|kr|d|f|V|tjjkr8d|ksFtn|d|d<|f|VdS)z9 Create plot on two subplots forcefully created. r$N)Z add_subplotpdZplottingZbootstrap_plotrrrrrrLs   r)rF)r __future__rtypingrrrZnumpyrJZpandas.util._decoratorsrZpandas.util._test_decoratorsutilZ_test_decoratorstdZpandas.core.dtypes.apirZpandasrrZpandas._testingZ_testingrrnr Zskip_if_no_mplr rrrrrrrs(      q :