【Python 高级特性】深入 NamedTuple 命名元组

2023-10-30 06:04
文章标签 python 特性 深入 高级 命名 元组 namedtuple

本文主要是介绍【Python 高级特性】深入 NamedTuple 命名元组，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

介绍

和元组 tuple 一样，NamedTuple 也是不可变数据类型，创建之后就不能改变内容。
如其名，和 tuple 的区别在于“Named”，即"命名"。NamedTuple 不像数组那样使用下标读写，反而和类相似，使用 . 来读写。

基本语法

创建 NamedTuple 的函数定义

collections.namedtuple(typename, field_names, *, rename=False, defaults=None, module=None)

参数说明：

  • typename：新创建的类的名称。
  • field_names：字段名称列表。必须是有效的 Python 变量名称，且不能以下划线开头。
  • rename：是否自动转换无效字段名。
  • defaults：字段默认值列表。
  • module：__module__ 的值。

使用教程

创建

首先看看如何创建命名元组。以 Point（代表二维坐标中的一个点）为例：

# 导包
from collections import namedtuple# 创建普通元组
point = (22, 33)
print(point) # 输出：(22, 33)# 创建命名元组
Point = namedtuple('Point', 'x y')
point_A = Point(22, 33)
print(point_A) # 输出：Point(x=22, y=33)

重点是这两句话

Point = namedtuple('Point', 'x y')
point_A = Point(22, 33)

需要注意，namedtuple() 是用来创建类的，不是创建对象实例！

我们先用 namedtuple 创建了一个名为 Point，有两个字段 x、y 的子类，然后将这个类赋给 Point 变量。
然后 Point(22, 33) 就是普通的 new 的语法。

类似于如下代码：

class Point:def __init__(self, x, y):self.x = xself.y = y
point_A = Point(22, 33)

创建命名元组对象时，也可以使用位置参数

a = Point(1, 2)
b = Point(y=2, x=1)
a == b # >>> True

field_names 参数用来设置命名元组字段名，有三种风格可以选择。
下面几种都是等价写法：

Point = namedtuple('Point', 'x y')
Point = namedtuple('Point', 'x,y')
Point = namedtuple('Point', ['x', 'y'])# 下面都是合法代码
# 中间允许存在任意空白字符
Point = namedtuple('Point', 'x,   \t\t\t\n\n y')
Point = namedtuple('Point', 'x   \t\t\t\n\n y')
# 元组也可以
Point = namedtuple('Point', ('x', 'y'))
# 事实上只要是可迭代都行
def fields():yield 'x'yield 'y'
Point = namedtuple('Point', fields())

使用

命名元组首先是一个元组，元组能怎么用，命名元组当然也可以。

print(point_A[0])
print(point_A[1])
print(*point_A) # tuple unpack# 输出
"""
22
33
22 33
"""

然后是命名元组的特殊用法：

print(point_A.x)
print(point_A.y)# 输出
"""
22
33
"""

常用方法

namedtuple 创建的类还附赠了一些实用方法：

Point._make(iterable) # 从某个序列创建命名元组
point._asdict() # 转成字典
point._replace(**kargs) # 返回一个新元组，新元组里的指定字段被替换为指定值point._fields # 列出字段名
point._field_defaults # 列出字段默认值

设置默认值

可以为命名元组的字段设置默认值，只需要在创建类的时候传入 defaults 参数即可。

# 四维向量
# 默认值为 Vector4D(0, 0, 0, 0)
Vector4 = namedtuple('Vector4D', 'x y z w', defaults=(0, 0, 0, 0))v1 = Vector4()
v2 = Vector4(1)
v3 = Vector4(1, 2, w=4)
print(v1)
print(v2)
print(v3)# 输出
"""
Vector4D(x=0, y=0, z=0, w=0)
Vector4D(x=1, y=0, z=0, w=0)
Vector4D(x=1, y=2, z=0, w=4)
"""

默认值的数量可以小于字段数，表示为右边 n 个参数设置默认值。

Foo = namedtuple('Foo', 'a b c d', defaults=(1, 2))
print(Foo(22, 33))
print(Foo())# 输出
"""
Foo(a=22, b=33, c=1, d=2)
Traceback (most recent call last):File "D:\TempCodeFiles\named_tuple.py", line 6, in <module>print(Foo())
TypeError: Foo.__new__() missing 2 required positional arguments: 'a' and 'b'
"""

更好的表示方式

namedtuple() 的写法既不直观，也不优雅。Python 3.5 新增了一种更好的写法：

# >= Python 3.5
from typing import NamedTuple
class PointA(NamedTuple):x: int = 0y: int = 0# >= Python 2
from collections import namedtuple
PointB = namedtuple('PointB', 'x y', defaults=(0, 0))print(PointA(2, 3) == PointB(2, 3)) # 输出：True

继承并扩展 NamedTuple

namedtuple() 返回的是一个正常的类。既然它是一个类，当然也可以被继承。

创建一个 Point 命名元组，增加一个方法，求两点距离。

# >= Python 3.5
class Point(NamedTuple):x: int = 0y: int = 0def distance(self, p) -> float:return math.sqrt((self.x - p.x) ** 2 + (self.y - p.y) ** 2)# >= Python 2
class Point(namedtuple('Point', 'x y', defaults=(0, 0))):def distance(self, p) -> float:return math.sqrt((self.x - p.x) ** 2 + (self.y - p.y) ** 2)a = Point()
b = Point(3, 2)
print(a, b)
print(a.distance(b))

应用

读 csv 文件

以读入一个储存英语单词的 csv 文件为例。

import csv
from collections import namedtuple# 定义命名元组
# 按照 csv 列名来定义字段
Word = namedtuple('Word', 'word, type, chs_def, eng_ch, context, example')file_path = r'C:\Users\ZhouXiaokang\Desktop\单词 Vol 1 Ch 1 Ep 2.csv'
with open(file_path, 'r', encoding='utf-8') as f:reader = csv.reader(f)next(reader) # 跳过标题行for word in map(Word._make, reader):print(f'{word.word} {word.type}. {word.chs_def} | 例：{word.context}')

输出

chirp n&v. (鸟、昆虫)啾啾叫，发唧唧声 | 例：(*chirp* *chirp* *chirp*)
screech v. (车辆、汽车轮胎)发出刺耳声 | 例：(*screech*)
Shiroko term. 白子 | 例：
mug v. 对…行凶抢劫 | 例：You didn't get mugged, did you?
faint v. 晕厥;晕倒 | 例：What's that? You fainted from hunger?
......

作为字典的代替品表示数据

相对于字典的优势：
1.快、小
2..field 比 ['field'] 更清晰

以下源码摘自 baidupcs_py 库：

class PcsFile(NamedTuple):"""A Baidu PCS filepath: str  # remote absolute pathis_dir: Optional[bool] = Noneis_file: Optional[bool] = Nonefs_id: Optional[int] = None  # file idsize: Optional[int] = Nonemd5: Optional[str] = Noneblock_list: Optional[List[str]] = None  # block md5 listcategory: Optional[int] = Noneuser_id: Optional[int] = Nonectime: Optional[int] = None  # server created timemtime: Optional[int] = None  # server modifed timelocal_ctime: Optional[int] = None  # local created timelocal_mtime: Optional[int] = None  # local modifed timeserver_ctime: Optional[int] = None  # server created timeserver_mtime: Optional[int] = None  # server modifed timeshared: Optional[bool] = None  # this file is shared if True"""path: str  # remote absolute pathis_dir: Optional[bool] = Noneis_file: Optional[bool] = Nonefs_id: Optional[int] = None  # file idsize: Optional[int] = Nonemd5: Optional[str] = Noneblock_list: Optional[List[str]] = None  # block md5 listcategory: Optional[int] = Noneuser_id: Optional[int] = Nonectime: Optional[int] = None  # server created timemtime: Optional[int] = None  # server modifed timelocal_ctime: Optional[int] = None  # local created timelocal_mtime: Optional[int] = None  # local modifed timeserver_ctime: Optional[int] = None  # server created timeserver_mtime: Optional[int] = None  # server modifed timeshared: Optional[bool] = None  # this file is shared if Truerapid_upload_info: Optional[PcsRapidUploadInfo] = Nonedl_link: Optional[str] = None@staticmethoddef from_(info) -> "PcsFile":return PcsFile(path=info.get("path"),is_dir=info.get("isdir") == 1,is_file=info.get("isdir") == 0,fs_id=info.get("fs_id"),size=info.get("size"),md5=info.get("md5"),block_list=info.get("block_list"),category=info.get("category"),user_id=info.get("user_id"),ctime=info.get("ctime"),mtime=info.get("mtime"),local_ctime=info.get("local_ctime"),local_mtime=info.get("local_mtime"),server_ctime=info.get("server_ctime"),server_mtime=info.get("server_mtime"),shared=info.get("shared"),)

源码

见 Github。

关键部分在这里：

    # Build-up the class namespace dictionary# and use type() to build the result class# 收集类的方法、字段等class_namespace = {'__doc__': f'{typename}({arg_list})','__slots__': (),'_fields': field_names,'_field_defaults': field_defaults,'__new__': __new__,'_make': _make,'__replace__': _replace,'_replace': _replace,'__repr__': __repr__,'_asdict': _asdict,'__getnewargs__': __getnewargs__,'__match_args__': field_names,}for index, name in enumerate(field_names):doc = _sys.intern(f'Alias for field number {index}')class_namespace[name] = _tuplegetter(index, doc)# 创建新类result = type(typename, (tuple,), class_namespace)

type() 函数传入一个参数，用来获取对象的类；如果传入三个参数，就变成了动态创建类，相当于 class 的动态写法。

class Foo:def hello(self):print('Hello')
# 等价于
def hello(self):print('Hello')
Foo = type('Foo', (object,), {'hello': hello})

参考文章

  1. https://docs.python.org/zh-cn/3/library/collections.html#collections.namedtuple
  2. https://realpython.com/python-namedtuple/

这篇关于【Python 高级特性】深入 NamedTuple 命名元组的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/306073。

相关文章

基于Python开发Windows屏幕控制工具

基于Python开发Windows屏幕控制工具

《基于Python开发Windows屏幕控制工具》在数字化办公时代,屏幕管理已成为提升工作效率和保护眼睛健康的重要环节,本文将分享一个基于Python和PySide6开发的Windows屏幕控制工具,... 目录概述功能亮点界面展示实现步骤详解1. 环境准备2. 亮度控制模块3. 息屏功能实现4. 息屏时间
阅读更多...
Python如何去除图片干扰代码示例

Python如何去除图片干扰代码示例

《Python如何去除图片干扰代码示例》图片降噪是一个广泛应用于图像处理的技术,可以提高图像质量和相关应用的效果,：本文主要介绍Python如何去除图片干扰的相关资料,文中通过代码介绍的非常详细,... 目录一、噪声去除1. 高斯噪声（像素值正态分布扰动）2. 椒盐噪声（随机黑白像素点）3. 复杂噪声（如伪
阅读更多...
Python中图片与PDF识别文本(OCR)的全面指南

Python中图片与PDF识别文本(OCR)的全面指南

《Python中图片与PDF识别文本(OCR)的全面指南》在数据爆炸时代,80%的企业数据以非结构化形式存在,其中PDF和图像是最主要的载体,本文将深入探索Python中OCR技术如何将这些数字纸张转... 目录一、OCR技术核心原理二、python图像识别四大工具库1. Pytesseract - 经典O
阅读更多...
基于Linux的ffmpeg python的关键帧抽取

基于Linux的ffmpeg python的关键帧抽取

《基于Linux的ffmpegpython的关键帧抽取》本文主要介绍了基于Linux的ffmpegpython的关键帧抽取,实现以按帧或时间间隔抽取关键帧,文中通过示例代码介绍的非常详细,对大家的学... 目录1.FFmpeg的环境配置1) 创建一个虚拟环境envjavascript2) ffmpeg-py
阅读更多...
python使用库爬取m3u8文件的示例

python使用库爬取m3u8文件的示例

《python使用库爬取m3u8文件的示例》本文主要介绍了python使用库爬取m3u8文件的示例,可以使用requests、m3u8、ffmpeg等库,实现获取、解析、下载视频片段并合并等步骤,具有... 目录一、准备工作二、获取m3u8文件内容三、解析m3u8文件四、下载视频片段五、合并视频片段六、错误
阅读更多...
Python中提取文件名扩展名的多种方法实现

Python中提取文件名扩展名的多种方法实现

《Python中提取文件名扩展名的多种方法实现》在Python编程中,经常会遇到需要从文件名中提取扩展名的场景,Python提供了多种方法来实现这一功能,不同方法适用于不同的场景和需求,包括os.pa... 目录技术背景实现步骤方法一：使用os.path.splitext方法二：使用pathlib模块方法三
阅读更多...
Python打印对象所有属性和值的方法小结

Python打印对象所有属性和值的方法小结

《Python打印对象所有属性和值的方法小结》在Python开发过程中,调试代码时经常需要查看对象的当前状态,也就是对象的所有属性和对应的值,然而,Python并没有像PHP的print_r那样直接提... 目录python中打印对象所有属性和值的方法实现步骤1. 使用vars()和pprint()2. 使
阅读更多...
使用Python和OpenCV库实现实时颜色识别系统

使用Python和OpenCV库实现实时颜色识别系统

《使用Python和OpenCV库实现实时颜色识别系统》：本文主要介绍使用Python和OpenCV库实现的实时颜色识别系统,这个系统能够通过摄像头捕捉视频流,并在视频中指定区域内识别主要颜色（红... 目录一、引言二、系统概述三、代码解析1. 导入库2. 颜色识别函数3. 主程序循环四、HSV色彩空间详解
阅读更多...
一文深入详解Python的secrets模块

一文深入详解Python的secrets模块

《一文深入详解Python的secrets模块》在构建涉及用户身份认证、权限管理、加密通信等系统时,开发者最不能忽视的一个问题就是“安全性”,Python在3.6版本中引入了专门面向安全用途的secr... 目录引言一、背景与动机：为什么需要 secrets 模块？二、secrets 模块的核心功能1. 基
阅读更多...
python常见环境管理工具超全解析

python常见环境管理工具超全解析

《python常见环境管理工具超全解析》在Python开发中,管理多个项目及其依赖项通常是一个挑战,下面：本文主要介绍python常见环境管理工具的相关资料,文中通过代码介绍的非常详细,需要的朋友... 目录1. conda2. pip3. uvuv 工具自动创建和管理环境的特点4. setup.py5.
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2