Baker Easy, powerful access to Python functions from the command-line
Download

Baker Ranking & Summary

Baker Tags

Python library Python Access functions Python functions

Baker Description

Easy, powerful access to Python functions from the command-line Baker is a Python module that lets you easily add a command line interface to your Python functions using a simple decorator, to create scripts with "sub-commands", similar to Django's manage.py, svn, hg, etc.:#!pythonimport baker# An imaginary script full of useful Python functions@baker.commanddef set(name, value=None, overwrite=False): """Sets the value of a key in the database. If you don't specify a value, the named key is deleted. Overwriting a value may not be visible to all clients until the next full sync. """ db = get_database() if overwrite or name not in db: if value is None: db.delete(name) print "Deleted %s" % name else: db.set(name, value) print "Set %s to %s" % (name, value) else: print "Key exists!"@baker.commanddef get(name): "Prints the value of a key in the database." db = get_database() print db.get(name)baker.run()You can then run the script and use your function names and parameters as the command line interface, using optparse-style options:$ script.py set alfa bravoSet alfa to bravo$ script.py set --overwrite alfa charlieSet alfa to charlie$ script.py get alfacharlie$ script.py --helpAvailable commands: get Prints the value of a key in the database. set Sets the value of a key in the databaseUse "script.py < command > --help" for individual command help.$ script.py set --helpUsage: script.py set < name > Sets the value of a key in the database. If you don't specify a value, the named key is deleted. Overwriting a value may not be visible to all clients until the next full sync.Options:--overwriteArgumentsBaker maps command line options to function parameters in the most natural way available.Bare arguments are used to fill in required parameters:@baker.commanddef test(a, b, c): print "a=", a, "b=", b, "c=", c$ script.py test 1 2 3a= 1 b= 2 c= 3--option arguments are used to fill in keyword parameters. You can use --option value or --option=value, as in optparse:@baker.commanddef test(key="C"): print "In the key of:", key$ script.py testIn the key of: C$ script.py test --key AIn the key of: A$ script.py test --key=GbIn the key of: GbFunction parameters where the default is None are considered optional arguments and will be filled if extra arguments are available. Otherwise, extra bare arguments never fill in keyword parameters:@baker.commanddef test(start, end=None, sortby="time"): print "start=", start, "end=", end, "sort=", sortby$ script.py --sortby name 1start= 1 end= sortby= name$ script.py 1 2start= 1 end= 2 sortby= timeIf a keyword parameter's default is an int or float, Baker will try to convert the option's string to the same type:@baker.commanddef test(limit=10): print type(limit)$ script.py test --limit 10< type 'int' >If the default of a parameter is a boolean, the corresponding command line option is a flag that sets the opposite of the default:@baker.commanddef test(name, verbose=False): if verbose: print "Opening", name$ script.py test --verbose alfaOpening alfaIf the function takes * and/or ** parameters, any leftover arguments and options will fill them in.Parameter helpBaker lets you specify help for parameters in three ways.In the decorator:@baker.command(params={"force": "Delete even if the file exists"})def delete(filename, force=False): "Deletes a file." if force or not os.path.exists(filename): os.remove(filename)In Python 3.x, you can use parameter annotations to associate doc strings with parameters:@baker.commanddef delete(filename, force:"Delete even if the file exists."=False): "Deletes a file." if force or not os.path.exists(filename): os.remove(filename)Baker can parse the function's docstring for Sphinx-style :param blocks:@baker.commanddef delete(filename, force=False): """Deletes a file. :param force: Delete even if the file exists. """ if force or not os.path.exists(filename): os.remove(filename)Short optionsTo allow single-character short options (e.g. -v for --verbose), use the shortopts keyword on the decorator:@baker.command(shortopts={"verbose": "v"}, params={"verbose", "Spew lots"})def test(verbose=False): pass$ script.py test --helpUsage: script.py testOptions: -v --verbose Spew lotsYou can group multiple short flag options together (-xvc). You can also optionally not put a space between a short option and its argument, for example -nCASE instead of -n CASE.MiscellaneousInstead of baker.run(), you can use baker.test() to print out how Baker will call your function based on the given command line.As in many UNIX command line utilities, if you specify a single hyphen (-) as a bare argument, any subsequent arguments will not parsed as options, even if they start with --.Commands are automatically given the same name as the decorated function. To give a command a different name, use the name keyword on the decorator. This is especially useful when the command name you want isn't a valid Python identifier:@baker.command(name="track-all")def trackall(): passYou can specify a "default" command that is used when the first argument to the script doesn't look like a command name:@baker.command(default=True)def here(back=False): print "here! back=", back@baker.commanddef there(back=False): print "there! back=", back$ script.py --backhere! back= True Requirements: · Python What's New in This Release: · baker.run() now prints the return value of the command function. · Command usage help now shows help for optional arguments. · Added options to baker.run(). · Added baker.usage(). · Added unit tests. · Fixed bugs.

Baker Related Software