Removal of deprecations for Contour #26907

DHClimber · 2023-09-24T23:39:44Z

PR summary

This change is related to [MNT]: Remove 3.7-deprecated API
#26865

This pull request removes deprecated classes and methods from contour.py and associated contour.pyi

"pre-commit.ci autofix"

PR checklist

"closes #0000" is in the body of the PR description to link the related issue
new and changed code is tested
Plotting related features are demonstrated in an example
New Features and API Changes are noted with a directive and release note
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

The code that has been removed is not needed in the removal note, please refer to the deprecation note, which can be copy/pasted and updated to reflect the removal rather than deprecation:

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

Lines 113 to 127 in 6028039

    
           ``contour.ClabelText`` and ``ContourLabeler.set_label_props`` 
        
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
        
           ... are deprecated. 
        
           Use ``Text(..., transform_rotates_text=True)`` as a replacement for 
        
           ``contour.ClabelText(...)`` and ``text.set(text=text, color=color, 
        
           fontproperties=labeler.labelFontProps, clip_box=labeler.axes.bbox)`` as a 
        
           replacement for the ``ContourLabeler.set_label_props(label, text, color)``. 
        
           ``ContourLabeler`` attributes 
        
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
        
           The ``labelFontProps``, ``labelFontSizeList``, and ``labelTextsList`` 
        
           attributes of `.ContourLabeler` have been deprecated.  Use the ``labelTexts`` 
        
           attribute and the font properties of the corresponding text objects instead.

Additionally, please rename the file with the PR number rather than 00001.

ksunden

Do you feel comfortable squashing the commits to avoid adding and removing the changelog file?

Other than that, just a bit of clean up of the changelog file left

ksunden · 2023-09-26T03:14:35Z

doc/api/next_api_changes/removals/26907-DCH.rst

+Removal change template
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Enter description of methods/classes removed here....
+


Suggested change

Removal change template

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

Enter description of methods/classes removed here....

ksunden · 2023-09-26T03:15:24Z

doc/api/next_api_changes/removals/26907-DCH.rst

+Please rename file with PR number and your initials i.e. "99999-ABC.rst"
+and ``git add`` the new file.


Suggested change

Please rename file with PR number and your initials i.e. "99999-ABC.rst"

and ``git add`` the new file.

This is missing the body of that change note

DHClimber · 2023-09-26T04:29:12Z

Do you feel comfortable squashing the commits to avoid adding and removing the changelog file?

Other than that, just a bit of clean up of the changelog file left

Thanks for the feedback, I'll try to figure it out. This is my first time and I'm not familiar with squashing, but I'll try.

doc/api/next_api_changes/removals/26907-DCH.rst

ksunden · 2023-09-26T04:36:25Z

We have some docs on squashing via git rebase -i:

https://matplotlib.org/stable/devel/development_workflow.html#rewrite-commit-history

ksunden · 2023-09-26T04:37:19Z

Also remove from the corresponding .pyi file, please

DHClimber · 2023-09-26T04:55:00Z

We have some docs on squashing via git rebase -i:

https://matplotlib.org/stable/devel/development_workflow.html#rewrite-commit-history

Thanks, I think I figured it out.

DHClimber · 2023-09-26T11:18:45Z

It shows one test failing Mypy. I'm having trouble understanding what the issue is, any suggestions on what I need to do to correct?

rcomer · 2023-09-26T11:23:28Z

I agree the Mypy message could be clearer, but I think it’s just that you have removed some methods from the .py file that you have not yet removed from the .pyi file.

ksunden

Just some lint things, if you can sqaush again, that might be ideal as well, though we can also just do that on merge

ksunden · 2023-09-27T01:46:37Z

doc/api/next_api_changes/removals/26907-DCH.rst

+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The ``labelFontProps``, ``labelFontSizeList``, and ``labelTextsList``
+attributes of `.ContourLabeler` have been removed.  Use the ``labelTexts``
+attribute and the font properties of the corresponding text objects instead.


Suggested change

attribute and the font properties of the corresponding text objects instead.

attribute and the font properties of the corresponding text objects instead.

ksunden · 2023-09-27T01:46:50Z

lib/matplotlib/contour.py

@@ -1909,4 +1871,4 @@ def _initialize_x_y(self, z):
   <https://en.wikipedia.org/wiki/Marching_squares>`_ algorithm to
   compute contour locations.  More information can be found in
   `ContourPy documentation <https://contourpy.readthedocs.io>`_.
-""" % _docstring.interpd.params)
+""" % _docstring.interpd.params)


Suggested change

""" % _docstring.interpd.params)

""" % _docstring.interpd.params)

QuLogic · 2023-09-27T02:55:09Z

stubtest is still complaining; the entries corresponding to the removed ones need to be removed from the .pyi file as well. You can see its comments on the Files changed tab.

stubtest failures still

DHClimber · 2023-09-28T15:56:38Z

I'm completely lost at this point. I don't understand where all the problems are coming from.

ksunden · 2023-09-28T18:50:03Z

You seem to have done the (roughly) same thing you did previously regarding rebasing.

If you only have the last commit, it looks correct (though I would want CI to run to be sure).

One issue is that main has also updated the inheritance-diagram that you had to update, which is causing a conflict.

Unfortunately that is one big long line that makes it hard to tell what the differences are:

It was edited in #26874, which removed the BrokenBarHCollection, so both that and CLabelText should be removed.

The following should resolve it:

git rebase --onto upstream/main HEAD~1
# Resolve the conflict noted above, leaving that line in once, the git `>>>>`/`====`/`<<<<` lines removed, etc and both entries to be removed left out
$EDITOR doc/api/artist_api.rst
git add doc/api/artist_api.rst
git rebase --continue
# Edit commit message
git push --force-with-lease

If you'd rather we do it, I'm willing, but that is what I believe is needed.

DHClimber · 2023-09-28T18:55:17Z

e is that main has also updated the

Thanks, I'll give it one more try. Thanks for the patience.

QuLogic · 2023-10-03T08:00:06Z

@DHClimber it appears something messed up here, as you have only a single newline added to one file now. I think the correct commit is f448c0f. You can re-fetch that with (assuming you have the upstream remote as we recommend):

$ git fetch upstream f448c0fc73a624edf46806db961392518b365358:original-depreciated

Then you can reset your branch to it:

$ git checkout depreciated
$ git reset --hard original-depreciated

and push to replace it here:

$ git push --force-with-lease origin depreciated

DHClimber · 2023-10-07T15:37:10Z

@DHClimber it appears something messed up here, as you have only a single newline added to one file now. I think the correct commit is f448c0f. You can re-fetch that with (assuming you have the upstream remote as we recommend):
$ git fetch upstream f448c0fc73a624edf46806db961392518b365358:original-depreciated
Then you can reset your branch to it:
$ git checkout depreciated
$ git reset --hard original-depreciated
and push to replace it here:
$ git push --force-with-lease origin depreciated

Thank you, I have been out of town traveling. I'll try to fix now.

DHClimber · 2023-10-08T23:13:34Z

It seems like correct commit now, but I'm confused what is causing automated tests to fail. If anyone can provide a hint I'm happy to try and correct it.

melissawm · 2023-10-09T12:07:44Z

It looks like you have some conflicts - it may be that something didn't go right on your rebase. Could you try checking again? Here's relevant documentation, hope it helps: https://matplotlib.org/devdocs/devel/development_workflow.html#manage-commit-history

If you need extra help let us know.

DHClimber · 2023-10-10T03:10:38Z

It looks like you have some conflicts - it may be that something didn't go right on your rebase. Could you try checking again? Here's relevant documentation, hope it helps: https://matplotlib.org/devdocs/devel/development_workflow.html#manage-commit-history

If you need extra help let us know.

Sorry, I've tried everything I can think of but nothing is making sense. I can't understand where the conflicts are coming from, I'm just shooting in the dark now.

artist_api.rst error is complaining my branch doesn't match "main", but I don't understand why that is an error when the file needed to be updated?

ksunden · 2023-10-10T04:37:01Z

I think I should have cleaned that up, I actually had a branch from the first time I advised a rebase sitting on one of my machines that I had taken care of the conflicts on, so I just rebased that again and pushed it up

DHClimber · 2023-10-10T22:36:03Z

I think I should have cleaned that up, I actually had a branch from the first time I advised a rebase sitting on one of my machines that I had taken care of the conflicts on, so I just rebased that again and pushed it up

Thanks! I was so confused, didn't even know that was a possibility.

QuLogic · 2023-10-11T02:49:50Z

Can you update the commit message? It currently is an incomplete statement: 'removal of deprecated'. It would be better if it matched this PR title, for example.

fix pyi fix pyi

DHClimber · 2023-10-11T03:37:38Z

Can you update the commit message? It currently is an incomplete statement: 'removal of deprecated'. It would be better if it matched this PR title, for example.

Sorry about that, should be corrected now.

QuLogic · 2023-10-11T05:55:16Z

lib/matplotlib/contour.pyi

@@ -16,7 +16,7 @@ from collections.abc import Callable, Iterable, Sequence
 from typing import Literal
 from .typing import ColorType

-class ClabelText(Text): ...
+


Remove this line instead.

Suggested change

DHClimber · 2023-11-15T23:22:49Z

Just following up, is there anything else that needs to be done here?

QuLogic · 2023-11-16T01:37:08Z

We require two approvals before merges, so this is waiting for a second reviewer.

github-actions bot reviewed Sep 24, 2023

View reviewed changes

ksunden requested changes Sep 25, 2023

View reviewed changes

ksunden changed the title ~~deprecated~~ Removal of deprecations for Contour Sep 25, 2023

QuLogic added mentored: hackathon Maintenance topic: contour labels Sep 25, 2023

ksunden mentioned this pull request Sep 25, 2023

[MNT]: Remove 3.7-deprecated API #26865

Closed

14 tasks

ksunden requested changes Sep 26, 2023

View reviewed changes

ksunden reviewed Sep 26, 2023

View reviewed changes

doc/api/next_api_changes/removals/26907-DCH.rst Show resolved Hide resolved

DHClimber force-pushed the depreciated branch 2 times, most recently from 0e2d856 to 9c61e6c Compare September 26, 2023 04:50

ksunden requested changes Sep 27, 2023

View reviewed changes

ksunden previously approved these changes Sep 27, 2023

View reviewed changes

github-actions bot added the status: needs rebase label Sep 27, 2023

DHClimber force-pushed the depreciated branch 2 times, most recently from de41f99 to dcfc245 Compare September 28, 2023 15:47

DHClimber force-pushed the depreciated branch 2 times, most recently from dfa1c38 to 105d422 Compare September 29, 2023 02:01

github-actions bot removed the status: needs rebase label Sep 29, 2023

DHClimber force-pushed the depreciated branch from 105d422 to f448c0f Compare October 8, 2023 21:58

github-actions bot added the status: needs rebase label Oct 8, 2023

DHClimber force-pushed the depreciated branch 3 times, most recently from f9af810 to a4704ce Compare October 8, 2023 23:06

DHClimber force-pushed the depreciated branch 3 times, most recently from e1219d8 to 998783e Compare October 10, 2023 02:54

ksunden force-pushed the depreciated branch from 998783e to 9f1f4e4 Compare October 10, 2023 04:35

github-actions bot removed the status: needs rebase label Oct 10, 2023

Removal of deprecations for Contour

6355271

fix pyi fix pyi

ksunden force-pushed the depreciated branch from 9f1f4e4 to 6355271 Compare October 11, 2023 03:25

QuLogic added this to the v3.9.0 milestone Oct 11, 2023

QuLogic approved these changes Oct 11, 2023

View reviewed changes

ksunden approved these changes Nov 16, 2023

View reviewed changes

ksunden merged commit b16031c into matplotlib:main Nov 16, 2023
40 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Removal of deprecations for Contour #26907

Removal of deprecations for Contour #26907

DHClimber commented Sep 24, 2023 •

edited

github-actions bot left a comment

ksunden left a comment

ksunden left a comment

ksunden Sep 26, 2023

ksunden Sep 26, 2023

DHClimber commented Sep 26, 2023

ksunden commented Sep 26, 2023

ksunden commented Sep 26, 2023

DHClimber commented Sep 26, 2023

DHClimber commented Sep 26, 2023

rcomer commented Sep 26, 2023

ksunden left a comment

ksunden Sep 27, 2023

ksunden Sep 27, 2023

QuLogic commented Sep 27, 2023 •

edited

DHClimber commented Sep 28, 2023

ksunden commented Sep 28, 2023

DHClimber commented Sep 28, 2023

QuLogic commented Oct 3, 2023 •

edited

DHClimber commented Oct 7, 2023

DHClimber commented Oct 8, 2023

melissawm commented Oct 9, 2023

DHClimber commented Oct 10, 2023 •

edited

ksunden commented Oct 10, 2023

DHClimber commented Oct 10, 2023

QuLogic commented Oct 11, 2023

DHClimber commented Oct 11, 2023

QuLogic Oct 11, 2023

DHClimber commented Nov 15, 2023

QuLogic commented Nov 16, 2023

	``contour.ClabelText`` and ``ContourLabeler.set_label_props``
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	... are deprecated.

	Use ``Text(..., transform_rotates_text=True)`` as a replacement for
	``contour.ClabelText(...)`` and ``text.set(text=text, color=color,
	fontproperties=labeler.labelFontProps, clip_box=labeler.axes.bbox)`` as a
	replacement for the ``ContourLabeler.set_label_props(label, text, color)``.

	``ContourLabeler`` attributes
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

	The ``labelFontProps``, ``labelFontSizeList``, and ``labelTextsList``
	attributes of `.ContourLabeler` have been deprecated. Use the ``labelTexts``
	attribute and the font properties of the corresponding text objects instead.

		Please rename file with PR number and your initials i.e. "99999-ABC.rst"
		and ``git add`` the new file.

	""" % _docstring.interpd.params)
	""" % _docstring.interpd.params)

Removal of deprecations for Contour #26907

Removal of deprecations for Contour #26907

Conversation

DHClimber commented Sep 24, 2023 • edited

PR summary

PR checklist

github-actions bot left a comment

Choose a reason for hiding this comment

ksunden left a comment

Choose a reason for hiding this comment

ksunden left a comment

Choose a reason for hiding this comment

ksunden Sep 26, 2023

Choose a reason for hiding this comment

ksunden Sep 26, 2023

Choose a reason for hiding this comment

DHClimber commented Sep 26, 2023

ksunden commented Sep 26, 2023

ksunden commented Sep 26, 2023

DHClimber commented Sep 26, 2023

DHClimber commented Sep 26, 2023

rcomer commented Sep 26, 2023

ksunden left a comment

Choose a reason for hiding this comment

ksunden Sep 27, 2023

Choose a reason for hiding this comment

ksunden Sep 27, 2023

Choose a reason for hiding this comment

QuLogic commented Sep 27, 2023 • edited

DHClimber commented Sep 28, 2023

ksunden commented Sep 28, 2023

DHClimber commented Sep 28, 2023

QuLogic commented Oct 3, 2023 • edited

DHClimber commented Oct 7, 2023

DHClimber commented Oct 8, 2023

melissawm commented Oct 9, 2023

DHClimber commented Oct 10, 2023 • edited

ksunden commented Oct 10, 2023

DHClimber commented Oct 10, 2023

QuLogic commented Oct 11, 2023

DHClimber commented Oct 11, 2023

QuLogic Oct 11, 2023

Choose a reason for hiding this comment

DHClimber commented Nov 15, 2023

QuLogic commented Nov 16, 2023

DHClimber commented Sep 24, 2023 •

edited

QuLogic commented Sep 27, 2023 •

edited

QuLogic commented Oct 3, 2023 •

edited

DHClimber commented Oct 10, 2023 •

edited