Analisando Valores Booleanos com Argparse

Eu gostaria de usar argparse para analisar argumentos booleanos da linha de comando escritos como "--foo True" ou "--foo True". Por exemplo:

my_program --my_boolean_flag False

No entanto, o código de teste a seguir não faz o que eu gostaria:

import argparse
parser = argparse.ArgumentParser(description="My parser")
parser.add_argument("--my_bool", type=bool)
cmd_line = ["--my_bool", "False"]
parsed_args = parser.parse(cmd_line)

Infelizmente, parsed_args.my_boolavalia como True. Este é o caso mesmo quando eu mudo cmd_linepara ser ["--my_bool", ""], o que é surpreendente, já que é bool("")avaliado em False.

Como posso obter argparse para analisar "False", "F"e sua minúscula variantes para ser False?

Outra solução usando as sugestões anteriores, mas com o erro de análise "correto" de argparse:

def str2bool(v):
    if isinstance(v, bool):
       return v
    if v.lower() in ('yes', 'true', 't', 'y', '1'):
        return True
    elif v.lower() in ('no', 'false', 'f', 'n', '0'):
        return False
    else:
        raise argparse.ArgumentTypeError('Boolean value expected.')

Isso é muito útil para fazer trocas com valores padrão; por exemplo

parser.add_argument("--nice", type=str2bool, nargs='?',
                        const=True, default=False,
                        help="Activate nice mode.")

me permite usar:

script --nice
script --nice <bool>

e ainda use um valor padrão (específico para as configurações do usuário). Uma desvantagem (relacionada indiretamente) com essa abordagem é que os 'nargs' podem pegar um argumento posicional - veja esta questão relacionada e este relatório de erro da argparse .

Eu acho que uma maneira mais canônica de fazer isso é via:

command --feature

e

command --no-feature

argparse suporta bem esta versão:

parser.add_argument('--feature', dest='feature', action='store_true')
parser.add_argument('--no-feature', dest='feature', action='store_false')
parser.set_defaults(feature=True)

Obviamente, se você realmente deseja a --arg <True|False>versão, pode passar ast.literal_evalcomo o "tipo" ou uma função definida pelo usuário ...

def t_or_f(arg):
    ua = str(arg).upper()
    if 'TRUE'.startswith(ua):
       return True
    elif 'FALSE'.startswith(ua):
       return False
    else:
       pass  #error condition maybe?

Eu recomendo a resposta de mgilson, mas com um grupo mutuamente exclusivo,
para que você não possa usar --featuree --no-featureao mesmo tempo.

command --feature

e

command --no-feature

mas não

command --feature --no-feature

Roteiro:

feature_parser = parser.add_mutually_exclusive_group(required=False)
feature_parser.add_argument('--feature', dest='feature', action='store_true')
feature_parser.add_argument('--no-feature', dest='feature', action='store_false')
parser.set_defaults(feature=True)

Você pode usar esse auxiliar se quiser definir muitos deles:

def add_bool_arg(parser, name, default=False):
    group = parser.add_mutually_exclusive_group(required=False)
    group.add_argument('--' + name, dest=name, action='store_true')
    group.add_argument('--no-' + name, dest=name, action='store_false')
    parser.set_defaults(**{name:default})

add_bool_arg(parser, 'useful-feature')
add_bool_arg(parser, 'even-more-useful-feature')

Aqui está outra variação sem linhas extras para definir os valores padrão. O bool sempre tem um valor atribuído para que possa ser usado em instruções lógicas sem pré-verificações.

import argparse
parser = argparse.ArgumentParser(description="Parse bool")
parser.add_argument("--do-something", default=False, action="store_true" , help="Flag to do something")
args = parser.parse_args()

if args.do_something:
     print("Do something")
else:
     print("Don't do something")
print("Check that args.do_something=" + str(args.do_something) + " is always a bool")

oneliner:

parser.add_argument('--is_debug', default=False, type=lambda x: (str(x).lower() == 'true'))

Parece haver alguma confusão sobre o que type=boole type='bool'pode significar. Um (ou ambos) deve significar 'executar a função bool()ou' retornar um booleano '? Tal como está type='bool', não significa nada. add_argumentdá um 'bool' is not callableerro, igual ao que você usou type='foobar', ou type='int'.

Mas argparsepossui um registro que permite definir palavras-chave como esta. É usado principalmente para action, por exemplo, `action = 'store_true'. Você pode ver as palavras-chave registradas com:

parser._registries

que exibe um dicionário

{'action': {None: argparse._StoreAction,
  'append': argparse._AppendAction,
  'append_const': argparse._AppendConstAction,
...
 'type': {None: <function argparse.identity>}}

Existem muitas ações definidas, mas apenas um tipo, o padrão argparse.identity,.

Este código define uma palavra-chave 'bool':

def str2bool(v):
  #susendberg's function
  return v.lower() in ("yes", "true", "t", "1")
p = argparse.ArgumentParser()
p.register('type','bool',str2bool) # add type keyword to registries
p.add_argument('-b',type='bool')  # do not use 'type=bool'
# p.add_argument('-b',type=str2bool) # works just as well
p.parse_args('-b false'.split())
Namespace(b=False)

parser.register()não está documentado, mas também não está oculto. Para a maior parte o programador não precisa saber sobre isso, porque typee actionfunção take e de classe valores. Existem muitos exemplos de stackoverflow para definir valores personalizados para ambos.

Caso isso não seja óbvio na discussão anterior, bool()não significa 'analisar uma string'. Na documentação do Python:

bool (x): converte um valor em um booleano, usando o procedimento padrão de teste da verdade.

Compare isso com

int (x): converte um número ou sequência x em um número inteiro.

Eu estava procurando o mesmo problema, e imho a solução bonita é:

def str2bool(v):
  return v.lower() in ("yes", "true", "t", "1")

e usando isso para analisar a string como booleana, conforme sugerido acima.

Uma maneira bastante semelhante é usar:

feature.add_argument('--feature',action='store_true')

e se você definir o argumento --feature em seu comando

 command --feature

o argumento será True, se você não definir type --feature, o argumento default será sempre False!

Além do que o @mgilson disse, deve-se notar que também há um ArgumentParser.add_mutually_exclusive_group(required=False)método que tornaria trivial impor isso --flage --no-flagnão é usado ao mesmo tempo.

Isso funciona para tudo o que eu espero:

add_boolean_argument(parser, 'foo', default=True)
parser.parse_args([])                   # Whatever the default was
parser.parse_args(['--foo'])            # True
parser.parse_args(['--nofoo'])          # False
parser.parse_args(['--foo=true'])       # True
parser.parse_args(['--foo=false'])      # False
parser.parse_args(['--foo', '--nofoo']) # Error

O código:

def _str_to_bool(s):
    """Convert string to bool (in argparse context)."""
    if s.lower() not in ['true', 'false']:
        raise ValueError('Need bool; got %r' % s)
    return {'true': True, 'false': False}[s.lower()]

def add_boolean_argument(parser, name, default=False):                                                                                               
    """Add a boolean argument to an ArgumentParser instance."""
    group = parser.add_mutually_exclusive_group()
    group.add_argument(
        '--' + name, nargs='?', default=default, const=True, type=_str_to_bool)
    group.add_argument('--no' + name, dest=name, action='store_false')

Uma maneira mais simples seria usar como abaixo.

parser.add_argument('--feature', type=lambda s: s.lower() in ['true', 't', 'yes', '1'])

Mais simples. Não é flexível, mas prefiro a simplicidade.

  parser.add_argument('--boolean_flag',
                      help='This is a boolean flag.',
                      type=eval, 
                      choices=[True, False], 
                      default='True')

EDIT: Se você não confia na entrada, não use eval.

A maneira mais simples seria usar as opções :

parser = argparse.ArgumentParser()
parser.add_argument('--my-flag',choices=('True','False'))

args = parser.parse_args()
flag = args.my_flag == 'True'
print(flag)

Não passando --my-flag é avaliado como False. A opção required = True pode ser adicionada se você sempre quiser que o usuário especifique explicitamente uma opção.

Eu acho que a maneira mais canônica será:

parser.add_argument('--ensure', nargs='*', default=None)

ENSURE = config.ensure is None

class FlagAction(argparse.Action):
    # From http://bugs.python.org/issue8538

    def __init__(self, option_strings, dest, default=None,
                 required=False, help=None, metavar=None,
                 positive_prefixes=['--'], negative_prefixes=['--no-']):
        self.positive_strings = set()
        self.negative_strings = set()
        for string in option_strings:
            assert re.match(r'--[A-z]+', string)
            suffix = string[2:]
            for positive_prefix in positive_prefixes:
                self.positive_strings.add(positive_prefix + suffix)
            for negative_prefix in negative_prefixes:
                self.negative_strings.add(negative_prefix + suffix)
        strings = list(self.positive_strings | self.negative_strings)
        super(FlagAction, self).__init__(option_strings=strings, dest=dest,
                                         nargs=0, const=None, default=default, type=bool, choices=None,
                                         required=required, help=help, metavar=metavar)

    def __call__(self, parser, namespace, values, option_string=None):
        if option_string in self.positive_strings:
            setattr(namespace, self.dest, True)
        else:
            setattr(namespace, self.dest, False)

A maneira mais simples e correta é

from distutils import util
arser.add_argument('--feature', dest='feature', type=lambda x:bool(distutils.util.strtobool(x)))

Observe que os valores verdadeiros são y, sim, t, verdadeiro, ativado e 1; valores falsos são n, não, f, falso, desligado e 0. Gera ValueError se val for outra coisa.

Rápido e fácil, mas apenas para argumentos 0 ou 1:

parser.add_argument("mybool", default=True,type=lambda x: bool(int(x)))
myargs=parser.parse_args()
print(myargs.mybool)

A saída será "False" após a chamada do terminal:

python myscript.py 0

Semelhante ao Akash, mas aqui está outra abordagem que eu usei. Ele usa do strque lambdaporque python lambdasempre me dá um sentimento estranho.

import argparse
from distutils.util import strtobool

parser = argparse.ArgumentParser()
parser.add_argument("--my_bool", type=str, default="False")
args = parser.parse_args()

if bool(strtobool(args.my_bool)) is True:
    print("OK")

Como uma melhoria na resposta de @Akash Desarda, você pode fazer

import argparse
from distutils.util import strtobool

parser = argparse.ArgumentParser()
parser.add_argument("--foo", 
    type=lambda x:bool(strtobool(x)),
    nargs='?', const=True, default=False)
args = parser.parse_args()
print(args.foo)

E suporta python test.py --foo

(base) [costa@costa-pc code]$ python test.py
False
(base) [costa@costa-pc code]$ python test.py --foo 
True
(base) [costa@costa-pc code]$ python test.py --foo True
True
(base) [costa@costa-pc code]$ python test.py --foo False
False