Python中的“命名元组”是什么?

2022-09-05 01:06:09
  • 什么是命名元组,如何使用它们?
  • 何时应使用命名元组而不是普通元组,反之亦然?
  • 是否也有“命名列表”?(即可变命名元组)

答案 1

命名元组基本上是易于创建的轻量级对象类型。可以使用类似对象的变量取消引用或标准元组语法来引用命名元组实例。它们可以类似于或其他常见记录类型使用,只是它们是不可变的。它们是在Python 2.6和Python 3.0中添加的,尽管在Python 2.4中有实现的配方struct

例如,通常将点表示为元组。这会导致生成如下代码:(x, y)

pt1 = (1.0, 5.0)
pt2 = (2.5, 1.5)

from math import sqrt
line_length = sqrt((pt1[0]-pt2[0])**2 + (pt1[1]-pt2[1])**2)

使用命名元组,它变得更具可读性:

from collections import namedtuple
Point = namedtuple('Point', 'x y')
pt1 = Point(1.0, 5.0)
pt2 = Point(2.5, 1.5)

from math import sqrt
line_length = sqrt((pt1.x-pt2.x)**2 + (pt1.y-pt2.y)**2)

但是,命名元组仍然与普通元组向后兼容,因此以下内容仍然有效:

Point = namedtuple('Point', 'x y')
pt1 = Point(1.0, 5.0)
pt2 = Point(2.5, 1.5)

from math import sqrt
# use index referencing
line_length = sqrt((pt1[0]-pt2[0])**2 + (pt1[1]-pt2[1])**2)
 # use tuple unpacking
x1, y1 = pt1

因此,您应该使用命名元组而不是元组,因为您认为对象表示法会使代码更具pythonic和更易于阅读。我个人已经开始使用它们来表示非常简单的值类型,尤其是在将它们作为参数传递给函数时。它使函数更具可读性,而无需查看元组打包的上下文。

此外,您还可以替换普通的不可变类,这些类没有函数,只有字段。您甚至可以将命名元组类型用作基类:

class Point(namedtuple('Point', 'x y')):
    [...]

但是,与元组一样,命名元组中的属性是不可变的:

>>> Point = namedtuple('Point', 'x y')
>>> pt1 = Point(1.0, 5.0)
>>> pt1.x = 2.0
AttributeError: can't set attribute

如果希望能够更改值,则需要另一种类型。可变记录类型有一个方便的配方,允许您为属性设置新值。

>>> from rcdtype import *
>>> Point = recordtype('Point', 'x y')
>>> pt1 = Point(1.0, 5.0)
>>> pt1 = Point(1.0, 5.0)
>>> pt1.x = 2.0
>>> print(pt1[0])
    2.0

但是,我不知道任何形式的“命名列表”可以让您添加新字段。在这种情况下,您可能只想使用字典。命名元组可以使用返回的字典转换为字典,并且可以使用所有常用的字典函数对其进行操作。pt1._asdict(){'x': 1.0, 'y': 5.0}

如前所述,您应该查看文档以获取构建这些示例的详细信息。


答案 2

什么是命名元组?

命名元组是元组。

它执行元组可以执行的所有操作。

但它不仅仅是一个元组。

它是以编程方式根据规范创建的元组的特定子类,具有命名字段和固定长度。

例如,这创建了元组的子类,除了长度固定(在本例中为三个)之外,它还可以在使用元组的任何地方使用而不会中断。这被称为Liskov可替代性。

Python 3.6中的新功能,我们可以在类型化中使用类定义。NamedTuple 创建 namedtuple:

from typing import NamedTuple

class ANamedTuple(NamedTuple):
    """a docstring"""
    foo: int
    bar: str
    baz: list

以上与 collections.namedtuple 相同,只是上面还有类型注释和文档字符串。以下内容在 Python 2+ 中可用:

>>> from collections import namedtuple
>>> class_name = 'ANamedTuple'
>>> fields = 'foo bar baz'
>>> ANamedTuple = namedtuple(class_name, fields)

这将实例化它:

>>> ant = ANamedTuple(1, 'bar', [])

我们可以检查它并使用其属性:

>>> ant
ANamedTuple(foo=1, bar='bar', baz=[])
>>> ant.foo
1
>>> ant.bar
'bar'
>>> ant.baz.append('anything')
>>> ant.baz
['anything']

更深入的解释

要理解命名元组,首先需要知道什么是元组。元组本质上是一个不可变(无法在内存中就地更改)列表。

下面介绍了如何使用常规元组:

>>> student_tuple = 'Lisa', 'Simpson', 'A'
>>> student_tuple
('Lisa', 'Simpson', 'A')
>>> student_tuple[0]
'Lisa'
>>> student_tuple[1]
'Simpson'
>>> student_tuple[2]
'A'

您可以使用可迭代解包来扩展元组:

>>> first, last, grade = student_tuple
>>> first
'Lisa'
>>> last
'Simpson'
>>> grade
'A'

命名元组是允许按名称(而不仅仅是索引)访问其元素的元组!

你做了一个像这样的命名:

>>> from collections import namedtuple
>>> Student = namedtuple('Student', ['first', 'last', 'grade'])

您还可以使用名称由空格分隔的单个字符串,这是 API 的可读性稍强的用法:

>>> Student = namedtuple('Student', 'first last grade')

如何使用它们?

您可以执行元组可以执行的所有操作(见上文),也可以执行以下操作:

>>> named_student_tuple = Student('Lisa', 'Simpson', 'A')
>>> named_student_tuple.first
'Lisa'
>>> named_student_tuple.last
'Simpson'
>>> named_student_tuple.grade
'A'
>>> named_student_tuple._asdict()
OrderedDict([('first', 'Lisa'), ('last', 'Simpson'), ('grade', 'A')])
>>> vars(named_student_tuple)
OrderedDict([('first', 'Lisa'), ('last', 'Simpson'), ('grade', 'A')])
>>> new_named_student_tuple = named_student_tuple._replace(first='Bart', grade='C')
>>> new_named_student_tuple
Student(first='Bart', last='Simpson', grade='C')

一位评论者问道:

在大型脚本或程序中,通常在哪里定义命名元组?

您创建时使用的类型基本上是可以使用简单速记创建的类。像对待类一样对待他们。在模块级别定义它们,以便泡菜和其他用户可以找到它们。namedtuple

在全局模块级别上的工作示例:

>>> from collections import namedtuple
>>> NT = namedtuple('NT', 'foo bar')
>>> nt = NT('foo', 'bar')
>>> import pickle
>>> pickle.loads(pickle.dumps(nt))
NT(foo='foo', bar='bar')

这显示了查找定义的失败:

>>> def foo():
...     LocalNT = namedtuple('LocalNT', 'foo bar')
...     return LocalNT('foo', 'bar')
... 
>>> pickle.loads(pickle.dumps(foo()))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
_pickle.PicklingError: Can't pickle <class '__main__.LocalNT'>: attribute lookup LocalNT on __main__ failed

为什么/何时应该使用命名元组而不是普通元组?

当代码改进以在代码中表达元组元素的语义时,请使用它们。

如果本来要使用具有不变数据属性且没有功能的对象,则可以使用它们而不是对象。

您还可以对它们进行子类化以添加功能,例如

class Point(namedtuple('Point', 'x y')):
    """adding functionality to a named tuple"""
        __slots__ = ()
        @property
        def hypot(self):
            return (self.x ** 2 + self.y ** 2) ** 0.5
        def __str__(self):
            return 'Point: x=%6.3f  y=%6.3f  hypot=%6.3f' % (self.x, self.y, self.hypot)

为什么/何时应该使用普通元组而不是命名元组?

从使用命名元组切换到元组可能是一种回归。前期设计决策围绕着在使用元组时所涉及的额外代码的成本是否值得提高可读性。

命名元组与元组之间没有使用额外的内存。

是否有任何类型的“命名列表”(命名元组的可变版本)?

您正在寻找一个实现静态大小列表所有功能的槽化对象,或者一个类似于命名元组(并且以某种方式阻止列表大小更改)的子类化列表。

一个现在扩展的,甚至可能是Liskov可替代的第一个例子:

from collections import Sequence

class MutableTuple(Sequence): 
    """Abstract Base Class for objects that work like mutable
    namedtuples. Subclass and define your named fields with 
    __slots__ and away you go.
    """
    __slots__ = ()
    def __init__(self, *args):
        for slot, arg in zip(self.__slots__, args):
            setattr(self, slot, arg)
    def __repr__(self):
        return type(self).__name__ + repr(tuple(self))
    # more direct __iter__ than Sequence's
    def __iter__(self): 
        for name in self.__slots__:
            yield getattr(self, name)
    # Sequence requires __getitem__ & __len__:
    def __getitem__(self, index):
        return getattr(self, self.__slots__[index])
    def __len__(self):
        return len(self.__slots__)

要使用,只需子类并定义:__slots__

class Student(MutableTuple):
    __slots__ = 'first', 'last', 'grade' # customize 


>>> student = Student('Lisa', 'Simpson', 'A')
>>> student
Student('Lisa', 'Simpson', 'A')
>>> first, last, grade = student
>>> first
'Lisa'
>>> last
'Simpson'
>>> grade
'A'
>>> student[0]
'Lisa'
>>> student[2]
'A'
>>> len(student)
3
>>> 'Lisa' in student
True
>>> 'Bart' in student
False
>>> student.first = 'Bart'
>>> for i in student: print(i)
... 
Bart
Simpson
A