3 ƽh@sddlmZmZddlmZddlZddlZddlmZddl Z ddl Z ddl Z ddl ZddlmZmZddlmZddlmZmZmZmZmZmZejeZd d Zd d Zed dZ GdddZ!GdddZ"dddZ#e#Z$ddddZ%ddZ&ej'j(e&e!ddS)) OrderedDict namedtuple)wrapsN)Number)cbook docstring)Path)BboxIdentityTransform TransformTransformedBboxTransformedPatchPathTransformedPathcstfdd}d|_|S)a- Decorator for Artist.draw method. Provides routines that run before and after the draw call. The before and after functions are useful for changing artist-dependent renderer attributes or making other setup function calls, such as starting and flushing a mixed-mode renderer. c shz6|jr|j|jdk r&|j||f||S|jdk rR|j|j|jrb|jXdS)N)get_rasterizedZstart_rasterizingget_agg_filterZ start_filterZ stop_filterZstop_rasterizing)artistrendererargskwargs)draw7/tmp/pip-build-7iwl8md4/matplotlib/matplotlib/artist.py draw_wrapper!s  z)allow_rasterization..draw_wrapperT)r_supports_rasterization)rrr)rrallow_rasterizations rcCs|jr||j_dS)N)axesstale)selfvalrrr_stale_axes_callback4sr _XYPairzx yc@seZdZdZdZddZddZddZd d Zd d Z d dZ e ddZ e j ddZ e ddZej ddZddZddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zdd*d+Zd,d-Zejd.d/d0d1d2Zejd.d3d0d4d5Zd6d7Zd8d9Z d:d;Z!dd?Z#d@dAZ$dBdCZ%dDdEZ&dFdGZ'dHdIZ(dJdKZ)ddLdMZ*dNdOZ+dPdQZ,dRdSZ-dTdUZ.dVdWZ/ddXdYZ0dZd[Z1d\d]Z2d^d_Z3d`daZ4dbdcZ5dddeZ6dfdgZ7dhdiZ8djdkZ9dldmZ:dndoZ;dpdqZej?d.dvej?d.dwdxdyZ@dzd{ZAd|d}ZBd~dZCddZDddZEddZFddZGddZHddZIe ddZJddZKddZLddZMdddZNddZOddZPe ddZQeQj ddZQd)S)Artistz Abstract base class for objects that render into a FigureCanvas. Typically, all visible elements in a figure are subclasses of Artist. rc Csd|_d|_d|_d|_d|_d|_d|_d|_d|_d|_ d|_ d|_ d|_ d|_ d|_d|_d|_t|jtjk|_d|_d|_i|_y d|_Wntk rYnXd|_d|_d|_d|_tjd|_ tjd|_!t"gg|_#d|_$dS)NTFrz path.sketchz path.effects)%_stalestale_callback_axesfigure _transform _transformSet_visible _animated_alphaclipbox _clippath_clipon_label_picker _contains _rasterized _agg_filtertypeget_cursor_datar" _mouseovereventson_oid_propobserversrAttributeError_remove_method_url_gid_snapmplrcParams_sketch _path_effectsr! _sticky_edges _in_layout)rrrr__init__EsB    zArtist.__init__cCs|jj}d|d<|S)Nr%)__dict__copy)rdrrr __getstate__ls zArtist.__getstate__cCsr|jdk rf|j|d|_d}t|drN|jrN|jjj|d|j_d|_d}|jrnd|_|snd|_ntddS)a Remove the artist from the figure if possible. The effect will not be visible until the figure is redrawn, e.g., with `.FigureCanvasBase.draw_idle`. Call `~.axes.Axes.relim` to update the axes limits if desired. Note: `~.axes.Axes.relim` will not see collections even if the collection was added to the axes with *autolim* = True. Note: there is no support for removing the artist's legend entry. NFrTzcannot remove artist) r<r%hasattrr_mouseover_setdiscardrr'NotImplementedError)rZ_ax_flagrrrremovess  z Artist.removecCs |j}|otdd|jDS)z+Return *True* if units are set on any axis.css|]}|jVqdS)N) have_units).0Zaxisrrr sz$Artist.have_units..)ranyZ_get_axis_list)raxrrrrPszArtist.have_unitscCs.t|dd}|dks|jdkr"|S|jj|S)z Convert *x* using the unit type of the xaxis. If the artist is not in contained in an Axes or if the xaxis does not have units, *x* itself is returned. rN)getattrZxaxis convert_units)rxrTrrrconvert_xunitss zArtist.convert_xunitscCs.t|dd}|dks|jdkr"|S|jj|S)z Convert *y* using the unit type of the yaxis. If the artist is not in contained in an Axes or if the yaxis does not have units, *y* itself is returned. rN)rUZyaxisrV)ryrTrrrconvert_yunitss zArtist.convert_yunitscCs|jS)z Any where *artist* is the calling `.Artist`. Return values may exist but are ignored. Returns ------- int The observer id associated with the callback. This id can be used for removing the callback with `.remove_callback` later. See Also -------- remove_callback r)r9r:)rfuncoidrrr add_callback!s zArtist.add_callbackc Cs&y |j|=Wntk r YnXdS)zu Remove a callback based on its observer id. See Also -------- add_callback N)r:KeyError)rrjrrrremove_callback?s zArtist.remove_callbackcCs$x|jjD]\}}||q WdS)z Call all of the registered callbacks. This function is triggered internally when a property is changed. See Also -------- add_callback remove_callback N)r:items)rrjrirrrpchangedLs zArtist.pchangedcCs|jS)z Return whether the Artist has an explicitly set transform. This is *True* after `.set_transform` has been called. )r))rrrris_transform_setZszArtist.is_transform_setcCs||_d|_|jd|_dS)zk Set the artist transform. Parameters ---------- t : `.Transform` TN)r(r)ror)rtrrr set_transformbszArtist.set_transformcCsD|jdkrt|_n*t|jt r>t|jdr>|jj|j|_|jS)z5Return the `.Transform` instance used by this artist.N_as_mpl_transform)r(r isinstancer rKrsr)rrrr get_transformos    zArtist.get_transformcCsgS)z9Return a list of the child `.Artist`\s of this `.Artist`.r)rrrr get_childrenxszArtist.get_childrenNcCs:t|jr|j||S|dk r2|j|jk r2difSdifS)a Base impl. for checking whether a mouseevent happened in an artist. 1. If the artist defines a custom checker, use it (deprecated). 2. If the artist figure is known and the event did not occur in that figure (by checking its ``canvas`` attribute), reject it. 3. Otherwise, return `None, {}`, indicating that the subclass' implementation should be used. Subclasses should start their definition of `contains` as follows: inside, info = self._default_contains(mouseevent) if inside is not None: return inside, info # subclass-specific implementation follows The *figure* kwarg is provided for the implementation of `.Figure.contains`. NF)callabler2canvas)r mouseeventr'rrr_default_contains|s   zArtist._default_containscCs6|j|\}}|dk r||fStjd|jjdifS)a Test whether the artist contains the mouse event. Parameters ---------- mouseevent : `matplotlib.backend_bases.MouseEvent` Returns ------- contains : bool Whether any values are within the radius. details : dict An artist-specific dictionary of details of the event context, such as which points are contained in the pick radius. See the individual Artist subclasses for details. Nz%r needs 'contains' methodF)rz_logwarning __class____name__)rryinsideinforrrcontainss zArtist.containsz3.3 set_picker) alternativecCst|std||_dS)a Define a custom contains test for the artist. The provided callable replaces the default `.contains` method of the artist. Parameters ---------- picker : callable A custom picker function to evaluate if an event is within the artist. The function must have the signature:: def contains(artist: Artist, event: MouseEvent) -> bool, dict that returns: - a bool indicating if the event is within the artist - a dict of additional information. The dict should at least return the same information as the default ``contains()`` implementation of the respective artist, but may provide additional information. zpicker is not a callableN)rw TypeErrorr2)rpickerrrr set_containsszArtist.set_contains get_pickercCs|jS)z Return the custom contains function of the artist if set, or *None*. See Also -------- set_contains )r2)rrrr get_containss zArtist.get_containscCs|jdk o|jdk S)z Return whether the artist is pickable. See Also -------- set_picker, get_picker, pick N)r'r1)rrrrpickableszArtist.pickablecCs|jrN|j}t|r(|||\}}n|j|\}}|rN|jjj||f|xB|jD]6}t|dd}|j dks|dks|j |krX|j |qXWdS)z Process a pick event. Each child artist will fire a pick event if *mouseevent* is over the artist and the artist has picker set. See Also -------- set_picker, get_picker, pickable rN) rrrwrr'rxZ pick_eventrvrUZinaxespick)rryrrproparTrrrrs   z Artist.pickcCs ||_dS)af Define the picking behavior of the artist. Parameters ---------- picker : None or bool or callable This can be one of the following: - *None*: Picking is disabled for this artist (default). - A boolean: If *True* then picking will be enabled and the artist will fire a pick event if the mouse event is over the artist. - A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event:: hit, props = picker(artist, mouseevent) to determine the hit test. if the mouse event is over the artist, return *hit=True* and props is a dictionary of properties you want added to the PickEvent attributes. - *deprecated*: For `.Line2D` only, *picker* can also be a float that sets the tolerance for checking whether an event occurred "on" the line; this is deprecated. Use `.Line2D.set_pickradius` instead. N)r1)rrrrrrszArtist.set_pickercCs|jS)z Return the picking behavior of the artist. The possible values are described in `.set_picker`. See Also -------- set_picker, pickable, pick )r1)rrrrr!s zArtist.get_pickercCs|jS)zReturn the url.)r=)rrrrget_url-szArtist.get_urlcCs ||_dS)zf Set the url for the artist. Parameters ---------- url : str N)r=)rurlrrrset_url1szArtist.set_urlcCs|jS)zReturn the group id.)r>)rrrrget_gid;szArtist.get_gidcCs ||_dS)zm Set the (group) id for the artist. Parameters ---------- gid : str N)r>)rgidrrrset_gid?szArtist.set_gidcCstjdr|jSdSdS)zP Return the snap setting. See `.set_snap` for details. z path.snapFN)r@rAr?)rrrrget_snapIs zArtist.get_snapcCs||_d|_dS)a Set the snapping behavior. Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which would be a grey value on both adjacent pixel positions. In contrast, snapping will move the line to the nearest integer pixel value, so that the resulting image will really contain a 1px wide black line. Snapping is currently only supported by the Agg and MacOSX backends. Parameters ---------- snap : bool or None Possible values: - *True*: Snap vertices to the nearest pixel center. - *False*: Do not modify vertex positions. - *None*: (auto) If the path contains only rectilinear line segments, round to the nearest pixel center. TN)r?r)rZsnaprrrset_snapTszArtist.set_snapcCs|jS)a Return the sketch parameters for the artist. Returns ------- tuple or None A 3-tuple with the following elements: - *scale*: The amplitude of the wiggle perpendicular to the source line. - *length*: The length of the wiggle along the line. - *randomness*: The scale factor by which the length is shrunken or expanded. Returns *None* if no sketch parameters were set. )rB)rrrrget_sketch_paramspszArtist.get_sketch_paramscCs.|dkrd|_n||pd|pdf|_d|_dS)a{ Sets the sketch parameters. Parameters ---------- scale : float, optional The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is `None`, or not provided, no sketch filter will be provided. length : float, optional The length of the wiggle along the line, in pixels (default 128.0) randomness : float, optional The scale factor by which the length is shrunken or expanded (default 16.0) .. ACCEPTS: (scale: float, length: float, randomness: float) Ng`@g0@T)rBr)rZscalelengthZ randomnessrrrset_sketch_paramsszArtist.set_sketch_paramscCs||_d|_dS)z{ Set the path effects. Parameters ---------- path_effects : `.AbstractPathEffect` TN)rCr)rZ path_effectsrrrset_path_effectsszArtist.set_path_effectscCs|jS)N)rC)rrrrget_path_effectsszArtist.get_path_effectscCs|jS)z4Return the `.Figure` instance the artist belongs to.)r')rrrr get_figureszArtist.get_figurecCsH|j|krdS|jdk r td||_|jr>|j|k r>|jd|_dS)z Set the `.Figure` instance the artist belongs to. Parameters ---------- fig : `.Figure` Nz1Can not put single artist in more than one figureT)r' RuntimeErrorror)rZfigrrr set_figures  zArtist.set_figurecCs||_|jd|_dS)zq Set the artist's clip `.Bbox`. Parameters ---------- clipbox : `.Bbox` TN)r-ror)rr-rrr set_clip_boxszArtist.set_clip_boxcCsddlm}m}d}|dkrrt||rFttj|j|_d|_ d}n,t||r`t ||_ d}nt|t rr|\}}|dkrd|_ d}nFt|t rt |||_ d}n*t|t r||_ d}nt|t r||_ d}|stdjt|jt|j|jd|_dS)a Set the artist's clip path. Parameters ---------- path : `.Patch` or `.Path` or `.TransformedPath` or None The clip path. If given a `.Path`, *transform* must be provided as well. If *None*, a previously set clip path is removed. transform : `~matplotlib.transforms.Transform`, optional Only used if *path* is a `.Path`, in which case the given `.Path` is converted to a `.TransformedPath` using *transform*. Notes ----- For efficiency, if *path* is a `.Rectangle` this method will set the clipping box to the corresponding rectangle and set the clipping path to ``None``. For technical reasons (support of `~.Artist.set`), a tuple (*path*, *transform*) is also accepted as a single positional parameter. .. ACCEPTS: Patch or (Path, Transform) or None r)Patch RectangleFNTz5Invalid arguments to set_clip_path, of type {} and {})Zmatplotlib.patchesrrrtr r unitrur-r.rtupler rrformatr5r~ror)rpathZ transformrrsuccessrrr set_clip_paths>         zArtist.set_clip_pathcCs|jS)zc Return the alpha value used for blending - not supported on all backends. )r,)rrrr get_alphaszArtist.get_alphacCs|jS)zReturn the visibility.)r*)rrrr get_visibleszArtist.get_visiblecCs|jS)z&Return whether the artist is animated.)r+)rrrrr\szArtist.get_animatedcCs|jS)a Return boolean flag, ``True`` if artist is included in layout calculations. E.g. :doc:`/tutorials/intermediate/constrainedlayout_guide`, `.Figure.tight_layout()`, and ``fig.savefig(fname, bbox_inches='tight')``. )rE)rrrr get_in_layout s zArtist.get_in_layoutcCs|jS)z(Return whether the artist uses clipping.)r/)rrrrr^+szArtist.get_clip_oncCs|jS)zReturn the clipbox.)r-)rrrrr_/szArtist.get_clip_boxcCs|jS)zReturn the clip path.)r.)rrrrr`3szArtist.get_clip_pathcCs|jdk r|jjSdS)z Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation. N)NN)r.Zget_transformed_path_and_affine)rrrr$get_transformed_clip_path_and_affine7s  z+Artist.get_transformed_clip_path_and_affinecCs||_|jd|_dS)z Set whether the artist uses clipping. When False artists will be visible outside of the axes which can lead to unexpected results. Parameters ---------- b : bool TN)r/ror)rbrrr set_clip_onAs zArtist.set_clip_oncCsB|jr*|jdk r|j|j|j|jn|jd|jddS)z!Set the clip properly for the gc.N)r/r-Zset_clip_rectanglerr.)rgcrrr _set_gc_clipRs    zArtist._set_gc_clipcCs|jS)z.Return whether the artist is to be rasterized.)r3)rrrrr\szArtist.get_rasterizedcCs*|r t|jd r tjd|||_dS)z Force rasterized (bitmap) drawing in vector backend output. Defaults to None, which implies the backend's default behavior. Parameters ---------- rasterized : bool or None rz%Rasterization of '%s' will be ignoredN)rKrrZ_warn_externalr3)rZ rasterizedrrrset_rasterized`s  zArtist.set_rasterizedcCs|jS)z1Return filter function to be used for agg filter.)r4)rrrrrpszArtist.get_agg_filtercCs||_d|_dS)ay Set the agg filter. Parameters ---------- filter_func : callable A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array. .. ACCEPTS: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array TN)r4r)rZ filter_funcrrrset_agg_filterts zArtist.set_agg_filterrrcOs|js dSd|_dS)ac Draw the Artist (and its children) using the given renderer. This has no effect if the artist is not visible (`.Artist.get_visible` returns False). Parameters ---------- renderer : `.RendererBase` subclass. Notes ----- This method is overridden in the Artist subclasses. NF)rr)rrrrrrrrsz Artist.drawcCs4|dk rt|t rtd||_|jd|_dS)z Set the alpha value used for blending - not supported on all backends. Parameters ---------- alpha : float or None Nzalpha must be a float or NoneT)rtrrr,ror)ralpharrr set_alphas zArtist.set_alphacCs||_|jd|_dS)zf Set the artist's visibility. Parameters ---------- b : bool TN)r*ror)rrrrr set_visibleszArtist.set_visiblecCs|j|kr||_|jdS)zk Set the artist's animation state. Parameters ---------- b : bool N)r+ro)rrrrr set_animateds zArtist.set_animatedcCs ||_dS)a) Set if artist is to be included in layout calculations, E.g. :doc:`/tutorials/intermediate/constrainedlayout_guide`, `.Figure.tight_layout()`, and ``fig.savefig(fname, bbox_inches='tight')``. Parameters ---------- in_layout : bool N)rE)rZ in_layoutrrr set_in_layouts zArtist.set_in_layoutc Csg}tj|ddx|jD]\}}||jkrHtjddd|j}|dkrd|jt|||qt|d|d}t|st t |j d ||j||qWWdQRX|r|j d |_ |S) z Update this artist's properties from the dict *props*. Parameters ---------- props : dict F)r8z3.3z`Case-insensitive properties were deprecated in %(since)s and support will be removed %(removal)s)messagerset_Nz object has no property T)rZ _setattr_cmrnlowerwarn_deprecatedappendsetattrrUrwr;r5r~ror)rpropsretkvrirrrupdates"  z Artist.updatecCs|jS)z4Return the label used for this artist in the legend.)r0)rrrr get_labelszArtist.get_labelcCs,|dk rt||_nd|_|jd|_dS)z Set a label that will be displayed in the legend. Parameters ---------- s : object *s* will be converted to a string by calling `str`. NT)strr0ror)rsrrr set_labels  zArtist.set_labelcCs|jS)zReturn the artist's zorder.)zorder)rrrr get_zorderszArtist.get_zordercCs(|dkr|jj}||_|jd|_dS)z Set the zorder for the artist. Artists with lower zorder values are drawn first. Parameters ---------- level : float NT)r}rror)rlevelrrr set_zorders zArtist.set_zordercCs|jS)a ``x`` and ``y`` sticky edge lists for autoscaling. When performing autoscaling, if a data limit coincides with a value in the corresponding sticky_edges list, then no margin will be added--the view limit "sticks" to the edge. A typical use case is histograms, where one usually expects no margin on the bottom edge (0) of the histogram. This attribute cannot be assigned to; however, the ``x`` and ``y`` lists can be modified in place as needed. Examples -------- >>> artist.sticky_edges.x[:] = (xmin, xmax) >>> artist.sticky_edges.y[:] = (ymin, ymax) )rD)rrrr sticky_edgesszArtist.sticky_edgescCs|j|_|j|_|j|_|j|_|j|_|j|_|j|_|j|_|j|_|j |_ |j j j |j j dd<|j j j |j j dd<|jd|_dS)z'Copy properties from *other* to *self*.NT)r(r)r*r,r-r/r.r0rBrCrrWrHrYror)rotherrrr update_from)szArtist.update_fromcCs t|jS)z8Return a dictionary of all the properties of the artist.)ArtistInspector properties)rrrrr:szArtist.propertiescKstj||}d}d|kr|}|jd}ddg}tddt|jDrR|jdxB|D]:}||krfqX|j|}||krXd}tjd d |d d qXW|rd|jdi|}|j |S) z:A property batch setter. Pass *kwargs* to set properties.FcolorZ edgecolorZ facecolorcss"|]}|jdko|jdkVqdS)zmatplotlib.collections CollectionN) __module__r~)rQtprrrrRFszArtist.set..rTz3.3zYou have passed the z kwarg before the 'color' kwarg. Artist.set() currently reorders the properties to apply 'color' first, but this is deprecated since %(since)s and will be removed %(removal)s; please pass 'color' first instead.)r) rZnormalize_kwargsindexrSr5__mro__rrpopr)rrZmove_color_to_startkeysZi_colorrrZi_otherrrrset>s(     z Artist.setTcsdkrddn8ttr4ttr4fddntrBntdtfdd|jDg}|r||r||j||S)a Find artist objects. Recursively find all `.Artist` instances contained in the artist. Parameters ---------- match A filter criterion for the matches. This can be - *None*: Return all objects contained in artist. - A function with signature ``def match(artist: Artist) -> bool``. The result will only contain artists for which the function returns *True*. - A class instance: e.g., `.Line2D`. The result will only contain artists of this class or its subclasses (``isinstance`` check). include_self : bool Include *self* in the list to be checked for a match. Returns ------- list of `.Artist` NcSsdS)NTr)rWrrr matchfuncvsz!Artist.findobj..matchfunccs t|S)N)rt)rW)matchrrryszFmatch must be None, a matplotlib.artist.Artist subclass, or a callablecsg|]}|jqSr)findobj)rQc)rrr sz"Artist.findobj..) rtr5 issubclassr"rwr[sumrvr)rrZ include_selfZartistsr)rrrr[s   zArtist.findobjcCsdS)a Return the cursor data for a given event. .. note:: This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself. Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns *None*. Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that `.format_cursor_data` can convert the data to a string representation. The only current use case is displaying the z-value of an `.AxesImage` in the status bar of a plot window, while moving the mouse. Parameters ---------- event : `matplotlib.backend_bases.MouseEvent` See Also -------- format_cursor_data Nr)reventrrrr6szArtist.get_cursor_datac CsLy |dWnttfk r*|g}YnXdjdd|D}d|dS)a Return a string representation of *data*. .. note:: This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself. The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets. See Also -------- get_cursor_data rz, css"|]}t|trdj|VqdS)z{:0.3g}N)rtrr)rQitemrrrrRsz,Artist.format_cursor_data..[])r IndexErrorjoin)rdataZdata_strrrrformat_cursor_datas   zArtist.format_cursor_datacCs|jS)a  If this property is set to *True*, the artist will be queried for custom context information when the mouse cursor moves over it. See also :meth:`get_cursor_data`, :class:`.ToolCursorPosition` and :class:`.NavigationToolbar2`. )r7)rrrr mouseovers zArtist.mouseovercCs:t|}||_|j}|r6|r*|jj|n |jj|dS)N)boolr7rrLaddrM)rrrTrrrrs)N)NNN)N)NT)Rr~r __qualname____doc__rrFrJrOrPrXrZpropertyrsetterrr]rgrhrkrmrorprrrurvrzrrZ deprecatedrrrrrrrrrrrrrrrrrrrrrrr\rr^r_r`rrrrrrrZ_delete_parameterrrrrrrrrrrrrrrrr6rrrrrrr"<s'-          #        >          + r"c@s~eZdZdZddZddZejdZddZ d d Z d d Z d dZ ddZ ddZdddZdddZddZddZdS) rz A helper class to inspect an `~matplotlib.artist.Artist` and return information about its settable properties and their current values. cCsXt|ts,tj|r,t|}t|r,|d}||_t|tsDt|}||_|j |_ dS)a Initialize the artist inspector with an `Artist` or an iterable of `Artist`\s. If an iterable is used, we assume it is a homogeneous sequence (all `Artist`\s are of the same type) and it is your responsibility to make sure this is so. rN) rtr"npiterablelistlenoorigr5o get_aliasesaliasd)rrrrrrFs   zArtistInspector.__init__csfddtjD}i}xn|D]f}tj|}j|s>q"tjdj|ddtj|j d}|j |ddt j |ddq"W|S)a  Get a dict mapping property fullnames to sets of aliases for each alias in the :class:`~matplotlib.artist.ArtistInspector`. e.g., for lines:: {'markerfacecolor': {'mfc'}, 'linewidth' : {'lw'}, } cs*g|]"}|jdrttj|r|qS)rget_)rr) startswithrwrUr)rQname)rrrrs z/ArtistInspector.get_aliases..z`({}.*)`Nr) dirrrUis_aliasresearchrinspectgetdocgroup setdefaultrr)rnamesaliasesrriZpropnamer)rrrs    (zArtistInspector.get_aliasesz6\n\s*(?:\.\.\s+)?ACCEPTS:\s*((?:.|\n)*?)(?:$|(?:\n\n))cCsd|}t|j|s&td|j|ft|j|}tj|}|dkrHdS|jdrVdS|jj|}|dk r~t j dd|j dS|j j d}t jd j||}|r|j dSdS) a/ Get the legal arguments for the setter associated with *attr*. This is done by querying the docstring of the setter for a line that begins with "ACCEPTS:" or ".. ACCEPTS:", and then by looking for a numpydoc-style documentation for the setter's first argument. zset_%sz%s has no function %sNunknownz Alias for z * rz(?m)^ *\*?{} : (.+))rKrr;rUrrr_get_valid_values_regexrrsubr__code__ co_varnamesr)rattrrrirr param_namerrrget_valid_values s"        z ArtistInspector.get_valid_valuescCs0ddd}x |jD]\}}|j||}qW|S)z Changes the full path to the public API path that is used in sphinx. This is needed for links to work. Axes)z_base._AxesBasez _axes.Axes)rnreplace)rZ source_classZ replace_dictkeyvaluerrr _replace_path.s zArtistInspector._replace_pathcCspg}xft|jD]X}|jds qt|j|}t| sttj|jdks|j |rVq|j |ddqW|S)z Get the attribute strings with setters for object. For example, for a line, return ``['markerfacecolor', 'linewidth', ....]``. rrN) rrrrUrwrr signature parametersrr)rZsettersrrirrr get_setters9s    zArtistInspector.get_setterscCs tj|}|dkrdS|jdS)z@Return whether method object *o* is an alias for another method.NFz Alias for )rrr)rrZdsrrrrLs zArtistInspector.is_aliascCs*djddt|jj|gD}||S)a Return 'PROPNAME or alias' if *s* has an alias, else return 'PROPNAME'. e.g., for the line markerfacecolor property, which has an alias, return 'markerfacecolor or mfc' and for the transform property, which does not, return 'transform'. r#css|]}d|VqdS)z or %sNr)rQrWrrrrR[sz/ArtistInspector.aliased_name..)rsortedrget)rrrrrr aliased_nameSs"zArtistInspector.aliased_namecCs0djddt|jj|gD}d|||fS)a3 Return 'PROPNAME or alias' if *s* has an alias, else return 'PROPNAME', formatted for reST. e.g., for the line markerfacecolor property, which has an alias, return 'markerfacecolor or mfc' and for the transform property, which does not, return 'transform'. r#css|]}d|VqdS)z or %sNr)rQrWrrrrRgsz4ArtistInspector.aliased_name_rest..z:meth:`%s <%s>`%s)rrrr)rrtargetrrrraliased_name_rest^s "z!ArtistInspector.aliased_name_restNrcCsx|rd|}nd}|dk r2|j|}d|||fSg}x.csg|]\}}j|qSr)r )rQr_)rrrrscss|]}t|VqdS)N)r)rQnrrrrRsz6ArtistInspector.pprint_setters_rest..css|]}t|VqdS)N)r)rQrrrrrRsz =z .. table::z :class: property-tableZProperty Descriptioncs0g|](\}}d|jd|jqS)z )ljust)rQr r)col0_lencol1_lenrrrrs) r rrrrrUrrrrmaxr#zip) rrrrZprop_and_qualnamesclsmethodrZtable_formatstrr)r$r%rrrpprint_setters_restsB      z#ArtistInspector.pprint_setters_restcs|jfddtD}|ji}xr|D]j}t|}|j|rHq.y(tjtjd|}WdQRXWntk rw.Yq.X|||dd<q.W|S)z3Return a dictionary mapping property name -> value.cs(g|] }|jdrtt|r|qS)r)rrwrU)rQr)rrrrsz.ArtistInspector.properties..ignoreNr) rrsortrUrwarningscatch_warnings simplefilter Exception)rgettersrIrrirr)rrrs      zArtistInspector.propertiescCsg}xt|jjD]\}}t|dffkrPt|dkrPt|ddd}nt|}|jdd}t|dkr|ddd}|j|}|jd||fqW|S) z8Return the getters and actual values as list of strings.shapeNz... r2z %s = %s) rrrnrUrrr rr)rrrrrrrrpprint_getterss   zArtistInspector.pprint_getters)Nr)Nr)r~rrrrFrrcompilerr rrrrrrr*rr6rrrrrs$    7rcCs:|dkr*t|}|j}tdj|dSt|d|S)a Return the value of an object's *property*, or print all of them. Parameters ---------- obj : `.Artist` The queried artist; e.g., a `.Line2D`, a `.Text`, or an `~.axes.Axes`. property : str or None, default: None If *property* is 'somename', this function returns ``obj.get_somename()``. If is is None (or unset), it *prints* all gettable properties from *obj*. Many properties have aliases for shorter typing, e.g. 'lw' is an alias for 'linewidth'. In the output, aliases and full property names will be listed as: property or alias = value e.g.: linewidth or lw = 2 Nr4r)rr6printrrU)objrinsprrrrgetps r;)filecst|tr|g}nttj|}|s(dSt|d} r~t|dkr~|rdt|j|dd|dntdj |j|ddSt|drt dt dd t |ddd|d ddDfd d |Dfd d |D}ttj|S)a Set a property on an artist object. matplotlib supports the use of :func:`setp` ("set property") and :func:`getp` to set and get object properties, as well as to do introspection on the object. For example, to set the linestyle of a line to be dashed, you can do:: >>> line, = plot([1, 2, 3]) >>> setp(line, linestyle='--') If you want to know the valid types of arguments, you can provide the name of the property you want to set without a value:: >>> setp(line, 'linestyle') linestyle: {'-', '--', '-.', ':', '', (offset, on-off-seq), ...} If you want to see all the properties that can be set, and their possible values, you can do:: >>> setp(line) ... long output listing omitted By default `setp` prints to `sys.stdout`, but this can be modified using the *file* keyword-only argument:: >>> with fopen('output.log') as f: >>> setp(line, file=f) :func:`setp` operates on a single instance or a iterable of instances. If you are in query mode introspecting the possible values, only the first instance in the sequence is used. When actually setting values, all the instances will be set. e.g., suppose you have a list of two lines, the following will make both lines thicker and red:: >>> x = arange(0, 1, 0.01) >>> y1 = sin(2*pi*x) >>> y2 = sin(4*pi*x) >>> lines = plot(x, y1, x, y2) >>> setp(lines, linewidth=2, color='r') :func:`setp` works with the MATLAB style string/value pairs or with python kwargs. For example, the following are equivalent:: >>> setp(lines, 'linewidth', 2, 'color', 'r') # MATLAB style >>> setp(lines, linewidth=2, color='r') # python style Nrr)r)r<r4z(The set args must be string, value pairscss|]\}}||fVqdS)Nr)rQrrrrrrRHszsetp..rcsg|]}|jqSr)r)rQr)funcvalsrrrIszsetp..csg|]}|jfqSr)r)rQr)rrrrIs) rtr"rrflattenrrr8rrr[rr')r9r<rrobjsr:rr)r=rrsetps 2   ,$r@cCs:t|}tjdr$dj|jddSddj|jddS)a Inspect an `~matplotlib.artist.Artist` class (using `.ArtistInspector`) and return information about its settable properties and their current values. Parameters ---------- artist : `~matplotlib.artist.Artist` or an iterable of `Artist`\s Returns ------- str The settable properties of *artist*, as plain text if :rc:`docstring.hardcopy` is False and as a rst table (intended for use in Sphinx) if it is True. zdocstring.hardcopyr4r)rz Properties: )rr@rArr*r)rZairrrkwdocMsrA)r")N)) collectionsrr functoolsrrloggingnumbersrrr-numpyrZ matplotlibr@r#rrrr Z transformsr r r r rr getLoggerr~r{rr r!r"rr;rr@rAZinterpdrrrrrsB       ! L