namedtuple和可选关键字参数的默认值

时间:2012-07-05 19:16:08

标签: python default-value namedtuple optional-arguments

我正在尝试将一个冗长的空洞“数据”类转换为一个命名元组。我的班级目前看起来像这样:

class Node(object):
    def __init__(self, val, left=None, right=None):
        self.val = val
        self.left = left
        self.right = right

转换为namedtuple后,它看起来像是:

from collections import namedtuple
Node = namedtuple('Node', 'val left right')

但这里有一个问题。我的原始类允许我传入一个值,并使用命名/关键字参数的默认值来处理默认值。类似的东西:

class BinaryTree(object):
    def __init__(self, val):
        self.root = Node(val)

但是这对我重构的名为元组的情况不起作用,因为它希望我传递所有字段。我当然可以将Node(val)的出现更换为Node(val, None, None),但这不符合我的喜好。

那么是否有一个好的技巧可以让我重写成功而不会增加很多代码复杂性(元编程)或者我应该吞下药丸并继续“搜索和替换”? :)

22 个答案:

答案 0 :(得分:421)

Python 3.7

使用默认值参数。

>>> from collections import namedtuple
>>> fields = ('val', 'left', 'right')
>>> Node = namedtuple('Node', fields, defaults=(None,) * len(fields))
>>> Node()
Node(val=None, left=None, right=None)

在Python 3.7之前

Node.__new__.__defaults__设置为默认值。

>>> from collections import namedtuple
>>> Node = namedtuple('Node', 'val left right')
>>> Node.__new__.__defaults__ = (None,) * len(Node._fields)
>>> Node()
Node(val=None, left=None, right=None)

在Python 2.6之前

Node.__new__.func_defaults设置为默认值。

>>> from collections import namedtuple
>>> Node = namedtuple('Node', 'val left right')
>>> Node.__new__.func_defaults = (None,) * len(Node._fields)
>>> Node()
Node(val=None, left=None, right=None)

顺序

在所有版本的Python中,如果您设置的默认值少于namedtuple中存在的默认值,则默认值将应用于最右侧的参数。这允许您将一些参数保留为必需参数。

>>> Node.__new__.__defaults__ = (1,2)
>>> Node()
Traceback (most recent call last):
  ...
TypeError: __new__() missing 1 required positional argument: 'val'
>>> Node(3)
Node(val=3, left=1, right=2)

Python 2.6至3.6

的包装器

这是一个包装器,它甚至可以让你(可选)将默认值设置为None以外的其他值。这不支持必需的参数。

import collections
def namedtuple_with_defaults(typename, field_names, default_values=()):
    T = collections.namedtuple(typename, field_names)
    T.__new__.__defaults__ = (None,) * len(T._fields)
    if isinstance(default_values, collections.Mapping):
        prototype = T(**default_values)
    else:
        prototype = T(*default_values)
    T.__new__.__defaults__ = tuple(prototype)
    return T

示例:

>>> Node = namedtuple_with_defaults('Node', 'val left right')
>>> Node()
Node(val=None, left=None, right=None)
>>> Node = namedtuple_with_defaults('Node', 'val left right', [1, 2, 3])
>>> Node()
Node(val=1, left=2, right=3)
>>> Node = namedtuple_with_defaults('Node', 'val left right', {'right':7})
>>> Node()
Node(val=None, left=None, right=7)
>>> Node(4)
Node(val=4, left=None, right=7)

答案 1 :(得分:135)

我将namedtuple子类化并覆盖了__new__方法:

from collections import namedtuple

class Node(namedtuple('Node', ['value', 'left', 'right'])):
    __slots__ = ()
    def __new__(cls, value, left=None, right=None):
        return super(Node, cls).__new__(cls, value, left, right)

这保留了一个直观的类型层次结构,伪装成类的工厂函数的创建不会。

答案 2 :(得分:89)

将其包裹在一个功能中。

NodeT = namedtuple('Node', 'val left right')

def Node(val, left=None, right=None):
  return NodeT(val, left, right)

答案 3 :(得分:52)

使用Python 3.6.1+中的typing.NamedTuple,您可以为NamedTuple字段提供默认值和类型注释。如果您只需要前者,请使用typing.Any

from typing import Any, NamedTuple


class Node(NamedTuple):
    val: Any
    left: 'Node' = None
    right: 'Node' = None

用法:

>>> Node(1)
Node(val=1, left=None, right=None)
>>> n = Node(1)
>>> Node(2, left=n)
Node(val=2, left=Node(val=1, left=None, right=None), right=None)

此外,如果你需要默认值和可选的可变性,Python 3.7将会有data classes (PEP 557),可以在某些(很多?)情况下替换namedtuples。

<小时/> 旁注:Python中当前规范annotations(参数和变量的:之后的表达式和函数的->之后的一个)的一个怪癖是它们在定义时间 *进行评估。因此,由于“一旦类的整个主体被执行就会定义类名”,上面类字段中'Node'的注释必须是字符串以避免NameError。

这种类型的提示被称为“前向引用”([1][2]),而PEP 563 Python 3.7+将被__future__导入(默认情况下在4.0)中启用,允许使用不带引号的前向引用,推迟评估。

* AFAICT仅在运行时不评估局部变量注释。 (来源:PEP 526

答案 4 :(得分:19)

我不确定是否有一个简单的方法只有内置的namedtuple。有一个名为recordtype的好模块具有此功能:

>>> from recordtype import recordtype
>>> Node = recordtype('Node', [('val', None), ('left', None), ('right', None)])
>>> Node(3)
Node(val=3, left=None, right=None)
>>> Node(3, 'L')
Node(val=3, left=L, right=None)

答案 5 :(得分:19)

这是an example straight from the docs

  

可以使用_replace()来自定义a来实现默认值   原型实例:

>>> Account = namedtuple('Account', 'owner balance transaction_count')
>>> default_account = Account('<owner name>', 0.0, 0)
>>> johns_account = default_account._replace(owner='John')
>>> janes_account = default_account._replace(owner='Jane')

因此,OP的例子是:

from collections import namedtuple
Node = namedtuple('Node', 'val left right')
default_node = Node(None, None, None)
example = default_node._replace(val="whut")

但是,我更喜欢这里给出的其他一些答案。我只是想补充一下这个完整性。

答案 6 :(得分:13)

这是一个更紧凑的版本,灵感来自justinfay的回答:

from collections import namedtuple
from functools import partial

Node = namedtuple('Node', ('val left right'))
Node.__new__ = partial(Node.__new__, left=None, right=None)

答案 7 :(得分:10)

在python3.7 +中,有一个全新的defaults=关键字参数。

  

默认值可以是None或可迭代的默认值。由于具有默认值的字段必须位于没有默认值的任何字段之后,因此默认值将应用于最右侧的参数。例如,如果字段名为['x', 'y', 'z']且默认值为(1, 2),则x将成为必填参数,y将默认为1,{ {1}}将默认为z

使用示例:

2

答案 8 :(得分:6)

简短,简单,并且不会导致人们不正当地使用isinstance

class Node(namedtuple('Node', ('val', 'left', 'right'))):
    @classmethod
    def make(cls, val, left=None, right=None):
        return cls(val, left, right)

# Example
x = Node.make(3)
x._replace(right=Node.make(4))

答案 9 :(得分:5)

使用None初始化所有缺少参数的略微扩展示例:

from collections import namedtuple

class Node(namedtuple('Node', ['value', 'left', 'right'])):
    __slots__ = ()
    def __new__(cls, *args, **kwargs):
        # initialize missing kwargs with None
        all_kwargs = {key: kwargs.get(key) for key in cls._fields}
        return super(Node, cls).__new__(cls, *args, **all_kwargs)

答案 10 :(得分:4)

结合@Denis和@Mark的方法:

from collections import namedtuple
import inspect

class Node(namedtuple('Node', 'left right val')):
    __slots__ = ()
    def __new__(cls, *args, **kwargs):
        args_list = inspect.getargspec(super(Node, cls).__new__).args[len(args)+1:]
        params = {key: kwargs.get(key) for key in args_list + kwargs.keys()}
        return super(Node, cls).__new__(cls, *args, **params) 

这应该支持使用位置参数和混合大小写创建元组。 测试用例:

>>> print Node()
Node(left=None, right=None, val=None)

>>> print Node(1,2,3)
Node(left=1, right=2, val=3)

>>> print Node(1, right=2)
Node(left=1, right=2, val=None)

>>> print Node(1, right=2, val=100)
Node(left=1, right=2, val=100)

>>> print Node(left=1, right=2, val=100)
Node(left=1, right=2, val=100)

>>> print Node(left=1, right=2)
Node(left=1, right=2, val=None)

但也支持TypeError:

>>> Node(1, left=2)
TypeError: __new__() got multiple values for keyword argument 'left'

答案 11 :(得分:4)

您也可以使用:

import inspect

def namedtuple_with_defaults(type, default_value=None, **kwargs):
    args_list = inspect.getargspec(type.__new__).args[1:]
    params = dict([(x, default_value) for x in args_list])
    params.update(kwargs)

    return type(**params)

这基本上使您可以构造具有默认值的任何命名元组,并仅覆盖您需要的参数,例如:

import collections

Point = collections.namedtuple("Point", ["x", "y"])
namedtuple_with_defaults(Point)
>>> Point(x=None, y=None)

namedtuple_with_defaults(Point, x=1)
>>> Point(x=1, y=None)

答案 12 :(得分:4)

Python 3.7:在namedtuple定义中引入了defaults参数。

示例如文档所示:

>>> Account = namedtuple('Account', ['type', 'balance'], defaults=[0])
>>> Account._fields_defaults
{'balance': 0}
>>> Account('premium')
Account(type='premium', balance=0)

了解更多here

答案 13 :(得分:3)

我觉得这个版本更容易阅读:

from collections import namedtuple

def my_tuple(**kwargs):
    defaults = {
        'a': 2.0,
        'b': True,
        'c': "hello",
    }
    default_tuple = namedtuple('MY_TUPLE', ' '.join(defaults.keys()))(*defaults.values())
    return default_tuple._replace(**kwargs)

这不是需要两次创建对象的效率,但是你可以通过在模块中定义默认的duple并让函数执行替换行来改变它。

答案 14 :(得分:2)

由于您使用namedtuple作为数据类,您应该知道python 3.7将为此目的引入@dataclass装饰器 - 当然它具有默认值。

An example from the docs

@dataclass
class C:
    a: int       # 'a' has no default value
    b: int = 0   # assign a default value for 'b'

比黑客namedtuple更清晰,可读和可用。随着采用3.7,不难预测namedtuple s的使用率会下降。

答案 15 :(得分:1)

受到this answer的启发,针对不同的问题,这是我提出的基于metaclass和使用super的解决方案(以正确处理未来的子计算)。它与justinfay's answer非常相似。

from collections import namedtuple

NodeTuple = namedtuple("NodeTuple", ("val", "left", "right"))

class NodeMeta(type):
    def __call__(cls, val, left=None, right=None):
        return super(NodeMeta, cls).__call__(val, left, right)

class Node(NodeTuple, metaclass=NodeMeta):
    __slots__ = ()

然后:

>>> Node(1, Node(2, Node(4)),(Node(3, None, Node(5))))
Node(val=1, left=Node(val=2, left=Node(val=4, left=None, right=None), right=None), right=Node(val=3, left=None, right=Node(val=5, left=None, right=None)))

答案 16 :(得分:1)

通过jterrace使用recordtype的答案很好,但是该库的作者建议使用他的namedlist项目,该项目同时提供可变(namedlist)和不可变(namedtuple)实施。

from namedlist import namedtuple
>>> Node = namedtuple('Node', ['val', ('left', None), ('right', None)])
>>> Node(3)
Node(val=3, left=None, right=None)
>>> Node(3, 'L')
Node(val=3, left=L, right=None)

答案 17 :(得分:0)

使用Advanced Enum (aenum)库中的NamedTuple类,并使用class语法,这非常简单:

from aenum import NamedTuple

class Node(NamedTuple):
    val = 0
    left = 1, 'previous Node', None
    right = 2, 'next Node', None

一个潜在的缺点是,对于具有默认值的任何属性,要求__doc__字符串(对于简单属性,它是可选的)。在使用中它看起来像:

>>> Node()
Traceback (most recent call last):
  ...
TypeError: values not provided for field(s): val

>>> Node(3)
Node(val=3, left=None, right=None)

此优势优于justinfay's answer

from collections import namedtuple

class Node(namedtuple('Node', ['value', 'left', 'right'])):
    __slots__ = ()
    def __new__(cls, value, left=None, right=None):
        return super(Node, cls).__new__(cls, value, left, right)

简单,而且基于metaclass而不是基于exec

答案 18 :(得分:0)

另一种解决方案:

Create a Struct which holds the required  array values.

Eg . 
  Struct Entities {    
    var room = Room()
    var floor = Floor()
    var alarm = Alarms()  
 }

 var tableDataSource = [Entites]()

// Now add required data to entities array by iteration 

// tableDataSource count will be your number of rows in section count 

用法:

import collections


def defaultargs(func, defaults):
    def wrapper(*args, **kwargs):
        for key, value in (x for x in defaults[len(args):] if len(x) == 2):
            kwargs.setdefault(key, value)
        return func(*args, **kwargs)
    return wrapper


def namedtuple(name, fields):
    NamedTuple = collections.namedtuple(name, [x[0] for x in fields])
    NamedTuple.__new__ = defaultargs(NamedTuple.__new__, [(NamedTuple,)] + fields)
    return NamedTuple

答案 19 :(得分:0)

这是一个简短,简单的通用答案,它带有带有默认参数的命名元组的漂亮语法:

import collections

def dnamedtuple(typename, field_names, **defaults):
    fields = sorted(field_names.split(), key=lambda x: x in defaults)
    T = collections.namedtuple(typename, ' '.join(fields))
    T.__new__.__defaults__ = tuple(defaults[field] for field in fields[-len(defaults):])
    return T

用法:

Test = dnamedtuple('Test', 'one two three', two=2)
Test(1, 3)  # Test(one=1, three=3, two=2)

缩小:

def dnamedtuple(tp, fs, **df):
    fs = sorted(fs.split(), key=df.__contains__)
    T = collections.namedtuple(tp, ' '.join(fs))
    T.__new__.__defaults__ = tuple(df[i] for i in fs[-len(df):])
    return T

答案 20 :(得分:0)

如果您想保留使用类型注释的可能性,不幸的是@mark-lodato 提供的非常好的解决方案不可用(我在设置 __defaults__ 时失败了)。 另一种方法是使用 attrs:

import attr

 
@attr.s
class Node(object):
    val: str = attr.ib()
    left: 'Node' = attr.ib(None)
    right: 'Node' = attr.ib(None)

这有:

  • 类型注释
  • 不错的__str____repr__
  • 可定制,因为它是一个真正的类
  • 与所有 Python 版本相同的实现

答案 21 :(得分:-1)

这是Mark Lodato包装器的一个不太灵活但更简洁的版本:它将字段和默认值作为字典。

import collections
def namedtuple_with_defaults(typename, fields_dict):
    T = collections.namedtuple(typename, ' '.join(fields_dict.keys()))
    T.__new__.__defaults__ = tuple(fields_dict.values())
    return T

示例:

In[1]: fields = {'val': 1, 'left': 2, 'right':3}

In[2]: Node = namedtuple_with_defaults('Node', fields)

In[3]: Node()
Out[3]: Node(val=1, left=2, right=3)

In[4]: Node(4,5,6)
Out[4]: Node(val=4, left=5, right=6)

In[5]: Node(val=10)
Out[5]: Node(val=10, left=2, right=3)