tfep.utils.cli.tool.FlagOption

class tfep.utils.cli.tool.FlagOption(option_name, prepend_to_false=None)[source]

Bases: CLIOption

A generic command line flag option.

This descriptor accepts only True/False or None and it specifies CLI flag parameters (i.e., that do not take a value). If None, it is not passed to the command. If False, its behavior depends on the prepend_no_to_false parameter (see below).

Parameters:

option_name (str) – The name of the option in the command line interface (e.g., '-o').
prepend_to_false (str, optional) – If given and the descriptor is False, this string (typically 'no') is inserted into the flag passed to the command right after the dash character(s).

__init__(option_name, prepend_to_false=None)[source]

Methods

`__init__`(option_name[, prepend_to_false])
`to_subprocess`(owner_instance)	Implements `CLIOption.to_subprocess()`.

to_subprocess(owner_instance)[source]: Implements CLIOption.to_subprocess().