U
    7cks                     @   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 k	r$| | d S N)nextiterZget_childrenupdate_from)ZtgtsrcZfirst_child r   =/tmp/pip-unpacked-wheel-bcsgmve3/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 kr| || n|  || 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rV|	d g}	|	D ]}
|	|
 qZ|	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d S )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f | || _|| _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`.
        N)superr   
_numpoints_marker_pad)r   
marker_pad	numpointskwargs	__class__r   r   r      s    zHandlerNpoints.__init__c                 C   s   | j d kr|jS | j S d S r	   )r7   r:   r   r    r   r   r   get_numpoints   s    
zHandlerNpoints.get_numpointsc                 C   sh   |  |}|dkr@| j| }t| | | | | |}	|	}
n | | | g}	| d|  g}
|	|
fS )N         ?)r?   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   r?   rG   __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f 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:   N)r6   r   	_yoffsets)r   r:   yoffsetsr;   r<   r   r   r      s    zHandlerNpointsYoffsets.__init__c                 C   s*   | j d kr||j }n|t| j  }|S r	   rJ   Z_scatteryoffsetsrB   asarrayr   r    r"   r#   r$   r%   r&   ydatar   r   r   	get_ydata   s    
z HandlerNpointsYoffsets.get_ydata)NN)r0   r1   r2   r3   r   rP   rH   r   r   r<   r   rI      s   rI   c                   @   s   e Zd ZdZdd Zd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.
    c	                 C   s   |  ||||||\}	}
t|	|| d }t|	|}| ||| |d |d t|
|d t|
 }| ||| |d |j	dkr|
 |j	 }|| ||_|| || ||gS )N   default Noner@   )rG   rB   	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/   rE   rF   rO   leglinelegline_markernewszr   r   r   r(      s(    
  







z$HandlerLine2DCompound.create_artistsNr0   r1   r2   r3   r(   r   r   r   r   rQ      s   rQ   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   r_   r   r   r   r      s    z_Line2DHandleList.__init__c                 C   s   dS NrR   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_deprecatedrc   )r   indexr   r   r   __getitem__   s     z_Line2DHandleList.__getitem__N)r0   r1   r2   r   re   rh   r   r   r   r   r*      s   r*   c                   @   s   e Zd Z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).
    c	                 C   s   |  ||||||\}	}
d }| |dkrFt|	d |	d d}	dg}t|	|| d }t|	||d}| ||| |jdkr| |j }|	| |
| t|S )Nr@   r      rR   )	markevery)rG   r?   rB   rC   rV   r   r!   r[   r\   r]   r^   r*   )r   r    r   r"   r#   r$   r%   r&   r/   rE   rF   rl   rO   r_   ra   r   r   r   r(     s"    
  


zHandlerLine2D.create_artistsNrb   r   r   r   r   ri   
  s   	ri   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f | || _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`.
        N)r6   r   _patch_func)r   Z
patch_funcr;   r<   r   r   r   6  s    zHandlerPatch.__init__c           	   	   C   s>   | j d kr"t| | f||d}n| j |||||||d}|S )Nxyr$   r%   )r    r   r"   r#   r$   r%   r&   )rn   r   	r   r    r   r"   r#   r$   r%   r&   pr   r   r   _create_patchK  s    
    zHandlerPatch._create_patchc	           
   	   C   s4   |  |||||||}	| |	|| |	| |	gS r	   )rs   r!   r^   
r   r    r   r"   r#   r$   r%   r&   r/   rr   r   r   r   r(   V  s        
zHandlerPatch.create_artists)N)r0   r1   r2   r3   r   rs   r(   rH   r   r   r<   r   rm   1  s   rm   c                   @   s(   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)rp   colorr$   r%   )r   get_facecolorrq   r   r   r   rs   d  s     zHandlerStepPatch._create_patchc           	      C   sF   t d|g|d |d g| | | d}|d |d |S )Nr   rR   )rv   Z	linestyleZ	linewidthrS   rT   )r   get_edgecolorget_linestyleZget_linewidthrW   rX   )	r   r    r   r"   r#   r$   r%   r&   r_   r   r   r   _create_linel  s    

zHandlerStepPatch._create_linec	           
   	   C   s`   |  s| d k	r:| |||||||}	| |	|| n| |||||||}	|	| |	gS r	   )get_fill	get_hatchrs   r!   rz   r^   rt   r   r   r   r(   z  s$            
zHandlerStepPatch.create_artistsN)r0   r1   r2   r3   rs   rz   r(   r   r   r   r   ru   _  s   ru   c                   @   s(   e Zd ZdZdd Zdd Zdd ZdS )	HandlerLineCollectionz2
    Handler for `.LineCollection` instances.
    c                 C   s   | j d kr|jS | j S d S r	   r7   Zscatterpointsr>   r   r   r   r?     s    
z#HandlerLineCollection.get_numpointsc                 C   sD   |  d }|jd }| d }|| || || d S Nr   )get_linewidthsZ_us_linestylesZ
get_colors	set_colorrZ   set_linewidth)r   r   r   ZlwZdashesrv   r   r   r   r     s    


z*HandlerLineCollection._default_update_propc	                 C   sT   |  ||||||\}	}
t|	|| d }t|	|}| ||| || |gS rd   )rG   rB   rV   r   r!   r^   )r   r    r   r"   r#   r$   r%   r&   r/   rE   rF   rO   r_   r   r   r   r(     s    
  

z$HandlerLineCollection.create_artistsN)r0   r1   r2   r3   r?   r   r(   r   r   r   r   r}     s   r}   c                       sX   e Zd ZdZd fdd	Zdd Zdd Zd	d
 Ze	ddddd Z
dd Z  ZS )HandlerRegularPolyCollectionz'Handler for `.RegularPolyCollection`\s.Nc                    s    t  jf d|i| || _d S )NrK   )r6   r   _sizes)r   rK   sizesr;   r<   r   r   r     s    z%HandlerRegularPolyCollection.__init__c                 C   s   | j d kr|jS | j S d S r	   r~   r>   r   r   r   r?     s    
z*HandlerRegularPolyCollection.get_numpointsc                 C   s   | j d kr| }t|s dg}t||jd  }	t||jd  }
| |}|dk rrd|	|
  |	|
gd | }q|	|
 }|tdd| |
 }n| j }|S )Nr@   rR      rA   r   )	r   	get_sizesrY   maxr[   minr?   rB   rC   )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_figurefigurer   r   r   r   r   r   r!     s    
z(HandlerRegularPolyCollection.update_prop3.6transOffsetoffset_transformc                 C   s   t || | |||dS )N)Zrotationr   offsetsr   )typeZget_numsidesZget_rotationr   r   r   r   r   r   r   r   create_collection  s      z.HandlerRegularPolyCollection.create_collectionc	              	   C   s|   |  ||||||\}	}
| ||||||}| |||||||}| j||tt|
||d}| ||| || |gS N)r   r   )rG   rP   r   r   listzipr!   Zset_offset_transform)r   r    r   r"   r#   r$   r%   r&   r/   rE   rF   rO   r   rr   r   r   r   r(     s0    
  
      
z+HandlerRegularPolyCollection.create_artists)NN)r0   r1   r2   r3   r   r?   r   r!   r   rename_parameterr   r(   rH   r   r   r<   r   r     s   	
r   c                   @   s&   e Zd ZdZeddddd ZdS )HandlerPathCollectionzDHandler for `.PathCollection`\s, which are used by `~.Axes.scatter`.r   r   r   c                 C   s   t || d g|||dS )Nr   )r   r   r   )r   	get_pathsr   r   r   r   r     s      z'HandlerPathCollection.create_collectionNr0   r1   r2   r3   r   r   r   r   r   r   r   r     s   r   c                   @   s&   e Zd ZdZeddddd ZdS )HandlerCircleCollectionz"Handler for `.CircleCollection`\s.r   r   r   c                 C   s   t ||||dS r   )r   r   r   r   r   r     s
      z)HandlerCircleCollection.create_collectionNr   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 )HandlerErrorbarzHandler for Errorbars.rA   Nr5   c                    s(   || _ || _t jf ||d| d S )N)r9   r:   )
_xerr_size
_yerr_sizer6   r   )r   	xerr_size	yerr_sizer9   r:   r;   r<   r   r   r     s    zHandlerErrorbar.__init__c           	      C   s,   | j | }| jd kr|}n
| 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 kr|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rlfddt||D }t|}| ||d	 | || |
rlt|| }t|| }| ||
d	 | | ||
d	 | |
d |
d || || ||||f}|D ]}|| q~|S )NrR   FrS   nonerU   r@   c                    s(   g | ] \}}|  |f|  |ffqS r   r   .0xy)r   r   r   
<listcomp>D  s   z2HandlerErrorbar.create_artists.<locals>.<listcomp>r   |c                    s(   g | ] \}}||  f||  ffqS r   r   r   )r   r   r   r   V  s   _)rG   rB   rV   r   rM   rY   r   Zset_visibler!   rW   rX   rZ   r[   r\   r]   Zhas_xerrr   mcollLineCollectionappendZhas_yerrr^   )r   r    r   r"   r#   r$   r%   r&   r/   Z	plotlinesZcaplinesZbarlinecolsrE   rF   rO   r_   Zydata_markerr`   ra   Zhandle_barlinecolsZhandle_caplinesZvertsZcollZcapline_leftZcapline_rightr+   artistr   )r   r   r   r(     s    

  


  




















   zHandlerErrorbar.create_artists)rA   Nr5   N)r0   r1   r2   r3   r   r   r(   rH   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f |||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`.
        )r9   r:   rK   N)r6   r   _bottom)r   r9   r:   bottomrK   r;   r<   r   r   r   t  s    zHandlerStem.__init__c                 C   s2   | j d kr|d|j d  }n|t| j  }|S )NrA   rL   rN   r   r   r   rP     s    
zHandlerStem.get_ydatac	              	      sB  |\}	}
}t |
tj}| ||||||\}}| ||||||}| jd krRd n| j t||d t| }| ||	|  fddt	||D }|rt
j| | jd |D ]}| ||
| qW 5 Q R X n"t	||
D ]\}}| ||| qtt|t|g  g}| ||| |||f}|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   rG   rP   r   r   rY   r!   r   r   Z_setattr_cm_copy_collection_propsrB   r   r   r^   )r   r    r   r"   r#   r$   r%   r&   r/   Z
markerlineZ	stemlinesZbaselineZusing_linecollrE   rF   rO   Zleg_markerlineZleg_stemlineslineZlmmZleg_baseliner+   r   r   r   r   r(     sJ    

  
  

 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_colorrZ   ry   r   r   r   r   r     s    z"HandlerStem._copy_collection_props)r5   NNN)	r0   r1   r2   r3   r   rP   r(   r   rH   r   r   r<   r   r   o  s       /r   c                       s*   e Zd ZdZd fdd	Zdd Z  ZS )	HandlerTuplez
    Handler for Tuple.
    r@   Nc                    s   || _ || _t jf | 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`.
        N)_ndivide_padr6   r   )r   ndividerD   r;   r<   r   r   r     s    zHandlerTuple.__init__c	                 C   s   |  }	| jd krt|}
n| j}
| jd kr8|j| }n
| j| }|
dkr^|||
d   |
 }t||| t|
  }g }|D ]J}||	|}|	||t
||||||}t|tr|d g}|| q|S )Nr@   r   )Zget_legend_handler_mapr   rY   r   Z	borderpadr   rB   ZarangeZget_legend_handlerr(   r
   r)   r*   extend)r   r    r   r"   r#   r$   r%   r&   r/   Zhandler_mapr   rD   Z	xds_cyclea_listZhandle1handlerZ_a_listr   r   r   r(     s6    



      

zHandlerTuple.create_artists)r@   N)r0   r1   r2   r3   r   r(   rH   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|_|j|_| |_| |_	|j
|_
|||  |||  |||  ||  d S )Nc                 S   s   | j dkrdS t| d S )Nr   )r   r   r   r   )sizetuple)colorsr   r   r   first_color  s    
z7HandlerPolyCollection._update_prop.<locals>.first_colorc                 S   s   t | r| d S d S d S r   )rY   )Z
prop_arrayr   r   r   	get_first  s    z5HandlerPolyCollection._update_prop.<locals>.get_first)rw   Z
_facecolorrx   Z
_edgecolorZ_original_facecolorZ_original_edgecolorr{   Z_fillr|   Z_hatchZ_hatch_colorr   r   rZ   Zget_linestylesr^   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 )Nro   )r   r!   r^   rt   r   r   r   r(   "  s     
z$HandlerPolyCollection.create_artistsN)r0   r1   r2   r3   r   r(   r   r   r   r   r      s   r   )"r3   collections.abcr   	itertoolsr   ZnumpyrB   Z
matplotlibr   r   Zmatplotlib.linesr   Zmatplotlib.patchesr   Zmatplotlib.collectionscollectionsr   r   r   r4   rI   rQ   r*   ri   rm   ru   r}   r   r   r   r   r   r   r   r   r   r   r   <module>   s0   \*%'.( I	kZ7