{"id":994,"date":"2020-11-09T04:46:37","date_gmt":"2020-11-09T04:46:37","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=994"},"modified":"2025-03-27T14:07:50","modified_gmt":"2025-03-27T14:07:50","slug":"python-namedtuple","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/advanced-python\/python-namedtuple\/","title":{"rendered":"Python NamedTuple"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to use the Python namedtuple<\/code> function to create named tuples.<\/p>\n\n\n\n

Introduction to Python named tuples #<\/a><\/h2>\n\n\n\n

The following shows a tuple<\/a> that has two elements:<\/p>\n\n\n

point = (100<\/span>,200<\/span>)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The point<\/code> tuple represents a 2D point whose x-coordinate is 100<\/code> and y-coordinate is 200<\/code>.<\/p>\n\n\n\n
To get the x-coordinate and y-coordinate, you can use the following syntax:<\/p>\n\n\n
x = point[0<\/span>]\ny = point[1<\/span>]<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
This code works fine. However, it’s not so obvious.<\/p>\n\n\n\n
When you look at the point[0]<\/code>, you need to know its implicitly meaning which doesn’t mention in the code.<\/p>\n\n\n\n
class<\/span> Point2D<\/span>:<\/span>\n    def<\/span> __init__<\/span>(self, x, y)<\/span>:<\/span>\n        self.x = x\n        self.y = y\n<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
And you can create a new instance of the Point2D<\/code>:<\/p>\n\n\n
a = Point2D(100<\/span>, 200<\/span>)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Also, you can access x-coordinate and y-coordinate attributes:<\/p>\n\n\n
print(a.x)\nprint(a.y)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
To compare if two points are the same, you need to implement the __eq__<\/code> method:<\/p>\n\n\n
class<\/span> Point2D<\/span>:<\/span>\n    def<\/span> __init__<\/span>(self, x, y)<\/span>:<\/span>\n        self.x = x\n        self.y = y\n\n    def<\/span> __eq__<\/span>(self, other)<\/span>:<\/span>\n        if<\/span> isinstance(other, Point2D):\n            return<\/span> self.x == other.x and<\/span> self.y == other.y\n        return<\/span> False<\/span>\n<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The __eq__<\/code> method checks if a point is an instance of the Point2D<\/code> class and returns True<\/code> if both x-coordinate and y-coordinate are equal.<\/p>\n\n\n\n
The following shows how to compare two instances of the Point2D<\/code> class:<\/p>\n\n\n
class<\/span> Point2D<\/span>:<\/span>\n    def<\/span> __init__<\/span>(self, x, y)<\/span>:<\/span>\n        self.x = x\n        self.y = y\n\n    def<\/span> __eq__<\/span>(self, other)<\/span>:<\/span>\n        if<\/span> isinstance(other, Point2D):\n            return<\/span> self.x == other.x and<\/span> self.y == other.y\n        return<\/span> False<\/span>\n\n\na = Point2D(100<\/span>, 200<\/span>)\nb = Point2D(100<\/span>, 200<\/span>)\n\nprint(a is<\/span> b)  # False<\/span>\nprint(a == b)  # true<\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The Point2D<\/code> might work as you expected. However, you need to write a lot of code.<\/p>\n\n\n\n
To combine the simplicity of a tuple and the obvious of a class, you can use a named tuple:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Named tuples allow you to create tuples and assign meaningful names to the positions of the tuple’s elements.<\/p>\n\n\n\n
Technically, a named tuple is a subclass of tuple<\/code>. On top of that, it adds property names to the positional elements.<\/p>\n\n\n\n
Creating named tuple classes #<\/a><\/h2>\n\n\n\n
To create a named tuple class, you need to the namedtuple<\/code> function of the collections<\/code> standard library.<\/p>\n\n\n\n
The namedtuple<\/code> is a function that returns a new named tuple class. In other words, the namedtuple()<\/code> is a class factory.<\/p>\n\n\n\n
To use the namedtuple<\/code> function, you need to import it from the collections<\/code> module first:<\/p>\n\n\n
from<\/span> collections import<\/span> namedtuple<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
The namedtuple<\/code> function accepts the following arguments to generate a class:<\/p>\n\n\n\n
Try it<\/a><\/p>\n\n\n\n
To make the code more clear, you might want to use a class<\/a>. For example:<\/p>\n\n\n