Функция возвращает несколько значений: return с кортежем

До сих пор функции возвращали одно значение: сумму, длину, отформатированную строку. Но половина жизненных задач просит два ответа разом: минимум и максимум списка, координаты точки, имя и возраст. Первое желание — написать две функции или спрятать вторую величину в глобальную переменную. Python предлагает путь короче: return с запятой. Функция собирает оба ответа в кортеж — структуру из урока 11 — и отдаёт одной посылкой, а распаковка из урока 13 раскладывает её по переменным. На этой паре держится половина чужого кода, который вам предстоит читать.

return с запятой: на самом деле это кортеж

Начнём с задачи, где двух ответов не избежать: найти в списке и минимум, и максимум. Функция min_max делает это за один вызов и возвращает обе величины:

def min_max(nums):
    return min(nums), max(nums)

result = min_max([3, 1, 4, 1, 5])
print(result)
print(type(result))

(1, 5)
<class 'tuple'>

Два значения приехали в одной посылке, и в выводе type это видно: tuple. Никакого особого синтаксиса вернуть несколько значений в Python нет: запятая в return собирает перечисленное в кортеж. Тот же самый результат получился бы и со скобками — return (min(nums), max(nums)) — потому что скобки у кортежей декоративные, работает запятая.

Распаковка: каждый ответ в свою переменную

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

def min_max(nums):
    return min(nums), max(nums)

low, high = min_max([3, 1, 4, 1, 5])
print('минимум:', low)
print('максимум:', high)
print('размах:', high - low)

минимум: 1
максимум: 5
размах: 4

Один вызов — две готовые переменные, и синтаксис симметричен: запятая упаковала, запятая распаковала. Именно так идиому потребляют в реальном коде: писали через запятую — читаем через запятую. Имена low и high документируют себя сами, и это вторая причина популярности приёма.

Число имён обязано совпасть с числом значений

Распаковка строгая: имён слева должно быть ровно столько, сколько значений справа. Ошибка называет обе цифры — ожидаемую и приехавшую:

def min_max(nums):
    return min(nums), max(nums)

try:
    a, b, c = min_max([3, 1, 4])
except ValueError as e:
    print('ValueError:', e)

ValueError: not enough values to unpack (expected 3, got 2)

Ожидалось три имени, приехали два — ValueError говорит это прямо. Лечится выравниванием числа имён по числу значений. А когда число значений заранее неизвестно или код должен переживать рост функции, помогает звёздочка.

Звёздочка собирает остаток

Если первое имя нужно само по себе, а остальное — пачкой, звёздочка перед именем забирает остаток. Приём тот же, что при распаковке списков в уроке 13, и работает на возвратах функций без изменений:

def stats(nums):
    return len(nums), min(nums), max(nums), sum(nums)

count, *rest = stats([4, 8, 15, 16, 23])
print('первое значение:', count)
print('остаток:', rest)
print('тип остатка:', type(rest).__name__)

первое значение: 5
остаток: [4, 23, 66]
тип остатка: list

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

Статистика списка одним вызовом

Соберём рабочую версию: функция stats возвращает три величины — минимум, максимум и среднее. Среднее — это сумма, делённая на количество, и считается в том же return:

def stats(nums):
    return min(nums), max(nums), sum(nums) / len(nums)

lo, hi, avg = stats([2, 4, 6, 8])
print('минимум:', lo)
print('максимум:', hi)
print('среднее:', avg)

минимум: 2
максимум: 8
среднее: 5.0

Среднее напечаталось как 5.0 с хвостом: деление в Python всегда даёт float, даже когда результат целый. Три переменные за один вызов, у каждой осмысленное имя — такой вызов читается как предложение. Три значения — удобный потолок: дальше читателю уже трудно держать в голове порядок возвратов.

def stats(nums):
    return min(nums), max(nums), sum(nums) / len(nums)

try:
    stats([])
except ValueError as e:
    print('ValueError:', e)

ValueError: min() iterable argument is empty

Идиома настолько стандартная, что сама стандартная библиотека так работает: os.path.split делит путь на папку и имя файла и возвращает пару.

import os

head, tail = os.path.split('docs/report.txt')
print('папка:', head)
print('файл:', tail)

папка: docs
файл: report.txt

Пара (docs, report.txt) распаковалась в две переменные, и ни один символ пути не потерялся. Заметьте: функция отдала кортеж, а не два аргумента — приём один и тот же и в библиотеке, и в вашем коде.

Что дальше

Запятая в return — самая короткая дорога от задачи «вернуть пару» к рабочему коду. Следующий шаг — дать значениям имена прямо в структуре: namedtuple делает кортеж с полями, и код читается как visitor.name вместо visitor[0]. А когда встанет задача почистить список от повторов, пригодится приём из урока про дубликаты — одна строка с множеством.

Функция возвращает несколько значений одним кортежем, распаковка принимает их поимённо — и посередине нет ни словарей, ни глобальных переменных. Две запятые: одна в return, другая слева от равенства.