o ·¶ßdÓJã@s´dZddlmZddlmZmZddlZddlm Z ddl m m Z ddlmZddlZddlmZddlmZerAddlmZe jGd d „d ƒƒZdd d „Zdd„Zdd„ZdS)zF Module consolidating common testing functions for checking plotting. é)Ú annotations)Ú TYPE_CHECKINGÚSequenceN)Úcache_readonly)Ú is_list_like)ÚSeries©ÚAxesc@sôeZdZdZdd„Zdd„Zedd„ƒZedd „ƒZd;d d „Z d;dd„Z dd„Z ddd„Zd d!„Z d?d"d#„Zd@d%d&„Zd>d'd(„Zd)d*„Zd+d,„ZdAd.d/„Z d;d0d1„Zifd2d3„ZdBd5d6„Zd7d8„Zd9d:„Zd S)CÚ TestPlotBasezE This is a common base class used for various plotting tests cCsddl}| ¡dS©Nr)Ú matplotlibZ rcdefaults)ÚselfÚmpl©rúP/app/.heroku/python/lib/python3.10/site-packages/pandas/tests/plotting/common.pyÚ setup_method!s zTestPlotBase.setup_methodcCs t ¡dS©N)ÚtmÚclose©r rrrÚteardown_method&s zTestPlotBase.teardown_methodcCsddlm}|Sr )Úmatplotlib.pyplotÚpyplot)r Úpltrrrr)s zTestPlotBase.pltcCsddlm}|jS)Nr)Úcolors)r rZcolorConverter)r rrrrÚcolorconverter/s zTestPlotBase.colorconverterNTcCsf|r |dur tdƒ‚| |¡}|D]}|r(| ¡dusJ‚| | ¡ ¡|¡q| ¡dus0J‚qdS)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_legendÚ_check_text_labelsZ get_texts)r ÚaxesÚlabelsÚvisibleÚaxrrrÚ_check_legend_labels5s  ûz!TestPlotBase._check_legend_labelscCsV|r |dur tdƒ‚|r!| ¡\}}dd„|Dƒ}||ksJ‚dS| ¡dus)J‚dS)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 TruecSóg|]}| ¡‘qSr)Z get_marker)Ú.0ÚhandlerrrÚ ]óz5TestPlotBase._check_legend_marker..)rZget_legend_handles_labelsr)r r#Zexpected_markersr"ZhandlesÚ_ÚmarkersrrrÚ_check_legend_markerLs  z!TestPlotBase._check_legend_markerc Cs`| ¡}| ¡}t|ƒt|ƒksJ‚t||ƒD]\}}| ¡}| ¡}t ||¡qt ¡dS)z¤ Check each axes has identical lines Parameters ---------- xp : matplotlib Axes object rs : matplotlib Axes object N)Ú get_linesÚlenÚzipZ get_xydatarÚassert_almost_equalr) r ZxpÚrsZxp_linesZrs_linesZxplÚrslZxpdataZrsdatarrrÚ _check_databs  zTestPlotBase._check_datacCsBddlm}t||ƒst|ƒs|g}|D] }| ¡|ksJ‚qdS)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.collectionsr4Ú isinstancerÚ get_visible)r Ú collectionsr"r4ÚpatchrrrÚ_check_visiblevs ÿzTestPlotBase._check_visibler úAxes | Sequence[Axes]ÚfilledÚboolÚreturnÚNonecCs2| |¡}|D]}|jD] }|j|ksJ‚q qdS)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)rZpatchesÚfill)r r r<r#r9rrrÚ_check_patches_all_filled‰s  ÿÿz&TestPlotBase._check_patches_all_filledcs*| ¡}tt||ƒƒ‰‡fdd„|jDƒS)Ncsg|]}ˆ|‘qSrr©r&Úv©Zmappedrrr( r)z3TestPlotBase._get_colors_mapped..)ÚuniqueÚdictr/Úvalues)r ZseriesrrErrDrÚ_get_colors_mapped›szTestPlotBase._get_colors_mappedcCs|ddlm}m}m}ddlm}|j} |durk|dur)| ||¡}|dt|ƒ…}t|ƒt|ƒks3J‚t ||ƒD]2\} } t | |ƒrK|   ¡} |   | ¡} nt | ||fƒr[t |  ¡dƒ} n|  ¡} |   | ¡} | | ksjJ‚q8|durº|dur| ||¡}|dt|ƒ…}t|ƒt|ƒks‹J‚t ||ƒD]+\} } t | |ƒr |  ¡d} n|  ¡} t | tjƒr®t | ƒ} |   | ¡} | | ks¹J‚qdSdS)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)r4ÚLineCollectionÚPolyCollection)ÚLine2DN)r5r4rIrJZmatplotlib.linesrKrrHr.r/r6Ú get_colorZto_rgbaÚtupleZ get_edgecolorZ get_facecolorÚnpZndarray)r r8Z linecolorsZ facecolorsÚmappingr4rIrJrKÚconvr9ÚcolorÚresultÚexpectedrrrÚ _check_colors¢s@         ïzTestPlotBase._check_colorscCsbt|ƒs| ¡|ks J‚dSdd„|Dƒ}t|ƒt|ƒksJ‚t||ƒD] \}}||ks.J‚q$dS)a. Check each text has expected labels Parameters ---------- texts : matplotlib Text object, or its list-like target text, or its list expected : str or list-like which has the same length as texts expected text label, or its list cSr%r)Úget_text)r&Útrrrr(ðr)z3TestPlotBase._check_text_labels..N)rrUr.r/)r ZtextsrSr!ÚlabelÚerrrrâs ÿzTestPlotBase._check_text_labelsc Csddlm}| |¡}|D]z}|dus|durKt|j ¡|ƒr$| ¡}n | ¡|jdd}|D]} |dur>t |   ¡|¡|durJt |   ¡|¡q0|dusS|dur‡t|j  ¡|ƒr`|  ¡}n |  ¡|j dd}|D]} |durzt |   ¡|¡|dur†t |   ¡|¡qlq dS)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.tickerrYrr6ÚxaxisZget_minor_formatterZget_xticklabelsrr0Z get_fontsizeZ get_rotationÚyaxisZget_yticklabels) r r Z xlabelsizeZxrotZ ylabelsizeZyrotrYr#r!rWrrrÚ_check_ticks_propsõs0   € €çzTestPlotBase._check_ticks_propsÚlinearcCs<| |¡}|D]}|j ¡|ksJ‚|j ¡|ksJ‚qdS)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)rr[Z get_scaler\)r r r[r\r#rrrÚ_check_ax_scales%s þzTestPlotBase._check_ax_scalesc Cs ddlm}|dur d}| |¡}|dur,t|ƒ|ksJ‚|D] }t| ¡ƒdks+J‚q|dur=| ||ƒ¡}||ks=J‚t |dj  ¡t j |t j d¡dS)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.toolsrarr.Z get_childrenÚ_get_axes_layoutrZassert_numpy_array_equalÚfigureZget_size_inchesrNÚarrayZfloat64) r r Zaxes_numZlayoutZfigsizeraZ visible_axesr#rRrrrÚ_check_axes_shape6s    þzTestPlotBase._check_axes_shapecCsVtƒ}tƒ}|D]}| ¡ ¡}| |dd¡| |dd¡qt|ƒt|ƒfS)Nré)ÚsetZ get_positionZ get_pointsÚaddr.)r r Zx_setZy_setr#ZpointsrrrrcZs 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)r7)r&r#rrrr(psz1TestPlotBase._flatten_visible..)rbra)r r rarrrrds zTestPlotBase._flatten_visiblerc Csx| |¡}|D]2}|j}d}d}|D]}t|ddƒ} t|ddƒ} | r&|d7}| r,|d7}q||ks3J‚||ks9J‚qdS)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 rÚhas_xerrFÚhas_yerrrgN)rÚ containersÚgetattr) r r ZxerrZyerrr#rlZ xerr_countZ yerr_countÚcrjrkrrrÚ_check_has_errorbarsss   € ôz!TestPlotBase._check_has_errorbarsc Csvddlm}t|tdœ}|dur7|durd}t|||ƒsJ‚|dkr3t|j|ƒs+J‚t|jtƒs5J‚dSdS|durL| |¡D] }t||ƒsIJ‚q@dSt|tƒsSJ‚t |  ¡ƒt |ƒks_J‚|  ¡D]U\}} t| ||ƒspJ‚|dkr|r~|   ¡|ks~J‚qc|dkrŸ|rŽ| j  ¡|ksŽJ‚t| j|ƒs–J‚t| jtƒsžJ‚qc|dkr·| dd} | j } |r¶|   ¡|ks¶J‚qct‚dS) 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)rFr ÚbothNrFrpr Zmedians)Úmatplotlib.axesr rFrMr6r#ÚlinesrrÚsortedÚkeysÚitemsZ get_titler ÚAssertionError) r ÚreturnedÚ return_typeZ expected_keysZcheck_ax_titler ÚtypesÚrÚkeyÚvalueÚliner rrrÚ_check_box_return_typeŽsH  þ€ €ïz#TestPlotBase._check_box_return_typecsŠddl}‡fdd„}d}|D]´}ˆj ddt|ƒ|¡|d7}|jddd|jd d |i|¤Ž|ƒr6J‚ˆj ¡ˆj ddt|ƒ|¡|d7}|jdd d|jd |dd œ|¤Ž|ƒrbJ‚ˆj ¡|d vrˆj ddt|ƒ|¡|d7}|jdd d|jd d |i|¤Ž|ƒs‘J‚ˆj ¡ˆj ddt|ƒ|¡|d7}|jddd|jd |d d œ|¤Ž|ƒs½J‚ˆj ¡qdS)NrcsNˆj ¡j ¡}ˆj ¡j ¡}tdd„|Dƒƒ}tdd„|Dƒƒ}|o%| S)Ncsó|] }|j ¡ VqdSr©Zgridliner7©r&ÚgrrrÚ Òó€zHTestPlotBase._check_grid_settings..is_grid_on..csrrr€rrrrrƒÓr„)rZgcar[Zget_major_ticksr\Úall)ZxticksZyticksZxoffZyoffrrrÚ is_grid_onÏs  z5TestPlotBase._check_grid_settings..is_grid_onrgér F)ÚgridÚkindT)r‰rˆ)ÚpieZhexbinZscatterr)r rZsubplotr.ÚrcZplotÚclf)r ÚobjÚkindsÚkwsrr†Zspndxr‰rrrÚ_check_grid_settingsÊs>         €äz!TestPlotBase._check_grid_settingsrQcs‡fdd„|dDƒS)zT Auxiliary function for correctly unpacking cycler after MPL >= 1.5 csg|]}|ˆ‘qSrrrB©Úfieldrrr(úr)z/TestPlotBase._unpack_cycler..zaxes.prop_cycler)r ZrcParamsr’rr‘rÚ_unpack_cycleröszTestPlotBase._unpack_cyclercCó |jdS)NÚx©Z _shared_axes©r r#rrrÚ get_x_axisüó zTestPlotBase.get_x_axiscCr”)NÚyr–r—rrrÚ get_y_axisÿr™zTestPlotBase.get_y_axis)NT)T)r r;r<r=r>r?)NNN)NNNN)r^r^)rr)rQ)Ú__name__Ú __module__Ú __qualname__Ú__doc__rrrrrr$r,r3r:rArHrTrr]r_rfrcrror~rr“r˜r›rrrrr s>      ÿ ÿ@ ÿ 0 $  ÿ < , r Fc Ks¼ddlm}|r t}nt}d}zH| d| ¡¡}| ¡|||fi|¤ŽD]}t |¡q%tj dd }|  |¡Wdƒn1sCwYWt  |¡|SWt  |¡|St  |¡w)a× Create plot and ensure that plot return object is valid. Parameters ---------- f : func Plotting function. 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. rNrdT)Zreturn_filelike) rrÚ_gen_default_plotÚ_gen_two_subplotsÚgetZgcfrŒrZ"assert_is_valid_plot_return_objectZ ensure_cleanZsavefigr)ÚfZ default_axesÚkwargsrZ gen_plotsÚretÚfigÚpathrrrÚ_check_plot_workss&   ÿ ú  þr¨cks|di|¤ŽVdS)z' Create plot in a default way. Nrr©r£r¦r¤rrrr 6s€r cks`d|vr | d¡|di|¤ŽV|tjjurd|vsJ‚n| d¡|d<|di|¤ŽVdS)z9 Create plot on two subplots forcefully created. r#éÓéÔNr)Z add_subplotÚpdZplottingZbootstrap_plotr©rrrr¡=s€  r¡)F)rŸÚ __future__rÚtypingrrÚnumpyrNZpandas.util._decoratorsrZpandas.util._test_decoratorsÚutilZ_test_decoratorsÚtdZpandas.core.dtypes.apirZpandasr¬rZpandas._testingZ_testingrrqr Zskip_if_no_mplr r¨r r¡rrrrÚs(       j3