Skip to content

Deprecate rcParams["datapath"] in favor of mpl.get_data_path().#16417

Closed
anntzer wants to merge 1 commit intomatplotlib:masterfrom
anntzer:deprecate-rcdatapath
Closed

Deprecate rcParams["datapath"] in favor of mpl.get_data_path().#16417
anntzer wants to merge 1 commit intomatplotlib:masterfrom
anntzer:deprecate-rcdatapath

Conversation

@anntzer
Copy link
Copy Markdown
Contributor

@anntzer anntzer commented Feb 5, 2020

The rcParam cannot be meaningfully set by the end user from their
matplotlibrc or Python code.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer anntzer added this to the v3.3.0 milestone Feb 5, 2020
@anntzer anntzer force-pushed the deprecate-rcdatapath branch 2 times, most recently from 8059bdf to 7c7e3e7 Compare February 5, 2020 13:39
@anntzer anntzer force-pushed the deprecate-rcdatapath branch from 7c7e3e7 to 9c5733e Compare February 11, 2020 23:45
@anntzer anntzer force-pushed the deprecate-rcdatapath branch from 9c5733e to d63442e Compare March 5, 2020 14:37
@anntzer anntzer mentioned this pull request Mar 5, 2020
Closed
@anntzer anntzer modified the milestones: v3.3.0, v3.2.1 Mar 5, 2020
@anntzer anntzer added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Mar 5, 2020
@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Mar 5, 2020

Should probably have made it to 3.2 instead due to #16678 (#14401), so I milestoned this to 3.2.1. If we agree about the remilestone I will update the version numbers in the diffs.

@tacaswell
Copy link
Copy Markdown
Member

tacaswell commented Mar 10, 2020

👍 but the deprecation notes should go in the 3.2 file.

I don't think this is going to backport cleanly as the "pull defaults from the sample file" logic is not on the 3.2.x branch. It may have to be re-written on that branch.

@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Mar 10, 2020 •
edited
Loading

that's fine, I'll open a separate pr for 3.2.1.
edit: done at #16722; also moved the deprecation note.

@anntzer anntzer mentioned this pull request Mar 10, 2020
Merged
6 tasks
@anntzer anntzer force-pushed the deprecate-rcdatapath branch from d63442e to a4a0925 Compare March 10, 2020 21:06
@anntzer anntzer modified the milestones: v3.2.1, v3.3.0 Mar 10, 2020
QuLogic
QuLogic requested changes Mar 16, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

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

This needs to be synced with changes in #16722 before merging, or just left for the branch merge up.

@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Mar 16, 2020

let's wait for that other pr to be merged

@anntzer anntzer force-pushed the deprecate-rcdatapath branch from a4a0925 to 4c51645 Compare March 18, 2020 23:27
@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Mar 18, 2020

looks like all's left after the rebase is just the changelog note?

@tacaswell
Copy link
Copy Markdown
Member

tacaswell commented Mar 18, 2020

We should back out most of the changes from #16722

@anntzer anntzer force-pushed the deprecate-rcdatapath branch from 4c51645 to c2451c6 Compare March 18, 2020 23:37
@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Mar 18, 2020

Ah, I see, done.

tacaswell
tacaswell reviewed Mar 18, 2020
View reviewed changes
@anntzer
Deprecate rcParams["datapath"] in favor of mpl.get_data_path().
0cf039c 
The rcParam cannot be meaningfully set by the end user from their
matplotlibrc or Python code.
@anntzer anntzer force-pushed the deprecate-rcdatapath branch from c2451c6 to 0cf039c Compare March 18, 2020 23:58
@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented Apr 1, 2020

Commit message needs updating.

@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Apr 1, 2020

I guess I vaguely lost track of the deprecation status here. The diff says "remove the datapath" kwarg, but it's clearly not actually removed, just deprecated? so this just removes the ability to set it in the matplotlibrc. But perhaps in that case we may as well wait for the entire deprecation period to be elapsed and strip out the rcparam all at once?

@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented Apr 1, 2020

So just wait for 3.4 then, and remove it all?

@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Apr 1, 2020

I guess so, @tacaswell?

@tacaswell tacaswell modified the milestones: v3.3.0, v3.4.0 Apr 29, 2020
@tacaswell
Copy link
Copy Markdown
Member

tacaswell commented Apr 29, 2020

Re-milestoned to 3.4 as this is going to take some time to sort out and remind our selves what is going on and it is better to leave a deprecating thing sitting around warning for an extra cycle that it is to pull the rug out from under someone accidentally.

@tacaswell tacaswell removed the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Apr 29, 2020
@QuLogic QuLogic mentioned this pull request Apr 29, 2020
Merged
2 tasks
@QuLogic QuLogic added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Jan 21, 2021
@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented Jan 22, 2021

@tacaswell @anntzer can you figure out what needs to be done here?

@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Jan 22, 2021

Are we fine with completely stripping out rcParams["datapath"] for 3.4? if so I can post a PR.

tacaswell
tacaswell reviewed Jan 22, 2021
View reviewed changes
doc/api/next_api_changes/removals.rst
- The ``pgf.debug``, ``verbose.fileo`` and ``verbose.verbose.level`` rcParams,
which had no effect, have been removed.
- Support for setting :rc:`mathtext.default` to "circled" has been removed.
- The ``datapath`` rcParam has been removed. Use `.get_data_path` instead.
Copy link
Copy Markdown
Member

@tacaswell tacaswell Jan 22, 2021

Choose a reason for hiding this comment

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

Suggested change
- The ``datapath`` rcParam has been removed. Use `.get_data_path` instead.
- The ``datapath`` rcParam is ignored. Use `.get_data_path` instead.

@tacaswell
Copy link
Copy Markdown
Member

tacaswell commented Jan 22, 2021

Yes to stripping out datapath for 3.4, we have given fair warning on this.

@anntzer anntzer mentioned this pull request Jan 22, 2021
Merged
7 tasks
@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Jan 22, 2021

Superseded by #19340.

@anntzer anntzer closed this Jan 22, 2021
@anntzer anntzer deleted the deprecate-rcdatapath branch January 22, 2021 18:16
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

@QuLogic QuLogic QuLogic requested changes

@timhoffm timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.

Projects

None yet

Milestone

v3.4.0

Development

Successfully merging this pull request may close these issues.

4 participants

@anntzer @tacaswell @QuLogic @timhoffm