René's URL Explorer Experiment

Title: Implement Axes.format features with individual setters by lukelbd · Pull Request #89 · proplot-dev/proplot · GitHub

Open Graph Title: Implement Axes.format features with individual setters by lukelbd · Pull Request #89 · proplot-dev/proplot

X Title: Implement Axes.format features with individual setters by lukelbd · Pull Request #89 · proplot-dev/proplot

Description: Starting this PR to keep #63 on everyone's radar. Along with #50 and #45 this is one of the major (but mostly internal) changes I am considering for the version 1.0 release. ProPlot adds "batch" setter methods called format to every Axes subclass. The idea is it's quicker to call 1 method with 10 keyword arguments rather than 10 methods on 10 lines. Interestingly, it looks like the Plots.jl julia package follows a similar philosophy (see the "Lorenz attractor" example). However: It seems kind of sloppy / unpythonic to me to have individual settings that can only be modified with a batch setter. It also makes the setter methods really long and difficult to maintain. (no longer valid; see below) I want to encourage batch setting but permit individual one-liner setting if the user so chooses. One of my goals for version 1 is to incorporate ProPlot internals more closely with matplotlib, and matplotlib apparently has its own batch setter, Artist.set. However nobody uses it, probably because (1) it seldom appears in the online examples and (2) the valid arguments are not explicitly documented, which is confusing for new userss. With this PR, I'd like to combine the features of Axes.format with Artist.update and Artist.set by overriding the latter for axes artists. I will deprecate format and break up the format tasks into individual setters, but encourage using the batch setters by using them in all of the examples and documenting the acceptable keyword args. Here is some pseudocode to outline the general idea. # The batch setters @cbook.deprecated("1.0.0", alternative="Axes.set(...)") # use matplotlib's deprecation system? def format(self, **kwargs): _warn_proplot( 'Axes.format() was deprecated in version 1.0.0. Please use `Axes.set()` instead.' ) # or "deprecation" with a simple warning return self.set(*args, **kwargs) def set(self, **kwargs): # Just like Artist.set(), process aliases here, e.g. `xticklabels` for `xformatter` # May just add `_alias_map` and `_prop_order` attributes to Axes! self._alias_map = ... # make sure these hidden props are stable! self._prop_order = ... # then filter out rc props here, and maybe we can have some sort of # rcupdate() method that updates *any* rc property that has changed rcprops, kwargs = _process_kwargs(kwargs) self.applyrc(rcprops) super().set(**kwargs) def update(self, props): # *Superset* of internal matplotlib.artist.Artist.update() # Permit passing *keyword arguments* to each setter # Example: If we get `xlim` and `xlim_kw`, call `Axes.set_xlim(xlim, **xlim_kw)` def _update_property(self, k, v, **kwargs): k = k.lower() if k in {'axes'}: return setattr(self, k, v) else: func = getattr(self, 'set_' + k, None) if not callable(func): raise AttributeError( f'{type(self).__name__!r} object has no property {k!r}.') return func(v) with cbook._setattr_cm(self, eventson=False): ret = [] for key, value in _kwargs_not_ending_in_kw(kwargs).items(): kw = _kwarg_ending_in_kw(key) ret.append(_update_property(self, k, v, **kw)) return ret # Helper method that looks for rc setting names passed # to the bulk setters def applyrc(self, **kwargs): # perform various actions currently spread around Axes.format() with plot.rc.context(**kwargs): # apply "cached" props (i.e. props changed in this block) # plot.rc.fill(props, cached=True) # plot.rc.get(props, cached=True) # etc. pass # The individual setters # These replace features originally coded in Axes.format def set_abcstyle(self, style): if not isinstance(style, str) or (style.count('a') != 1 and style.count('A') != 1): raise ValueError abc = _abc(self.number - 1) if 'A' in style: abc = abc.upper() abc = re.sub('[aA]', abc, abcstyle) self.abc.set_text(abc) def set_xticks(self, locator, **kwargs): locator = axistools.Locator(locator, **kwargs) self.xaxis.set_major_locator(locator) def set_xminorticks(self, locator, **kwargs): locator = axistools.Locator(locator, **kwargs) self.xaxis.set_minor_locator(locator) def set_xticklabels(self, formatter, **kwargs): formatter = axistools.Formatter(formatter, **kwargs) self.xaxis.set_major_formatter(formatter) ... Then to encourage using the batch setters, we can concatenate docstrings from each individual setter: # Documentation builder def _get_setter_docs(self): # Maybe just retrieve first sentence of each docstring, # and look at `Axes._alias_map` for aliases! .... Axes.set.__doc__ = f""" Bulk update the axes. Parameters ----------- {_get_setter_docs(Axes)} """ # Results in the following docstring # (not sure how we can consistently get argument types though) """ Parameters ----------- xlim : (float, float), optional Call `~Axes.set_xlim`. Set the x-axis view limits. ylim : (float, float), optional Call `~Axes.set_ylim`. Set the y-axis view limits. ... etc ... """

Open Graph Description: Starting this PR to keep #63 on everyone's radar. Along with #50 and #45 this is one of the major (but mostly internal) changes I am considering for the version 1.0 release. ProPlot adds "...

X Description: Starting this PR to keep #63 on everyone's radar. Along with #50 and #45 this is one of the major (but mostly internal) changes I am considering for the version 1.0 release. ProPlot adds &a...

Opengraph URL: https://github.com/proplot-dev/proplot/pull/89

X: @github

direct link

Domain: patch-diff.githubusercontent.com

Links:

Viewport: width=device-width