This PR is related to #89 and adds @property setters and getters to every single Artist subclass. The core logic for this turns out to be surprisingly simple:
After this PR is merged proplot users will be able to use the much cleaner, more object-oriented "dot" syntax for changing matplotlib artist attributes:
# Original APIfig, ax=pyplot.subplots()
ax.set_title('Title')
ax.set_xlabel('xlabel')
ax.set_xticks([1, 2, 3])
h, =ax.plot(...)
h.set_color('red')
h.set_linewidth(1)
# ProPlot API if this is mergedfig, ax=proplot.subplots()
ax.format(title='Title', xlabel='xlabel', xticks=[1, 2, 3]) # with bulk setterax.title='Title'# with individual settersax.xlabel='xlabel'ax.xticks= [1, 2, 3]
h, =ax.plot(...)
h.color='red'h.linewidth=1
I am not sure about the side-effects of this -- the problem is this breaks classes that use instance-level attributes with the same names as the setters and getters (e.g. if an artist subclass both the getter get_linewidth() and the literal attribute linewidth), and the only way to address this is to go through the source code class-by-class and make explicit exceptions (which is quite fragile, since the attributes may change from version-to-version). Monkey patching is not possible because you cannot add properties as instance-level attributes.
This is a really neat PR, but it will require a lot of testing and it's not as high priority as some other PRs. So it may be quite a while before this is merged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is related to #89 and adds @property setters and getters to every single Artist subclass. The core logic for this turns out to be surprisingly simple:
https://github.com/lukelbd/proplot/blob/5d29f3148975e898452c4101dab6338e2908c50f/proplot/artist.py#L14-L50
After this PR is merged proplot users will be able to use the much cleaner, more object-oriented "dot" syntax for changing matplotlib artist attributes:
I am not sure about the side-effects of this -- the problem is this breaks classes that use instance-level attributes with the same names as the setters and getters (e.g. if an artist subclass both the getter get_linewidth() and the literal attribute linewidth), and the only way to address this is to go through the source code class-by-class and make explicit exceptions (which is quite fragile, since the attributes may change from version-to-version). Monkey patching is not possible because you cannot add properties as instance-level attributes.
This is a really neat PR, but it will require a lot of testing and it's not as high priority as some other PRs. So it may be quite a while before this is merged.