Генераторы словарей и модули Рython
Функции в языке Python Функции в языке PythonВсе функции в языке Python возвращают какое-либо значение, хотя вполне возможно (и часто так и делается) просто игнорировать это значение. Возвращаемое значение может быть единственным значением или кортежем значений,...
Реализация генераторов Реализация генераторовМы рассмотрели коллекции-последовательности, tuple, collections, na-medtuple и list, поддерживающие, как и строки, возможность извлечения срезов. Также было рассмотрено использование оператора распаковывания...
Парсинг документов XML Парсинг документов XMLXML: Для парсинга документов XML широко используются два основных подхода. Один из них основан на анализе DOM (Document Object Model -объектная модель документа), а другой - на использовании SAX (Simple API for XML - упрощенный...
Копирование коллекций Копирование коллекцийКопирование коллекций: Поскольку в языке Python повсюду используются ссылки на объекты, когда выполняется оператор присваивания (=), никакого копирования данных на самом деле не происходит. Если справа от оператора находится литерал,...
Функции в языке Python
Это может быть неважно для того, кто будет пользоваться функцией, но может вводить в заблуждение тех, кто будет сопровождать программный код, если имя функции предполагает реализацию алгоритма линейного поиска, а в действительности со временем функцию могли переписать под использование алгоритма поиска методом дихотомии. Третий вариант можно назвать удачным, потому что имя функции говорит о том, что она возвращает, а имена параметров недвусмысленно показывают, что ожидает получить функция.

Ни одна из функций не имеет возможности указать, что произойдет, если поиск завершится неудачей - вернут ли они, скажем, значение -1, или возбудят исключение? В каком-то виде такая информация должна быть включена в описание, предоставляемое пользователям функции. Мы можем добавить описание к любой функции, используя строки документирования - это обычные строки, которые следуют сразу за строкой с инструкцией def и перед программным кодом функции.

Нет ничего необычного в том, что текст описания длиннее самой функции. В соответствии с общепринятыми соглашениями первая строка в описании должна представлять собой краткое, однострочное описание функции, затем следует пустая строка и далее следует полное описание функции, в конце которого приводится несколько примеров того, как может выглядеть использование функции в интерактивной оболочке.
Навигация: 1 2 3 4
 
 
© Copyright