Пропустить до содержимого
CodeMDD.io | Coding Tutorials

Как использовать named tuple в Python?

[

Написание Pythonic-кода с помощью именованных кортежей

Python предоставляет модуль collections, в котором содержится фабричная функция namedtuple(). Она предназначена для упрощения написания кода на Python при работе с кортежами. С помощью namedtuple() можно создавать неизменяемые типы последовательностей, к которым можно обращаться по ясным и понятным именам полей с использованием точечной нотации, а не неясных числовых индексов.

Если у вас уже есть опыт работы с Python, то вы знаете, что написание Pythonic-кода является основным навыком для разработчиков Python. В этом руководстве вы улучшите свои навыки, используя namedtuple.

Создание классов-кортежей с помощью namedtuple()

Основной способ создания классов-кортежей с именами полей - использование функции namedtuple() из модуля collections. Для создания класса, вы передаете имя класса в качестве первого аргумента и список имен полей в качестве второго аргумента. Вот пример:

from collections import namedtuple


# Создание класса-кортежа с именем Point и полями x и y
Point = namedtuple('Point', ['x', 'y'])

Предоставление обязательных аргументов в namedtuple()

При использовании класса-кортежа с помощью namedtuple(), вы должны передать все обязательные аргументы в порядке, в котором они были определены при создании класса. Вот пример:

# Создание экземпляра класса-кортежа Point
p = Point(1, 2)


# Обращение к полям класса-кортежа
print(p.x)  # Выводит: 1
print(p.y)  # Выводит: 2

Использование необязательных аргументов с помощью namedtuple()

Вы также можете использовать необязательные аргументы, чтобы предоставить значения по умолчанию для полей класса-кортежа. Вот пример:

# Создание класса-кортежа с именем Rectangle и полями width и height, с указанием значения по умолчанию для каждого поля
Rectangle = namedtuple('Rectangle', ['width', 'height'], defaults=[0, 0])


# Создание экземпляра класса-кортежа Rectangle, используя значения по умолчанию
r = Rectangle()


# Вывод значений полей
print(r.width)   # Выводит: 0
print(r.height)  # Выводит: 0

Изучение дополнительных возможностей классов-кортежей

Классы-кортежи имеют несколько дополнительных возможностей, которые делают их более гибкими и удобными для использования.

Создание экземпляров класса-кортежа из итерируемых объектов

Вы можете создавать экземпляры класса-кортежа из итерируемых объектов, например списков или кортежей. Вот пример:

values = [1, 2]
p = Point._make(values)


print(p.x)  # Выводит: 1
print(p.y)  # Выводит: 2

Преобразование экземпляров класса-кортежа в словари

Вы также можете преобразовывать экземпляры класса-кортежа в словари с помощью метода _asdict(). Вот пример:

p = Point(1, 2)
d = p._asdict()


print(d)  # Выводит: {'x': 1, 'y': 2}

Замена полей в существующих экземплярах класса-кортежа

Вы можете заменить значения полей в существующих экземплярах класса-кортежа с помощью метода _replace(). Вот пример:

p = Point(1, 2)
p = p._replace(x=3)


print(p.x)  # Выводит: 3
print(p.y)  # Выводит: 2

Изучение дополнительных атрибутов классов-кортежей

Классы-кортежи имеют несколько дополнительных атрибутов, которые предоставляют информацию о самом классе. Вот некоторые из этих атрибутов:

print(Point._fields)        # Выводит: ('x', 'y')
print(Point._field_defaults)  # Выводит: None
print(Point._asdict.__doc__)  # Выводит: 'Return a new OrderedDict which maps field names to their values.'

Создание Pythonic-кода с помощью классов-кортежей

Использование именованных кортежей делает ваш код более Pythonic и читаемым. Вот несколько способов использования классов-кортежей для написания более элегантного кода:

Использование имен полей вместо индексов

Вместо доступа к значениям полей класса-кортежа по числовым индексам, можно использовать ясные и понятные имена полей. Вот пример:

p = Point(1, 2)


# Непонятно, что означает p[0] и p[1]
print(p[0])  # Выводит: 1
print(p[1])  # Выводит: 2


# Ясно и понятно, что означает p.x и p.y
print(p.x)   # Выводит: 1
print(p.y)   # Выводит: 2

Возвращение нескольких именованных значений из функций

Классы-кортежи могут быть полезными при возвращении нескольких значений из функций. Вот пример:

def get_coordinates():
    # Возвращение координат в виде класса-кортежа
    return Point(1, 2)


p = get_coordinates()


print(p.x)  # Выводит: 1
print(p.y)  # Выводит: 2

Сокращение количества аргументов в функциях

Вы можете использовать классы-кортежи вместо обычных кортежей или списков в качестве аргументов функций, чтобы сократить количество аргументов. Вот пример:

def calculate_area(rectangle):
    # Используйте именованный кортеж вместо двух отдельных аргументов
    return rectangle.width * rectangle.height


# Создание экземпляра класса-кортежа Rectangle и передача его функции в качестве аргумента
r = Rectangle(2, 3)
area = calculate_area(r)


print(area)  # Выводит: 6

Чтение табличных данных из файлов и баз данных

Классы-кортежи могут быть полезными при работе с табличными данными из файлов или баз данных. Вы можете использовать именованные кортежи для представления строк таблицы, где имена полей соответствуют именам столбцов. Вот пример:

import csv


# Определение класса-кортежа для представления строки таблицы
Person = namedtuple('Person', ['name', 'age', 'city'])


# Чтение данных из CSV-файла и создание экземпляров класса-кортежа для каждой строки
people = []
with open('people.csv') as file:
    reader = csv.reader(file)
    for row in reader:
        person = Person(*row)
        people.append(person)


# Вывод данных о людях
for person in people:
    print(person.name, person.age, person.city)

Использование именованных кортежей по сравнению с другими структурами данных

В зависимости от вашей конкретной задачи, вы можете выбрать использование именованных кортежей или других структур данных, таких как словари или классы данных.

Именованные кортежи по сравнению со словарями

Именованные кортежи могут быть полезными при работе со структурированными данными, когда требуется фиксированное количество полей с определенными именами. В отличие от словарей, именованные кортежи имеют фиксированную структуру и не могут содержать дополнительные поля. Также доступ к полям именованных кортежей более эффективен по скорости, чем доступ к значениям словаря по ключу.

Однако словари более гибкие и позволяют добавлять и удалять поля динамически. Также в словарях можно использовать нестроковые ключи, в отличие от именованных кортежей.

Именованные кортежи по сравнению с классами данных

Именованные кортежи предоставляют простой и легкий способ создания неизменяемых классов с определенной структурой. Они позволяют определить класс с полями и методами, но без необходимости писать кастомный класс с конструктором и методами доступа к полям.

Однако классы данных могут быть более гибкими и могут содержать дополнительные методы и функциональность, которой может не быть в именованных кортежах.

Именованные кортежи по сравнению с типом typing.NamedTuple

Модуль typing в Python предоставляет тип NamedTuple, который аналогичен именованным кортежам, но с некоторыми дополнительными возможностями и проверкой типов во время выполнения.

Если вам необходима поддержка типов или дополнительная функциональность, предоставляемая модулем typing, то вы можете использовать тип NamedTuple. В противном случае именованные кортежи из модуля collections - простое и удобное решение.

Подклассирование классов-кортежей

Вы можете создавать подклассы классов-кортежей для добавления новых возможностей и функциональности. Вот пример:

class Point3D(Point):
    def __init__(self, x, y, z):
        super().__init__(x, y)
        self.z = z


    def __str__(self):
        return f'Point3D({self.x}, {self.y}, {self.z})'


p = Point3D(1, 2, 3)


print(p.x)  # Выводит: 1
print(p.y)  # Выводит: 2
print(p.z)  # Выводит: 3
print(p)    # Выводит: Point3D(1, 2, 3)

Измерение времени создания: кортеж против именованного кортежа

Именованные кортежи обычно быстрее создаются, чем обычные кортежи или словари, благодаря использованию класса-кортежа и фиксированной структуре. Однако разница в производительности может быть незначительной и зависит от конкретной ситуации.

Заключение

Именованные кортежи в Python - это мощный инструмент, который делает ваш код более Pythonic и читаемым. Они предоставляют простой и элегантный способ работы с неизменяемыми последовательностями с ясными именами полей. Вы можете использовать их для повышения читаемости кода и сокращения количества аргументов в функциях.

Используйте именованные кортежи, когда вам нужно определенное количество полей с определенными именами. Их структура предоставляет эффективный и простой способ хранения и обработки структурированных данных.

Теперь вы знаете, как использовать namedtuple для написания Pythonic-кода. Постепенно применяйте эти знания в своих проектах и улучшайте свои навыки программирования на Python.