Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "properties" to all matplotlib artists #168

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

lukelbd
Copy link
Collaborator

@lukelbd lukelbd commented May 16, 2020

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:

# Original API
fig, 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 merged
fig, ax = proplot.subplots()
ax.format(title='Title', xlabel='xlabel', xticks=[1, 2, 3])  # with bulk setter
ax.title = 'Title'  # with individual setters
ax.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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant