qpms.argproc Namespace Reference

Data Structures
class	ArgumentProcessingError
class	AppendTupleAction
class	ArgParser

Functions
def	flatten (S)
def	make_action_sharedlist (opname, listname)
def	make_dict_action (argtype=None, postaction='store', first_is_key=True)
def	float_range (string)
def	int_or_None (string)
def	sslice (string)
def	sfloat (string)
def	sint (string)
def	material_spec (string)

Variables
	nargs

Detailed Description

Common snippets for argument processing in command line scripts.

Function Documentation

float_range()

def qpms.argproc.float_range

(

string

)

Tries to parse a string either as one individual float value
or one of the following patterns:

first:last:increment
first:last|steps
first:last

(The last one is equivalent to first:last|50.)
Returns either float or numpy array.

int_or_None()

def qpms.argproc.int_or_None

(

string

)

Tries to parse a string either as an int or None (if it contains only whitespaces)

material_spec()

def qpms.argproc.material_spec

(

string

)

Tries to parse a string as a material specification, i.e. a 
real or complex number or one of the string in built-in Lorentz-Drude models.

Tries to interpret the string as 1) float, 2) complex, 3) Lorentz-Drude key.
Raises argparse.ArgumentTypeError on failure.

sfloat()

def qpms.argproc.sfloat

(

string

)

Tries to match a float, or a float with prepended 's'

Used as a workaraound for argparse's negative number matcher, which does not recognize
scientific notation.

sint()

def qpms.argproc.sint

(

string

)

Tries to match an int, or an int with prepended 's'

Used as a workaraound for argparse's negative number matcher if '+' is used as a
prefix 

sslice()

def qpms.argproc.sslice

(

string

)

Tries to parse a string either as one individual int value
or one of the following patterns:

first:last:increment
first:last

first, last and increment must be parseable as ints
or be empty (then 

In each case, 's' letter can be prepended to the whole string to avoid
argparse interpreting this as a new option (if the argument contains
'-' or '+').

Returns either int or slice containing ints or Nones.