python-novaclient

Use '-' in all CLI option names

Registered by Dean Troyer

Update the nova cli client by changing all options to use '-' (dash) in long names rather than '_' (underscore). The previous underscore option names will be maintained for backward compatibility for a release or two but not show up in help output or documentation, or be clearly marked 'DEPRECATED' if they do appear.

Blueprint information

Status:
Complete
Approver:
None
Priority:
Undefined
Drafter:
Dean Troyer
Direction:
Needs approval
Assignee:
Dean Troyer
Definition:
New
Series goal:
None
Implementation:
Implemented
Milestone target:
None
Started by
Dean Troyer
Completed by
Dean Troyer

Related branches

Sprints

Whiteboard

An example of the changed implementation looks like:

        parser.add_argument('--os-username',
                            metavar='<auth-user-name>',
                            default=env('OS_USERNAME'),
                            help='Defaults to env[OS_USERNAME]')
        parser.add_argument('--os_username',
                            help=argparse.SUPPRESSED)

This allows either option name to be used but only the 'dash' version appears in help.

The environment variable name is unaffected.

The internal variable name is the same in either case.

If both options appear on the command line the value of the second one will be used.

Gerrit topic: https://review.openstack.org/#q,topic:bp/command-options,n,z

Addressed by: https://review.openstack.org/11821
    Change '_' to '-' in options

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.
Edit subscription

Subscribers

No subscribers.