differentiating required and optional arguments in the help text for … #175

anusha94 · 2019-07-29T09:48:15Z

By default, all the keyword arguments are listed under the optional arguments section. This will lead to confusion to the user as to which arguments are required and actually optional.

To solve this problem, I have created an argument group called required arguments and listed all the required args under this header.

This PR contains modifications to VMC samples only.

…vmc samples

vmwclabot · 2019-07-29T09:48:16Z

@anusha94, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit ca0d0ec must be signed by [email protected]

tianhao64 · 2019-07-30T04:03:01Z

samples/vmc/networks_nsxt/cgw_firewall_crud.py

-        parser.add_argument('--refresh_token',
+        required_args = parser.add_argument_group('required arguments')
+
+        required_args.add_argument('--refresh_token',
                            required=True,


Try to maintain the vertical alignment..

Modified in the next commit

Signed-off-by: Anusha Hegde <[email protected]>

vmwclabot · 2019-07-30T07:26:11Z

@anusha94, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit ca0d0ec must be signed by [email protected]
Commit 0a5d210 must be signed by [email protected]
Commit 3b5d957 must be signed by [email protected]

pgbidkar · 2019-07-30T08:50:24Z

samples/vmc/networks_nsxt/cgw_firewall_crud.py

@@ -39,7 +39,8 @@ def __init__(self):
        parser = argparse.ArgumentParser(
            formatter_class=argparse.ArgumentDefaultsHelpFormatter)

-        required_args = parser.add_argument_group('required arguments')
+        required_args = parser.add_argument_group(


required_args is repeated in all the sample files. Can we declare it in library and use?

fixed in the next commit

new sample_cli.py file in the helpers directory

all other samples will import parser, required_args and optional_args as needed

Signed-off-by: Anusha Hegde <[email protected]>

vmwclabot · 2019-07-31T07:25:51Z

@anusha94, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit ca0d0ec must be signed by [email protected]
Commit 0a5d210 must be signed by [email protected]
Commit 3b5d957 must be signed by [email protected]
Commit 4456394 must be signed by [email protected]

Signed-off-by: Anusha Hegde <[email protected]>

vmwclabot · 2019-07-31T07:32:26Z

@anusha94, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit ca0d0ec must be signed by [email protected]
Commit 0a5d210 must be signed by [email protected]
Commit 3b5d957 must be signed by [email protected]
Commit 4456394 must be signed by [email protected]
Commit 5ff436a must be signed by [email protected]

samples/vsphere/common/sample_cli.py

pgbidkar · 2019-07-31T08:53:35Z

samples/vmc/networks_nsxv/nat_rule_crud.py

-            required=True,
-            help='VMware Cloud API refresh token')
+        required_args.add_argument(
+            '--org-id', required=True, help='Organization identifier.')


Most of the samples require org_id and sddc_id. Please check if we can move both to sample_cli.py and build seperate arg parser where it is not required

Signed-off-by: Anusha Hegde <[email protected]>

vmwclabot · 2019-08-06T10:13:39Z

@anusha94, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit ca0d0ec must be signed by [email protected]
Commit 0a5d210 must be signed by [email protected]
Commit 3b5d957 must be signed by [email protected]
Commit 4456394 must be signed by [email protected]
Commit 5ff436a must be signed by [email protected]

samples/vmc/networks_nsxt/cgw_firewall_crud.py

pgbidkar · 2019-08-07T10:03:13Z

samples/vmc/networks_nsxt/dfw_firewall_crud.py

 import requests
+from samples.vmc.helpers.sample_cli import parser, required_args


required_args is not required here?

samples/vmc/networks_nsxt/hello_world.py

pgbidkar · 2019-08-07T10:06:37Z

samples/vmc/sddc/sddc_crud.py

@@ -34,51 +33,52 @@ class CreateDeleteSDDC(object):
    """

    def __init__(self):
-        parser = argparse.ArgumentParser()
+        parser = argparse.ArgumentParser(
+        description='Standard Arguments for talking to vCenter')


Correct the description

samples/vmc/tasks/cancel_task.py

samples/vmc/tasks/list_tasks.py

pgbidkar · 2019-08-07T10:08:48Z

samples/vmc/tasks/list_tasks.py

-                    help='Task status to filter. Possible values are: {} \
-                    Show all tasks if no value is passed'.format(accepted))
+parser = argparse.ArgumentParser(
+        description='Standard Arguments for talking to vCenter')


correct the description

samples/vsphere/common/sample_cli.py

Signed-off-by: Anusha Hegde <[email protected]>

vmwclabot · 2019-08-08T06:43:22Z

@anusha94, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit ca0d0ec must be signed by [email protected]
Commit 0a5d210 must be signed by [email protected]
Commit 3b5d957 must be signed by [email protected]
Commit 4456394 must be signed by [email protected]
Commit 5ff436a must be signed by [email protected]

vmwclabot · 2019-08-09T10:33:19Z

@anusha94, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit ca0d0ec must be signed by [email protected]
Commit 0a5d210 must be signed by [email protected]
Commit 3b5d957 must be signed by [email protected]
Commit 4456394 must be signed by [email protected]
Commit 5ff436a must be signed by [email protected]
Commit c7036bb must be signed by [email protected]

differentiating required and optional arguments in the help text for …

ca0d0ec

…vmc samples

vmwclabot added the dco-required label Jul 29, 2019

tianhao64 reviewed Jul 30, 2019

View reviewed changes

Anusha Hegde added 2 commits July 30, 2019 12:47

adding required arguments group in argparse

0a5d210

formatting changes

3b5d957

Signed-off-by: Anusha Hegde <[email protected]>

pgbidkar reviewed Jul 30, 2019

View reviewed changes

moving required arguments to utility file

4456394

Signed-off-by: Anusha Hegde <[email protected]>

removed extra spaces

5ff436a

Signed-off-by: Anusha Hegde <[email protected]>

pgbidkar reviewed Jul 31, 2019

View reviewed changes

moving org_id and sddc_id to sample_cli utility

86b2fa9

Signed-off-by: Anusha Hegde <[email protected]>

pgbidkar reviewed Aug 7, 2019

View reviewed changes

removing unused imports

425930a

Signed-off-by: Anusha Hegde <[email protected]>

updated parser description

c7036bb

tianhao64 merged commit 2d2f32b into vmware:master Aug 20, 2019

		import requests
		from samples.vmc.helpers.sample_cli import parser, required_args

differentiating required and optional arguments in the help text for … #175

differentiating required and optional arguments in the help text for … #175

Uh oh!

Conversation

anusha94 commented Jul 29, 2019

Uh oh!

vmwclabot commented Jul 29, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vmwclabot commented Jul 30, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vmwclabot commented Jul 31, 2019

Uh oh!

vmwclabot commented Jul 31, 2019

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vmwclabot commented Aug 6, 2019

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vmwclabot commented Aug 8, 2019

Uh oh!

vmwclabot commented Aug 9, 2019

Uh oh!

Uh oh!