Needed for#18544 (GSOD). Some new machinery was needed to add the deprecation while keeping the existing API (namely, the ability to accessvalidJoin as a class property directly, i.e.Line2D.validJoin), so I pulled the necessary code out into this PR.

These properties already have long-existing comments marking them as "only there for backwards compatibility", and deprecation was initially suggested by@QuLogic.

PR Checklist

Has pytest style unit tests (andpytest passes).
IsFlake 8 compliant (runflake8 on changed files to check).
[N/A] New features are documented, with examples if plot related.
Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
Conforms to Matplotlib style conventions (installflake8-docstrings and runflake8 --docstring-convention=all).
[N/A] New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).

brunobeltran force-pushed thedeprecate_valid_joincap branch fromb884fe9 toc505b7bCompare

October 26, 2020 16:39

brunobeltran added the Maintenance label

Oct 26, 2020

brunobeltran mentioned this pull request

Oct 26, 2020

REORG: JoinStyle and CapStyle classes#18544

Merged

5 tasks

QuLogic added the status: needs rebase label

Oct 27, 2020

QuLogic reviewed

Oct 27, 2020

View reviewed changes

Copy link

Member

QuLogic left a comment

Choose a reason for hiding this comment

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

We don't normally put a full version number with micro component.

lib/matplotlib/lines.py OutdatedShow resolvedHide resolved

lib/matplotlib/patches.py OutdatedShow resolvedHide resolved

Copy link

Member

QuLogic commentedOct 27, 2020

I would also maybe wait until deprecation machinery is properly exposed from_api, so as to not introduce morecbook usage.

brunobeltran force-pushed thedeprecate_valid_joincap branch 3 times, most recently from4f55d60 to384d96aCompare

October 27, 2020 20:41

brunobeltran requested a review fromQuLogic

October 27, 2020 20:41

brunobeltran removed the status: needs rebase label

Oct 27, 2020

Copy link

ContributorAuthor

brunobeltran commentedOct 27, 2020

I would also maybe wait until deprecation machinery is properly exposed from_api, so as to not introduce morecbook usage.

Should be clean of any new references tocbook now.

Copy link

Member

QuLogic commentedOct 29, 2020

Based on#18823, I'm not sure that's the way@timhoffm wants to go, but it's still not ready yet.

brunobeltran force-pushed thedeprecate_valid_joincap branch from384d96a tod9674c3Compare

November 3, 2020 19:44

Copy link

ContributorAuthor

brunobeltran commentedNov 3, 2020•
edited
Loading

@timhoffm Can you review whether this is the way you want_api.deprecation to be used moving forward? It sounds like otherwise,~~this might be ready?~~

Copy link

ContributorAuthor

brunobeltran commentedNov 3, 2020

Per the call, this should wait until I silence the deprecation warnings this emits in conf.py, specifically for autodoc.

brunobeltran force-pushed thedeprecate_valid_joincap branch 2 times, most recently fromc6c3cd6 toaed162fCompare

November 5, 2020 01:16

Copy link

ContributorAuthor

brunobeltran commentedNov 5, 2020

Extra warnings have been quenched inconf.py. Thankfullywarnings allows enough specificity to explicit ask it to ignorejustMatplotlibDeprecationWarnings coming specifically from thesphinx.util.inspect module.

QuLogic reviewed

Nov 5, 2020

View reviewed changes

doc/conf.py OutdatedShow resolvedHide resolved

lib/matplotlib/_api/deprecation.py Outdated

		@@ -16,6 +16,42 @@
		import warnings


		# has to be here (instead of cbook) to prevent circular import, since
		# deprecation.deprecated is used during cbook's import
		class _classproperty:

Copy link

Member

QuLogicNov 5, 2020

Choose a reason for hiding this comment

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

Since_api is already private.

Suggested change

	class_classproperty:
	classclassproperty:

Also, this isn't actually a deprecation; does it belong in this file, or in_api/__init__.py?

Copy link

ContributorAuthor

brunobeltranNov 5, 2020

Choose a reason for hiding this comment

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

Most of the functions in_api.deprecation are still underscore delimited for direct importing intocbook.deprecation, happy to fix this one as long as you guys (@timhoffm) are cool with me sending in another PR to do this to the rest of the methods in_api, since I would feel gross if we end up with some random combination of underscores and no underscores.

Copy link

ContributorAuthor

brunobeltranNov 5, 2020

Choose a reason for hiding this comment

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

Oh, almost missed your other question. It should be in__init__ now thatdeprecation isn't incbook there's no more import-time circular stuff that can't be avoided by a local import.