U
|
ý°d M ã @ s´ d Z ddlmZ ddlmZmZ ddlZddlm Z ddl
|
m m Z ddlmZ ddlZddlmZ ddlmZ erddlmZ e jG d d
|
d
|
Zdd d Zdd Zdd Z dS )zF
|
Module consolidating common testing functions for checking plotting.
|
é )Ú annotations)Ú TYPE_CHECKINGÚSequenceN)Úcache_readonly)Ú is_list_like)ÚSeries©ÚAxesc @ sô e Zd ZdZdd Zdd Zedd Zedd Zd9d d Z d:ddZ
|
dd Z d;ddZ d<ddddddZ dd Zd=d d Zd d Zd>d d!Zd?d#d$Zd@d%d&Zd'd( Zd)d* ZdAd,d-ZdBd.d/Zi fd0d1ZdCd3d4Zd5d6 Zd7d8 Zd
|
S )DÚ TestPlotBasezE
|
This is a common base class used for various plotting tests
|
c C s dd l }| ¡ d S ©Nr )Ú
|
matplotlibZ
|
rcdefaults)ÚselfÚmpl© r úSd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\pandas/tests/plotting/common.pyÚ setup_method! s zTestPlotBase.setup_methodc C s t ¡ d S ©N)ÚtmÚclose©r r r r Úteardown_method& s z TestPlotBase.teardown_methodc C s dd l m} |S r )Úmatplotlib.pyplotÚpyplot)r Úpltr r r r ) s zTestPlotBase.pltc C s ddl m} |jS )Nr )Úcolors)r r ZcolorConverter)r r r r r Úcolorconverter/ s zTestPlotBase.colorconverterNTc C sf |r|dkrt d| |¡}|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_legendÚAssertionErrorÚ_check_text_labelsZ get_texts)r ÚaxesÚlabelsÚvisibleÚaxr r r Ú_check_legend_labels5 s
|
z!TestPlotBase._check_legend_labelsc C sT |r|dkrt d|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 Truec S s g | ] }| ¡ qS r )Z
|
get_marker)Ú.0Úhandler r r Ú
|
<listcomp>] s z5TestPlotBase._check_legend_marker.<locals>.<listcomp>)r Zget_legend_handles_labelsr r )r r$ Zexpected_markersr# ZhandlesÚ_Úmarkersr r r Ú_check_legend_markerL s z!TestPlotBase._check_legend_markerc C s` | ¡ }| ¡ }t|t|ks$tt||D ]$\}}| ¡ }| ¡ }t ||¡ q.t ¡ dS )z¤
|
Check each axes has identical lines
|
|
Parameters
|
----------
|
xp : matplotlib Axes object
|
rs : matplotlib Axes object
|
N)Ú get_linesÚlenr ÚzipZ
|
get_xydatar Úassert_almost_equalr ) r ZxpÚrsZxp_linesZrs_linesZxplZrslZxpdataZrsdatar r r Ú _check_datab s zTestPlotBase._check_datac C sB ddl m} 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# r2 Úpatchr r r Ú_check_visiblev s
|
zTestPlotBase._check_visiblezAxes | Sequence[Axes]ÚboolÚNone)r! ÚfilledÚreturnc C s2 | |¡}|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 ZpatchesÚfillr )r r! r; r$ r7 r r r Ú_check_patches_all_filled s
|
|
z&TestPlotBase._check_patches_all_filledc s* | ¡ }tt|| fdd|jD S )Nc s g | ] } | qS r r ©r& Úv©Zmappedr r r( s z3TestPlotBase._get_colors_mapped.<locals>.<listcomp>)ÚuniqueÚdictr. Úvalues)r Zseriesr rB r rA r Ú_get_colors_mapped s z TestPlotBase._get_colors_mappedc C s ddl m}m}m} ddlm} | j} |dk rÖ|dk rR| ||¡}|dt|
}t|t|ksft t
|
||D ]d\}
|
} t |
|
|r|
|
¡ } | | ¡} n(t |
|
||fr¶t|
|
¡ d } n|
|
¡ } | | ¡} | | kspt qp|dk r|dk r| ||¡}|dt|
}t|t|ks t 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 )r2 ÚLineCollectionÚPolyCollection)ÚLine2DN)r3 r2 rF rG Zmatplotlib.linesrH r rE r- r r. r4 Z get_colorZto_rgbaÚtupleZ get_edgecolorZ get_facecolorÚnpZndarray)r r6 Z
|
linecolorsZ
|
facecolorsÚmappingr2 rF rG rH Úconvr7 ÚcolorÚresultÚexpectedr r r Ú _check_colors¢ s<
|
|
|
|
|
zTestPlotBase._check_colorsc C s` t |s| ¡ |ks\tnBdd |D }t|t|ks<tt||D ]\}}||ksFtqFdS )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
|
c S s g | ] }| ¡ qS r )Úget_text)r& Útr r r r( ð s z3TestPlotBase._check_text_labels.<locals>.<listcomp>N)r rQ r r- r. )r ZtextsrO r" ÚlabelÚer r r r â s z TestPlotBase._check_text_labelsc
|
C s ddl m} | |¡}|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 rôt | ¡ |¡ |dk rØt |
|
¡ |¡ qØqdS )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.tickerrU r r4 ÚxaxisZget_minor_formatterZget_xticklabelsr r/ Z get_fontsizeZ get_rotationÚyaxisZget_yticklabels)
|
r r! Z
|
xlabelsizeZxrotZ
|
ylabelsizeZyrotrU r$ r" rS r r r Ú_check_ticks_propsõ s*
|
|
|
z TestPlotBase._check_ticks_propsÚlinearc C s< | |¡}|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 rW Z get_scaler rX )r r! rW rX r$ r r r Ú_check_ax_scales% s
|
z TestPlotBase._check_ax_scalesc C s ddl m} |dkrd}| |¡}|dk rXt||ks:t|D ]}t| ¡ dks>tq>|dk rz| ||¡}||ksztt |d j
|
¡ 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.toolsr] r r- r Z get_childrenÚ_get_axes_layoutr Zassert_numpy_array_equalÚfigureZget_size_inchesrJ ÚarrayÚfloat64) r r! Zaxes_numZlayoutZfigsizer] Z visible_axesr$ rN r r r Ú_check_axes_shape6 s
|
þz TestPlotBase._check_axes_shapec C sV t }t }|D ]4}| ¡ ¡ }| |d d ¡ | |d d ¡ qt|t|fS )Nr é )ÚsetÚ get_positionZ
|
get_pointsÚaddr- )r r! Zx_setZy_setr$ Zpointsr r r r_ Z s z TestPlotBase._get_axes_layoutc C s& ddl m} ||}dd |D }|S )z
|
Flatten axes, and filter only visible
|
|
Parameters
|
----------
|
axes : matplotlib Axes object, or its list-like
|
|
r r\ c S s g | ]}| ¡ r|qS r )r5 )r& r$ r r r r( p s z1TestPlotBase._flatten_visible.<locals>.<listcomp>)r^ r] )r r! r] r r r r d s z TestPlotBase._flatten_visibler c C sx | |¡}|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
|
r Úhas_xerrFÚhas_yerrrd N)r Ú
|
containersÚgetattrr ) r r! ZxerrZyerrr$ rj Z
|
xerr_countZ
|
yerr_countÚcrh ri r r r Ú_check_has_errorbarss s
|
|
z!TestPlotBase._check_has_errorbarsc C s ddl m} t|td}|dkrj|dkr,d}t||| s>t|dkrft|j|sVtt|jtsftn|dkr| |¡D ]}t||s|tq|dS t|t s¢tt
|
| ¡ t
|
|ksºt| ¡ D ]¼\}} t| || sÜt|dkrú|rø| ¡ |ksøtqÂ|dkrD|r | j ¡ |ks tt| j|s0tt| jts~tqÂ|dkrz| d d }
|
|
|
j} |r~| ¡ |ks~tqÂtqÂ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.
|
r r )rC r! ÚbothNrC rn r! Zmedians)Úmatplotlib.axesr rC rI r4 r r$ Úlinesr r ÚsortedÚkeysÚitemsZ get_titler! ) r ZreturnedÚ return_typeZ expected_keysZcheck_ax_titler ÚtypesÚrÚkeyÚvalueÚliner! r r r Ú_check_box_return_type s>
|
|
z#TestPlotBase._check_box_return_typec s dd l } fdd}d}|D ]l} j ddt| |¡ |d7 }|jddd |jf d |i| | rnt j ¡ j ddt| |¡ |d7 }|jdd
|
d |jf |dd | | rÆt j ¡ |d kr j ddt| |¡ |d7 }|jdd
|
d |jf d |i| | s&t j ¡ j ddt| |¡ |d7 }|jddd |jf |d
|
d | | st j ¡ q d S ) Nr c sN j ¡ j ¡ } j ¡ j ¡ }tdd | D }tdd |D }|oJ| S )Nc s s | ]}|j ¡ V qd S r ©Zgridliner5 ©r& Úgr r r Ú <genexpr>Ò s zHTestPlotBase._check_grid_settings.<locals>.is_grid_on.<locals>.<genexpr>c s s | ]}|j ¡ V qd S r r{ r| r r r r~ Ó s )r ZgcarW Zget_major_ticksrX Úall)ZxticksZyticksZxoffZyoffr r r Ú
|
is_grid_onÏ s
|
z5TestPlotBase._check_grid_settings.<locals>.is_grid_onrd é r! F)ÚgridÚkindT)r r )ZpieZhexbinZscatter)r r Zsubplotr- ÚrcZplotr Úclf)r ÚobjÚkindsÚkwsr r Zspndxr r r r Ú_check_grid_settingsÊ s:
|
|
|
|
|
|
z!TestPlotBase._check_grid_settingsrM c s fdd|d D S )zT
|
Auxiliary function for correctly unpacking cycler after MPL >= 1.5
|
c s g | ] }| qS r r r? ©Úfieldr r r( ú s z/TestPlotBase._unpack_cycler.<locals>.<listcomp>zaxes.prop_cycler )r ZrcParamsr r r r Ú_unpack_cyclerö s zTestPlotBase._unpack_cyclerc C s
|
|j d S )NÚx©Z _shared_axes©r r$ r r r Ú
|
get_x_axisü s zTestPlotBase.get_x_axisc C s
|
|j d S )NÚyr r r r r Ú
|
get_y_axisÿ s zTestPlotBase.get_y_axis)NT)NT)T)T)NNN)NNNN)rZ rZ )NNN)r r )NT)rM ) Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__r r r r r r% r+ r1 r8 r> rE rP r rY r[ rc r_ r rm rz r r r r r r r r r
|
sH
|
|
|
|
|
ÿ ÿ
|
@ ÿ
|
0
|
|
$
|
|
ÿ
|
< ,
|
r
|
Fc K s ddl m} |rt}nt}d}z\| d| ¡ ¡}| ¡ || |f|D ]}t |¡ qFtj
|
dd}| |¡ W 5 Q R X W 5 t |¡ X |S )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.
|
r Nr` T)Zreturn_filelike) r r Ú_gen_default_plotÚ_gen_two_subplotsr r ÚgetZgcfr
Z"assert_is_valid_plot_return_objectZ ensure_cleanZsavefig)ÚfZ default_axesÚkwargsr Z gen_plotsÚretÚfigÚpathr r r Ú_check_plot_works s r c k s | f |V dS )z'
|
Create plot in a default way.
|
Nr ©r r r r r r r 6 s r c k sV d|kr| d¡ | f |V | tjjkr8d|ksFtn| d¡|d< | f |V dS )z9
|
Create plot on two subplots forcefully created.
|
r$ éÓ éÔ N)Z add_subplotÚpdZplottingZbootstrap_plotr r r r r r = s
|
r )F) r Ú
|
__future__r Útypingr r ÚnumpyrJ Zpandas.util._decoratorsr Z pandas.util._test_decoratorsÚutilZ_test_decoratorsÚtdZpandas.core.dtypes.apir Zpandasr£ r Zpandas._testingZ_testingr ro r Zskip_if_no_mplr
|
r r r r r r r Ú<module> s& j
|
3
|
