Removed the deprecated code from offsetbox.py #26910

jpgianfaldoni · Sep 25, 2023

PR summary

This PR removes the deprecated code during the version 3.7 from lib/matplotlib/offsetbox.py which is a sub issue in the parent issues here: #26865
-->

PR checklist

[N/A ] "closes #0000" is in the body of the PR description to link the related issue
[N/A] new and changed code is tested
[N/A] Plotting related features are demonstrated in an example
New Features and API Changes are noted with a directive and release note
[N/A] Documentation complies with general and docstring guidelines

github-actions

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. 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.

ksunden

Just a bit of an adjustment to the release note,

These methods have alternatives that should be mentioned here, though you can largely copy/paste from the deprecation notice, just reflecting that they are removed rather than deprecated

ksunden · Sep 25, 2023

doc/api/next_api_changes/removals/26910-JP.rst

+``bbox_artist``
+~~~~~~~~~~~~~~~~
+... of `matplotlib.offsetbox` is removed without replacements.
+``get_extent_offsets``
+~~~~~~~~~~~~~~~~~~~~~~~
+
+... of `matplotlib.offsetbox` is removed without replacements.
+``get_extent``
+~~~~~~~~~~~~~~~
+... of `matplotlib.offsetbox` is removed without replacements.


All of these have alternatives that are mentioned in the deprecation decorator, so they are not removed "without replacements"

See the deprecation note, which can be modified to reflect the "removed" rather than "deprecated":

matplotlib/doc/api/prev_api_changes/api_changes_3.7.0/deprecations.rst

Lines 211 to 215 in 6028039

``offsetbox.bbox_artist``

~~~~~~~~~~~~~~~~~~~~~~~~~

... is deprecated. This is just a wrapper to call `.patches.bbox_artist` if a

flag is set in the file, so use that directly if you need the behavior.

matplotlib/doc/api/prev_api_changes/api_changes_3.7.0/deprecations.rst

Lines 191 to 201 in 6028039

``OffsetBox.get_extent_offsets`` and ``OffsetBox.get_extent``

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

... are deprecated; these methods are also deprecated on all subclasses of

`.OffsetBox`.

To get the offsetbox extents, instead of ``get_extent``, use

`.OffsetBox.get_bbox`, which directly returns a `.Bbox` instance.

To also get the child offsets, instead of ``get_extent_offsets``, separately

call `~.OffsetBox.get_offset` on each children after triggering a draw.

@ksunden changed the rst file to reflect the requested changes. Please let me know if any more modifications are needed.

doc/api/next_api_changes/removals/26910-JP.rst

Co-authored-by: Kyle Sunden <git@ksunden.space>

rcomer

Just a couple of very minor things!

doc/api/next_api_changes/removals/26910-JP.rst

Co-authored-by: Ruth Comer <10599679+rcomer@users.noreply.github.com>

rcomer

Thanks @jpgianfaldoni! This can be merged once the checks pass again.

QuLogic · Sep 25, 2023

Thanks @jpgianfaldoni! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again.

jpgianfaldoni added 3 commits September 25, 2023 08:39

Removed the deprecated code from offsetbox.py

a9c3dae

fix spacing

6398fcc

add rst file

a1224ca

github-actions bot reviewed Sep 25, 2023

View reviewed changes

fix title underline

c56ae38

ksunden requested changes Sep 25, 2023

View reviewed changes

jpgianfaldoni added 2 commits September 25, 2023 14:36

fix rst file

f46584d

make lowercase

1aaf489

ksunden reviewed Sep 25, 2023

View reviewed changes

doc/api/next_api_changes/removals/26910-JP.rst Outdated Show resolved Hide resolved

Update doc/api/next_api_changes/removals/26910-JP.rst

4de81d6

Co-authored-by: Kyle Sunden <git@ksunden.space>

jpgianfaldoni requested a review from ksunden September 25, 2023 18:01

ksunden approved these changes Sep 25, 2023

View reviewed changes

rcomer reviewed Sep 25, 2023

View reviewed changes

doc/api/next_api_changes/removals/26910-JP.rst Outdated Show resolved Hide resolved

Update doc/api/next_api_changes/removals/26910-JP.rst

93f9e3a

Co-authored-by: Ruth Comer <10599679+rcomer@users.noreply.github.com>

jpgianfaldoni requested a review from rcomer September 25, 2023 19:34

rcomer approved these changes Sep 25, 2023

View reviewed changes

QuLogic added mentored: hackathon Maintenance labels Sep 25, 2023

QuLogic merged commit 8491561 into matplotlib:main Sep 25, 2023

This was referenced Sep 25, 2023

Updated offsetbox.py #26880

Closed

[MNT]: Remove 3.7-deprecated API #26865

Closed

ksunden added this to the v3.9.0 milestone Mar 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Removed the deprecated code from offsetbox.py #26910

Removed the deprecated code from offsetbox.py #26910

Uh oh!

jpgianfaldoni commented Sep 25, 2023 •

edited

Loading

Uh oh!

github-actions bot left a comment

Uh oh!

ksunden left a comment

Uh oh!

ksunden Sep 25, 2023

Uh oh!

jpgianfaldoni Sep 25, 2023

Uh oh!

Uh oh!

rcomer left a comment

Uh oh!

Uh oh!

rcomer left a comment

Uh oh!

QuLogic commented Sep 25, 2023

Uh oh!

Uh oh!

	``offsetbox.bbox_artist``
	~~~~~~~~~~~~~~~~~~~~~~~~~

	... is deprecated. This is just a wrapper to call `.patches.bbox_artist` if a
	flag is set in the file, so use that directly if you need the behavior.

	``OffsetBox.get_extent_offsets`` and ``OffsetBox.get_extent``
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

	... are deprecated; these methods are also deprecated on all subclasses of
	`.OffsetBox`.

	To get the offsetbox extents, instead of ``get_extent``, use
	`.OffsetBox.get_bbox`, which directly returns a `.Bbox` instance.

	To also get the child offsets, instead of ``get_extent_offsets``, separately
	call `~.OffsetBox.get_offset` on each children after triggering a draw.

Search code, repositories, users, issues, pull requests...

Uh oh!

Removed the deprecated code from offsetbox.py #26910

Removed the deprecated code from offsetbox.py #26910

Uh oh!

Conversation

jpgianfaldoni commented Sep 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR summary

PR checklist

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

ksunden left a comment

Choose a reason for hiding this comment

Uh oh!

ksunden Sep 25, 2023

Choose a reason for hiding this comment

Uh oh!

jpgianfaldoni Sep 25, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rcomer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rcomer left a comment

Choose a reason for hiding this comment

Uh oh!

QuLogic commented Sep 25, 2023

Uh oh!

Uh oh!

jpgianfaldoni commented Sep 25, 2023 •

edited

Loading