10000 Added get_shape method by Lumijek · Pull Request #22510 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Added get_shape method #22510

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 5 commits into from
Closed

Added get_shape method #22510

wants to merge 5 commits into from

Conversation

Lumijek
Copy link
@Lumijek Lumijek commented Feb 19, 2022 •
edited
Loading

PR Summary

Added get_shape method and updated __str__ to AxesImage as specified by (#22494)

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [N/A ] New features are documented, with examples if plot related.
  • [N/A] 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).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

github-actions[bot]
github-actions bot reviewed Feb 19, 2022
View reviewed changes
Copy link
@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

oscargus
oscargus reviewed Mar 6, 2022
View reviewed changes
lib/matplotlib/image.py
Comment on lines +297 to +299
"""Return the shape of the image as
tuple (numrows, numcols, channels).
"""
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"""Return the shape of the image as
tuple (numrows, numcols, channels).
"""
"""
Return the shape of the image as tuple (numrows, numcols, channels).
"""

Copy link
Member

Choose a reason for hiding this comment

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

Can you use the numpydoc format for the returns?

Copy link
Author

Choose a reason for hiding this comment

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

I was going to do that but line length exceeded pep8 limit.

@oscargus
Copy link
Member
oscargus commented Mar 6, 2022

Please add tests for these changes.

You can example generate a test image as:

    ax = plt.gca()
    im = AxesImage(ax)
    z = np.arange(12, dtype=float).reshape((4, 3))
    im.set_data(z)

and then call the methods (in separate tests) and add an assert for the expected results. Add these tests to https://github.com/matplotlib/matplotlib/blob/main/lib/matplotlib/tests/test_image.py

@tacaswell tacaswell added this to the v3.6.0 milestone Mar 6, 2022
@tacaswell
Copy link
Member

Please do not merge the main branch into your feature branch (we prefer to rebase if there are conflicts).

@timhoffm
Copy link
Member

@Lumijek are you still planning to continue on this? If not, I'd pick this up so that it can move forward.

@jklymak jklymak marked this pull request as draft May 18, 2022 09:53
@jklymak
Copy link
Member
jklymak commented May 18, 2022

Moved to draft until someone picks this up.

@QuLogic QuLogic modified the milestones: v3.6.0, v3.7.0 Jul 5, 2022
@tacaswell tacaswell modified the milestones: v3.7.0, future releases Dec 21, 2022
@saranti
Copy link
Contributor
saranti commented Mar 10, 2023

It's been a while so I can write some tests for this. I don't know what the procedure is for picking up orphaned PRs though.

@rcomer
Copy link
Member
rcomer commented Mar 10, 2023

Thanks @saranti, basically just create a new branch and a new PR referencing this one. You could git cherry-pick the relevant commit from here into your branch, or just write your new branch from scratch, whichever you prefer.

@saranti saranti mentioned this pull request Mar 10, 2023
Merged
2 tasks
@tacaswell
Copy link
Member

Closing in favor of #25425

@tacaswell tacaswell closed this Mar 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell left review comments

@oscargus oscargus oscargus left review comments

@github-actions github-actions[bot] github-actions[bot] left review comments

Assignees
No one assigned
Labels
status: orphaned PR status: superseded topic: images
Projects
First Time Contributors
Status: Done
Milestone
future releases
Development

Successfully merging this pull request may close these issues.
9 participants
@Lumijek @oscargus @tacaswell @timhoffm @jklymak @saranti @rcomer @QuLogic @anntzer
0