Document htpasswd.py

[anonymous]

Trac docs mention:

$ ./contrib/htpasswd.py -cb htpasswd user1 user1
$ ./contrib/htpasswd.py -b htpasswd user2 user2

What's the difference between -cb and -b?

Running the script:

Usage:
        htpasswd.py [-c] filename username
        htpasswd.py -b[c] filename username password
        htpasswd.py -D filename username

What do -c, b[c] or -D mean?

[anonymous]

Ah, passing --help is required to see the description of the option (but not the "usage"):

Options:
  -h, --help  show this help message and exit
  -b          Batch mode; password is passed on the command line IN THE CLEAR.
  -c          Create a new htpasswd file, overwriting any existing file.
  -D          Remove the given user from the password file.

Maybe that should also be printed even when no arguments are given?

[Jun Omae]

Okay. We should print help with no arguments.

contrib/htpasswd.py

@@ -107 +107 @@
         help.
         """
         sys.stderr.write("Syntax error: " + msg)
-        sys.stderr.write(parser.get_usage())
+        parser.print_help(file=sys.stderr)
         sys.exit(1)
 
     if not (options.batch or options.delete_user):

Before the patch:

$ PYTHONPATH=. ~/venv/py27-1.0/bin/python contrib/htpasswd.py
Syntax error: Only batch and delete modes are supported
Usage:
        htpasswd.py -b[c] filename username password
        htpasswd.py -D filename username

After the patch:

$ PYTHONPATH=. ~/venv/py27-1.0/bin/python contrib/htpasswd.py
Syntax error: Only batch and delete modes are supported
Usage:
        htpasswd.py -b[c] filename username password
        htpasswd.py -D filename username

Options:
  -h, --help  show this help message and exit
  -b          Batch mode; password is passed on the command line IN THE CLEAR.
  -c          Create a new htpasswd file, overwriting any existing file.
  -D          Remove the given user from the password file.

[Jun Omae]

It would be good to prevent Syntax error message and show help only when no arguments. contrib/htdigest.py has the same issue.

contrib/htdigest.py

@@ -46 +46 @@
 parser.add_option('-b', action='store_true', dest='batch', default=False,
                   help='Batch mode, password on the commandline.')
 
+if len(sys.argv) <= 1:
+    parser.print_help(file=sys.stderr)
+    sys.exit(1)
+
 opts, args = parser.parse_args()
 
 try:

contrib/htpasswd.py

@@ -100 +100 @@
     parser.add_option('-D', action='store_true', dest='delete_user',
         default=False, help='Remove the given user from the password file.')
 
+    if len(sys.argv) <= 1:
+        parser.print_help(file=sys.stderr)
+        sys.exit(1)
     options, args = parser.parse_args()
 
     def syntax_error(msg):

[Ryan J Ollos]

Moving tickets that appear to be uncompleted for milestone:1.0.9. Please move back to milestone:1.0.9 if the ticket can be completed by 2015-09-07 18:00 UTC.

[Jun Omae]

Fixed in [14439] and merged to trunk in [14440].