NEWS for cliapp
Important, backwards incompatible bug fixes:
- Jan Gerber fixed string list option handling. Command line options
no longer parse values by commas, so that
--foo=bar,foobarresults in a single value
bar,foobar, instead of two values (
foobar). Also, in configuration files, values may be quoted with double quotes.
- Memory use profiling with Meliae was fixed.
- Richard Ipsum added the
cliapp.Application.get_subcommand_usagemethod to return a short usage text for a subcommand. This allows better error message.
Lars Wirzenius added the
ssh_optionskeyword argument to
cliapp.ssh_runcmdto allow adding command line options to the ssh program.
Lars Wirzenius added the
remote_cwdkeyword argument to
cliapp.ssh_runcmdto allow the caller to easily change to a directory on the server.
heapymemory profile has been dropped. It's not packaged for Debian, and is rarely available anywhere.
Richard Ipsum added callbacks to
cliapp.runcmdfor handling captured stdout/stderr output from the pipeline. This allows, for example, progress reporting during a long-running command.
Richard Maw and Richard Ipsum fixed
cliapp.runcmdto close file descriptors correctly, to make
cliapp.runcmd(['cat', '/dev/zero'], ['false'])work correctly. Previously, the pipeline would never finish, but now it does, because closing an unnecessary file descriptor in the parent results in
SIGPIPEbeing sent to the
Richard Maw changed
cliapp.runcmdso that the stderr of all commands in the pipeline are collected, when stderr is set to
The way logging is set up has been split into smaller methods, to allow overriding better. See
Plugins no longer need to define a
disablemethod: the default implementation is now a no-op, instead of raising
- When getting help for a subcommand, cliapp would crash saying
get_help_text_formattercouldn't be found. This has been fixed.
Portability patch to disable VmRSS reporting on non-Linux platforms. The code assumed that /proc/self/status exists, but that's only true on Linux. Patch from Itamar Turner-Trauring.
cliappnow logs the current working directory, uid, effective uid, gid, and effective gid at startup.
Settings.load_configs) now reports an unknown variable in a configuration file with a nice error message, rather than a stack trace.
A new method,
cliapp.Application.get_subcommand_help_formatterallows overriding how the full help text for a subcommand is to be formatted. This can be useful for allowing help texts be marked up in, say, Markdown.
cliapp.Settings.requiremethod now accepts many setting names, and check for all of them. Patch by Stephen Judd.
- Bug fix to cliapp.runcmd pipeline handling: the pipeline now returns failure if any of the processes fails, rather than only the last one. Found and reported by Richard Maw.
- Fix a problem in the pipeline code in runcmd. Reported and fix provided by Richard Maw.
- cliapp(5) now mentions subcommands and the automatic subcommand "help".
ssh_runcmdnow has the
ttykeyword argument to enable ssh allocation of pseudo-TTYs. Patch from Jannis Pohlmann.
helpsubcommand now writes a useful error message, instead of a stack trace, if given an unknown subcommand. Reported by Rob Taylor.
- The API documentation has been split into more than one page.
cliapp.runcmdno longer dies from the
cliapp.Application.compute_setting_valuesmethod. This allows the application to have settings with values that are computed after configuration files and the command line are parsed.
- Cliapp now logs the Python version at startup, to aid debugging.
cliapp.runcmdnow logs much less during execution of a command. The verbose logging was useful while developing pipeline support, but has now not been useful for months.
- More default settings and options have an option group now, making
--helpoutput and the output of the
helpsubcommand now only list summaries for subcommands. The full documentation for a subcommand can be seen by giving the name of the subcommand to
- Logging setup is now more overrideable. The
setup_logging_handler_to_file, and the last one calls
setup_logging_timestampto create the format strings for messages and timestamps. This allows applications to add, for example, more detailed timestamps easily.
- The process and system CPU times, and those of the child processes, and the process wall clock duration, are now logged when the memory profiling information is logged.
- Subcommands added with
add_subcommandmay now have aliases. Subcommands defined using
Applicationclass methods named
cmd_*cannot have aliases.
- Settings and subcommands may now be hidden from
helpoutput. New option
--help-alland new subcommand
- cliapp(5) now explains how
--generate-manpageis used. Thanks to Enrico Zini for the suggestion.
- New function
cliapp.ssh_runcmdfor executing a command remotely over ssh. The function automatically shell-quotes the argv array given to it so that arguments with spaces and other shell meta-characters work over ssh.
- New function
cliapp.shell_quotequotes strings for passing as shell arguments.
cliapp.runcmdnow has a new keyword argument:
log_error. If set to false, errors are not logged. Defaults to true.
- The process title is now set only if
/proc/self/commexists. Previously, on the kernel in Debian squeeze (2.6.32), setting the process title would fail, and the error would be logged to the terminal. Reported by William Boughton.
- A setting may no longer have a default value of None.
- Options in option groups are now included in manual page SYNOPSIS and OPTIONS sections.
--log=syslogmessage format improvement by Daniel Silverstone. No longer includes a timestamp, since syslog adds it anyway. Also, the process name is now set on Linux.
- Make the default subcommand argument synopsis be an empty string, instead of None. Reported by Sam Thursfield.
- Meliae memory dumping support has been fixed. Reported by Joey Hess.
- Memory profiling reports can now be done at minimum intervals in seconds, rather than every time the code asks for them. This can reduce the overhead of memory profiling quite a lot.
- If there are any subcommands, cliapp now adds a subcommand called
help, unless one already exists.
- For every boolean setting foo, there will no be a --no-foo option to be used on the command line.
- Print error messages from
SystemExitexceptions. As a side effect, this fixes the problem that an unknown subcommand would not cause an error message to be printed.
- Fix a busy-wait problem when
runcmdruns a command with both standard output and error redirected to files and there was nothing to feed to its standard input (i.e.,
runcmddidn't need to write to the command, or read any of its output). This problem was found and fixed during work done for Codethink Limited.
- New version numbering scheme:
- cliapp now logs the command line and all settings, and the environment variables when the application starts. This helps when debugging problems other people are having.
cliapp.runcmd_uncheckedfunctions are now callable without having a
cliapp.Applicationinstance. This makes it easier to use them in large programs.
- All types of settings can now have a
groupkeyword argument for grouping them in the
Version 0.29, released 2012-05-09
- Pointless error message about exit code of an application removed. It is one of the mysteries of the universe why this ever made sense at all.
Version 0.28, released 2012-05-08
- Log files are now created using a 0600 file mode by default. The new
--log-modecan be used to change that.
- Logging can now be disabled using
--log=none. This is useful for overriding on the command a logging setting from a configuration file.
for name in settingsand
settings.keys()now work, making the settings class act more like an object. Thanks to Jannis Pohlmann for giving the inpiration for this change.
- Settingses can now be grouped, using the new keyword argment
groupto the various methods to add a new setting. The grouping affects
--helpoutput only. The value to
groupis the title of the group.
- There is now a plugin system included in cliapp.
Version 0.27, released 2012-02-17
- Bug fix: The
runcmd_uncheckedmethods now properly add the name of the program that failed to execute to the error message. This did not always happen previously, depending on race conditions on getting errors from a child process.
Version 0.26, released 2012-02-11
cliapp.Settingsnow allows access to all sections in configuration files. The new
as_cpmethod returns a
ConfigParserinstance, which is set to the current value of every registered setting, in the
configsection, plus any additional sections in the configuration files that have been read.
Version 0.25.2, released 2012-02-08
- Fixed another bug in the process pipelining support. This time it was a silly Python optional argument handling problem.
Version 0.25.1, released 2012-02-08
- Fix bug in the process pipelining support.
Version 0.25, released 2012-02-06
- Improved error message for when executing a non-existent command.
runcmd_uncheckedcan now execute a pipeline.
- New overrideable methods
cleanupmake it easier to add code to be run just before and after
Version 0.24, released 2012-01-14
- Show the subcommand synopsis in --help output.
- Bug fix: setting a boolean setting to false in a configuration file now works. Thanks to Richard Maw for the bug report.
Version 0.23, released 2011-12-18
- Back off from using the
logging.NullHandlerclass, since that exists only in Python 2.7, and we want to support 2.6 too.
Version 0.22, released 2011-12-03
runcmd_uncheckedmethods have had an API change: the
stdinargument is now called
feed_stdin. This is so that callers may use
stdinto control how the
subprocess.Popenmodule sets up the child program's standard input.
- Syslog support has been added. Use
Version 0.21, released 2011-10-02
- License changed to GPL version 2 or later.
Version 0.20, released 2011-09-17
cliapp(5)manual page added, to explain in one place how applications built on cliapp will parse command lines and configuration files.
- The manual pages can now specify how the non-option arguments are formatted, in manual pages, including for each subcommand separately.
Version 0.19, released 2011-09-04
- Subcommand descriptions are formatted more prettily, in --help output.
- When a string list setting is set in a configuration file, any use of the corresponding option overrides the value from the configuration file, rather than appending to it.
Version 0.18, released 2011-08-24
cliapp.Settings.dump_configmethod, which can be useful, for example, if an application wants to save its configuration, or log it at startup.
Version 0.17, released 2011-08-22
- Give more humane error messages for IOError and OSError exceptions.
runcmd_uncheckedmethods now allow overriding the standard output and error redirections.
- Memory profiling statistics can now be logged by the application,
by calling the
--dump-memory-profilesetting is provided by the user to specify how the profiling is done: simple RSS memory size, and meliae and heapy Python memory profilers are supported.
Version 0.16, released 2011-08-19
- An EPIPE error when writing to stdout is suppressed. This avoids a Python stack trace or other error when user pipes output to, say, less, and quits less before the application finishes writing everything to stdout.
- Improve description of --log. (Thanks, Tapani Tarvainen.)
Version 0.15.1, released 2011-08-03
- Fix parsing of string list options: their values were being added
-foo=barwould result in
settings['foo']having the values
['bar', 'bar']. Oops. As a result, the
parse_argsmethod has a new keyword argument,
configs_only, which it should pass onto
- The argument names for the
process_input_linemethod have been improved.
Version 0.15, released 2011-08-02
cliapp.Applicationnow has a
subcommandsattribute, which is a directory mapping subcommand names to the functions that implement them. This provides an alternative way to define new subcommands, which may be useful in plugin-based applications.
- New method
- There are some new options provided by defaults:
--list-config-fileslists the config files the application will try to read
--config=FILEadds a file to the list of configuration files to be read
--no-default-configsprevents any of the default configuration files from being used; any
--configoptions used after this one will still be read
- Parsing of string list values in config files has been fixed. INI files
have no standard syntax for presenting files (maybe JSON would be a
better option), but I invented something. How very clever of me.
At the same time,
--dump-confignow formats string list values properly.
- Default values for string lists work better now: the default is used, unless the user specifies some values, in which only the values from the user are used.
Version 0.14, released 2011-07-20
- Start and end of program are now logged. This makes it easier to read log files.
- Commands run by the
runcmdmethod are now logged.
runcmdnow passes extra arguments to
Settings.requiremethod is added, so that it's easy to fail if the user has failed the give an option that is required in a given situation. (Mandatory options are a bit weird, but sometimes they happen.)
- Subcommands may now be added explicitly, using the
Application.add_subcommandmethod. This is helpful for applications that support plugins, for example.
Version 0.13, released 2011-06-18
- Change default log level to be
debug. Nothing is logged unless the user requests it, and if they do, they probably want to debug something, so this seems like the natural default.
- Log files are now rotated. See options --log-max, --log-keep.
- Log files are formatted in a nicer way now.
- Now registered with PyPI.
- String list settings now have a more sensible handling of default values. Previously the default value would always be used and user-supplied values would be appended to the default. Now user-supplied values replace the default value entirely.
- The old API for adding settings (
self.settings.add_string_settingetc) is gone. This should not bother anyone, since I am the only known user of cliapp so far, and I've fixed my stuff already.
metavaris provided if caller does not provide one. This fixes
--generate-manpageissue where an option would be documented as not having an argument unless
metavarwas set explicitly.
cliapp.Application.runcmdruns external programs and captures their standard output.
- The option parser is now created in a separate method than the one that uses it. This allows applications to modify the option parser in whatever way they want.
- Only the basename of a program (from
sys.argv) is used when determining
progname. This fixes a problem where config files could not be found because
Version 0.12, released 2011-05-29
- The new option
--generate-manpageallows one to fill in the OPTIONS section of a manpage.
cliappnow supports subcommands, e.g., "git help".
- API documentation is now formatted using Sphinx.
Version 0.11, released 2011-03-21
pydoc cliappnow works more usefully, and includes documentation for the various classes exported, not just a list of packages.
- Bugfix: if user specifies no log file, logging no longer happens to the standard output. This prevents exceptions from being reported twice.
- Log format now includes timestamps.
- New settings can now be added using shorter method names:
self.settins.add_string_setting. The old method names continue to work.
Version 0.10, released 2011-03-21
optparse.OptionParsercan now be set for settings. This makes for prettier
- The default value for integer settings is now 0, not
- README now has some more documentation of how to use the framework.
Version 0.9, released 2011-03-21
- Bugfix: Boolean options now work correctly, even in --help output.
Version 0.8, released 2011-03-20
- Bugfix: duplicate option names in --help output fixed.
- Exception handling has been improved: stack traces are now logged, and
cliapp.AppExceptionbase class for application exceptions, which will cause an error message to be written out, but no stack trace. All other exceptions cause a stack trace, so as to make it easier to debug things.
Version 0.7, released 2011-03-12
- Add configuration file support.
- API change: all settings are now in a class of their own, and are accessed
app.settings['output']. See the
cliapp.Settingsclass. This change breaks old code, sorry. But since I am still the only user, nobody minds.
- The callback setting type is now gone.
- Application name can now be set via the Application class's initializer
prognameargument), or by assigning to
cliapp.Settings.progname. If not set explicitly, it is set from
Version 0.6, released 2011-02-19
- New option types: list of strings, choice of strings, callback.
- New standard option: --dump-setting-names.
- Python profiling support: automatically if the right environment variable is set. If the process's argv is 'foo', and 'FOO_PROFILE' is set, then profiling happens.
- Documentation improvments.
Version 0.5, released 2011-02-13
- Catches exceptions and prints error message, instead of having the Python interpreter do a stack trace.
- Support more traditional Unix command line filter behavior: read from stdin if no arguments are given, or a dash ('-') is given as the filename.
- Count files and lines in files.
- New options: --output, --log, --log-level.
Version 0.4, released 2011-01-30
- Bugfix: Subclasses can now actually set the application version, so that --version works.