Tuple parameter unpacking python 3

Python Unpacking Tuple

Summary: in this tutorial, you’ll learn how to unpack tuples in Python.

Reviewing Python tuples

Python defines a tuple using commas ( , ), not parentheses () . For example, the following defines a tuple with two elements:

1,2 Code language: Python (python)

Python uses the parentheses to make the tuple clearer:

(1, 2)Code language: Python (python)

Python also uses the parentheses to create an empty tuple:

()Code language: Python (python)

In addition, you can use the tuple() constructor like this:

tuple()Code language: Python (python)

To define a tuple with only one element, you still need to use a comma. The following example illustrates how to define a tuple with one element:

1,Code language: Python (python)

It’s equivalent to the following:

(1, )Code language: Python (python)

Note that the following is an integer, not a tuple:

(1)Code language: Python (python)

Unpacking a tuple

Unpacking a tuple means splitting the tuple’s elements into individual variables. For example:

x, y = (1, 2)Code language: Python (python)

x, yCode language: Python (python)

is a tuple of two variables x and y .

The right side is also a tuple of two integers 1 and 2 .

The expression assigns the tuple elements on the right side (1, 2) to each variable on the left side (x, y) based on the relative position of each element.

In the above example, x will take 1 and y will take 2 .

x, y ,z = 10, 20, 30Code language: Python (python)

The right side is a tuple of three integers 10 , 20 , and 30 . You can quickly check its type as follows:

numbers = 10, 20, 30 print(type(numbers))Code language: Python (python)

class 'tuple'>Code language: Python (python)

In the above example, the x , y , and z variables will take the values 10 , 20 , and 30 respectively.

Using unpacking tuple to swap values of two variables

Traditionally, to swap the values of two variables, you would use a temporary variable like this:

x = 10 y = 20 print(f'x= , y= ') tmp = x x = y y = tmp print(f'x= , y= ')Code language: Python (python)

x=10, y=20 x=20, y=10 Code language: Python (python)

In Python, you can use the unpacking tuple syntax to achieve the same result:

x = 10 y = 20 print(f'x= , y= ') x, y = y, x print(f'x= , y= ')Code language: Python (python)

x=10, y=20 x=20, y=10 Code language: Python (python)

The following expression swaps the values of two variables, x and y.

x, y = y, xCode language: Python (python)

In this expression, Python evaluates the right-hand side first and then assigns the variable from the left-hand side to the values from the right-hand side.

ValueError: too many values to unpack

The following example unpacks the elements of a tuple into variables. However, it’ll result in an error:

x, y = 10, 20, 30Code language: Python (python)

ValueError: too many values to unpack (expected 2)Code language: Python (python)

This error is because the right-hand side returns three values while the left-hand side only has two variables.

To fix this, you can add a _ variable:

x, y, _ = 10, 20, 30Code language: Python (python)

The _ variable is a regular variable in Python. By convention, it’s called a dummy variable.

Typically, you use the dummy variable to unpack when you don’t care and use its value afterward.

Extended unpacking using the * operator

Sometimes, you don’t want to unpack every single item in a tuple. For example, you may want to unpack the first and second elements. In this case, you can use the * operator. For example:

r, g, *other = (192, 210, 100, 0.5)Code language: Python (python)

192 210 [100, 0.5]Code language: Python (python)

In this example, Python assigns 192 to r , 210 to g . Also, Python packs the remaining elements 100 and 0.5 into a list and assigns it to the other variable.

Notice that you can only use the * operator once on the left-hand side of an unpacking assignment.

The following example results in error:

x, y, *z, *t = (10, 20, 30, '10:30')Code language: Python (python)

SyntaxError: two starred expressions in assignmentCode language: Python (python)

Using the * operator on the right hand side

Python allows you to use the * operator on the right-hand side. Suppose that you have two tuples:

odd_numbers = (1, 3, 5) even_numbers = (2, 4, 6)Code language: Python (python)

The following example uses the * operator to unpack those tuples and merge them into a single tuple:

numbers = (*odd_numbers, *even_numbers) print(numbers)Code language: Python (python)

(1, 3, 5, 2, 4, 6)Code language: Python (python)

Summary

• Python uses the commas ( , ) to define a tuple, not parentheses.
• Unpacking tuples means assigning individual elements of a tuple to multiple variables.
• Use the * operator to assign remaining elements of an unpacking assignment into a list and assign it to a variable.

Источник

Распаковка кортежей в Python

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

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

Альтернатива неинформативным и жестко закодированным индексам

Допустим, мы имеем кортеж first_tuple , состоящий из 3-х элементов:

Тогда, для того чтобы получить доступ к каждому элементу данного кортежа, первое, что напрашивается на ум – обратиться к этим элементам через их индекс:

>>> print(first_tuple[0], first_tuple[1], first_tuple[2]) 2 1 3 

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

Операция присваивания из вышеприведенного примера, как раз и называется распаковкой кортежа. Такое название прямо отражает сущность данной операции, в которой кортеж, состоящий из трех элементов просто, был распакован в три переменные ( x , y , и z ):

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

Важно отметить, что если мы попытаемся распаковать наш кортеж из трех элементов не в три, а в меньшее или большее число переменных, то получим ошибку:

>>> x, y = first_tuple Traceback (most recent call last): File "", line 1, in ValueError: too many values to unpack (expected 2) 

При распаковке какого-либо картежа всегда необходимо, чтобы его структура и перемененных, в которые он распаковывается, совпадали. Проще говоря, количество переменных, в которые распаковывается ваш картеж должно соответствовать количеству элементов самого этого картежа.

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

Распаковка кортежей без применения знака равенства

На практике распаковка кортежей чаще всего используется не в операторах присваивания с применением знака равенства, а в for циклах.

Но, прежде чем рассматривать распаковку кортежей в циклах, давайте подготовим себе исходные данные для этой цели. В частности, давайте вызовем метод items() для словаря furniture с тем, чтобы получить итерацию кортежей из двух элементов:

>>> furniture = "tables": 2, "chairs": 3, "stands": 0> >>> furniture.items() dict_items([('tables', 2), ('chairs', 3), ('stands', 0)]) 

Каждый полученный нами таким образом двухэлементный кортеж на самом деле представляет собой пару ключ-значение для каждого элемента в нашем словаре. Давайте попробуем отобразить кортежи для каждого элемента этого словаря с помощью цикла for:

>>> for item in furniture.items(): . print(item) . ('tables', 2) ('chairs', 3) ('stands', 0) 

Из предыдущего раздела данной статьи мы уже знаем, что можем распаковать каждый элемент кортежа в соответствующую поименованную переменную. Давайте попробуем это сделать и с кортежами для элементов нашего словаря. Каждый из таких картежей, содержащий пару ключ-значение для соответствующего элемента словаря мы распакуем в переменную furniture и переменную amount соответственно:

>>> for item in furniture.items(): . furniture, amount = item . print(furniture, amount) . tables 2 chairs 3 stands 0 

Фактически же распаковка наших кортежей в отдельной строке внутри тела цикла с использованием оператора присваивания ( = ) было излишеством. Ведь на самом деле при каждой итерации цикла for в самой строке с определением этого цикла происходит так называемое неявное присваивание, когда в переменную, находящуюся между for и in, присваивается результат выражения, находящегося справа от in.

Таким образом, вышеприведенный пример мы можем переписать в несколько более компактной форме, производя распаковку наших кортежей прямо в строке с определением for цикла:

>>> for furniture, amount in furniture.items(): . print(furniture, amount) . tables 2 chairs 3 stands 0 

Следовательно, в строке с определением for цикла нам вообще не была нужна промежуточная переменная item поскольку все, что можно поместить слева от знака равенства в операторе присваивания, с таким же успехом мы можем разместить между for и in в цикле for. Вообще же, первая (определяющая) строка цикла for явится в вашей практике тем наиболее распространенным местом, куда вам потребуется распаковывать, как разнообразные кортежи, так и другие итерируемые объекты.

Выводы

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

Чаще всего вы будете сталкиваться именно с распаковками итерируемых двухэлементных или же трехэлементных кортежей при их переборе в for циклах. Хотя, на самом деле Python позволяет распаковывать кортежи и любые другие итерируемые объекты в любом месте кода, где вам может потребоваться дать описательные имена к элементам внутри данных объектов.

Источник