将 Python argparse.Namespace() 视为字典的正确方法是啥？

Posted 2023-02-23

【中文标题】将 Python argparse.Namespace() 视为字典的正确方法是啥？

【英文标题】：What is the right way to treat Python argparse.Namespace() as a dictionary?将 Python argparse.Namespace() 视为字典的正确方法是什么？

【发布时间】：2013-05-28 12:23:34

【问题描述】：

如果我想使用argparse.ArgumentParser() 的结果，它是一个Namespace 对象，并带有一个需要字典或类似映射的对象的方法（请参阅collections.Mapping），正确的方法是什么?

C:\>python
Python 2.7.3 (default, Apr 10 2012, 23:31:26) [MSC v.1500 32 bit (Intel)] on win
32
Type "help", "copyright", "credits" or "license" for more information.
>>> import argparse
>>> args = argparse.Namespace()
>>> args.foo = 1
>>> args.bar = [1,2,3]
>>> args.baz = 'yippee'
>>> args['baz']
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'Namespace' object has no attribute '__getitem__'
>>> dir(args)
['__class__', '__contains__', '__delattr__', '__dict__', '__doc__', '__eq__', '_
_format__', '__getattribute__', '__hash__', '__init__', '__module__', '__ne__',
'__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__
', '__str__', '__subclasshook__', '__weakref__', '_get_args', '_get_kwargs', 'ba
r', 'baz', 'foo']

“进入”对象并使用其__dict__ 属性是否合适？

我认为答案是否定的：__dict__ 闻起来像是实现约定，但不是接口，就像 __getattribute__ 或 __setattr__ 或 __contains__ 似乎那样。

【问题讨论】：

你试过dict(args)吗？为什么显而易见的方式不起作用？

【参考方案1】：

您可以使用vars() 访问命名空间的字典：

>>> import argparse
>>> args = argparse.Namespace()
>>> args.foo = 1
>>> args.bar = [1,2,3]
>>> d = vars(args)
>>> d
'foo': 1, 'bar': [1, 2, 3]

如果你愿意，可以直接修改字典：

>>> d['baz'] = 'store me'
>>> args.baz
'store me'

是的，可以访问 __dict__ 属性。这是一种定义明确、经过测试且有保证的行为。

【讨论】：

文档说：“返回的字典不应该被修改：对相应符号表的影响是未定义的。”哪个可能仅指vars()（locals()或globals()）的行为，但我不太确定。

嗯，我想我不太明白使用vars() 和__dict__ 之间的区别

@delnan 有人对文档进行了不正确的编辑，并发出了过于宽泛的警告。随后对文档进行了更正。请参阅docs.python.org/2.7/library/functions.html#vars 虽然有一些特殊情况具有只读字典（例如本地和类字典代理），但其余情况是可更新的。 vars(obj) 调用与 obj.__dict__ 同义。对于 argparse 命名空间，vars(args) 提供对可更新字典的直接访问。

@RaymondHettinger 好的，整洁。我从文档的/3/ 版本（仔细检查后，包括 3.1 到 3.4）中得到了该注释，因此那里显然缺少更正。

@delnan 我刚刚更新了 3.3 和 3.3 文档。明天就可以看到了。感谢您指出。

【参考方案2】：

“进入”一个对象并使用它的 dict 属性是否合适？

一般来说，我会说“不”。然而，Namespace 让我觉得设计过度，可能是因为类无法从内置类型继承。

另一方面，Namespace 确实为 argparse 提供了一种面向任务的方法，我想不出需要抓住__dict__ 的情况，但我的想象力限制不一样和你一样。

【讨论】：

完全可以访问 __dict__ 属性。内省是语言的基础。该属性被公开是有原因的 :-)

但是 Python 中的一切都是“公共的”。实例中使用的实现变量和它呈现的公共接口之间没有区别（前导下划线约定除外）。尤其是在类字典对象中：实例方法和作为函数的字典值之间的界限有点​​模糊。

如果您将参数作为命名参数传递？ do_something(**args.__dict__)

为什么明显的方式不起作用，例如dict(args)?或者至少为什么这不是最佳答案/推荐？

【参考方案3】：

Straight from the horse's mouth:

如果您喜欢类似字典的属性视图，可以使用标准 Python 习惯用法vars()：

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> args = parser.parse_args(['--foo', 'BAR'])
>>> vars(args)
'foo': 'BAR'

— Python 标准库，16.4.4.6。 The Namespace object

【讨论】：

仍然 'foo' 错过了 '--'。有什么想法吗？

@user2678074 这是为了匹配 shell 标志。破折号在 python 执行中是无关的。

vars(args) 给我TypeError: 'dict' object is not callable

@user5359531 你可能用变量覆盖了全局vars。您可以使用__builtins__.vars 直接访问它，或使用del vars 停止对其进行遮蔽。

@NickT 次要更正：Python 函数是静态作用域的，因此如果您在函数中隐藏全局变量，则该标识符将始终引用该函数中的局部变量，即使在分配之前或之后 @987654331 @。在模块范围 del 可以“取消隐藏”内置函数。

【参考方案4】：

请注意，如果您尝试将 args 视为一个 dict 来确定它是否具有属性，则可以改为执行以下操作：

if hasattr(args, 'someProperty'):
    a.someProperty

更多关于hasattr和similar answer to another question的信息

此外，如果您更喜欢使用类似的getattr method，您可以获取该值：

value = getattr(args, 'someProperty')