Что будет являться возвращаемым значением данной функции

5. Функции, возвращающие значения¶

Встроенные функции, которыми мы пользовались, такие как abs , pow и max , возвращают результат. Вызов каждой из этих функций производит значение, которое обычно присваивается переменной или используется в выражении.

biggest = max(3, 7, 2, 5) x = abs(3 - 11) + 10 

До сих пор ни одна из написанных нами функций не возвращала значения.

В этой главе мы будем писать функции, возвращающие значения. Первый пример — функция area (англ.: площадь), возвращающая площадь круга с указанным радиусом:

def area(radius): temp = 3.14159 * radius**2 return temp 

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

def area(radius): return 3.14159 * radius**2 

Однако имейте в виду, что временные переменные, такие как temp , часто делают отладку проще.

Функция может иметь несколько предложений return, по одному в каждой ветке условного выполнения. Мы уже видели встроенную функцию abs , а теперь напишем нашу собственную:

def absolute_value(x): if x  0: return -x else: return x 

Поскольку предложения return здесь находятся в альтернативных ветках потока выполнения, будет выполнено только одно из них. Как только это произойдет, функция завершится; никакие последующие предложения выполняться не будут.

В рассматриваемой функции можно опустить else и просто поместить второе предложение return после составного предложения if .

def absolute_value(x): if x  0: return -x return x 

Посмотрите внимательно на эту версию и убедитесь, что она работает так же, как и первая.

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

Стоит убедиться в том, что в возвращающей значение функции каждый из возможных путей выполнения содержит предложение return . В следующей версии функции absolute_value это не так:

def absolute_value(x): if x  0: return -x elif x > 0: return x 

Эта функция некорректна, поскольку, если x окажется равным 0, ни одно из условий не выполнится и функция закончится, не выполнив предложения return . В таком случае, возвращаемым значением будет специальное значение None (англ.: ничто):

>>> print absolute_value(0) None 

None является единственным значением типа NoneType :

>>> type(None)

Все функции Python, если не возвращают некоторое значение явно, возвращают None .

5.2. Разработка программы¶

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

Для того, чтобы разрабатывать программы все возрастающей сложности, рассмотрим прием, называемый инкрементной разработкой. Цель инкрементной разработки — избежать длительной и мучительной отладки программы. Это становится возможным, если за один раз добавлять и тестировать небольшой объем кода.

Предположим, вы хотите найти расстояние между двумя точками, заданными с помощью их координат (x₁, y₁) и (x₂, y₂). Согласно теореме Пифагора, расстояние составляет:

Первый шаг разработки — обдумать, как должна выглядеть функция distance на языке Python. Другими словами, что должно быть у функции на входе (параметры) и что — на выходе (возвращаемое значение)?

В данном случае, на вход функции подаются две точки, которые можно представить четырьмя параметрами. А возвращаемое значение — расстояние, представленное числом с плавающей точкой.

Теперь можно набросать эскиз функции:

def distance(x1, y1, x2, y2): return 0.0 

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

Чтобы протестировать эту функцию, вызовем её с тестовыми значениями:

>>> distance(1, 2, 4, 6) 0.0 

Значения параметров подобраны так, чтобы горизонтальное расстояние равнялось 3, а вертикальное равнялось 4. Таким образом, результат должен быть равен 5 — гипотенуза прямоугольного треугольника со сторонами 3-4-5, изображенного на рисунке. При тестировании функции полезно заранее знать правильный ответ.

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

Первый шаг состоит в нахождении разностей x₂— x₁и y₂— y₁. Мы сохраним эти значения во временных переменных dx и dy и выведем их.

def distance(x1, y1, x2, y2): dx = x2 - x1 dy = y2 - y1 print "dx is", dx print "dy is", dy return 0.0 

Функция должна вывести 3 и 4. Если так и произошло, то теперь мы знаем, что первый шаг вычислений выполняется правильно. Если нет, то нужно проверить всего несколько строк.

Далее мы подсчитываем сумму квадратов dx и dy :

def distance(x1, y1, x2, y2): dx = x2 - x1 dy = y2 - y1 dsquared = dx**2 + dy**2 print "dsquared is: ", dsquared return 0.0 

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

И вновь мы запустим программу и проверим её вывод. Должно получиться 25.

Наконец, используя степень 0.5 для нахождения квадратного корня, мы вычислим и вернем результат:

def distance(x1, y1, x2, y2): dx = x2 - x1 dy = y2 - y1 dsquared = dx**2 + dy**2 result = dsquared**0.5 return result 

Если эта версия работает правильно, значит, программа готова. В противном случае, чтобы внести ясность, попробуйте вывести значение result перед предложением return.

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

Придерживайтесь следующих правил:

1. Начните с работающей программы и делайте небольшие инкрементные изменения. В каждый момент, когда вы столкнетесь с ошибкой, вы будете знать, где она.
2. Используйте временные переменные для сохранения промежуточных результатов, так чтобы их можно было вывести и проверить.
3. Если программа работает, то можно удалить вспомогательный код и собрать отдельные предложения в составные выражения. Однако это не должно сделать программу трудной для чтения!

5.3. Композиция¶

Как вы уже знаете, можно вызывать одну функцию из другой. Этот прием называется композиция.

Напишем функцию, которая принимает в качестве входных параметров две точки, центр окружности и точку на периметре, и расчитывает площадь круга.

Пусть координаты центральной точки хранятся в переменных xc и yc , а координаты точки на периметре окружности — в переменных xp и yp . Первым шагом будет нахождение радиуса окружности, равного расстоянию между этими двумя точками. Для этого воспользуемся функцией distance , которая делает именно то, что нам нужно:

radius = distance(xc, yc, xp, yp) 

Второй шаг — найти площадь круга данного радиуса и вернуть её. И снова мы воспользуемся одной из ранее написанных функций:

result = area(radius) return result 

Оформив этот код в виде функции, получаем:

def area2(xc, yc, xp, yp): radius = distance(xc, yc, xp, yp) result = area(radius) return result 

Мы назвали эту функцию area2 , чтобы отличать её от написанной ранее функции area . Внутри некоторого модуля может быть только одна функция с данным именем.

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

def area2(xc, yc, xp, yp): return area(distance(xc, yc, xp, yp)) 

5.4. Логические функции¶

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

def is_divisible(x, y): if x % y == 0: return True else: return False 

Имя этой функции is_divisible . Принято давать логическим функциям имена, выглядящие как вопрос, предполагающий один из двух возможных ответов: да или нет. Функция is_divisible возвращает либо True либо False , тем самым показывая, делится или не делится x на y .

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

def is_divisible(x, y): return x % y == 0 

А вот новая функция в действии:

>>> is_divisible(6, 4) False >>> is_divisible(6, 3) True 

Логические функции часто используются в условных предложениях:

if is_divisible(x, y): print "x is divisible by y" else: print "x is not divisible by y" 

У вас может появиться соблазн написать:

if is_divisible(x, y) == True: 

Но дополнительное сравнение здесь лишнее.

5.5. Тип function ¶

В Python function (англ.: функция) также является типом, как и уже известные нам int , float , str , bool и NoneType .

>>> def func(): . return "function func was called. " . >>> type(func) >>> 

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

def f(n): return 3*n - 6 def g(n): return 5*n + 2 def h(n): return -2*n + 17 def doto(value, func): return func(value) print doto(7, f) print doto(7, g) print doto(7, h) 

Функция doto вызывается три раза. В каждом вызове аргументом для value является 7, а для func — функции f , g и h , по очереди. Этот скрипт выводит:

15 37 3 

Этот пример, конечно, надуманный. Но позднее мы встретимся с ситуациями, когда передача функции в качестве аргумента другой функции очень полезна.

5.6. Оформление программ¶

Читабельность программ очень важна для программистов, поскольку на практике читать и изменять программы приходится гораздо чаще, чем писать новые. Все примеры кода в этой книге соответствуют Python Enhancement Proposal 8 (PEP 8). Это руководство по стилю программирования, разработанное сообществом программистов Python.

Чем сложнее становятся программы, тем большую роль начинает играть стиль программирования. Нескольких важных правил полезно придерживаться с самого начала:

• используйте 4 пробела для отступа,
• помещайте предложения import в начало файла,
• отделяйте определения функций двумя пустыми строчками,
• размещайте определения функций все вместе,
• размещайте предложения верхнего уровня, включая вызовы функций, все вместе в конце скрипта.

5.7. Строки в тройных кавычках¶

В дополнение к строкам, заключенным в одинарные и двойные кавычки, с которыми мы впервые встретились в разделе Значения и типы главы 2, в Python также имеются строки в тройных кавычках:

>>> type("""This is a triple quoted string using 3 double quotes.""") >>> type('''This triple quoted strings uses 3 single quotes.''') >>> 

Строки в тройных кавычках могут содержать внутри как одинарные, так и двойные кавычки:

>>> print '''"Oh no", she exclaimed, "Ben's bike is broken!"''' "Oh no", she exclaimed, "Ben's bike is broken!" >>> 

Кроме того, строковые значения, заключенные в тройные кавычки, могут распространяться на несколько строк:

>>> message = """This message will . span several . lines.""" >>> print message This message will span several lines. >>> 

5.8. Модульное тестирование с помощью doctest ¶

В последнее время широкую известность получило автоматическое модульное тестирование (англ.: unit testing) — очень полезная практика разработки программ. Модульное тестирование позволяет убедиться, что отдельные части кода, такие как функции, работают правильно.

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

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

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

Модуль doctest автоматически выполняет предложения, начинающиеся с >>> , и сравнивает следующую строку с тем, что вывел интерпретатор.

Чтобы посмотреть, как это работает, поместите следующее в скрипт с именем myfunctions.py :

def is_divisible_by_2_or_5(n): """ >>> is_divisible_by_2_or_5(8) True """ if __name__ == '__main__': import doctest doctest.testmod() 

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

Запустив скрипт на выполнение, получим следующее:

$ python myfunctions.py ********************************************************************** File "myfunctions.py", line 3, in __main__.is_divisible_by_2_or_5 Failed example: is_divisible_by_2_or_5(8) Expected: True Got nothing ********************************************************************** 1 items had failures: 1 of 1 in __main__.is_divisible_by_2_or_5 ***Test Failed*** 1 failures. $

Это пример неуспешного теста. Тест ожидает, что вызов is_divisible_by_2_or_5(8) даст результат True . Поскольку вызов is_divisible_by_2_or_5 не вернул ничего, тест считается неуспешным, и doctest сообщает, что ожидалось значение True , но не было получено ничего.

Заставим этот тест выполняться, возвращая True :

def is_divisible_by_2_or_5(n): """ >>> is_divisible_by_2_or_5(8) True """ return True if __name__ == '__main__': import doctest doctest.testmod() 

Если теперь запустить скрипт, он не выведет ничего. Это значит, что тест прошел успешно. Еще раз обратите внимание, что строка с тестом должна быть помещена сразу после заголовка в определении функции.

Чтобы увидеть более подробный отчет о выполнении теста, запустите скрипт с опцией -v :

$ python myfunctions.py -v Trying: is_divisible_by_2_or_5(8) Expecting: True ok 1 items had no tests: __main__ 1 items passed all tests: 1 tests in __main__.is_divisible_by_2_or_5 1 tests in 2 items. 1 passed and 0 failed. Test passed. $

Хотя тест проходит, наш набор тестов явно неадекватен, так как функция is_divisible_by_2_or_5 возвращает True независимо от переданных ей аргументов. Но вот окончательная версия набора тестов и корректного кода:

def is_divisible_by_2_or_5(n): """ >>> is_divisible_by_2_or_5(8) True >>> is_divisible_by_2_or_5(7) False >>> is_divisible_by_2_or_5(5) True >>> is_divisible_by_2_or_5(9) False """ return n % 2 == 0 or n % 5 == 0 if __name__ == '__main__': import doctest doctest.testmod() 

Теперь запустите скрипт с опцией -v и посмотрите, что получится.

5.9. Глоссарий¶

None Специальное значение Python, возвращаемое функцией, в которой либо нет предложения return, либо предложение return без аргумента. None — единственное значение типа NoneType . возвращаемое значение Значение, возвращаемое функцией. Вызывающий код получает это значение как результат вызова функции. временная переменная Переменная, используемая для хранения промежуточного результата вычислений. вспомогательный код Код, полезный для отладки программы в ходе ее разработки, но не включаемый в окончательную версию программы. инкрементная разработка Процесс разработки программы, нацеленный на то, чтобы избежать длительной отладки, за счет добавления и тестирования только небольших кусков кода за один раз. композиция функций Вызов одной функции в теле другой, или использование возвращаемого функцией значения в качестве аргумента при вызове другой функции. логическая функция Функция, возвращающая логическое значение. мертвый код Часть программы, которая не может быть выполнена ни при каких обстоятельствах, часто из-за того, что располагается после предложения return . модульное тестирование Практика программирования, нацеленная на проверку того, что отдельные части программы работают корректно. В Python имеется встроенный модуль doctest для автоматического выполнения модульных тестов.

5.10. Упражнения¶

Все упражнения, приведенные ниже, добавляйте в файл ch05.py , в конце которого поместите следующие строки:

if __name__ == '__main__': import doctest doctest.testmod() 

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

Напишите функцию compare , которая возвращает 1 , если a > b , 0 , если a == b и -1 , если a < b . Поместите тело функции после следующих доктестов и убедитесь, что они успешно проходят.

def compare(a, b): """ >>> compare(5, 4) 1 >>> compare(7, 7) 0 >>> compare(2, 3) -1 >>> compare(42, 1) 1 """ 

def hypotenuse(a, b): """ >>> hypotenuse(3, 4) 5.0 >>> hypotenuse(12, 5) 13.0 >>> hypotenuse(7, 24) 25.0 >>> hypotenuse(9, 12) 15.0 """ 

def slope(x1, y1, x2, y2): """ >>> slope(5, 3, 4, 2) 1.0 >>> slope(1, 2, 3, 2) 0.0 >>> slope(1, 2, 3, 3) 0.5 >>> slope(2, 4, 1, 2) 2.0 """ 

def intercept(x1, y1, x2, y2): """ >>> intercept(1, 6, 3, 12) 3.0 >>> intercept(6, 1, 1, 6) 7.0 >>> intercept(4, 6, 12, 8) 5.0 """ 

def is_factor(f, n): """ >>> is_factor(3, 12) True >>> is_factor(5, 12) False >>> is_factor(7, 14) True >>> is_factor(2, 14) True >>> is_factor(7, 15) False """ 

def is_multiple(m, n): """ >>> is_multiple(12, 3) True >>> is_multiple(12, 4) True >>> is_multiple(12, 5) False >>> is_multiple(12, 6) True >>> is_multiple(12, 7) False """ 

def f2c(t): """ >>> f2c(212) 100 >>> f2c(32) 0 >>> f2c(-40) -40 >>> f2c(36) 2 >>> f2c(37) 3 >>> f2c(38) 3 >>> f2c(39) 4 """ 

def c2f(t): """ >>> c2f(0) 32 >>> c2f(100) 212 >>> c2f(-40) -40 >>> c2f(12) 54 >>> c2f(18) 64 >>> c2f(-48) -54 """ 

Просмотр

© Copyright 2009, 2012, Джеффри Элкнер, Аллен Б. Дауни, Крис Мейерс, Андрей Трофимов. При создании использован Sphinx 1.1.3.

Возврат значений из функции. Оператор return

Функции могут передавать какие-либо данные из своих тел в основную ветку программы. Говорят, что функция возвращает значение. В большинстве языков программирования, в том числе Python, выход из функции и передача данных в то место, откуда она была вызвана, выполняется оператором return .

Если интерпретатор Питона, выполняя тело функции, встречает return , то он "забирает" значение, указанное после этой команды, и "уходит" из функции.

def cylinder(): r = float(input()) h = float(input()) # площадь боковой поверхности цилиндра: side = 2 * 3.14 * r * h # площадь одного основания цилиндра: circle = 3.14 * r**2 # полная площадь цилиндра: full = side + 2 * circle return full square = cylinder() print(square)

3 7 188.4

В данной программе в основную ветку из функции возвращается значение локальной переменной full . Не сама переменная, а ее значение, в данном случае – какое-либо число, полученное в результате вычисления площади цилиндра.

В основной ветке программы это значение присваивается глобальной переменной square . То есть выражение square = cylinder() выполняется так:

1. Вызывается функция cylinder() .
2. Из нее возвращается значение.
3. Это значение присваивается переменной square .

Не обязательно присваивать результат переменной, его можно сразу вывести на экран:

. print(cylinder())

Здесь число, полученное из cylinder() , непосредственно передается функции print() . Если мы в программе просто напишем cylinder() , не присвоив полученные данные переменной или не передав их куда-либо дальше, то эти данные будут потеряны. Но синтаксической ошибки не будет.

В функции может быть несколько операторов return . Однако всегда выполняется только один из них. Тот, которого первым достигнет поток выполнения. Допустим, мы решили обработать исключение, возникающее на некорректный ввод. Пусть тогда в ветке except обработчика исключений происходит выход из функции без всяких вычислений и передачи значения:

def cylinder(): try: r = float(input()) h = float(input()) except ValueError: return side = 2 * 3.14 * r * h circle = 3.14 * r**2 full = side + 2 * circle return full print(cylinder())

Если попытаться вместо цифр ввести буквы, то сработает return , вложенный в except . Он завершит выполнение функции, так что все нижеследующие вычисления, в том числе return full , будут опущены. Пример выполнения:

r None

Но постойте! Что это за слово None , которое нам вернул "пустой" return ? Это ничего, такой объект – "ничто". Он принадлежит классу NoneType . До этого мы знали четыре типа данных, они же четыре класса: int , float , str , bool . Пришло время пятого.

Когда после return ничего не указывается, то по умолчанию считается, что там стоит объект None . При желании мы можете явно писать return None .

Более того. Ранее мы рассматривали функции, которые вроде бы не возвращали никакого значения, потому что в них не было оператора return . На самом деле возвращали, просто мы не обращали на него внимание, не присваивали никакой переменной и не выводили на экран. В Python всякая функция что-либо возвращает. Если в ней нет оператора return , то она возвращает None . То же самое, как если в ней имеется "пустой" return .

Возврат нескольких значений

В Питоне позволительно возвращать из функции несколько объектов, перечислив их через запятую после команды return :

def cylinder(): r = float(input()) h = float(input()) side = 2 * 3.14 * r * h circle = 3.14 * r ** 2 full = side + 2 * circle return side, full s_cyl, f_cyl = cylinder() print("Площадь боковой поверхности %.2f" % s_cyl) print("Полная площадь %.2f" % f_cyl)

Из функции cylinder() возвращаются два значения. Первое из них присваивается переменной s_cyl , второе – f_cyl . Возможность такого группового присвоения – особенность Python, обычно не характерная для других языков:

>>> a, b, c = 10, 15, 19 >>> a 10 >>> b 15 >>> c 19

Фокус здесь в том, что перечисление значений через запятую (например, 10, 15, 19 ) создает объект типа tuple . На русский переводится как "кортеж". Это разновидность структур данных, которые будут изучены позже.

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

Таким образом, когда из функции возвращается несколько значений, на самом деле из нее возвращается один объект класса tuple . Перед возвратом эти несколько значений упаковываются в кортеж. Если же после оператора return стоит только одна переменная или объект, то ее/его тип сохраняется как есть.

Распаковка не является обязательной. Будет работать и так:

… print(cylinder())

4 3 (75.36, 175.84)

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

Практическая работа

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

Примеры решения и дополнительные уроки в pdf-версии курса

X Скрыть Наверх

Python. Введение в программирование

Что будет являться возвращаемым значением данной функции

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

Замечание:

Если конструкция return не указана, то функция вернёт значение null .

Использование выражения return

Пример #1 Использование конструкции return

function square ( $num )
return $num * $num ;
>
echo square ( 4 ); // выводит '16'.
?>

Функция не может возвращать несколько значений, но аналогичного результата можно добиться, возвращая массив.

Пример #2 Возврат нескольких значений в виде массива

function small_numbers ()
return [ 0 , 1 , 2 ];
>
// Деструктуризация массива будет собирать каждый элемент массива индивидуально
[ $zero , $one , $two ] = small_numbers ();

// До версии 7.1.0 единственной эквивалентной альтернативой было использование конструкции list().
list( $zero , $one , $two ) = small_numbers ();

Для того, чтобы функция возвращала результат по ссылке, вам необходимо использовать оператор & и при описании функции, и при присвоении переменной возвращаемого значения:

Пример #3 Возврат результата по ссылке

Для получения более детальной информации о ссылках обратитесь к разделу документации Подробно о ссылках.

User Contributed Notes 10 notes

6 years ago

PHP 7.1 allows for void and null return types by preceding the type declaration with a ? -- (e.g. function canReturnNullorString(): ?string)

However resource is not allowed as a return type:

function fileOpen ( string $fileName , string $mode ): resource
$handle = fopen ( $fileName , $mode );
if ( $handle !== false )
return $handle ;
>
>

$resourceHandle = fileOpen ( "myfile.txt" , "r" );
?>

Errors with:
Fatal error: Uncaught TypeError: Return value of fileOpen() must be an instance of resource, resource returned.

13 years ago

Developers with a C background may expect pass by reference semantics for arrays. It may be surprising that pass by value is used for arrays just like scalars. Objects are implicitly passed by reference.

# (1) Objects are always passed by reference and returned by reference

class Obj public $x ;
>

function obj_inc_x ( $obj ) $obj -> x ++;
return $obj ;
>

$obj = new Obj ();
$obj -> x = 1 ;

$obj2 = obj_inc_x ( $obj );
obj_inc_x ( $obj2 );

print $obj -> x . ', ' . $obj2 -> x . "\n" ;

# (2) Scalars are not passed by reference or returned as such

function scalar_inc_x ( $x ) $x ++;
return $x ;
>

$x2 = scalar_inc_x ( $x );
scalar_inc_x ( $x2 );

print $x . ', ' . $x2 . "\n" ;

# (3) You have to force pass by reference and return by reference on scalars

$x2 =& scalar_ref_inc_x ( $x ); # Need reference here as well as the function sig
scalar_ref_inc_x ( $x2 );

print $x . ', ' . $x2 . "\n" ;

# (4) Arrays use pass by value sematics just like scalars

function array_inc_x ( $array ) $array < 'x' >++;
return $array ;
>

$array = array();
$array [ 'x' ] = 1 ;

$array2 = array_inc_x ( $array );
array_inc_x ( $array2 );

print $array [ 'x' ] . ', ' . $array2 [ 'x' ] . "\n" ;

# (5) You have to force pass by reference and return by reference on arrays

$array = array();
$array [ 'x' ] = 1 ;

$array2 =& array_ref_inc_x ( $array ); # Need reference here as well as the function sig
array_ref_inc_x ( $array2 );

print $array [ 'x' ] . ', ' . $array2 [ 'x' ] . "\n" ;

15 years ago

Be careful about using "do this thing or die()" logic in your return lines. It doesn't work as you'd expect:

function myfunc1 () return( 'thingy' or die( 'otherthingy' ));
>
function myfunc2 () return 'thingy' or die( 'otherthingy' );
>
function myfunc3 () return( 'thingy' ) or die( 'otherthingy' );
>
function myfunc4 () return 'thingy' or 'otherthingy' ;
>
function myfunc5 () $x = 'thingy' or 'otherthingy' ; return $x ;
>
echo myfunc1 (). "\n" . myfunc2 (). "\n" . myfunc3 (). "\n" . myfunc4 (). "\n" . myfunc5 (). "\n" ;
?>

Only myfunc5() returns 'thingy' - the rest return 1.

6 years ago

With 7.1, these are possible yet;

function ret_void (): void // do something but no return any value
// if needs to break fn exec for any reason simply write return;
if (. ) return; // break
// return null; // even this NO!
>

$db -> doSomething ();
// no need return call anymore
>

function ret_nullable () ? int if (. ) return 123 ;
> else return null ; // MUST!
>
>
?>

20 years ago

Functions which return references, may return a NULL value. This is inconsistent with the fact that function parameters passed by reference can't be passed as NULL (or in fact anything which isnt a variable).

if ( testRet () === NULL )
echo "NULL" ;
>
?>

parses fine and echoes NULL

8 years ago

PHP 7 return types if specified can not return a null.
For example:
declare( strict_types = 1 );

function add2ints ( int $x , int $y ): int
$z = $x + $y ;
if ( $z === 0 )
return null ;
>
return $z ;
>
$a = add2ints ( 3 , 4 );
echo is_null ( $a ) ? 'Null' : $a ;
$b = add2ints (- 2 , 2 );
echo is_null ( $b ) ? 'Null' : $b ;
exit();

Output :
7
Process finished with exit code 139

5 years ago

Be careful when introducing return types to your code.

Only one return type can be specified (but prefacing with ? allows null).

Return values of a type different to that specified are silently converted with sometimes perplexing results. These can be tedious to find and will need rewriting, along with calling code.

Declare strict types using "declare(strict_types=1);" and an error will be generated, saving much head-scratching.

5 years ago

You may specify child return type if there is no parent:

class A public function f ( $a )
return 1 ;
>
>

class B extends A public function f ( $a ): int // + return type, OK
return 1 ;
>
>

class C extends A public function f ( int $a ) // + argument type, WARNING
return 1 ;
>
>
?>

7 years ago

Note: the function does not have "alternative syntax" as if/endif, while/endwhile, and colon (:) here is used to define returning type and not to mark where the block statement begins.

4 years ago

Declaring a collection of objects as return type is not implemented and forbidden:
class Child <>

function getChilds (): Child []
return [(new Child ()), (new Child ())];
>

var_dump ( getChilds ());
// Returns: Parse error: syntax error, unexpected '[', expecting ' ?>

We have to use:
class Child <>

function getChilds (): array
return [(new Child ()), (new Child ())];
>

var_dump ( getChilds ());
// Returns:
/*
array (size=2)
0 =>
object(Child)[168]
1 =>
object(Child)[398]
*/
?>

Idem for function parameter:
function setChilds ( Child [] $childs )<>
// Not allowed

function setChilds (array $childs )<>
// Allowed
?>

• Функции
  • Функции, определяемые пользователем
  • Аргументы функции
  • Возврат значений
  • Обращение к функциям через переменные
  • Встроенные функции
  • Анонимные функции
  • Стрелочные функции
  • Callback-​функции как объекты первого класса
  • Copyright © 2001-2023 The PHP Group
  • My PHP.net
  • Contact
  • Other PHP.net sites
  • Privacy policy

  Возвращаемые значения функций

  Для нас в этом курсе имеется ещё один важный момент. Посмотрим внимательнее на возвращаемое значение функций. Некоторые функции не возвращают существенное значение после завершения, но некоторые возвращают, и важно понимать что это за значение и как использовать его в своём коде и как сделать так чтобы ваши собственные функции возвращали полезные значения. Мы объясним всё это ниже.

  Необходимые навыки:	Базовая компьютерная грамотность, знание основ HTML и CSS, JavaScript first steps, Functions — reusable blocks of code.
  Цели:	Понять что такое возвращаемое значение функции и как его использовать.

  Что из себя представляют возвращаемые значения?

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

  var myText = "I am a string"; var newString = myText.replace("string", "sausage"); console.log(newString); // функция replace() принимает строку, // заменяет одну подстроку другой и возвращает // новую строку со сделанными заменами 

  Мы уже видели этот блок кода в нашей первой статье про функции. Мы вызываем функцию replace() на строке myText и передаём ей 2 параметра — заменяемую подстроку и подстроку, которой будем заменять. Когда функция завершит выполнение, она вернёт значение, которым является новая строка со сделанными в ней заменами. В коде выше мы сохраняем это возвращаемое значение как значение переменной newString .

  Если вы посмотрите на функцию replace() на MDN reference page, вы увидите секцию под названием Return value. Очень важно знать и понимать какие значения возвращаются функциями, так что мы пытаемся включать эту информацию везде, где это возможно.

  Некоторые функции не возвращают значения( на наших reference pages, возвращаемое значение обозначено как void или undefined в таких случаях). Например, в функции displayMessage() которую мы сделали в прошлой статье, в результате выполнения функции не возвращается никакого значения. Функция всего лишь отображает что-то где-то на экране.

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

  Использование возвращаемых значений в ваших собственных функциях

  Чтобы вернуть значение своей функции, вы должны использовать ключевое слово return. Мы видели это в действии недавно - в нашем примере random-canvas-circles.html. Наша функция draw() отрисовывает где-то на экране 100 случайных кружков.

  function draw()  ctx.clearRect(0, 0, WIDTH, HEIGHT); for (var i = 0; i  100; i++)  ctx.beginPath(); ctx.fillStyle = "rgba(255,0,0,0.5)"; ctx.arc(random(WIDTH), random(HEIGHT), random(50), 0, 2 * Math.PI); ctx.fill(); > > 

  Внутри каждой итерации есть 3 вызова функции random() . Это сделано чтобы сгенерировать случайное значение для текущей координаты x, y и для радиуса. Функция random() принимает 1 параметр (целое число) и возвращает случайное число в диапазоне от 0 до этого числа. Выглядит это вот так:

  function random(number)  return Math.floor(Math.random() * number); > 

  Тоже самое может быть написано вот так:

  function random(number)  var result = Math.floor(Math.random() * number); return result; > 

  Но первую версию написать быстрее и она более компактна.

  Мы возвращаем результат вычисления Math.floor(Math.random()*number) каждый раз когда функция вызывается. Это возвращаемое значение появляется в момент вызова функции и код продолжается. Так, например, если мы выполним следующую строчку:

  .arc(random(WIDTH), random(HEIGHT), random(50), 0, 2 * Math.PI); 

  и 3 вызова random() вернут значения 500, 200 и 35, соответственно, строчка будет выполнена как если бы она была такой:

  .arc(500, 200, 35, 0, 2 * Math.PI); 

  Сначала выполняются вызовы функции random() , на место которых подставляются возвращаемые ей значения, а затем выполнятся сама строка.

  Активное обучение: наша собственная, возвращающая значение функция

  Теперь напишем нашу собственную возвращающую значение функцию.

  function squared(num)  return num * num; > function cubed(num)  return num * num * num; > function factorial(num)  var x = num; while (x > 1)  num *= x - 1; x--; > return num; > 

  .onchange = function ()  var num = input.value; if (isNaN(num))  para.textContent = "You need to enter a number!"; > else  para.textContent = num + " squared is " + squared(num) + ". " + num + " cubed is " + cubed(num) + ". " + num + " factorial is " + factorial(num) + "."; > >; 

  Примечание: Если у вас проблемы с работой данного примера, не стесняйтесь сверить ваш код с работающей версией finished version on GitHub (или смотрите живой пример), или спросите нас.

  К этому моменту мы хотели бы чтобы вы написали парочку собственных функций и добавили их в библиотеку. Как на счёт квадратного или кубического корня числа или длины окружности круга с длиной радиуса равной числу num ?

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

  • Приведите другой пример написание обработчика ошибок. Это довольно хорошая идея проверять что важные параметры предоставлены в правильном типе и если они опциональны то предусматривать для них значения по умолчанию. В таком случая ваша программа с меньшей вероятность подвержена ошибкам.
  • Поразмышляйте о идее создания библиотеки функций. Чем дальше вы будите расти в профессиональном плане, тем больше будете сталкиваться с однотипными вещами. Это хорошая идея начать собирать свою собственную библиотеку функций, которые вы часто используют — в таком случае вы сможете просто скопировать их в ваш новый код или просто добавить их в любую HTML страничку, где это требуется.

  Заключение

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

  Если в статье есть что-то что вы не поняли, не стесняйтесь перечитать статью ещё раз или свяжитесь с нами для получения помощи.

  Смотрите также

  • Функции более подробно — подробное руководство, охватывающее более продвинутую информацию, связанную с функциями.
  • Колбэк-функции в JavaScript — распространённый паттерн JavaScript для передачи функции в другую функцию как аргумент, который затем вызывается внутри первой функции.
  • Назад
  • Обзор: Building blocks
  • Далее

  In this module

  • Making decisions in your code — conditionals
  • Looping code
  • Functions — reusable blocks of code
  • Build your own function
  • Function return values
  • Introduction to events
  • Image gallery

  Found a content problem with this page?

  • Edit the page on GitHub.
  • Report the content issue.
  • View the source on GitHub.

  This page was last modified on 3 авг. 2023 г. by MDN contributors.

  Your blueprint for a better internet.