controlflow.md
1> **Источник:** https://python-all.ru/3.5/tutorial/controlflow.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 4. Дополнительные инструменты управления потоком89Помимо только что представленного оператора [`while`](https://python-all.ru/3.5/reference/compound_stmts.html#while), Python поддерживает обычные операторы управления потоком, знакомые по другим языкам, но с некоторыми отличиями.1011## 4.1. [`if`](https://python-all.ru/3.5/reference/compound_stmts.html#if) Операторы1213Пожалуй, наиболее известным типом оператора является оператор [`if`](https://python-all.ru/3.5/reference/compound_stmts.html#if). Например:1415```python16>>> x = int(input("Please enter an integer: "))17Please enter an integer: 4218>>> if x < 0:19... x = 020... print('Negative changed to zero')21... elif x == 0:22... print('Zero')23... elif x == 1:24... print('Single')25... else:26... print('More')27...28More29```3031Может быть ноль или более частей [`elif`](https://python-all.ru/3.5/reference/compound_stmts.html#elif), а часть [`else`](https://python-all.ru/3.5/reference/compound_stmts.html#else) является необязательной. Ключевое слово ‘[`elif`](https://python-all.ru/3.5/reference/compound_stmts.html#elif)’ является сокращением от ‘else if’ и полезно для избежания чрезмерного отступа. Последовательность [`if`](https://python-all.ru/3.5/reference/compound_stmts.html#if) … [`elif`](https://python-all.ru/3.5/reference/compound_stmts.html#elif) … [`elif`](https://python-all.ru/3.5/reference/compound_stmts.html#elif) … является заменой операторов `switch` или `case`, встречающихся в других языках.3233## 4.2. [`for`](https://python-all.ru/3.5/reference/compound_stmts.html#for) Операторы3435Оператор [`for`](https://python-all.ru/3.5/reference/compound_stmts.html#for) в Python немного отличается от того, к чему вы могли привыкнуть в C или Pascal. Вместо того чтобы всегда выполнять итерацию по арифметической прогрессии чисел (как в Pascal) или давать пользователю возможность задавать как шаг итерации, так и условие остановки (как в C), оператор [`for`](https://python-all.ru/3.5/reference/compound_stmts.html#for) в Python выполняет итерацию по элементам любой последовательности (списка или строки) в том порядке, в котором они встречаются в последовательности. Например (без каламбура):3637```python38>>> # Измеряем некоторые строки:39... words = ['cat', 'window', 'defenestrate']40>>> for w in words:41... print(w, len(w))42...43cat 344window 645defenestrate 1246```4748Если требуется изменить последовательность, по которой выполняется итерация, внутри цикла (например, для дублирования выбранных элементов), рекомендуется сначала создать копию. Итерация по последовательности не создаёт копию неявно. Синтаксис среза делает это особенно удобным:4950```python51>>> for w in words[:]: # Выполнить итерацию по копии среза всего списка.52... if len(w) > 6:53... words.insert(0, w)54...55>>> words56['defenestrate', 'cat', 'window', 'defenestrate']57```5859## 4.3. Функция [`range()`](https://python-all.ru/3.5/library/stdtypes.html#range)6061Если вам действительно нужно выполнить итерацию по последовательности чисел, встроенная функция [`range()`](https://python-all.ru/3.5/library/stdtypes.html#range) оказывается полезной. Она генерирует арифметические прогрессии:6263```python64>>> for i in range(5):65... print(i)66...67068169270371472```7374Указанная конечная точка никогда не входит в сгенерированную последовательность; `range(10)` генерирует 10 значений – допустимые индексы для элементов последовательности длины 10. Можно заставить диапазон начинаться с другого числа или указать другой шаг (даже отрицательный; иногда это называется «шаг»):7576```python77range(5, 10)78 5 through 97980range(0, 10, 3)81 0, 3, 6, 98283range(-10, -100, -30)84 -10, -40, -7085```8687Для итерации по индексам последовательности можно комбинировать [`range()`](https://python-all.ru/3.5/library/stdtypes.html#range) и [`len()`](https://python-all.ru/3.5/library/functions.html#len) следующим образом:8889```python90>>> a = ['Mary', 'had', 'a', 'little', 'lamb']91>>> for i in range(len(a)):92... print(i, a[i])93...940 Mary951 had962 a973 little984 lamb99```100101Однако в большинстве таких случаев удобно использовать функцию [`enumerate()`](https://python-all.ru/3.5/library/functions.html#enumerate), см. [Техники циклической обработки](https://python-all.ru/3.5/tutorial/datastructures.html#tut-loopidioms).102103Странная вещь происходит, если просто вывести range:104105```python106>>> print(range(10))107range(0, 10)108```109110Во многих отношениях объект, возвращаемый [`range()`](https://python-all.ru/3.5/library/stdtypes.html#range), ведёт себя как список, но на самом деле это не так. Это объект, который при итерации возвращает последовательные элементы нужной последовательности, но на самом деле не создаёт список, экономя тем самым память.111112Говорят, что такой объект является *итерируемым*, то есть пригодным в качестве цели для функций и конструкций, которые ожидают нечто, из чего можно последовательно получать элементы, пока запас не иссякнет. Мы видели, что оператор [`for`](https://python-all.ru/3.5/reference/compound_stmts.html#for) является таким *итератором*. Функция [`list()`](https://python-all.ru/3.5/library/stdtypes.html#list) – ещё один пример; она создаёт списки из итерируемых объектов:113114```python115>>> list(range(5))116[0, 1, 2, 3, 4]117```118119Позже мы увидим больше функций, которые возвращают итерируемые объекты и принимают их в качестве аргумента.120121## 4.4. Операторы [`break`](https://python-all.ru/3.5/reference/simple_stmts.html#break) и [`continue`](https://python-all.ru/3.5/reference/simple_stmts.html#continue), а также предложения [`else`](https://python-all.ru/3.5/reference/compound_stmts.html#else) в циклах122123Оператор [`break`](https://python-all.ru/3.5/reference/simple_stmts.html#break), как и в C, прерывает выполнение самого внутреннего цикла [`for`](https://python-all.ru/3.5/reference/compound_stmts.html#for) или [`while`](https://python-all.ru/3.5/reference/compound_stmts.html#while).124125Операторы цикла могут иметь предложение `else`; оно выполняется, когда цикл завершается исчерпанием списка (с [`for`](https://python-all.ru/3.5/reference/compound_stmts.html#for)) или когда условие становится ложным (с [`while`](https://python-all.ru/3.5/reference/compound_stmts.html#while)), но не когда цикл прерван оператором [`break`](https://python-all.ru/3.5/reference/simple_stmts.html#break). Это демонстрируется следующим циклом, который ищет простые числа:126127```python128>>> for n in range(2, 10):129... for x in range(2, n):130... if n % x == 0:131... print(n, 'equals', x, '*', n//x)132... break133... else:134... # цикл завершился без нахождения множителя135... print(n, 'is a prime number')136...1372 is a prime number1383 is a prime number1394 equals 2 * 21405 is a prime number1416 equals 2 * 31427 is a prime number1438 equals 2 * 41449 equals 3 * 3145```146147(Да, это правильный код. Присмотритесь: предложение `else` относится к циклу [`for`](https://python-all.ru/3.5/reference/compound_stmts.html#for), **а не** к инструкции [`if`](https://python-all.ru/3.5/reference/compound_stmts.html#if).)148149При использовании с циклом предложение `else` имеет больше общего с `else` предложением оператора [`try`](https://python-all.ru/3.5/reference/compound_stmts.html#try), чем с предложением операторов [`if`](https://python-all.ru/3.5/reference/compound_stmts.html#if): предложение `else` оператора [`try`](https://python-all.ru/3.5/reference/compound_stmts.html#try) выполняется, когда не возникает исключения, а предложение `else` цикла выполняется, когда не происходит `break`. Подробнее об операторе [`try`](https://python-all.ru/3.5/reference/compound_stmts.html#try) и исключениях см. [Обработка исключений](https://python-all.ru/3.5/tutorial/errors.html#tut-handling).150151Оператор [`continue`](https://python-all.ru/3.5/reference/simple_stmts.html#continue), также заимствованный из C, переходит к следующей итерации цикла:152153```python154>>> for num in range(2, 10):155... if num % 2 == 0:156... print("Found an even number", num)157... continue158... print("Found a number", num)159Found an even number 2160Found a number 3161Found an even number 4162Found a number 5163Found an even number 6164Found a number 7165Found an even number 8166Found a number 9167```168169## 4.5. Оператор [`pass`](https://python-all.ru/3.5/reference/simple_stmts.html#pass)170171Инструкция [`pass`](https://python-all.ru/3.5/reference/simple_stmts.html#pass) ничего не делает. Она может использоваться, когда синтаксически требуется инструкция, но программа не должна выполнять никаких действий. Например:172173```python174>>> while True:175... pass # Активное ожидание прерывания с клавиатуры (Ctrl+C)176...177```178179Это часто используется для создания минимальных классов:180181```python182>>> class MyEmptyClass:183... pass184...185```186187Ещё одно место, где можно использовать [`pass`](https://python-all.ru/3.5/reference/simple_stmts.html#pass) – в качестве заполнителя для тела функции или условного оператора при работе над новым кодом, позволяя сохранять более абстрактный уровень мышления. [`pass`](https://python-all.ru/3.5/reference/simple_stmts.html#pass) молча игнорируется:188189```python190>>> def initlog(*args):191... pass # Не забудьте реализовать это!192...193```194195## 4.6. Определение функций196197Можно создать функцию, которая выводит ряд Фибоначчи до произвольной границы:198199```python200>>> def fib(n): # вывести ряд Фибоначчи до n201... """Вывести ряд Фибоначчи до n."""202... a, b = 0, 1203... while a < n:204... print(a, end=' ')205... a, b = b, a+b206... print()207...208>>> # Теперь вызовите только что определённую функцию:209... fib(2000)2100 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597211```212213Ключевое слово [`def`](https://python-all.ru/3.5/reference/compound_stmts.html#def) вводит *определение* функции. За ним должны следовать имя функции и список формальных параметров в скобках. Инструкции, составляющие тело функции, начинаются со следующей строки и должны иметь отступ.214215Первый оператор тела функции может быть строковым литералом; этот строковый литерал является строкой документации функции, или *docstring*. (Подробнее о docstring можно найти в разделе [Строки документации](https://python-all.ru/3.5/tutorial/controlflow.html#tut-docstrings).) Существуют инструменты, которые используют docstring для автоматического создания онлайн- или печатной документации, или чтобы позволить пользователю интерактивно просматривать код; рекомендуется включать docstring в код, который вы пишете, так что сделайте это привычкой.216217При *выполнении* функции создаётся новая таблица символов, используемая для локальных переменных функции. Точнее, все присваивания переменных в функции сохраняют значение в локальной таблице символов; тогда как ссылки на переменные сначала ищут в локальной таблице символов, затем в локальных таблицах символов окружающих функций, затем в глобальной таблице символов и, наконец, в таблице встроенных имён. Таким образом, глобальным переменным нельзя напрямую присвоить значение внутри функции (если только они не указаны в операторе [`global`](https://python-all.ru/3.5/reference/simple_stmts.html#global)), хотя на них можно ссылаться.218219Фактические параметры (аргументы) вызова функции вносятся в локальную таблицу символов вызываемой функции при её вызове; таким образом, аргументы передаются с использованием *передачи по значению* (где *значение* всегда является ссылкой *на объект*, а не значением объекта). [\[1\]](https://python-all.ru/3.5/tutorial/controlflow.html#id2) Когда функция вызывает другую функцию, для этого вызова создаётся новая локальная таблица символов.220221Определение функции вводит имя функции в текущую таблицу символов. Значение имени функции имеет тип, который распознаётся интерпретатором как определяемая пользователем функция. Это значение может быть присвоено другому имени, которое затем также можно использовать как функцию. Это служит общим механизмом переименования:222223```python224>>> fib225<function fib at 10042ed0>226>>> f = fib227>>> f(100)2280 1 1 2 3 5 8 13 21 34 55 89229```230231Приходя из других языков, вы можете возразить, что `fib` – это не функция, а процедура, поскольку она не возвращает значение. На самом деле даже функции без оператора [`return`](https://python-all.ru/3.5/reference/simple_stmts.html#return) возвращают значение, хотя и довольно скучное. Это значение называется `None` (это встроенное имя). Запись значения `None` обычно подавляется интерпретатором, если оно было бы единственным записанным значением. Вы можете увидеть его, если действительно захотите, с помощью [`print()`](https://python-all.ru/3.5/library/functions.html#print):232233```python234>>> fib(0)235>>> print(fib(0))236None237```238239Просто написать функцию, которая возвращает список чисел ряда Фибоначчи, вместо того чтобы выводить его:240241```python242>>> def fib2(n): # возвращает ряд Фибоначчи до n243... """Возвращает список, содержащий ряд Фибоначчи до n."""244... result = []245... a, b = 0, 1246... while a < n:247... result.append(a) # см. ниже248... a, b = b, a+b249... return result250...251>>> f100 = fib2(100) # вызов252>>> f100 # вывод результата253[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]254```255256Этот пример, как обычно, демонстрирует некоторые новые возможности Python:257258- Оператор [`return`](https://python-all.ru/3.5/reference/simple_stmts.html#return) возвращает значение из функции. [`return`](https://python-all.ru/3.5/reference/simple_stmts.html#return) без выражения-аргумента возвращает `None`. Завершение функции без явного возврата также возвращает `None`.259- Оператор `result.append(a)` вызывает *метод* объекта списка `result`. Метод – это функция, которая «принадлежит» объекту и имеет имя `obj.methodname`, где `obj` – некоторый объект (это может быть выражение), а `methodname` – имя метода, определённого типом объекта. Разные типы определяют разные методы. Методы разных типов могут иметь одинаковые имена без неоднозначности. (Можно определять собственные типы объектов и методы, используя *классы*; см. [Классы](https://python-all.ru/3.5/tutorial/classes.html#tut-classes)). Метод `append()`, показанный в примере, определён для объектов списка; он добавляет новый элемент в конец списка. В этом примере он эквивалентен `result = result + [a]`, но более эффективен.260261## 4.7. Подробнее об определении функций262263Также можно определять функции с переменным числом аргументов. Существует три формы, которые можно комбинировать.264265### 4.7.1. Значения аргументов по умолчанию266267Наиболее полезная форма – указать значение по умолчанию для одного или нескольких аргументов. Это создаёт функцию, которую можно вызывать с меньшим количеством аргументов, чем она определена допускать. Например:268269```python270def ask_ok(prompt, retries=4, reminder='Please try again!'):271 while True:272 ok = input(prompt)273 if ok in ('y', 'ye', 'yes'):274 return True275 if ok in ('n', 'no', 'nop', 'nope'):276 return False277 retries = retries - 1278 if retries < 0:279 raise ValueError('invalid user response')280 print(reminder)281```282283Эту функцию можно вызывать несколькими способами:284285- передавая только обязательный аргумент: `ask_ok('Do you really want to quit?')`286- передавая один из необязательных аргументов: `ask_ok('OK to overwrite the file?', 2)`287- или даже передавая все аргументы: `ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')`288289Этот пример также вводит ключевое слово [`in`](https://python-all.ru/3.5/reference/expressions.html#in). Оно проверяет, содержит ли последовательность определённое значение.290291Значения по умолчанию вычисляются в точке определения функции в *определяющей* области видимости, так что292293```python294i = 5295296def f(arg=i):297 print(arg)298299i = 6300f()301```302303выведет `5`.304305**Важное предупреждение:** Значение по умолчанию вычисляется только один раз. Это имеет значение, когда значение по умолчанию является изменяемым объектом, таким как список, словарь или экземпляры большинства классов. Например, следующая функция накапливает аргументы, переданные ей при последующих вызовах:306307```python308def f(a, L=[]):309 L.append(a)310 return L311312print(f(1))313print(f(2))314print(f(3))315```316317Это выведет318319```python320[1]321[1, 2]322[1, 2, 3]323```324325Если вы не хотите, чтобы значение по умолчанию разделялось между последующими вызовами, вы можете написать функцию так:326327```python328def f(a, L=None):329 if L is None:330 L = []331 L.append(a)332 return L333```334335### 4.7.2. Именованные аргументы336337Функции также можно вызывать с помощью [именованных аргументов](https://python-all.ru/3.5/glossary.html#term-keyword-argument) вида `kwarg=value`. Например, следующая функция:338339```python340def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'):341 print("-- This parrot wouldn't", action, end=' ')342 print("if you put", voltage, "volts through it.")343 print("-- Lovely plumage, the", type)344 print("-- It's", state, "!")345```346347принимает один обязательный аргумент (`voltage`) и три необязательных аргумента (`state`, `action` и `type`). Эту функцию можно вызывать любым из следующих способов:348349```python350parrot(1000) # 1 позиционный аргумент351parrot(voltage=1000) # 1 именованный аргумент352parrot(voltage=1000000, action='VOOOOOM') # 2 именованных аргумента353parrot(action='VOOOOOM', voltage=1000000) # 2 именованных аргумента354parrot('a million', 'bereft of life', 'jump') # 3 позиционных аргумента355parrot('a thousand', state='pushing up the daisies') # 1 позиционный, 1 именованный356```357358но все следующие вызовы будут недопустимы:359360```python361parrot() # отсутствует обязательный аргумент362parrot(voltage=5.0, 'dead') # неименованный аргумент после именованного363parrot(110, voltage=220) # дублирование значения для одного и того же аргумента364parrot(actor='John Cleese') # неизвестный именованный аргумент365```366367В вызове функции именованные аргументы должны следовать за позиционными. Все переданные именованные аргументы должны соответствовать одному из аргументов, принимаемых функцией (например, `actor` не является допустимым аргументом для функции `parrot`), и их порядок не важен. Это также включает необязательные аргументы (например, `parrot(voltage=1000)` тоже допустим). Ни один аргумент не может получать значение более одного раза. Вот пример, который завершается ошибкой из-за этого ограничения:368369```python370>>> def function(a):371... pass372...373>>> function(0, a=0)374Traceback (most recent call last):375 File "<stdin>", line 1, in <module>376TypeError: function() got multiple values for keyword argument 'a'377```378379Когда присутствует последний формальный параметр вида `**name`, он получает словарь (см. [Типы отображений – dict](https://python-all.ru/3.5/library/stdtypes.html#typesmapping)), содержащий все именованные аргументы, кроме тех, которые соответствуют формальному параметру. Это может быть объединено с формальным параметром вида `*name` (описанным в следующем подразделе), который получает кортеж, содержащий позиционные аргументы, выходящие за пределы формальных параметров списка. (`*name` должен идти до `**name`.) Например, если определить функцию следующим образом:380381```python382def cheeseshop(kind, *arguments, **keywords):383 print("-- Do you have any", kind, "?")384 print("-- I'm sorry, we're all out of", kind)385 for arg in arguments:386 print(arg)387 print("-" * 40)388 keys = sorted(keywords.keys())389 for kw in keys:390 print(kw, ":", keywords[kw])391```392393Её можно было бы вызвать так:394395```python396cheeseshop("Limburger", "It's very runny, sir.",397 "It's really very, VERY runny, sir.",398 shopkeeper="Michael Palin",399 client="John Cleese",400 sketch="Cheese Shop Sketch")401```402403и, конечно, она выведет:404405```text406-- Do you have any Limburger ?407-- I'm sorry, we're all out of Limburger408It's very runny, sir.409It's really very, VERY runny, sir.410----------------------------------------411client : John Cleese412shopkeeper : Michael Palin413sketch : Cheese Shop Sketch414```415416Обратите внимание, что список имен именованных аргументов создается путем сортировки результата метода `keys()` словаря keywords перед выводом его содержимого; если этого не сделать, порядок вывода аргументов будет неопределенным.417418### 4.7.3. Произвольные списки аргументов419420Наконец, наименее часто используемая возможность – указать, что функцию можно вызывать с произвольным количеством аргументов. Эти аргументы будут упакованы в кортеж (см. [Кортежи и последовательности](https://python-all.ru/3.5/tutorial/datastructures.html#tut-tuples)). Перед переменным числом аргументов может быть ноль или более обычных аргументов.421422```python423def write_multiple_items(file, separator, *args):424 file.write(separator.join(args))425```426427Обычно эти аргументы `variadic` находятся последними в списке формальных параметров, потому что они собирают все остальные входные аргументы, переданные функции. Любые формальные параметры, которые следуют после `*args` параметра, являются аргументами, передаваемыми только по ключевому слову, то есть они могут использоваться только как ключевые, а не позиционные аргументы.428429```python430>>> def concat(*args, sep="/"):431... return sep.join(args)432...433>>> concat("earth", "mars", "venus")434'earth/mars/venus'435>>> concat("earth", "mars", "venus", sep=".")436'earth.mars.venus'437```438439### 4.7.4. Распаковка списков аргументов440441Обратная ситуация возникает, когда аргументы уже находятся в списке или кортеже, но их нужно распаковать для вызова функции, требующей отдельных позиционных аргументов. Например, встроенная функция [`range()`](https://python-all.ru/3.5/library/stdtypes.html#range) ожидает отдельные аргументы *start* и *stop*. Если они недоступны по отдельности, запишите вызов функции с оператором `*`, чтобы распаковать аргументы из списка или кортежа:442443```python444>>> list(range(3, 6)) # обычный вызов с отдельными аргументами445[3, 4, 5]446>>> args = [3, 6]447>>> list(range(*args)) # вызов с аргументами, распакованными из списка448[3, 4, 5]449```450451Точно так же словари могут передавать именованные аргументы с помощью оператора `**`:452453```python454>>> def parrot(voltage, state='a stiff', action='voom'):455... print("-- This parrot wouldn't", action, end=' ')456... print("if you put", voltage, "volts through it.", end=' ')457... print("E's", state, "!")458...459>>> d = {"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"}460>>> parrot(**d)461-- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !462```463464### 4.7.5. Лямбда-выражения465466Небольшие анонимные функции можно создать с помощью ключевого слова [`lambda`](https://python-all.ru/3.5/reference/expressions.html#lambda). Эта функция возвращает сумму двух своих аргументов: `lambda a, b: a+b`. Лямбда-функции можно использовать везде, где требуются объекты функций. Синтаксически они ограничены одним выражением. Семантически это просто синтаксический сахар для обычного определения функции. Как и вложенные определения функций, лямбда-функции могут ссылаться на переменные из содержащей области видимости:467468```python469>>> def make_incrementor(n):470... return lambda x: x + n471...472>>> f = make_incrementor(42)473>>> f(0)47442475>>> f(1)47643477```478479В приведённом выше примере лямбда-выражение используется для возврата функции. Другое применение – передача небольшой функции в качестве аргумента:480481```python482>>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]483>>> pairs.sort(key=lambda pair: pair[1])484>>> pairs485[(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')]486```487488### 4.7.6. Строки документации489490Вот некоторые соглашения о содержании и форматировании строк документации.491492Первая строка всегда должна быть кратким и сжатым описанием назначения объекта. Для краткости в ней не следует явно указывать имя или тип объекта, так как они доступны другими способами (кроме случая, когда имя оказывается глаголом, описывающим действие функции). Эта строка должна начинаться с заглавной буквы и заканчиваться точкой.493494Если в строке документации есть несколько строк, вторая строка должна быть пустой, чтобы визуально отделить краткое описание от остальной части. Последующие строки должны быть одним или несколькими абзацами, описывающими соглашения о вызове объекта, его побочные эффекты и т.д.495496Парсер Python не удаляет отступы из многострочных строковых литералов в Python, поэтому инструменты, обрабатывающие документацию, должны при необходимости удалять отступы. Это делается по следующему соглашению. Первая непустая строка *после* первой строки строки определяет величину отступа для всей строки документации. (Первую строку мы не можем использовать, так как она обычно примыкает к открывающим кавычкам строки, и её отступ не очевиден в строковом литерале.) Затем пробельные символы, «эквивалентные» этому отступу, удаляются из начала всех строк строки. Строки с меньшим отступом встречаться не должны, но если они встречаются, все их начальные пробелы должны быть удалены. Эквивалентность пробелов следует проверять после замены табуляции (обычно на 8 пробелов).497498Вот пример многострочной строки документации:499500```python501>>> def my_function():502... """Ничего не делает, но документирует.503...504... Нет, правда, он ничего не делает.505... """506... pass507...508>>> print(my_function.__doc__)509Do nothing, but document it.510511 No, really, it doesn't do anything.512```513514### 4.7.7. Аннотации функций515516[Аннотации функций](https://python-all.ru/3.5/reference/compound_stmts.html#function) являются полностью необязательной метаинформацией о типах, используемых пользовательскими функциями (см. [**PEP 484**](https://python-all.ru/3.5/tutorial/controlflow.html) для получения дополнительной информации).517518Аннотации хранятся в атрибуте `__annotations__` функции в виде словаря и не влияют на любую другую часть функции. Аннотации параметров определяются двоеточием после имени параметра, за которым следует выражение, вычисляющее значение аннотации. Аннотации возвращаемого значения определяются литералом `->`, за которым следует выражение, между списком параметров и двоеточием, обозначающим конец оператора [`def`](https://python-all.ru/3.5/reference/compound_stmts.html#def). В следующем примере показаны позиционный аргумент, именованный аргумент и аннотированное возвращаемое значение:519520```python521>>> def f(ham: str, eggs: str = 'eggs') -> str:522... print("Annotations:", f.__annotations__)523... print("Arguments:", ham, eggs)524... return ham + ' and ' + eggs525...526>>> f('spam')527Annotations: {'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>}528Arguments: spam eggs529'spam and eggs'530```531532## 4.8. Интермеццо: стиль кодирования533534Теперь, когда вы собираетесь писать более длинные и сложные программы на Python, самое время поговорить о *стиле кодирования*. Большинство языков можно писать (или, точнее, *форматировать*) в разных стилях; одни стили более читаемы, чем другие. Облегчить чтение вашего кода другим – всегда хорошая идея, и принятие хорошего стиля кодирования в этом очень помогает.535536Для Python [**PEP 8**](https://python-all.ru/3.5/tutorial/controlflow.html) стал руководством по стилю, которому следуют большинство проектов; он продвигает очень читаемый и приятный глазу стиль кодирования. Каждый разработчик Python должен прочитать его в какой-то момент; вот наиболее важные моменты, извлечённые для вас:537538- Используйте отступы в 4 пробела и никаких табуляций.539540 4 пробела – хороший компромисс между маленьким отступом (позволяет большую глубину вложенности) и большим отступом (легче читать). Табуляция вносит путаницу, и её лучше избегать.541- Переносите строки так, чтобы они не превышали 79 символов.542543 Это помогает пользователям с маленькими экранами и позволяет размещать несколько файлов с кодом рядом на больших экранах.544- Используйте пустые строки для разделения функций и классов, а также крупных блоков кода внутри функций.545- По возможности размещайте комментарии на отдельных строках.546- Используйте строки документации.547- Используйте пробелы вокруг операторов и после запятых, но не непосредственно внутри скобочных конструкций: `a = f(1, 2) + g(3, 4)`.548- Давайте классам и функциям согласованные имена; принято использовать `CamelCase` для классов и `lower_case_with_underscores` для функций и методов. Всегда используйте `self` в качестве имени первого аргумента метода (см. [Первый взгляд на классы](https://python-all.ru/3.5/tutorial/classes.html#tut-firstclasses) для получения дополнительной информации о классах и методах).549- Не используйте экзотические кодировки, если ваш код предназначен для использования в международной среде. Стандартная кодировка Python, UTF-8 или даже обычный ASCII в любом случае подходят лучше всего.550- Аналогично, не используйте символы, не входящие в ASCII, в идентификаторах, если есть хоть малейшая вероятность, что код будут читать или сопровождать люди, говорящие на другом языке.551552Сноски553554| [\[1\]](https://python-all.ru/3.5/tutorial/controlflow.html#id1) | На самом деле, *вызов по ссылке на объект* было бы лучшим описанием, поскольку если передаётся изменяемый объект, вызывающий увидит любые изменения, вносимые вызываемым (например, элементы, добавленные в список). |555| --- | --- |556