FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

FIX: better error message for shared axes and axis('equal') by jklymak · Pull Request #21318 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

FIX: better error message for shared axes and axis('equal') - #21318

Merged
timhoffm merged 3 commits into
matplotlib:mainfrom
jklymak:fix-improve-shared-aspect-error
Nov 23, 2021
ConversationCommits (3)ChecksFiles changed
Merged

FIX: better error message for shared axes and axis('equal')#21318
timhoffm merged 3 commits into
matplotlib:mainfrom
jklymak:fix-improve-shared-aspect-error

Conversation

jklymak commented Oct 8, 2021

Copy link
Copy Markdown
Member

PR Summary

Closes #11416

The error message was pretty mysterious if you called ax.axis('equal') on a shared axes...

Not clear that the functionality users are trying to get from this could not be provided, but at least clarifying the error message will help...

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

jklymak added the API: argument checking Validation of acceptable argument values label Oct 8, 2021
jklymak force-pushed the fix-improve-shared-aspect-error branch from 5b2ad5d to 5d37e45 Compare October 15, 2021 14:49
timhoffm reviewed Oct 16, 2021
View reviewed changes
Comment thread lib/matplotlib/axes/_base.py Outdated

tacaswell commented Oct 20, 2021

Copy link
Copy Markdown
Member

This PR is affected by a re-writing of our history to remove a large number of accidentally committed files see discourse for details.

To recover this PR it will need be rebased onto the new default branch (main). There are several ways to accomplish this, but we recommend (assuming that you call the matplotlib/matplotlib remote "upstream"

git remote update
git checkout main
git merge --ff-only upstream/main
git checkout YOUR_BRANCH
git rebase --onto=main upstream/old_master
# git rebase -i main # if you prefer
git push --force-with-lease   # assuming you are tracking your branch

If you do not feel comfortable doing this or need any help please reach out to any of the Matplotlib developers. We can either help you with the process or do it for you.

Thank you for your contributions to Matplotlib and sorry for the inconvenience.

jklymak force-pushed the fix-improve-shared-aspect-error branch from 5d37e45 to 400445a Compare October 20, 2021 20:34
jklymak force-pushed the fix-improve-shared-aspect-error branch from 400445a to 2ad34af Compare October 20, 2021 20:39

jklymak commented Oct 20, 2021

Copy link
Copy Markdown
Member Author

-- rebased

QuLogic reviewed Oct 20, 2021
View reviewed changes
Comment thread lib/matplotlib/axes/_base.py Outdated
Comment on lines +2052 to +2053
raise RuntimeError("'equal' is not allowed on shared "
"axes, try 'scaled' instead.")

QuLogic Oct 20, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Is the original exception important here, or should we do from None here?

greglucas Nov 23, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Is it a RunTimeError that we want to re-raise here, or should we change it to ValueError instead since you are saying that value isn't allowed?

jklymak Nov 23, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

As above, I'm not sure I can even trigger this so lets try removing...

tacaswell added this to the v3.6.0 milestone Oct 20, 2021
timhoffm reviewed Nov 23, 2021
View reviewed changes
Comment thread lib/matplotlib/axes/_base.py Outdated
self.set_aspect('equal', adjustable='datalim')
try:
self.set_aspect('equal', adjustable='datalim')
except RuntimeError:

timhoffm Nov 23, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

We only want to catch the above exception, right? Technically, we should make sure not to catch other RuntimeErrors here, either by inspecting the message or by using a custom exception above.

But I'm not sure if we have to be that pedantic. Catching the wrong exception does not change control flow, it could only issue a non-instructive error message.

jklymak Nov 23, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

OK, looking back at it now, I'm not sure what this is supposed to catch. set_aspect does not call apply_aspect, and apply_aspect is only called at draw time so far as I can tell. I couldn't figure out a test for this, so lets see if anything fails just removing it again.

jklymak Nov 23, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Confirmed, this doesn't fail any tests - so I'm not even sure this was reachable. Sorry I don't remember what prompted this int he first place!

timhoffm merged commit 73304d2 into matplotlib:main Nov 23, 2021
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

QuLogic QuLogic left review comments
greglucas greglucas left review comments
tacaswell tacaswell approved these changes
timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

API: argument checking Validation of acceptable argument values

Projects

None yet

Milestone

v3.6.0

Development

Successfully merging this pull request may close these issues.

RuntimeError: adjustable='datalim' is not allowed when both axes are shared.

5 participants

Back | FazBrowse Home | New Git URL