A year after I started to use docopts a colleague (two colleagues actually) introduced me to the Python click package. I was initially reluctant to migrate an existing code base to docopt, but I decided to give it a spin and have not looked back.
There was a recent post comparing argparse, docopt and click shared by another colleague, perhaps prompted by an internal debate about the merits of the different options available.
One thing that gets missed in these comparisons is more specific and complicated use cases. I just found a simple, specific use case where Click blows the other two away in terms of managing complexity and improving readability:
My application requires me to pass in key, value pairs in the command line that serve as metadata for a system. The keys for the metadata are constrained to come from a predefined list. Now, how would you do this in argparse? In docopts?
In click, it's very, very straightforward.
import click keys = ['key1', 'key2', 'key3'] @click.command() @click.option('--meta', multiple=True, type=(click.Choice(keys), str), help='Metadata') def cli(meta): """Print the supplied metadata values""" print meta
This code will validate the metadata keys, will accept multiple entries for
--metaand will present you with a list of tuples. It is very terse and very maintainable.
In this respect, I think Click is very far in advance of the other Python packages available for constructing commmand line interfaces.