From 39f7906b5774243e6fe9fb622dcec37d0cef3ca0 Mon Sep 17 00:00:00 2001
From: David Pursehouse <david.pursehouse@sonymobile.com>
Date: Fri, 11 Apr 2014 16:59:50 +0900
Subject: Fix up usage of argparse in examples

Since a76db4cfc83d4cf7a52d045e4df82ec8b1e3f562 it is broken.

- Use ArgumentDefaultsHelpFormatter to automatically show default
  values for the options.

- Remove hard-coded 'default' information from help texts.

- Add a metavar for the ssh event timeout option.

- Integer arguments must now be specified as `int` rather than
  `'int'` with quotation marks.

- Fix calls to `parser.parse_args`, which now returns a single
  value rather than a tuple.

Change-Id: If5cf4e2d1f4014a60f7a7634d43df12b788bc7b4
---
 example.py      | 22 ++++++++++++----------
 rest_example.py |  8 +++++---
 2 files changed, 17 insertions(+), 13 deletions(-)

diff --git a/example.py b/example.py
index a5b7be8..99fe940 100755
--- a/example.py
+++ b/example.py
@@ -25,8 +25,8 @@
 
 """ Example of using the Gerrit client class. """
 
-import logging
 import argparse
+import logging
 import sys
 from threading import Event
 import time
@@ -38,22 +38,24 @@ from pygerrit.events import ErrorEvent
 
 def _main():
     descr = 'Send request using Gerrit ssh API'
-    parser = argparse.ArgumentParser(description=descr)
+    parser = argparse.ArgumentParser(
+        description=descr,
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
     parser.add_argument('-g', '--gerrit-hostname', dest='hostname',
                         default='review',
-                        help='gerrit server hostname (default: %default)')
+                        help='gerrit server hostname')
     parser.add_argument('-p', '--port', dest='port',
-                        type='int', default=29418,
-                        help='port number (default: %default)')
+                        type=int, default=29418,
+                        help='port number')
     parser.add_argument('-u', '--username', dest='username',
                         help='username')
     parser.add_argument('-b', '--blocking', dest='blocking',
                         action='store_true',
-                        help='block on event get (default: False)')
+                        help='block on event get')
     parser.add_argument('-t', '--timeout', dest='timeout',
-                        default=None, type='int',
-                        help='timeout (seconds) for blocking event get '
-                        '(default: None)')
+                        default=None, type=int,
+                        metavar='SECONDS',
+                        help='timeout for blocking event get')
     parser.add_argument('-v', '--verbose', dest='verbose',
                         action='store_true',
                         help='enable verbose (debug) logging')
@@ -61,7 +63,7 @@ def _main():
                         action='store_true',
                         help='do not exit when an error event is received')
 
-    (options, _args) = parser.parse_args()
+    options = parser.parse_args()
     if options.timeout and not options.blocking:
         parser.error('Can only use --timeout with --blocking')
 
diff --git a/rest_example.py b/rest_example.py
index 825ed7c..1b69c00 100755
--- a/rest_example.py
+++ b/rest_example.py
@@ -25,8 +25,8 @@
 
 """ Example of using the Gerrit client REST API. """
 
-import logging
 import argparse
+import logging
 import sys
 
 from requests.auth import HTTPBasicAuth, HTTPDigestAuth
@@ -45,7 +45,9 @@ from pygerrit.rest.auth import HTTPDigestAuthFromNetrc, HTTPBasicAuthFromNetrc
 
 def _main():
     descr = 'Send request using Gerrit HTTP API'
-    parser = argparse.ArgumentParser(description=descr)
+    parser = argparse.ArgumentParser(
+        description=descr,
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
     parser.add_argument('-g', '--gerrit-url', dest='gerrit_url',
                         required=True,
                         help='gerrit server url')
@@ -67,7 +69,7 @@ def _main():
                         action='store_true',
                         help='enable verbose (debug) logging')
 
-    (options, _args) = parser.parse_args()
+    options = parser.parse_args()
 
     level = logging.DEBUG if options.verbose else logging.INFO
     logging.basicConfig(format='%(asctime)s %(levelname)s %(message)s',
-- 
cgit v1.2.1