[Mailman-Developers] Click CLI branch

[Mark Sapiro]

On 07/20/2017 02:12 PM, Mark Sapiro wrote:
> On 07/20/2017 01:56 PM, Barry Warsaw wrote:
>> Just a quick note to mention that my big branch to adopt click for command line option parsing should now be done.
>>
>> https://gitlab.com/mailman/mailman/merge_requests/292
> 
> I'll look at it. ...


The first thing I notice right away is the help text doesn't fill. E.g.,

> $ ./mailman --help
> Usage: mailman [OPTIONS] COMMAND [ARGS]...
> 
>   The GNU Mailman mailing list management system Copyright 1998-2017 by the
>   Free Software Foundation, Inc. http://www.list.org
> 
> Options:
>   -C, --config PATH  Configuration file to use.  If not given, the environment
>                      variable
>                      MAILMAN_CONFIG_FILE is consulted and used if
>                      set.  If neither are given, a
>                      default configuration file
>                      is loaded.
>   --version          Show the version and exit.
>   --help             Show this message and exit.
> 
> Commands:
> ...

and

> $ ./mailman shell --help
> Usage: mailman shell [OPTIONS] [RUN_ARGS]...
> 
>   Operate on a mailing list.
> 
>   For detailed help, see --details
> 
> Options:
>   -i, --interactive    Leaves you at an interactive prompt after all other
>                        processing is complete.
>                        This is the default unless the
>                        --run option is given.
>   -r, --run TEXT       Run a script on a mailing list.  The argument is the
>                        module path to a
>                        callable.  This callable will be
>                        imported and then called with the mailing
>                        list as the
>                        first argument.  If additional arguments are given at
>                        the end
>                        of the command line, they are passed as
>                        subsequent positional arguments to
>                        the callable.  For
>                        additional help, see --details.
>   --details            Print detailed instructions and exit.
>   -l, --listspec TEXT  A specification of the mailing list to operate on.
>                        This may be the posting
>                        address of the list, or its
>                        List-ID.  The argument can also be a Python
>                        regular
>                        expression, in which case it is matched against both
>                        the posting
>                        address and List-ID of all mailing lists.
>                        To use a regular expression,
>                        LISTSPEC must start with a
>                        ^ (and the matching is done with re.match().
>                        LISTSPEC
>                        cannot be a regular expression unless --run is given.
>   --help               Show this message and exit.



-- 
Mark Sapiro <mark at msapiro.net>        The highway is for gamblers,
San Francisco Bay Area, California    better use your sense - B. Dylan

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 181 bytes
Desc: OpenPGP digital signature
URL: <http://mail.python.org/pipermail/mailman-developers/attachments/20170720/e918d966/attachment-0001.sig>