Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 20, 2019
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ca0d0ec
differentiating required and optional arguments in the help text for …
Jul 29, 2019
0a5d210
adding required arguments group in argparse
Jul 30, 2019
3b5d957
formatting changes
Jul 30, 2019
4456394
moving required arguments to utility file
Jul 31, 2019
5ff436a
removed extra spaces
Jul 31, 2019
86b2fa9
moving org_id and sddc_id to sample_cli utility
anusha94 Aug 6, 2019
425930a
removing unused imports
anusha94 Aug 8, 2019
c7036bb
updated parser description
anusha94 Aug 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions samples/vmc/networks_nsxt/cgw_firewall_crud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,19 @@ def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)

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

required_args.add_argument('--refresh_token',
required=True,
Copy link
Contributor

Choose a reason for hiding this comment

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

Try to maintain the vertical alignment..

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Modified in the next commit

help='Refresh token obtained from CSP')

parser.add_argument('--org_id',
required_args.add_argument('--org_id',
required=True,
help='Orgization ID')

parser.add_argument('--sddc_id',
required_args.add_argument('--sddc_id',
required=True,
help='Sddc ID')
help='SDDC ID')

args = parser.parse_args()

Expand Down
10 changes: 6 additions & 4 deletions samples/vmc/networks_nsxt/dfw_firewall_crud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,19 @@ def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)

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

required_args.add_argument('--refresh_token',
required=True,
help='Refresh token obtained from CSP')

parser.add_argument('--org_id',
required_args.add_argument('--org_id',
required=True,
help='Orgization ID')

parser.add_argument('--sddc_id',
required_args.add_argument('--sddc_id',
required=True,
help='Sddc ID')
help='SDDC ID')

args = parser.parse_args()

Expand Down
10 changes: 6 additions & 4 deletions samples/vmc/networks_nsxt/hello_world.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,19 @@ class AuthExample(object):
def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('-r', '--refresh-token',

required_args = parser.add_argument_group('required arguments')
required_args.add_argument('-r', '--refresh-token',
required=True,
help='VMware Cloud API refresh token')

parser.add_argument('-o', '--org-id',
required_args.add_argument('-o', '--org-id',
required=True,
help='Organization identifier.')

parser.add_argument('-s', '--sddc-id',
required_args.add_argument('-s', '--sddc-id',
required=True,
help='Sddc Identifier.')
help='SDDC Identifier.')

args = parser.parse_args()

Expand Down
13 changes: 7 additions & 6 deletions samples/vmc/networks_nsxt/l3_vpn_crud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,23 +42,24 @@ def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)

parser.add_argument('--refresh_token',
required_args = parser.add_argument_group('required arguments')
required_args.add_argument('--refresh_token',
required=True,
help='Refresh token obtained from CSP')

parser.add_argument('--org_id',
required_args.add_argument('--org_id',
required=True,
help='Orgization ID')

parser.add_argument('--sddc_id',
required_args.add_argument('--sddc_id',
required=True,
help='Sddc ID')
help='SDDC ID')

parser.add_argument('--remote_endpoint_public_ip',
required_args.add_argument('--remote_endpoint_public_ip',
required=True,
help='L3 VPN Remote end point\'s public ip')

parser.add_argument('--passphrase',
required_args.add_argument('--passphrase',
required=True,
help='Passphrase used for VPN')

Expand Down
9 changes: 5 additions & 4 deletions samples/vmc/networks_nsxt/nat_crud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,18 @@ def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)

parser.add_argument('--refresh_token',
required_args = parser.add_argument_group('required arguments')
required_args.add_argument('--refresh_token',
required=True,
help='Refresh token obtained from CSP')

parser.add_argument('--org_id',
required_args.add_argument('--org_id',
required=True,
help='Orgization ID')

parser.add_argument('--sddc_id',
required_args.add_argument('--sddc_id',
required=True,
help='Sddc ID')
help='SDDC ID')

args = parser.parse_args()

Expand Down
9 changes: 5 additions & 4 deletions samples/vmc/networks_nsxt/security_group_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,23 +38,24 @@
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)

parser.add_argument('--refresh_token',
required_args = parser.add_argument_group('required arguments')
required_args.add_argument('--refresh_token',
required=True,
help='Refresh token obtained from CSP')

parser.add_argument('--org_id',
required_args.add_argument('--org_id',
required=True,
help='Orgization ID')

parser.add_argument('--sddc_id',
required_args.add_argument('--sddc_id',
required=True,
help='Sddc ID')

parser.add_argument('--gateway_type',
default='mgw',
help='Gateway type. Either mgw or cgw')

parser.add_argument('--name',
required_args.add_argument('--name',
required=True,
help='Name of the security group to be created')

Expand Down
9 changes: 5 additions & 4 deletions samples/vmc/networks_nsxt/security_group_delete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,18 @@
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)

parser.add_argument('--refresh_token',
required_args = parser.add_argument_group('required arguments')
required_args.add_argument('--refresh_token',
required=True,
help='Refresh token obtained from CSP')

parser.add_argument('--org_id',
required_args.add_argument('--org_id',
required=True,
help='Orgization ID')

parser.add_argument('--sddc_id',
required_args.add_argument('--sddc_id',
required=True,
help='Sddc ID')
help='SDDC ID')

parser.add_argument('--gateway_type',
default='mgw',
Expand Down
9 changes: 5 additions & 4 deletions samples/vmc/networks_nsxt/security_group_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,18 @@
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)

parser.add_argument('--refresh_token',
required_args = parser.add_argument_group('required arguments')
required_args.add_argument('--refresh_token',
required=True,
help='Refresh token obtained from CSP')

parser.add_argument('--org_id',
required_args.add_argument('--org_id',
required=True,
help='Orgization ID')

parser.add_argument('--sddc_id',
required_args.add_argument('--sddc_id',
required=True,
help='Sddc ID')
help='SDDC ID')

parser.add_argument('--gateway_type',
default='mgw',
Expand Down
11 changes: 6 additions & 5 deletions samples/vmc/networks_nsxt/security_group_update.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,18 @@
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)

parser.add_argument('--refresh_token',
required_args = parser.add_argument_group('required arguments')
required_args.add_argument('--refresh_token',
required=True,
help='Refresh token obtained from CSP')

parser.add_argument('--org_id',
required_args.add_argument('--org_id',
required=True,
help='Orgization ID')

parser.add_argument('--sddc_id',
required_args.add_argument('--sddc_id',
required=True,
help='Sddc ID')
help='SDDC ID')

parser.add_argument('--gateway_type',
default='mgw',
Expand All @@ -62,7 +63,7 @@
parser.add_argument('--group_id',
help='ID of the group to be updated')

parser.add_argument('--name',
required_args.add_argument('--name',
required=True,
help='New name of the security group to be updated')

Expand Down
9 changes: 5 additions & 4 deletions samples/vmc/networks_nsxt/segments_firewall_crud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,18 @@ def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)

parser.add_argument('--refresh_token',
required_args = parser.add_argument_group('required arguments')
required_args.add_argument('--refresh_token',
required=True,
help='Refresh token obtained from CSP')

parser.add_argument('--org_id',
required_args.add_argument('--org_id',
required=True,
help='Orgization ID')

parser.add_argument('--sddc_id',
required_args.add_argument('--sddc_id',
required=True,
help='Sddc ID')
help='SDDC ID')

args = parser.parse_args()

Expand Down
12 changes: 7 additions & 5 deletions samples/vmc/networks_nsxv/dns_crud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,27 @@ class DNSCrud(object):
def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('-r', '--refresh-token',

required_args = parser.add_argument_group('required arguments')
required_args.add_argument('--refresh-token',
required=True,
help='VMware Cloud API refresh token')

parser.add_argument('-o', '--org-id',
required_args.add_argument('--org-id',
required=True,
help='Organization identifier.')

parser.add_argument('-s', '--sddc-id',
required_args.add_argument('--sddc-id',
required=True,
help='Sddc Identifier.')
help='SDDC Identifier.')

parser.add_argument('--use-compute-gateway',
action='store_true',
default=False,
help='Use compute gateway. Default is using '
'management gateway')

parser.add_argument('-c', '--cleardata',
parser.add_argument('--cleardata',
action='store_true',
help='Clean up after sample run')
args = parser.parse_args()
Expand Down
14 changes: 8 additions & 6 deletions samples/vmc/networks_nsxv/expose_public_ip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,19 @@ class ExposePublicIP(object):
def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('-r', '--refresh-token',

required_args = parser.add_argument_group('required arguments')
required_args.add_argument('--refresh-token',
required=True,
help='VMware Cloud API refresh token')

parser.add_argument('-o', '--org-id',
required_args.add_argument('--org-id',
required=True,
help='Organization identifier.')

parser.add_argument('-s', '--sddc-id',
required_args.add_argument('--sddc-id',
required=True,
help='Sddc Identifier.')
help='SDDC Identifier.')

parser.add_argument('--notes',
default='Sample public IP ' + str(random.randint(0, 100)),
Expand All @@ -62,11 +64,11 @@ def __init__(self):
default='Sample NAT rule ' + str(random.randint(0, 100)),
help='Description for the NAT rule')

parser.add_argument('--internal-ip',
required_args.add_argument('--internal-ip',
required=True,
help='Private IP of the VM')

parser.add_argument('-c', '--cleardata',
parser.add_argument('--cleardata',
action='store_true',
help='Clean up after sample run')
args = parser.parse_args()
Expand Down
14 changes: 7 additions & 7 deletions samples/vmc/networks_nsxv/firewall_rules_crud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,18 @@ class FirewallRulesCrud(object):
def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument(
'-r',

required_args = parser.add_argument_group('required arguments')
required_args.add_argument(
'--refresh-token',
required=True,
help='VMware Cloud API refresh token')

parser.add_argument(
'-o', '--org-id', required=True, help='Organization identifier.')
required_args.add_argument(
'--org-id', required=True, help='Organization identifier.')

parser.add_argument(
'-s', '--sddc-id', required=True, help='Sddc Identifier.')
required_args.add_argument(
'--sddc-id', required=True, help='Sddc Identifier.')

parser.add_argument(
'--rule-name',
Expand All @@ -59,7 +60,6 @@ def __init__(self):
'management gateway')

parser.add_argument(
'-c',
'--cleardata',
action='store_true',
help='Clean up after sample run')
Expand Down
14 changes: 7 additions & 7 deletions samples/vmc/networks_nsxv/ipsec_vpns_crud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,18 @@ class IpsecVPNsCrud(object):
def __init__(self):
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument(
'-r',

required_args = parser.add_argument_group('required arguments')
required_args.add_argument(
'--refresh-token',
required=True,
help='VMware Cloud API refresh token')

parser.add_argument(
'-o', '--org-id', required=True, help='Organization identifier.')
required_args.add_argument(
'--org-id', required=True, help='Organization identifier.')

parser.add_argument(
'-s', '--sddc-id', required=True, help='Sddc Identifier.')
required_args.add_argument(
'--sddc-id', required=True, help='SDDC Identifier.')

parser.add_argument(
'--use-compute-gateway',
Expand Down Expand Up @@ -82,7 +83,6 @@ def __init__(self):
help='Pre Shared Key for the IPsec Site')

parser.add_argument(
'-c',
'--cleardata',
action='store_true',
help='Clean up after sample run')
Expand Down
Loading