Skip to main content

Python - Click

Python excels at making it quick and simple to convert your one-off scripts (or so you thought) into easy to use command line driven programs. The package that made me fall in love with this process was docopt (my notes here, here and here).

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 --meta and 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.
Labels:

Comments

Post a Comment

Popular posts from this blog

A note on Python's __exit__() and errors

Python's context managers are a very neat way of handling code that needs a teardown once you are done. Python objects have do have a destructor method ( __del__ ) called right before the last instance of the object is about to be destroyed. You can do a teardown there. However there is a lot of fine print to the __del__ method. A cleaner way of doing tear-downs is through Python's context manager , manifested as the with keyword. class CrushMe: def __init__(self): self.f = open('test.txt', 'w') def foo(self, a, b): self.f.write(str(a - b)) def __enter__(self): return self def __exit__(self, exc_type, exc_val, exc_tb): self.f.close() return True with CrushMe() as c: c.foo(2, 3) One thing that is important, and that got me just now, is error handling. I made the mistake of ignoring all those 'junk' arguments ( exc_type, exc_val, exc_tb ). I just skimmed the docs and what popped out is that you need to return True or...
Post a Comment
Read more

Remove field code from Word document

e.g. before submitting a MS, or hand manipulating some formatting because Word does things (like cross-references) so half-assed [from here ] Select all the text (CTRL-A) Press Ctrl+Shift+F9 Editing to remove anonymous comments that only contain thanks. I really appreciate the thanks, but it makes it harder to find comments that carry pertinent information. I'm also going to try and paste informative comments in the body of the post to make them easier to find.
24 comments
Read more

h5py and multiprocessing

The HDF5 format has been working awesome for me, but I ran into danger when I started to mix it with multiprocessing. It was the worst kind of danger: the intermittent error. Here are the dangers/issues in order of escalation (TL;DR is use a generator to feed data from your file into the child processes as they spawn. It's the easiest way. Read on for harder ways.) An h5py file handle can't be pickled and therefore can't be passed as an argument using pool.map() If you set the handle as a global and access it from the child processes you run the risk of racing which leads to corrupted reads. My personal runin was that my code sometimes ran fine but sometimes would complain that there are NaNs or Infinity in the data. This wasted some time tracking down. Other people have had this kind of problem [ 1 ]. Same problem if you pass the filename and have the different processes open individual instances of the file separately. The hard way to solve this problem is to sw...
Post a Comment
Read more