microprobe.utils.cmdline

microprobe.utils.cmdline module

Functions

csv_with_integer(argument)

csv_with_ranges(min_value, max_value)

dict_key(dictionary)

existing_cmd(argument)

existing_dir(argument)

existing_file(argument)

existing_file_ext(extension)

file_with(base_function)

float_range(min_val, max_val)

float_type(min_val, max_val)

int_choices(choices)

int_range(min_val, max_val)

int_type(min_val, max_val)

new_file(argument[, internal])

new_file_ext(extension)

parse_instruction_list(target, sequence)

print_error(string)

print_info(string)

print_warning(string)

string_with_chars(chars)

string_with_fields(sep, min_elem, max_elem, fmt)

Classes

CLI(description, **kwargs)

Object to define a Command Line Interface.

LazyArgumentParser(**kwargs)

A Lazy argument parser.

ParagraphFormatterML(prog[, ...])

A support class for nicer CLI help output.

Classes diagram

Inheritance diagram of CLI, LazyArgumentParser, ParagraphFormatterML

Exceptions

LazyArgumentError

An exception class to report argument error.


Functions

csv_with_integer(argument)[source]
Parameters:

argument

csv_with_ranges(min_value, max_value)[source]
Parameters:

argument

dict_key(dictionary)[source]
Parameters:

dictionary

existing_cmd(argument)[source]
Parameters:

argument

existing_dir(argument)[source]
Parameters:

argument

existing_file(argument)[source]
Parameters:

argument

existing_file_ext(extension)[source]
Parameters:

extension

file_with(base_function)[source]
float_range(min_val, max_val)[source]
Parameters:

  • min_val

  • max_val

float_type(min_val, max_val)[source]
Parameters:

  • min_val

  • max_val

int_choices(choices)[source]
int_range(min_val, max_val)[source]
Parameters:

  • min_val

  • max_val

int_type(min_val, max_val)[source]
Parameters:

  • min_val

  • max_val

new_file(argument, internal=False)[source]
Parameters:

argument

new_file_ext(extension)[source]
Parameters:

extension

parse_instruction_list(target, sequence)[source]
Parameters:

  • target

  • sequence

print_error(string)[source]
Parameters:

string

print_info(string)[source]
Parameters:

string

print_warning(string)[source]
Parameters:

string

string_with_chars(chars)[source]
string_with_fields(sep, min_elem, max_elem, fmt)[source]