Add Deprecation support by tjprescott · Pull Request #6472 · Azure/azure-cli

Travis Prescott (tjprescott) · 2018-05-31T21:07:13Z

Closes #5954. Closes #5968. Closes #6059.

Deprecates (hides) the monitor autoscale-settings commands as well as the previously deprecated commands in redis: import-method, update-settings, list-all, and the patch-schedule patch-schedule group.

To be done:

Test extensions
Ref doc gen script

This checklist is used to make sure that common guidelines for a pull request are followed.

The PR has modified HISTORY.rst describing any customer-facing, functional changes. Note that this does not include changes only to help content. (see Modifying change log).
I adhere to the Command Guidelines.

Troy Dai (troydai) · 2018-06-04T16:02:14Z

Please take a look at the CI.

Troy Dai (troydai) · 2018-06-04T16:03:03Z

Many versions in setup.py will need to be updated once the 2.0.34 is released to the PyPI.

Codecov (codecov-io) · 2018-06-13T20:22:49Z

Codecov Report

Merging #6472 into dev will not change coverage.
The diff coverage is n/a.

@@         Coverage Diff         @@
##           dev   #6472   +/-   ##
===================================
  Coverage    0%      0%           
===================================
  Files       11      11           
  Lines      145     145           
  Branches    11      11           
===================================
  Misses     145     145

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f5c43c8...863758d. Read the comment docs.

Travis Prescott (tjprescott) · 2018-06-19T22:19:48Z

Per discussion with Mayuri Diwan (@mayurid) and Aaron Roney (@twitchax) we will not worry about interactive support for deprecation messages in this PR.

Travis Prescott (tjprescott) · 2018-06-20T20:31:08Z

Willie Xu (@williexu) Troy Dai (@troydai) Yugang Wang (@yugangw-msft) please take a look.

Willie Xu (williexu) · 2018-06-20T20:37:19Z

Travis Prescott (@tjprescott) I'm assuming interactive won't break when encountering deprecated items, at least.

Out of curiosity, what is the behavior for deprecated commands/args/etc.
Are they just treated like normal ones?

Travis Prescott (tjprescott) · 2018-06-20T21:23:37Z

Yes, I made sure interactive didn't crash. They run just like normal.

Willie Xu (williexu) · 2018-06-25T17:48:37Z

Can you also delete the groups from the loader's command_group_table here?

Willie Xu (williexu) · 2018-06-25T17:54:01Z

This return will be reached, probably intended to return the list if there are options in it?

It was dead code. Removed.

Willie Xu (williexu) · 2018-06-25T17:56:50Z

Why the switch from using get_parameter_options?

No idea. Reverted.

Willie Xu (williexu) · 2018-06-25T18:12:56Z

Can you add the command_table and command_group_table as hidden fields, or let them be accessed from the loader? They should not be exposed easily. These properties should just have the command/group names, which can be referenced from the table keys.

I changed them to just return the keys. Now I use the get_metadata methods.

Willie Xu (williexu) · 2018-06-25T18:27:37Z

Are these get-metadata methods used anywhere?

~~No, though it seems they do what you were asking for above.~~ Now that the commands and command_groups properties just return keys, I use this.

Willie Xu (williexu) · 2018-06-25T18:48:47Z

Are we no longer limiting the kwargs being merged?

Instead of raising an error (some unsupported kwargs may be in a kwarg bundle), on the next line we simply gather up the supported args.

Willie Xu (williexu) · 2018-06-25T18:54:32Z

travis, can you explain this? was this moved from somewhere else?

This was copied from the base knack implementation and essentially cuts out where the old-style deprecation messages were displayed in knack. In the future I could remove that code (potentially) from knack and then just rely on the base implementation.

Willie Xu (williexu) · 2018-06-25T18:56:36Z

We didn't use this method?

show_help reverted to the knack implementation. print_detailed_help was changed at the knack and az level to be a regular method, not a class method.

Willie Xu (williexu) · 2018-06-25T19:04:35Z

Can you explain what the bug was that caused this to be needed?

I think this is just ensuring that all help will end in a proper "stopping" punctuation mark.

It shouldn't be necessary and works just fine without this on Python 3. But for whatever reason, stupid Python 2.7 ends up looking into the SDK docstring, finds some non-ASCII character, and crashes. Not wanting to invest a lot of time into the philosophical question of why Python 2.7 is such crap, I just went with this.

Willie Xu (williexu) · 2018-06-25T19:07:04Z

These probably should be removed.

Removed. Debugging remnants.

Travis Prescott (tjprescott) · 2018-06-25T23:06:44Z

Willie Xu (@williexu) comments addressed. Please take another look.

Willie Xu (williexu) · 2018-06-26T19:48:09Z

Maybe I'm seeing this wrong but are you deleting all the groups in the table...?
It should only be the ones from the selected modules/extensions.

Yep, you're right. Fixed. However, this will not exclude orphan help file entries (botservice has some).

Willie Xu (williexu) · 2018-06-26T20:08:56Z

logging.warning will call str on the argument for you

Willie Xu (williexu) · 2018-06-26T20:16:32Z

is it certain that args will have at least one element?

Yes. It is the same in knack.

Willie Xu (williexu) · 2018-06-26T22:09:49Z

This is inside a for loop over all the commands in the command_table.
Please move this outside the for loop

Good catch. Thought I had done that!

Travis Prescott (tjprescott) added do-not-merge Infrastructure labels May 31, 2018

Travis Prescott (tjprescott) added this to the Sprint 39 milestone May 31, 2018

Travis Prescott (tjprescott) requested review from Stephen Tramer (sptramer), Troy Dai (troydai), Willie Xu (williexu) and Yugang Wang (yugangw-msft) May 31, 2018 21:07

Stephen Tramer (sptramer) approved these changes May 31, 2018

View reviewed changes

Travis Prescott (tjprescott) modified the milestones: Sprint 39, Sprint 40 Jun 12, 2018

Travis Prescott (tjprescott) changed the title ~~[DNM] Deprecation strategy~~ Add Deprecation support Jun 19, 2018

Travis Prescott (tjprescott) removed the do-not-merge label Jun 19, 2018

Travis Prescott (tjprescott) modified the milestones: Sprint 40, Sprint 41 Jun 25, 2018

Willie Xu (williexu) suggested changes Jun 25, 2018

View reviewed changes

Willie Xu (williexu) suggested changes Jun 26, 2018

View reviewed changes

Willie Xu (williexu) approved these changes Jun 26, 2018

View reviewed changes

Yugang Wang (yugangw-msft) approved these changes Jun 28, 2018

View reviewed changes

Travis Prescott (tjprescott) added 3 commits June 28, 2018 09:09

CLI deprecation mechanisms.

d3797fb

Add encoding to help files. Partial fix #5954.

e039a19

Progress.

35e0270

Travis Prescott (tjprescott) added 12 commits June 28, 2018 09:10

Bump versions.

78348ca

Workaround for strange help issue.

6be8588

CI fixes.

b96beed

Update help generation script.

00c729b

Fixes for az interactive.

f685903

Interactive work

9a30ff6

Bump versions.

aa6ece4

Code review feedback.

ce9b502

Rebase conflict.

0d154c0

Code review feedback.

e030eff

Code review feedback. Fix command group deletion.

b894a2c

Bump versions.

863758d

Travis Prescott (tjprescott) merged commit b3d52ca into Azure:dev Jun 28, 2018

Travis Prescott (tjprescott) deleted the DeprecationStrategy branch June 28, 2018 18:01

Willie Xu (williexu) mentioned this pull request Jul 19, 2018

ref doc gen broken due to deprecation work Azure/azure-cli-extensions#240

Merged

Matt Boersma (mboersma) mentioned this pull request Jul 25, 2018

[AKS] properly deprecate "az aks create --enable-rbac" argument #6889

Merged

2 tasks

Harold Ran (haroldrandom) added the Infrastructure label Oct 25, 2019

Uh oh!

Conversation

Travis Prescott (tjprescott) commented May 31, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Troy Dai (troydai) commented Jun 4, 2018

Uh oh!

Troy Dai (troydai) commented Jun 4, 2018

Uh oh!

Codecov (codecov-io) commented Jun 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Travis Prescott (tjprescott) commented Jun 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Travis Prescott (tjprescott) commented Jun 20, 2018

Uh oh!

Willie Xu (williexu) commented Jun 20, 2018

Uh oh!

Travis Prescott (tjprescott) commented Jun 20, 2018

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!

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!

Travis Prescott (tjprescott) Jun 25, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

Willie Xu (williexu) Jun 25, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Travis Prescott (tjprescott) commented Jun 25, 2018

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!

Travis Prescott (tjprescott) commented May 31, 2018 •

edited

Loading

Codecov (codecov-io) commented Jun 13, 2018 •

edited

Loading

Travis Prescott (tjprescott) commented Jun 19, 2018 •

edited

Loading

Travis Prescott (tjprescott) Jun 25, 2018 •

edited

Loading

Willie Xu (williexu) Jun 25, 2018 •

edited

Loading

Willie Xu (williexu) Jun 26, 2018 •

edited

Loading