o
    :av                     @   sb  d Z ddlmZ ddlmZ ddlZddlmZm	Z	 ddl
mZ ddlmZ ddlmZ dd	 ZG d
d dZG dd deZG dd deZG dd deZG dd deZG dd deZG dd deZG dd deZG dd deZG dd deZG dd deZG d d! d!eZG d"d# d#eZG d$d% d%eZG d&d' d'eZ G d(d) d)eZ!dS )*a  
Default legend handlers.

.. important::

    This is a low-level legend API, which most end users do not need.

    We recommend that you are familiar with the :doc:`legend guide
    </tutorials/intermediate/legend_guide>` before reading this documentation.

Legend handlers are expected to be a callable object with a following
signature. ::

    legend_handler(legend, orig_handle, fontsize, handlebox)

Where *legend* is the legend itself, *orig_handle* is the original
plot, *fontsize* is the fontsize in pixels, and *handlebox* is a
OffsetBox instance. Within the call, you should create relevant
artists (using relevant properties from the *legend* and/or
*orig_handle*) and add them into the handlebox. The artists needs to
be scaled according to the fontsize (note that the size is in pixel,
i.e., this is dpi-scaled value).

This module includes definition of several legend handler classes
derived from the base class (HandlerBase) with the following method::

    def legend_artist(self, legend, orig_handle, fontsize, handlebox)
    )Sequence)cycleN)_apicbookLine2D)	Rectanglec                 C   s,   t t| d }|d ur| | d S d S N)nextiterZget_childrenupdate_from)ZtgtsrcZfirst_child r   ;/usr/lib/python3/dist-packages/matplotlib/legend_handler.pyupdate_from_first_child)   s   r   c                   @   sJ   e Zd ZdZdddZdd Zdd	 Zd
d Zdd Zdd Z	dd Z
dS )HandlerBasea   
    A Base class for default legend handlers.

    The derived classes are meant to override *create_artists* method, which
    has a following signature.::

      def create_artists(self, legend, orig_handle,
                         xdescent, ydescent, width, height, fontsize,
                         trans):

    The overridden method needs to create artists of the given
    transform that fits in the given dimension (xdescent, ydescent,
    width, height) that are scaled by fontsize if necessary.

            Nc                 C   s   ||| _ | _|| _d S r	   )_xpad_ypad_update_prop_func)selfZxpadZypadZupdate_funcr   r   r   __init__?   s   
zHandlerBase.__init__c                 C   s*   | j d u r| || d S |  || d S r	   )r   _default_update_propr   legend_handleorig_handler   r   r   _update_propC   s   
zHandlerBase._update_propc                 C   s   | | d S r	   )r   r   r   r   r   r   I   s   z HandlerBase._default_update_propc                 C   s.   |  || || |d  |d  d S r	   )r   Z_set_artist_propsset_clip_boxset_clip_pathr   r   r   legendr   r   r   update_propL   s   

zHandlerBase.update_propc                 C   sD   || j |  }|| j|  }|| j |  }|| j|  }||||fS r	   )r   r   )r   r    r   xdescentydescentwidthheightfontsizer   r   r   adjust_drawing_areaT   s
   zHandlerBase.adjust_drawing_areac                 C   sr   |  |||j|j|j|j|\}}}}| |||||||| }	t|	tr+|	d g}	|	D ]}
|	|
 q-|	d S )a-  
        Return the artist that this HandlerBase generates for the given
        original artist/handle.

        Parameters
        ----------
        legend : `~matplotlib.legend.Legend`
            The legend for which these legend artists are being created.
        orig_handle : :class:`matplotlib.artist.Artist` or similar
            The object for which these legend artists are being created.
        fontsize : int
            The fontsize in pixels. The artists being created should
            be scaled according to the given fontsize.
        handlebox : `matplotlib.offsetbox.OffsetBox`
            The box which has been created to hold this legend entry's
            artists. Artists created in the `legend_artist` method must
            be added to this handlebox inside this method.

        r   )
r'   r"   r#   r$   r%   create_artistsZget_transform
isinstance_Line2DHandleListZ
add_artist)r   r    r   r&   Z	handleboxr"   r#   r$   r%   artistsar   r   r   legend_artist]   s   

zHandlerBase.legend_artistc	           	      C   s   t d)NzDerived must override)NotImplementedError)	r   r    r   r"   r#   r$   r%   r&   transr   r   r   r(      s   zHandlerBase.create_artists)r   r   N)__name__
__module____qualname____doc__r   r   r   r!   r'   r-   r(   r   r   r   r   r   /   s    
	(r   c                       s2   e Zd ZdZd
 fdd	Zdd Zdd	 Z  ZS )HandlerNpointszM
    A legend handler that shows *numpoints* points in the legend entry.
    333333?Nc                    s"   t  jdi | || _|| _dS )a  
        Parameters
        ----------
        marker_pad : float
            Padding between points in legend entry.
        numpoints : int
            Number of points to show in legend entry.
        **kwargs
            Keyword arguments forwarded to `.HandlerBase`.
        Nr   )superr   
_numpoints_marker_padr   
marker_pad	numpointskwargs	__class__r   r   r      s   
zHandlerNpoints.__init__c                 C      | j d u r|jS | j S r	   )r7   r;   r   r    r   r   r   get_numpoints      
zHandlerNpoints.get_numpointsc                 C   sn   |  |}|dkr#| j| }t| | | | | |}	|	}
|	|
fS | | | g}	| d|  g}
|	|
fS )N         ?)rA   r8   nplinspace)r   r    r"   r#   r$   r%   r&   r;   padxdataxdata_markerr   r   r   	get_xdata   s   

zHandlerNpoints.get_xdatar5   N)r0   r1   r2   r3   r   rA   rJ   __classcell__r   r   r=   r   r4      s
    r4   c                       s*   e Zd ZdZd fdd	Zdd Z  ZS )HandlerNpointsYoffsetsz
    A legend handler that shows *numpoints* in the legend, and allows them to
    be individually offset in the y-direction.
    Nc                    s    t  jdd|i| || _dS )aL  
        Parameters
        ----------
        numpoints : int
            Number of points to show in legend entry.
        yoffsets : array of floats
            Length *numpoints* list of y offsets for each point in
            legend entry.
        **kwargs
            Keyword arguments forwarded to `.HandlerNpoints`.
        r;   Nr   )r6   r   	_yoffsets)r   r;   yoffsetsr<   r=   r   r   r      s   
zHandlerNpointsYoffsets.__init__c                 C   s,   | j d u r||j }|S |t| j  }|S r	   rN   Z_scatteryoffsetsrE   asarrayr   r    r"   r#   r$   r%   r&   ydatar   r   r   	get_ydata   s
   

z HandlerNpointsYoffsets.get_ydataNN)r0   r1   r2   r3   r   rT   rL   r   r   r=   r   rM      s    rM   c                       *   e Zd ZdZd fdd	Zdd Z  ZS )	HandlerLine2DCompoundz
    Original handler for `.Line2D` instances, that relies on combining
    a line-only with a marker-only artist.  May be deprecated in the future.
    r5   Nc                    s   t  jd||d| dS )  
        Parameters
        ----------
        marker_pad : float
            Padding between points in legend entry.
        numpoints : int
            Number of points to show in legend entry.
        **kwargs
            Keyword arguments forwarded to `.HandlerNpoints`.
        r:   r;   Nr   )r6   r   r9   r=   r   r   r      s   zHandlerLine2DCompound.__init__c	                 C   s   |  ||||||\}	}
t|	|| d }t|	|}| ||| |d |d t|
|d t|
 }| ||| |d |j	dkrT|
 |j	 }|| ||_|| || ||gS )N   default NonerC   )rJ   rE   	full_liker   r!   set_drawstyle
set_markerlenset_linestylemarkerscaleget_markersizeset_markersizeZ
_legmarkerset_transform)r   r    r   r"   r#   r$   r%   r&   r/   rH   rI   rS   leglinelegline_markernewszr   r   r   r(      s$   








z$HandlerLine2DCompound.create_artistsrK   r0   r1   r2   r3   r   r(   rL   r   r   r=   r   rW      s    rW   c                   @   s$   e Zd Zdd Zdd Zdd ZdS )r*   c                 C   s
   || _ d S r	   )_legline)r   rg   r   r   r   r     s   
z_Line2DHandleList.__init__c                 C   s   dS NrZ   r   )r   r   r   r   __len__	  s   z_Line2DHandleList.__len__c                 C   s&   |dkrt jddd | j| jg| S )Nr   z3.5zuAccess to the second element returned by HandlerLine2D is deprecated since %(since)s; it will be removed %(removal)s.)message)r   Zwarn_deprecatedrk   )r   indexr   r   r   __getitem__  s
   z_Line2DHandleList.__getitem__N)r0   r1   r2   r   rm   rp   r   r   r   r   r*     s    r*   c                   @   s"   e Zd ZdZdddZdd ZdS )	HandlerLine2Dz
    Handler for `.Line2D` instances.

    See Also
    --------
    HandlerLine2DCompound : An earlier handler implementation, which used one
                            artist for the line and another for the marker(s).
    r5   Nc                 K   s   t j| f||d| dS )rX   rY   N)r4   r   )r   r:   r;   kwr   r   r   r   !  s
   

zHandlerLine2D.__init__c	                 C   s   |  ||||||\}	}
d }| |dkr#t|	d |	d d}	dg}t|	|| d }t|	||d}| ||| |jdkrL| |j }|	| |
| t|S )NrC   r      rZ   )	markevery)rJ   rA   rE   rF   r^   r   r!   rc   rd   re   rf   r*   )r   r    r   r"   r#   r$   r%   r&   r/   rH   rI   ru   rS   rg   ri   r   r   r   r(   /  s   



zHandlerLine2D.create_artistsrK   )r0   r1   r2   r3   r   r(   r   r   r   r   rq     s    
	rq   c                       s2   e Zd ZdZd	 fdd	Zdd Zdd Z  ZS )
HandlerPatchz)
    Handler for `.Patch` instances.
    Nc                    s   t  jdi | || _dS )a  
        Parameters
        ----------
        patch_func : callable, optional
            The function that creates the legend key artist.
            *patch_func* should have the signature::

                def patch_func(legend=legend, orig_handle=orig_handle,
                               xdescent=xdescent, ydescent=ydescent,
                               width=width, height=height, fontsize=fontsize)

            Subsequently the created artist will have its ``update_prop``
            method called and the appropriate transform will be applied.

        **kwargs
            Keyword arguments forwarded to `.HandlerBase`.
        Nr   )r6   r   _patch_func)r   Z
patch_funcr<   r=   r   r   r   Q  s   
zHandlerPatch.__init__c           	   	   C   s@   | j d u rt| | f||d}|S | j |||||||d}|S )Nxyr$   r%   )r    r   r"   r#   r$   r%   r&   )rw   r   	r   r    r   r"   r#   r$   r%   r&   pr   r   r   _create_patchf  s   
zHandlerPatch._create_patchc	           
   	   C   s4   |  |||||||}	| |	|| |	| |	gS r	   )r|   r!   rf   
r   r    r   r"   r#   r$   r%   r&   r/   r{   r   r   r   r(   q  s   

zHandlerPatch.create_artistsr	   )r0   r1   r2   r3   r   r|   r(   rL   r   r   r=   r   rv   L  s
    rv   c                   @   (   e Zd ZdZdd Zdd Zdd ZdS )	HandlerStepPatchzA
    Handler for `~.matplotlib.patches.StepPatch` instances.
    c           	      C   s    t | | f| ||d}|S )N)ry   colorr$   r%   )r   get_facecolorrz   r   r   r   r|     s
   zHandlerStepPatch._create_patchc           	      C   sF   t d|g|d |d g| | | d}|d |d |S )Nr   rZ   )r   Z	linestyleZ	linewidthr[   r\   )r   get_edgecolorget_linestyleZget_linewidthr_   r`   )	r   r    r   r"   r#   r$   r%   r&   rg   r   r   r   _create_line  s   

zHandlerStepPatch._create_linec	           
   	   C   s`   |  s
| d ur| |||||||}	| |	|| n| |||||||}	|	| |	gS r	   )get_fill	get_hatchr|   r!   r   rf   r}   r   r   r   r(     s   


zHandlerStepPatch.create_artistsN)r0   r1   r2   r3   r|   r   r(   r   r   r   r   r   z  s
    r   c                   @   r~   )	HandlerLineCollectionz2
    Handler for `.LineCollection` instances.
    c                 C   r?   r	   r7   Zscatterpointsr@   r   r   r   rA     rB   z#HandlerLineCollection.get_numpointsc                 C   sD   |  d }|jd }| d }|| || || d S Nr   )get_linewidthsZ_us_linestylesZ
get_colors	set_colorrb   set_linewidth)r   r   r   ZlwZdashesr   r   r   r   r     s   


z*HandlerLineCollection._default_update_propc	                 C   sT   |  ||||||\}	}
t|	|| d }t|	|}| ||| || |gS rl   )rJ   rE   r^   r   r!   rf   )r   r    r   r"   r#   r$   r%   r&   r/   rH   rI   rS   rg   r   r   r   r(     s   


z$HandlerLineCollection.create_artistsN)r0   r1   r2   r3   rA   r   r(   r   r   r   r   r     s
    r   c                       sJ   e Zd ZdZd fdd	Zdd Zdd Zd	d
 Zdd Zdd Z	  Z
S )HandlerRegularPolyCollectionz'Handler for `.RegularPolyCollection`\s.Nc                    s    t  jdd|i| || _d S )NrO   r   )r6   r   _sizes)r   rO   sizesr<   r=   r   r   r     s   
z%HandlerRegularPolyCollection.__init__c                 C   r?   r	   r   r@   r   r   r   rA     rB   z*HandlerRegularPolyCollection.get_numpointsc                 C   s   | j d u rK| }t|sdg}t||jd  }	t||jd  }
| |}|dk r:d|	|
  |	|
gd | }|S |	|
 }|tdd| |
 }|S | j }|S )NrC   rZ      rD   r   )	r   	get_sizesra   maxrc   minrA   rE   rF   )r   r    r   r"   r#   r$   r%   r&   Zhandle_sizesZsize_maxZsize_minr;   r   rngr   r   r   r     s&   

z&HandlerRegularPolyCollection.get_sizesc                 C   s0   |  || ||j |d  |d  d S r	   )r   
set_figureZfigurer   r   r   r   r   r   r!     s   
z(HandlerRegularPolyCollection.update_propc                 C   s"   t || | |||d}|S )N)Zrotationr   offsetstransOffset)typeZget_numsidesZget_rotationr   r   r   r   r   r{   r   r   r   create_collection  s   z.HandlerRegularPolyCollection.create_collectionc	              	   C   sx   |  ||||||\}	}
| ||||||}| |||||||}| j||tt|
||d}| ||| ||_|gS N)r   r   )rJ   rT   r   r   listzipr!   Z_transOffset)r   r    r   r"   r#   r$   r%   r&   r/   rH   rI   rS   r   r{   r   r   r   r(     s    

z+HandlerRegularPolyCollection.create_artistsrU   )r0   r1   r2   r3   r   rA   r   r!   r   r(   rL   r   r   r=   r   r     s    		r   c                   @      e Zd ZdZdd ZdS )HandlerPathCollectionzDHandler for `.PathCollection`\s, which are used by `~.Axes.scatter`.c                 C   s"   t || d g|||d}|S )Nr   )r   r   r   )r   Z	get_pathsr   r   r   r   r     s   z'HandlerPathCollection.create_collectionNr0   r1   r2   r3   r   r   r   r   r   r         r   c                   @   r   )HandlerCircleCollectionz"Handler for `.CircleCollection`\s.c                 C   s   t ||||d}|S r   )r   r   r   r   r   r     s
   z)HandlerCircleCollection.create_collectionNr   r   r   r   r   r     r   r   c                       s6   e Zd ZdZ		d fdd	Zdd Zd	d
 Z  ZS )HandlerErrorbarzHandler for Errorbars.rD   Nr5   c                    s(   || _ || _t jd||d| d S )NrY   r   )
_xerr_size
_yerr_sizer6   r   )r   	xerr_size	yerr_sizer:   r;   r<   r=   r   r   r   $  s   zHandlerErrorbar.__init__c           	      C   s2   | j | }| jd u r|}||fS | j| }||fS r	   )r   r   )	r   r    r"   r#   r$   r%   r&   r   r   r   r   r   get_err_size,  s   


zHandlerErrorbar.get_err_sizec	                    s  |\}	}
}|  ||||||\}}t||| d }t||}t|}t|d t| }| ||||||\ t||}|	d u rP|d |d n.| ||	| |	d |
d | ||	| |d |jdkr~| |j }|| g }g }|jrڇ fddt||D }t|}| ||d | || |
rt|  |}t|  |}| ||
d | | ||
d | |
d	 |
d	 || || |jr4fd
dt||D }t|}| ||d | || |
r4t|| }t|| }| ||
d | | ||
d | |
d |
d || || g ||||}|D ]}|| q@|S )NrZ   Fr[   r]   rC   c                    s(   g | ]\}}|  |f|  |ffqS r   r   .0xy)r   r   r   
<listcomp>a      z2HandlerErrorbar.create_artists.<locals>.<listcomp>r   |c                    s(   g | ]\}}||  f||  ffqS r   r   r   )r   r   r   r   s  r   _)rJ   rE   r^   r   rQ   ra   r   Zset_visibler!   r_   r`   rb   rc   rd   re   Zhas_xerrr   mcollLineCollectionappendZhas_yerrrf   )r   r    r   r"   r#   r$   r%   r&   r/   Z	plotlinesZcaplinesZbarlinecolsrH   rI   rS   rg   Zydata_markerrh   ri   Zhandle_barlinecolsZhandle_caplinesZvertsZcollZcapline_leftZcapline_rightr+   artistr   )r   r   r   r(   7  s   

























zHandlerErrorbar.create_artists)rD   Nr5   N)r0   r1   r2   r3   r   r   r(   rL   r   r   r=   r   r   !  s    r   c                       s>   e Zd ZdZ		d fdd	Zdd Zdd	 Zd
d Z  ZS )HandlerStemz6
    Handler for plots produced by `~.Axes.stem`.
    r5   Nc                    s$   t  jd|||d| || _dS )a  
        Parameters
        ----------
        marker_pad : float, default: 0.3
            Padding between points in legend entry.
        numpoints : int, optional
            Number of points to show in legend entry.
        bottom : float, optional

        yoffsets : array of floats, optional
            Length *numpoints* list of y offsets for each point in
            legend entry.
        **kwargs
            Keyword arguments forwarded to `.HandlerNpointsYoffsets`.
        )r:   r;   rO   Nr   )r6   r   _bottom)r   r:   r;   bottomrO   r<   r=   r   r   r     s   
zHandlerStem.__init__c                 C   s4   | j d u r|d|j d  }|S |t| j  }|S )NrD   rP   rR   r   r   r   rT     s
   
zHandlerStem.get_ydatac	                    sX  |\}	}
}t |
tj}| ||||||\}}| ||||||}| jd u r)d n| j t||d t| }| ||	|  fddt	||D }|rqt
j| | jd |D ]	}| ||
| qWW d    n1 skw   Y  nt	||
D ]\}}| ||| qvtt|t|g  g}| ||| g |||}|D ]}|| q|S )Nr   c                    s"   g | ]\}}t ||g |gqS r   r   r   r   r   r   r     s    z.HandlerStem.create_artists.<locals>.<listcomp>)r   )r)   r   r   rJ   rT   r   r   ra   r!   r   r   Z_setattr_cm_copy_collection_propsrE   r   r   rf   )r   r    r   r"   r#   r$   r%   r&   r/   Z
markerlineZ	stemlinesZbaselineZusing_linecollrH   rI   rS   Zleg_markerlineZleg_stemlineslineZlmmZleg_baseliner+   r   r   r   r   r(     sF   




zHandlerStem.create_artistsc                 C   s(   | | d  || d  dS )zt
        Copy properties from the `.LineCollection` *orig_handle* to the
        `.Line2D` *legend_handle*.
        r   N)r   Z	get_colorrb   r   r   r   r   r   r     s   z"HandlerStem._copy_collection_props)r5   NNN)	r0   r1   r2   r3   r   rT   r(   r   rL   r   r   r=   r   r     s    /r   c                       rV   )	HandlerTuplez
    Handler for Tuple.
    rC   Nc                    s"   || _ || _t jdi | dS )a  
        Parameters
        ----------
        ndivide : int, default: 1
            The number of sections to divide the legend area into.  If None,
            use the length of the input tuple.
        pad : float, default: :rc:`legend.borderpad`
            Padding in units of fraction of font size.
        **kwargs
            Keyword arguments forwarded to `.HandlerBase`.
        Nr   )_ndivide_padr6   r   )r   ndividerG   r<   r=   r   r   r     s   zHandlerTuple.__init__c	                 C   s   |  }	| jd u rt|}
n| j}
| jd u r|j| }n| j| }|
dkr/|||
d   |
 }t||| t|
  }g }|D ]%}||	|}|	||t
||||||}t|tr`|d g}|| q@|S )NrC   r   )Zget_legend_handler_mapr   ra   r   Z	borderpadr   rE   ZarangeZget_legend_handlerr(   r
   r)   r*   extend)r   r    r   r"   r#   r$   r%   r&   r/   Zhandler_mapr   rG   Z	xds_cyclea_listZhandle1ZhandlerZ_a_listr   r   r   r(     s*   





zHandlerTuple.create_artists)rC   Nrj   r   r   r=   r   r     s    r   c                   @   s    e Zd ZdZdd Zdd ZdS )HandlerPolyCollectionza
    Handler for `.PolyCollection` used in `~.Axes.fill_between` and
    `~.Axes.stackplot`.
    c                 C   s   dd }dd }||  |_|| |_| |_| |_|j|_|	||
  |||  |||  ||  d S )Nc                 S   s   | j dkrdS t| d S )Nr   )r   r   r   r   )sizetuple)Zcolorsr   r   r   first_color#  s   
z7HandlerPolyCollection._update_prop.<locals>.first_colorc                 S   s   t | r| d S d S r   )ra   )Z
prop_arrayr   r   r   	get_first(  s   z5HandlerPolyCollection._update_prop.<locals>.get_first)r   Z
_facecolorr   Z
_edgecolorr   Z_fillr   Z_hatchZ_hatch_colorr   r   rb   Zget_linestylesrf   Zget_transformsr   Z
get_figure)r   r   r   r   r   r   r   r   r   "  s   

z"HandlerPolyCollection._update_propc	           
      C   s4   t | | f||d}	| |	|| |	| |	gS )Nrx   )r   r!   rf   r}   r   r   r   r(   =  s   
z$HandlerPolyCollection.create_artistsN)r0   r1   r2   r3   r   r(   r   r   r   r   r     s    r   )"r3   Zcollections.abcr   	itertoolsr   ZnumpyrE   Z
matplotlibr   r   Zmatplotlib.linesr   Zmatplotlib.patchesr   Zmatplotlib.collectionscollectionsr   r   r   r4   rM   rW   r*   rq   rv   r   r   r   r   r   r   r   r   r   r   r   r   r   <module>   s2    \*25.( J
kZ7