Python — Урок 1.1 TDD для начинающих на Python

Представляю вашему вниманию первую часть первого урока посвящённую разработке через тестирование. Надеюсь будет полезно:) Старался написать максимально простым языком:) Комментарии приветствуются.

Добро пожаловать на серию уроков по Test Driven Development. Для тех кто ещё не знает что такое TDD: Разрабо?тка че?рез тести?рование (англ. test-driven development) — техника программирования, при которой модульные тесты для программы или её фрагмента пишутся до самой программы и, по существу, управляют её разработкой. Основная идея - реализовать правильно работающий функционал, обеспечить возможность повторного использования и простого изменения структуры исходного кода, при этом не изменяя его поведения (рефакторинг)

Давайте в начале рассмотрим из каких
шагов состоит TDD:
Красный. Подготавливаем файл с тестом,
создаём не работающий тест
Зелёный. Заставляем тест сработать
Рефакторинг Удаляем дублирование
Помимо этих основных шагов я применяю в начале нулевой шаг - «исследование и хакинг» в случае, когда я с трудом представляю, как мне пройти последующие 3-и шага. Давайте пройдёмся по этим шагам на примере реализации простой задачи, например вычисления факториала.
Исследование и хакинг. Что нам известно о
факториале?
Давайте разберём пример:
n! = 1 * 2 * 3 * … * n
0! = 1 1! = 1 2! = 2 3! = 6 4! = 24 и так далее

Предположим, что я впервые открыл интерпретатор python и пока с трудом представляю себе как этом можно
реализовать. :) Попробуем поэксперементировать и немного похакать)
Но для начала, составим список того, что нам понадобиться сделать.
Умножение
Функции
Условные операторы
Аргументы функции
Рекурсия
Запускаем консоль и заходим в python.

>>> 2 * 3
6
Умножение
Функции
Условные операторы
Аргументы функции
Рекурсия
С умножением всё ясно. Теперь попробуем написать какую-нибудь простую функцию:

1 2 3 4 5

>>> def f(): ... print "hello" ... >>> f() hello

Отлично, наша функция отработала. Не забываем про отступы в функциях, те перед print "hello" у меня стоят два пробела.
Посмотрим как функция будет возвращать наше значение:

1 2 3 4 5

>>> def f(): ... return "hello" ... >>> f() 'hello'

С этим разобрались.
Умножение
Функции
Условные операторы
Аргументы функции
Рекурсия
Теперь посмотрим как работают условные операторы и аргументы функции:

1 2 3 4 5 6 7 8 9 10

>>> def f(flag): ... if flag: ... return True ... else: ... return False ... >>> f(1) True >>> f(0) False

Если наш флаг присутствует, то возвращаем True, в противном случае False.
Умножение
Функции
Условные операторы
Аргументы функции
Рекурсия
Что же такое рекурсия. Рекурсия — это функция вызывающая сама себя. Давайте разберёмся:

1 2 3 4 5 6 7 8 9 10 11 12 13 14

>>> def f(n): ... if n == 0: ... return 0 ... else: ... print "n: %s" % n ... return f(n-1) ... >>> f(5) n: 5 n: 4 n: 3 n: 2 n: 1 0

В месте return f(n-1) функция будет вызывать сама себя, но n при этом будет уменьшаться на единицу. Конструкция print "n: %s" % n
вставляет n в строку и форматирует его как строковое значение.
Умножение
Функции
Условные операторы
Аргументы функции
Рекурсия
Достаточно поэкспериментировав, мы готовы перейти к разработке через тестирование нашей функции факториала :)
Что-бы упростить задачу, воспользуемся
doctest-ами.

Снова составим список того, что нам надо
сделать:
Эксперимент с doctest
Вычисление факториала
Созадём файл factor.py содержащий:

1 2 3 4 5

#!/usr/bin/python # -*- coding: UTF-8 -*- if __name__ == '__main__': pass

Попробуйте его запустить из консоли: python
factor.py
Отлично, пока что у нас нечего не выводиться, но файл выполнился.

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

Смотрим пример:

1 2 3 4 5 6 7 8 9 10 11 12

def f(a, b): ''' Функция складывает два числа >>> f(1,2) 3 ''' pass if __name__ == '__main__': import doctest doctest.testmod() pass

Оператор pass означает, что делать нечего не надо. Попробуем запустить: python factor.py

В результате видим:
**********************************************************************
File "factor.py", line 11, in __main__.f
Failed example:
f(1,2)
Expected:
3
Got nothing
**********************************************************************
1 items had failures:
1 of 1 in __main__.f
***Test Failed*** 1 failures.

Отлично, мы проделали первый шаг TDD - «Красный». Приступим к зелёному .

1 2 3 4 5 6 7

def f(a, b): ''' Функция складывает два числа >>> f(1,2) 3 ''' return 1 + 2

Запускаем и видим, что наша функция прошла тест, второй шаг «Зелёный» вроде пройден, но что если мы попробуем вызвать
f(2, 3). Изменим функцию и посмотрим результат:

1 2 3 4 5 6 7 8 9

def f(a, b): ''' Функция складывает два числа >>> f(1,2) 3 >>> f(2,3) 5 ''' return 1 + 2

Запускаем python factor.py
**********************************************************************
File "factor.py", line 13, in __main__.f
Failed example:
f(2,3)
Expected:
5
Got:
3
**********************************************************************
1 items had failures:
1 of 2 in __main__.f
***Test Failed*** 1 failures

Что и следовало ожидать, мы хотим 2 + 3 = 5, но получили 3. Теперь у нас достаточно тестов чтобы реализовать нашу функцию. Приступим:

1 2 3 4 5 6 7 8 9

def f(a, b): ''' Функция складывает два числа >>> f(1,2) 3 >>> f(2,3) 5 ''' return a + b

Запускаем python factor.py и видим, что тесты прошли. Отлично. Мы написали первую функию в рамках TDD и разобрались с doctest-ом.

На этом я заканчиваю первую часть первого урока. Во второй части разберёмся как реализовать функцию вычисления
факториала.
Эксперимент с doctest
Вычисление факториала
Домашнее задание
Напишите функцию разницы. Тест для функции:

1 2 3 4 5 6 7 8 9 10 11

def minus(a, b): ''' Функция разницы >>> f(4,2) 2 >>> f(2,4) -2 >>> f(10,3) 7 ''' pass

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