Розбір булевих значень з argparse

Я б хотів використовувати argparse для розбору бульних аргументів командного рядка, записаних як "--foo True" або "--foo False". Наприклад:

my_program --my_boolean_flag False

Однак наступний тестовий код не робить того, що я хотів би:

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)

Сумно, parsed_args.my_boolоцінює True. Це трапляється навіть тоді, коли я змінюсь cmd_lineбути ["--my_bool", ""], що дивно, оскільки bool("")оцінюється False.

Як я можу отримати argparse розібрати "False", "F"і їх малі варіанти бути False?

Ще одне рішення з використанням попередніх пропозицій, але з помилкою "правильного" розбору 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.')

Це дуже корисно для перемикань із значеннями за замовчуванням; наприклад

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

дозволяє мені використовувати:

script --nice
script --nice <bool>

і все-таки використовувати значення за замовчуванням (специфічне для налаштувань користувача). Один (опосередковано) недолік цього підходу полягає в тому, що "наркотики" можуть спіймати позитивний аргумент - див. Це пов'язане питання та цей звіт про помилку argparse .

Я думаю, що більш канонічний спосіб зробити це через:

command --feature

і

command --no-feature

argparse підтримує цю версію:

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

Звичайно, якщо ви дійсно хочете --arg <True|False>версії, ви можете перейти ast.literal_evalяк "тип" або визначена користувачем функція ...

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?

Я рекомендую відповідь mgilson, але з взаємовиключної групою ,
так що ви не можете використовувати --featureі --no-featureв той же час.

command --feature

і

command --no-feature

але не

command --feature --no-feature

Сценарій:

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)

Потім ви можете скористатися цим помічником, якщо ви збираєтеся встановити багато з них:

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')

Ось ще один варіант без додаткових рядків / с для встановлення значень за замовчуванням. У bool завжди присвоюється значення, щоб його можна було використовувати в логічних операторах без попередніх перевірок.

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'))

Там , здається, деяка плутанина щодо того , що type=boolі type='bool'могло б означати. Чи повинен один (або обидва) означати "запустити функцію bool()або" повернути булевий "? Так як він type='bool'нічого не означає. add_argumentвидає 'bool' is not callableпомилку, як і якщо ви використовували type='foobar', або type='int'.

Але argparseє реєстр, який дозволяє визначати такі ключові слова. В основному використовується для action, наприклад, `action = 'store_true'. Ви можете переглянути зареєстровані ключові слова за допомогою:

parser._registries

який відображає словник

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

Є багато дій визначені, але тільки один тип, за замовчуванням один, argparse.identity.

Цей код визначає ключове слово "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()не задокументовано, але також не приховано. Здебільшого програміст не повинен знати про це , тому що typeі actionфункції приймають і класові цінності. Є безліч прикладів stackoverflow для визначення спеціальних значень для обох.

Якщо це не очевидно з попереднього обговорення, bool()це не означає "розбір рядка". З документації Python:

bool (x): перетворити значення на булеве, використовуючи стандартну процедуру перевірки істинності.

Контрастуйте це з

int (x): Перетворити число або рядок x в ціле число.

Я шукав ту саму проблему, і їм дуже гарне рішення:

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

і використовуючи це для розбору рядка до булевого, як було запропоновано вище.

Досить схожий спосіб - це використовувати:

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

і якщо ви встановите аргумент - особливість у вашій команді

 command --feature

аргумент буде істинним, якщо ви не встановили тип - особливості аргументів за замовчуванням завжди помилкові!

На додаток до того, що сказав @mgilson, слід зазначити, що існує також ArgumentParser.add_mutually_exclusive_group(required=False)метод, який зробить тривіальним рішення про його виконання --flagі --no-flagне використовуються одночасно.

Це працює для всього, що я очікую від нього:

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

Код:

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')

Більш простим способом було б використання, як показано нижче.

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

Найпростіший. Це не гнучко, але я віддаю перевагу простоті.

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

EDIT: Якщо ви не довіряєте введенню, не використовуйте eval.

Найпростішим способом було б використання варіантів :

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

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

Не проходить --my-flag оцінюється на False. Потрібно = True варіант може бути доданий , якщо ви завжди хочете, щоб користувач явно вказати вибір.

Я думаю, що найбільш канонічним буде такий спосіб:

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)

Найпростіший і правильний спосіб

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

Зауважте, що значення True - y, так, t, true, on і 1; значення false - n, no, f, false, off та 0. Підвищує ValueError, якщо val - щось інше.

Швидко і просто, але лише для аргументів 0 або 1:

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

Вихід буде помилковим після виклику з терміналу:

python myscript.py 0

Схожий на @Akash, але ось інший підхід, який я використав. Він використовує, strніж lambdaтому, що пітон lambdaзавжди викликає в мене чужі почуття.

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")

Як покращення відповіді @Akash Desarda, ви можете зробити це

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)

І це підтримує 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