Python argparse可选位置参数默认值设为None的问题

问题场景 #

想要实现：不传入位置参数时，参数值为None；传入多个位置参数时，参数值为包含这些参数的列表，预期运行效果如下：

$> my_app
Namespace(positional=None)
$> my_app file.txt somedir
Namespace(positional=['file.txt', 'somedir'])

尝试了以下代码：

p = argparse.ArgumentParser()
p.add_argument("positional", nargs='*', default=None)

print(p.parse_args())

但实际运行结果却是：

$> my_app
Namespace(positional=[])
$> my_app file.txt somedir
Namespace(positional=['file.txt', 'somedir'])

由于现有代码依赖None作为默认值触发后续逻辑，空列表无法满足需求。经确认，这种行为是argparse的设计如此，但不符合直觉。

解决方案 #

方案1：解析后手动替换空列表为None #

最简单的方式是在解析完成后，判断参数值是否为空列表，若是则替换为None：

import argparse

p = argparse.ArgumentParser()
p.add_argument("positional", nargs='*')

args = p.parse_args()
# 空列表时替换为None
if not args.positional:
    args.positional = None

print(args)

运行效果符合预期：

$> my_app
Namespace(positional=None)
$> my_app file.txt somedir
Namespace(positional=['file.txt', 'somedir'])

方案2：自定义Action类处理逻辑 #

如果希望在argparse内部完成逻辑，可以自定义一个Action类，在处理参数时判断值是否为空，为空则设置为None：

import argparse

class NoneDefaultListAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
        # 有值则赋值列表，无值则赋值None
        setattr(namespace, self.dest, values if values else None)

p = argparse.ArgumentParser()
p.add_argument("positional", nargs='*', action=NoneDefaultListAction)

print(p.parse_args())

原因说明 #

argparse中使用nargs='*'时，其语义是匹配0个或多个位置参数。对于0个参数的情况，argparse会默认返回空列表，而忽略你设置的default=None——这是官方设计的行为，目的是保持nargs='*'返回值的类型一致性（始终为列表类型），但确实和直观预期有冲突。

内容的提问来源于stack exchange，提问作者Sokrutu