HappyDoc Generated Documentation HappyDoc3-r3_1/happydoclib/optiontools.py

HappyDoc3-r3_1 / happydoclib / optiontools.py 

Functions for handling options and arguments.

Functions   
  getBooleanArgumentValue 
getBooleanArgumentValue ( inputValue )

Convert value for a boolean argument into a boolean representation.

When presented with a representation of a boolean value, convert that represetntation to a 1 or 0 and return it. Currently accepts:

  • integer or floating point values
  • strings (with mixed case) with words true, false, yes, no, on, off, None

Exceptions   

ValueError( 'Unrecognized boolean value', inputValue )

  getParameters 
getParameters (
        prefix,
        args,
        prefixSeparator='_',
        )

Find parameter settings in an argument sequence.

Arguments
prefix
Parameter names must begin with this string followed by prefixSeparator.
args
Sequence containing arguments to scan.
prefixSeparator
String separating prefix from actual parameter names.
Classes   

OptionToolTest


This document was automatically generated Tue Dec 5 08:30:27 2006 by HappyDoc version 3.1