MNT: Deprecate get_upper_air_data #519

jrleeman · 2017-07-19T22:03:26Z

Use the matplotlib deprecation framework and deprecate get_upper_air_data. We can/should decide on which version that is official. Closes #516

dopplershift · 2017-07-21T05:12:28Z

Not wild about adding a top-level metpy.deprecation module. Can we move to cbook?

jrleeman · 2017-07-21T13:56:08Z

We could. It's a decent chunk of code and seemed well encapsulated in its own module. What are the cons of having it separate in this case?

dopplershift · 2017-07-21T15:43:06Z

I wasn't wild about having a top-level metpy.deprecation module. I guess there's no harm since we don't have to put it in the API docs.

dopplershift

There's at least one flake8 failure. Also, it would be good for the top of deprecation.py to have the Matplotlib license.

jrleeman · 2017-07-21T15:47:06Z

Yep, flake8 needs some help, on the list for today hopefully. I'm not dead set on it being a separate module, but seemed like a nice unit of code that made more sense this way than as part of cbook.

dopplershift · 2017-07-21T20:36:19Z

metpy/deprecation.py

@@ -0,0 +1,316 @@
+# Copyright (c) 2008-2017 MetPy Developers.


Might be better to blacklist the license check for this file in setup.cfg rather than, essentially, an incorrect block before the proper one. It could then go back to being a comment.

dopplershift · 2017-07-21T20:37:08Z

metpy/io/upperair.py



+@deprecated('0.8', addendum=' This function is being moved to the Siphon package.',
+            pending=True)


Why pending? Doesn't pending mean "this will soon be deprecated"? Rather than, this will be deprecated in 0.6 and removed in 0.8?

Pending Message:

/Users/johnleeman/miniconda3/envs/metpydev/lib/python3.6/site-packages/ipykernel_launcher.py:5: MetpyDeprecationWarning: The get_upper_air_data function will be deprecated in a future version. This function is being moved to the Siphon package.

Without pending:

/Users/johnleeman/miniconda3/envs/metpydev/lib/python3.6/site-packages/ipykernel_launcher.py:5: MetpyDeprecationWarning: The get_upper_air_data function was deprecated in version 0.8. This function is being moved to the Siphon package.

Then I'd say change the version to '0.6' and leave it as not pending since it's not actually pending--it's done.

I was thinking of it as pending since it's still in MetPy, but I see what you're saying. Update coming.

jrleeman · 2017-08-04T20:35:17Z

Do we want to move on this in 0.6 @dopplershift - with the functionality not being in Siphon yet?

dopplershift · 2017-08-04T20:50:30Z

No, the plan was to cut another Siphon release before the MetPy release.

jrleeman · 2017-08-07T14:10:58Z

So, yes we want to move on it 😉 Sounds good.

stickler-ci · 2017-08-07T17:06:59Z

metpy/deprecation.py

+            def finalize(wrapper, new_doc):
+                try:
+                    pass
+                    #obj.__doc = new_doc


E265 block comment should start with '# '

stickler-ci · 2017-08-07T17:07:00Z

metpy/deprecation.py

+
+                def finalize(wrapper, new_doc):
+                    wrapper = functools.wraps(func)(wrapper)
+                    #wrapper.__doc__ = new_doc


E265 block comment should start with '# '

stickler-ci · 2017-08-07T17:07:00Z

metpy/deprecation.py

+
+                def finalize(wrapper, new_doc):
+                    wrapper = functools.wraps(func)(wrapper)
+                    #wrapper.__doc__ = new_doc


E265 block comment should start with '# '

jrleeman · 2017-08-07T17:07:06Z

I'll squash down once you have a look - wanted to make the diff easier to see.

dopplershift

Looks good now. Just squash down.

dopplershift · 2017-08-24T23:01:03Z

I think this is on hold until we have the final resting place for the upper air code in siphon.

jrleeman · 2017-09-13T13:10:38Z

@dopplershift - Should be good to go. I think we're safe ignoring codecov/codacy as the dep tool is straight from matplotlib.

dopplershift requested changes Jul 21, 2017

View reviewed changes

jrleeman force-pushed the Upperair_Warning branch from e174225 to 90a869f Compare July 21, 2017 20:13

dopplershift requested changes Jul 21, 2017

View reviewed changes

dopplershift reviewed Jul 21, 2017

View reviewed changes

jrleeman force-pushed the Upperair_Warning branch from 90a869f to 8e7fef8 Compare July 21, 2017 20:57

dopplershift added Area: IO Pertains to reading data Type: API Change Changes to how existing functionality works Type: Maintenance Updates and clean ups (but not wrong) labels Jul 21, 2017

dopplershift added this to the 0.6 milestone Jul 21, 2017

jrleeman force-pushed the Upperair_Warning branch from 8e7fef8 to 09b2c94 Compare August 7, 2017 14:28

stickler-ci reviewed Aug 7, 2017

View reviewed changes

metpy/deprecation.py Outdated

def finalize(wrapper, new_doc):

try:

pass

#obj.__doc = new_doc

Copy link

stickler-ci Aug 7, 2017

Choose a reason for hiding this comment

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

E265 block comment should start with '# '

stickler-ci reviewed Aug 7, 2017

View reviewed changes

dopplershift approved these changes Aug 7, 2017

View reviewed changes

jrleeman force-pushed the Upperair_Warning branch from 929cb21 to ce002de Compare August 8, 2017 13:18

jrleeman added Status: Needs Review Pull request needs review Status: Team Discussion Development team needs to discuss issue to decide how to proceed and removed Status: Needs Review Pull request needs review labels Aug 8, 2017

jrleeman force-pushed the Upperair_Warning branch from ce002de to 4161fb0 Compare August 23, 2017 14:46

jrleeman removed the Status: Team Discussion Development team needs to discuss issue to decide how to proceed label Aug 23, 2017

jrleeman force-pushed the Upperair_Warning branch from 4161fb0 to 7d39ab8 Compare September 12, 2017 19:39

jrleeman added 2 commits September 12, 2017 15:39

Add deprecation helper

e85c364

MNT: Deprecate get_upper_air_data

4b0b6c8

jrleeman force-pushed the Upperair_Warning branch from 7d39ab8 to 4b0b6c8 Compare September 12, 2017 21:39

dopplershift merged commit b29d102 into Unidata:master Sep 13, 2017

jrleeman deleted the Upperair_Warning branch September 26, 2017 21:43

jrleeman restored the Upperair_Warning branch September 26, 2017 21:43

jrleeman deleted the Upperair_Warning branch September 26, 2017 21:47

wholmgren mentioned this pull request Feb 19, 2018

add get_[relative_airmass,sky_diffuse,ground_diffuse,extra_radiation,total_irradiance] and pvlibDeprecationWarning pvlib/pvlib-python#427

Merged

6 tasks

		@@ -0,0 +1,316 @@
		# Copyright (c) 2008-2017 MetPy Developers.



		@deprecated('0.8', addendum=' This function is being moved to the Siphon package.',
		pending=True)

MNT: Deprecate get_upper_air_data #519

MNT: Deprecate get_upper_air_data #519

Uh oh!

Conversation

jrleeman commented Jul 19, 2017

Uh oh!

dopplershift commented Jul 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jrleeman commented Jul 21, 2017

Uh oh!

dopplershift commented Jul 21, 2017

Uh oh!

dopplershift left a comment

Choose a reason for hiding this comment

Uh oh!

jrleeman commented Jul 21, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrleeman commented Aug 4, 2017

Uh oh!

dopplershift commented Aug 4, 2017

Uh oh!

jrleeman commented Aug 7, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrleeman commented Aug 7, 2017

Uh oh!

dopplershift left a comment

Choose a reason for hiding this comment

Uh oh!

dopplershift commented Aug 24, 2017

Uh oh!

jrleeman commented Sep 13, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dopplershift commented Jul 21, 2017 •

edited

Loading