26.5. unittest.mock – начало работы¶unittest.mock – getting started

26.5.1.1. Подмена методов с помощью Mock¶Mock Patching Methods

Типичные случаи использования объектов Mock:

• Подмена методов
• Запись вызовов методов объектов

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

>>> real = SomeClass()
>>> real.method = MagicMock(name='method')
>>> real.method(3, 4, 5, key='value')
<MagicMock name='method()' id='...'>

После того как наш mock был использован (в этом примере real.method), у него появляются методы и атрибуты, позволяющие делать утверждения о том, как он использовался.

После вызова mock его атрибут called принимает значение True. Что ещё важнее, можно воспользоваться методом assert_called_with() или assert_called_once_with(), чтобы проверить, что он был вызван с правильными аргументами.

Этот пример проверяет, что вызов ProductionClass().method приводит к вызову метода something:

>>> class ProductionClass:
...     def method(self):
...         self.something(1, 2, 3)
...     def something(self, a, b, c):
...         pass
...
>>> real = ProductionClass()
>>> real.something = MagicMock()
>>> real.method()
>>> real.something.assert_called_once_with(1, 2, 3)

26.5.1.2. Mock для вызовов методов объекта¶Mock for Method Calls on an Object

В последнем примере мы напрямую подменили метод объекта, чтобы проверить, что он был вызван корректно. Другой типичный случай – передать объект в метод (или какую-то часть тестируемой системы), а затем проверить, что он используется правильным образом.

У простого класса ProductionClass ниже есть метод closer. Если его вызвать с объектом, то он вызовет у этого объекта close.

>>> class ProductionClass:
...     def closer(self, something):
...         something.close()
...

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

>>> real = ProductionClass()
>>> mock = Mock()
>>> real.closer(mock)
>>> mock.close.assert_called_with()

Нам не нужно ничего делать, чтобы предоставить метод 'close' в нашем mock. Обращение к close создаёт его. Поэтому, если close ещё не был вызван, обращение к нему в тесте создаст его, но assert_called_with() вызовет исключение.

26.5.1.3. Подмена классов¶Mocking Classes

Типичный сценарий – подменить классы, которые инстанциируются тестируемым кодом. При подмене класса он заменяется mock. Экземпляры создаются вызовом класса. Это значит, что «экземпляр mock» доступен через возвращаемое значение подменённого класса.

В примере ниже есть функция some_function, которая создаёт экземпляр Foo и вызывает его метод. Вызов patch() заменяет класс Foo на mock. Экземпляр Foo – результат вызова mock, поэтому он настраивается изменением return_value у mock.

>>> def some_function():
...     instance = module.Foo()
...     return instance.method()
...
>>> with patch('module.Foo') as mock:
...     instance = mock.return_value
...     instance.method.return_value = 'the result'
...     result = some_function()
...     assert result == 'the result'

26.5.1.4. Именование заглушек¶Naming your mocks

Полезно давать вашим mock имена. Имя отображается в repr mock и может помочь, когда mock фигурирует в сообщениях об ошибках тестов. Имя также распространяется на атрибуты и методы mock:

>>> mock = MagicMock(name='foo')
>>> mock
<MagicMock name='foo' id='...'>
>>> mock.method
<MagicMock name='foo.method' id='...'>

26.5.1.5. Отслеживание всех вызовов¶Tracking all Calls

Часто требуется отследить не один вызов метода, а несколько. Атрибут mock_calls записывает все вызовы дочерних атрибутов mock, а также их потомков.

>>> mock = MagicMock()
>>> mock.method()
<MagicMock name='mock.method()' id='...'>
>>> mock.attribute.method(10, x=53)
<MagicMock name='mock.attribute.method()' id='...'>
>>> mock.mock_calls
[call.method(), call.attribute.method(10, x=53)]

Если сделать утверждение о mock_calls, а какие-то неожиданные методы были вызваны, утверждение не пройдёт. Это полезно, поскольку позволяет не только убедиться, что ожидаемые вызовы были сделаны, но и проверить, что они были сделаны в правильном порядке и без лишних вызовов:

Объект call используется для построения списков, которые затем сравниваются с mock_calls:

>>> expected = [call.method(), call.attribute.method(10, x=53)]
>>> mock.mock_calls == expected
True

26.5.1.6. Установка возвращаемых значений и атрибутов¶Setting Return Values and Attributes

Установка возвращаемых значений для mock-объекта очень проста:

>>> mock = Mock()
>>> mock.return_value = 3
>>> mock()
3

Конечно, то же самое можно сделать для методов mock:

>>> mock = Mock()
>>> mock.method.return_value = 3
>>> mock.method()
3

Возвращаемое значение также можно задать в конструкторе:

>>> mock = Mock(return_value=3)
>>> mock()
3

Если требуется задать атрибут на mock, сделайте это:

>>> mock = Mock()
>>> mock.x = 3
>>> mock.x
3

Иногда нужно сэмулировать более сложную ситуацию, например mock.connection.cursor().execute("SELECT 1"). Если нужно, чтобы этот вызов вернул список, придётся настроить результат вложенного вызова.

Можно использовать call для построения набора вызовов в виде «цепочки вызовов», как здесь, для последующей простой проверки:

>>> mock = Mock()
>>> cursor = mock.connection.cursor.return_value
>>> cursor.execute.return_value = ['foo']
>>> mock.connection.cursor().execute("SELECT 1")
['foo']
>>> expected = call.connection.cursor().execute("SELECT 1").call_list()
>>> mock.mock_calls
[call.connection.cursor(), call.connection.cursor().execute('SELECT 1')]
>>> mock.mock_calls == expected
True

Именно вызов .call_list() превращает объект call в список вызовов, представляющих цепочку.

26.5.1.7. Вызов исключений с помощью заглушек¶Raising exceptions with mocks

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

>>> mock = Mock(side_effect=Exception('Boom!'))
>>> mock()
Traceback (most recent call last):
  ...
Exception: Boom!

26.5.1.8. Функции и итерируемые объекты в side_effect¶Side effect functions and iterables

side_effect также можно задать как функцию или итерируемый объект. Сценарий использования side_effect как итерируемого объекта: mock будет вызван несколько раз, и каждый вызов должен возвращать разное значение. Если задать side_effect как итерируемый объект, каждый вызов mock будет возвращать следующее значение из этого объекта:

>>> mock = MagicMock(side_effect=[4, 5, 6])
>>> mock()
4
>>> mock()
5
>>> mock()
6

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

>>> vals = {(1, 2): 1, (2, 3): 2}
>>> def side_effect(*args):
...     return vals[args]
...
>>> mock = MagicMock(side_effect=side_effect)
>>> mock(1, 2)
1
>>> mock(2, 3)
2

26.5.1.9. Создание mock на основе существующего объекта¶Creating a Mock from an Existing Object

Одна из проблем чрезмерного использования mock – это привязка тестов к реализации mock, а не к реальному коду. Предположим, есть класс, реализующий метод some_method. В тесте для другого класса вы предоставляете mock этого объекта, который также содержит some_method. Если позже вы реорганизуете первый класс, так что он больше не будет иметь some_method, то ваши тесты по-прежнему будут проходить, хотя код уже сломан!

Mock позволяет указать объект в качестве спецификации для mock через именованный аргумент spec. Обращение к методам/атрибутам mock, отсутствующим в объекте-спецификации, немедленно вызовет ошибку атрибута. Если изменить реализацию спецификации, тесты, использующие этот класс, немедленно начнут падать, причём без необходимости создавать экземпляр класса в этих тестах.

>>> mock = Mock(spec=SomeClass)
>>> mock.old_method()
Traceback (most recent call last):
   ...
AttributeError: object has no attribute 'old_method'

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

>>> def f(a, b, c): pass
...
>>> mock = Mock(spec=f)
>>> mock(1, 2, 3)
<Mock name='mock()' id='140161580456576'>
>>> mock.assert_called_with(a=1, b=2, c=3)

Если нужно, чтобы такое интеллектуальное сопоставление работало и для вызовов методов мока, можно воспользоваться авто-спецификацией (auto-speccing).

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

26.5.3.1. Мокирование цепочечных вызовов¶Mocking chained calls

Мокирование цепочечных вызовов на самом деле несложно с mock, если понять атрибут return_value. Когда mock вызывается впервые или вы получаете его return_value до вызова, создаётся новый Mock.

Это означает, что можно увидеть, как использовался объект, возвращённый вызовом мокированного объекта, анализируя mock return_value:

>>> mock = Mock()
>>> mock().foo(a=2, b=3)
<Mock name='mock().foo()' id='...'>
>>> mock.return_value.foo.assert_called_with(a=2, b=3)

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

Итак, предположим, у нас есть код, который выглядит примерно так:

>>> class Something:
...     def __init__(self):
...         self.backend = BackendProvider()
...     def method(self):
...         response = self.backend.get_endpoint('foobar').create_call('spam', 'eggs').start_call()
...         # ещё код

Предполагая, что BackendProvider уже хорошо протестирован, как тестировать method()? В частности, мы хотим проверить, что участок кода # more code правильно использует объект ответа.

Поскольку эта цепочка вызовов производится через атрибут экземпляра, мы можем применить monkey patch к атрибуту backend экземпляра Something. В данном случае нас интересует только возвращаемое значение последнего вызова start_call, так что настраивать нужно немного. Предположим, что возвращаемый объект является файлоподобным, поэтому мы обеспечим, чтобы наш объект ответа использовал встроенную функцию open() в качестве своего spec.

Для этого мы создаём mock-экземпляр в качестве mock-бэкенда и создаём mock-объект ответа. Чтобы установить ответ как возвращаемое значение для этого последнего start_call, можно сделать так:

mock_backend.get_endpoint.return_value.create_call.return_value.start_call.return_value = mock_response

Это можно сделать немного элегантнее с помощью метода configure_mock(), чтобы напрямую установить возвращаемое значение:

>>> something = Something()
>>> mock_response = Mock(spec=open)
>>> mock_backend = Mock()
>>> config = {'get_endpoint.return_value.create_call.return_value.start_call.return_value': mock_response}
>>> mock_backend.configure_mock(**config)

С их помощью мы применяем monkey-patch к «mock backend» и можем выполнить реальный вызов:

>>> something.backend = mock_backend
>>> something.method()

Используя mock_calls, можно проверить цепочечный вызов одним assert. Цепочечный вызов – это несколько вызовов в одной строке кода, поэтому в mock_calls будет несколько записей. Для создания этого списка вызовов можно использовать call.call_list():

>>> chained = call.get_endpoint('foobar').create_call('spam', 'eggs').start_call()
>>> call_list = chained.call_list()
>>> assert mock_backend.mock_calls == call_list

26.5.3.2. Частичное мокирование¶Partial mocking

В некоторых тестах я хотел замокировать вызов datetime.date.today(), чтобы он возвращал известную дату, но не хотел препятствовать созданию новых объектов date тестируемым кодом. К сожалению, datetime.date написан на C, поэтому я не мог просто применить monkey patch к статическому методу date.today().

Я нашел простой способ сделать это: обернуть класс date в mock, но передавать вызовы конструктора настоящему классу (и возвращать настоящие экземпляры).

Здесь patch декоратор используется, чтобы замокировать класс date в тестируемом модуле. Затем атрибут side_effect в mock-классе date устанавливается в лямбда-функцию, которая возвращает реальную дату. При вызове mock-класса date реальная дата будет создана и возвращена side_effect.

>>> from datetime import date
>>> with patch('mymodule.date') as mock_date:
...     mock_date.today.return_value = date(2010, 10, 8)
...     mock_date.side_effect = lambda *args, **kw: date(*args, **kw)
...
...     assert mymodule.date.today() == date(2010, 10, 8)
...     assert mymodule.date(2009, 6, 8) == date(2009, 6, 8)
...

Обратите внимание, что мы не патчим datetime.date глобально, мы патчим date в модуле, который использует его. См. где патчить.

Когда вызывается date.today(), возвращается известная дата, но вызовы конструктора date(...) по-прежнему возвращают обычные даты. Без этого можно оказаться в ситуации, когда приходится вычислять ожидаемый результат с использованием того же алгоритма, что и тестируемый код, что является классическим антипаттерном тестирования.

Вызовы конструктора date записываются в атрибутах mock_date (call_count и подобных), что также может быть полезно для ваших тестов.

Альтернативный способ мокирования дат или других встроенных классов описан в этой записи блога.

26.5.3.3. Мокирование метода-генератора¶Mocking a Generator Method

Генератор Python – это функция или метод, использующий оператор yield для возврата последовательности значений при итерации [1].

Метод/функция-генератор вызывается для возврата объекта-генератора. Затем именно объект-генератор итерируется. Метод протокола для итерации – __iter__(), поэтому мы можем замокировать его с помощью MagicMock.

Вот пример класса с методом “iter”, реализованным как генератор:

>>> class Foo:
...     def iter(self):
...         for i in [1, 2, 3]:
...             yield i
...
>>> foo = Foo()
>>> list(foo.iter())
[1, 2, 3]

Как бы мы мокировали этот класс и, в частности, его метод “iter”?

Чтобы настроить значения, возвращаемые при итерации (неявно при вызове list), необходимо настроить объект, возвращаемый вызовом foo.iter().

>>> mock_foo = MagicMock()
>>> mock_foo.iter.return_value = iter([1, 2, 3])
>>> list(mock_foo.iter())
[1, 2, 3]

26.5.3.4. Применение одного и того же патча к каждому тестовому методу¶Applying the same patch to every test method

Если требуется применить несколько патчей для нескольких тестовых методов, очевидный способ – применить декораторы патчей к каждому методу. Это может показаться излишним повторением. Начиная с Python 2.6 можно использовать patch() (во всех его формах) в качестве декоратора класса. Это применяет патчи ко всем тестовым методам класса. Тестовые методы определяются по именам, начинающимся с test:

>>> @patch('mymodule.SomeClass')
... class MyTest(TestCase):
...
...     def test_one(self, MockSomeClass):
...         self.assertIs(mymodule.SomeClass, MockSomeClass)
...
...     def test_two(self, MockSomeClass):
...         self.assertIs(mymodule.SomeClass, MockSomeClass)
...
...     def not_a_test(self):
...         return 'something'
...
>>> MyTest('test_one').test_one()
>>> MyTest('test_two').test_two()
>>> MyTest('test_two').not_a_test()
'something'

Альтернативный способ управления патчами – использовать методы patch: start и stop. Они позволяют перенести установку патчей в методы setUp и tearDown.

>>> class MyTest(TestCase):
...     def setUp(self):
...         self.patcher = patch('mymodule.foo')
...         self.mock_foo = self.patcher.start()
...
...     def test_foo(self):
...         self.assertIs(mymodule.foo, self.mock_foo)
...
...     def tearDown(self):
...         self.patcher.stop()
...
>>> MyTest('test_foo').run()

Если используется этот приём, необходимо убедиться, что патч «отменён» вызовом stop. Это может быть сложнее, чем кажется, поскольку если в setUp возникнет исключение, tearDown не вызывается. unittest.TestCase.addCleanup() упрощает эту задачу:

>>> class MyTest(TestCase):
...     def setUp(self):
...         patcher = patch('mymodule.foo')
...         self.addCleanup(patcher.stop)
...         self.mock_foo = patcher.start()
...
...     def test_foo(self):
...         self.assertIs(mymodule.foo, self.mock_foo)
...
>>> MyTest('test_foo').run()

26.5.3.5. Мокирование несвязанных методов¶Mocking Unbound Methods

При написании тестов мне потребовалось исправить несвязанный метод (исправить метод на уровне класса, а не экземпляра). Мне нужно было, чтобы self передавался первым аргументом, потому что я хотел проверять, какие объекты вызывали этот конкретный метод. Проблема в том, что для этого нельзя использовать мок: если заменить несвязанный метод на мок, тот не станет связанным методом при получении из экземпляра, и self не будет передан. Обходной путь – исправить несвязанный метод настоящей функцией. Декоратор patch() настолько упрощает замену методов моками, что создание настоящей функции становится обременительным.

Если передать autospec=True в patch, то патч будет выполнен с использованием настоящего объекта функции. Этот объект функции имеет ту же сигнатуру, что и заменяемый, но делегирует вызовы моку под капотом. Мок по-прежнему создаётся автоматически, как и раньше. Однако это означает, что если использовать его для замены несвязанного метода класса, то замоканная функция превратится в связанный метод при получении из экземпляра. В неё будет передан self в качестве первого аргумента – именно то, что мне было нужно:

>>> class Foo:
...   def foo(self):
...     pass
...
>>> with patch.object(Foo, 'foo', autospec=True) as mock_foo:
...   mock_foo.return_value = 'foo'
...   foo = Foo()
...   foo.foo()
...
'foo'
>>> mock_foo.assert_called_once_with(foo)

Если не использовать autospec=True, то несвязанный метод заменяется экземпляром Mock и не вызывается с self.

26.5.3.6. Проверка множественных вызовов с помощью mock¶Checking multiple calls with mock

У mock есть удобный API для проверки того, как используются объекты mock.

>>> mock = Mock()
>>> mock.foo_bar.return_value = None
>>> mock.foo_bar('baz', spam='eggs')
>>> mock.foo_bar.assert_called_with('baz', spam='eggs')

Если мок вызывается только один раз, можно использовать метод assert_called_once_with(), который также проверяет, что call_count равен единице.

>>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')
>>> mock.foo_bar()
>>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')
Traceback (most recent call last):
    ...
AssertionError: Expected to be called once. Called 2 times.

Оба метода assert_called_with и assert_called_once_with проверяют последний вызов. Если мок будет вызываться несколько раз, и требуется проверить все эти вызовы, можно использовать call_args_list:

>>> mock = Mock(return_value=None)
>>> mock(1, 2, 3)
>>> mock(4, 5, 6)
>>> mock()
>>> mock.call_args_list
[call(1, 2, 3), call(4, 5, 6), call()]

Вспомогательный объект call упрощает проверку этих вызовов. Можно составить список ожидаемых вызовов и сравнить его с call_args_list. Это очень похоже на repr от call_args_list:

>>> expected = [call(1, 2, 3), call(4, 5, 6), call()]
>>> mock.call_args_list == expected
True

26.5.3.7. Работа с изменяемыми аргументами¶Coping with mutable arguments

Ещё одна редкая, но коварная ситуация возникает, когда мок вызывается с изменяемыми аргументами. call_args и call_args_list хранят ссылки на аргументы. Если тестируемый код изменяет аргументы, то уже невозможно проверить, какими были значения на момент вызова мока.

Вот пример кода, демонстрирующий проблему. Предположим, в 'mymodule' определены следующие функции:

def frob(val):
    pass

def grob(val):
    "First frob and then clear val"
    frob(val)
    val.clear()

При попытке проверить, что grob вызывает frob с правильным аргументом, происходит следующее:

>>> with patch('mymodule.frob') as mock_frob:
...     val = {6}
...     mymodule.grob(val)
...
>>> val
set()
>>> mock_frob.assert_called_with({6})
Traceback (most recent call last):
    ...
AssertionError: Expected: (({6},), {})
Called with: ((set(),), {})

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

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

>>> from copy import deepcopy
>>> from unittest.mock import Mock, patch, DEFAULT
>>> def copy_call_args(mock):
...     new_mock = Mock()
...     def side_effect(*args, **kwargs):
...         args = deepcopy(args)
...         kwargs = deepcopy(kwargs)
...         new_mock(*args, **kwargs)
...         return DEFAULT
...     mock.side_effect = side_effect
...     return new_mock
...
>>> with patch('mymodule.frob') as mock_frob:
...     new_mock = copy_call_args(mock_frob)
...     val = {6}
...     mymodule.grob(val)
...
>>> new_mock.assert_called_with({6})
>>> new_mock.call_args
call({6})

Функция copy_call_args вызывается с моком, который будет вызван. Она возвращает новый мок, для которого выполняется проверка. Функция side_effect создаёт копию аргументов и вызывает new_mock с этой копией.

>>> def side_effect(arg):
...     assert arg == {6}
...
>>> mock = Mock(side_effect=side_effect)
>>> mock({6})
>>> mock(set())
Traceback (most recent call last):
    ...
AssertionError

Альтернативный подход – создать подкласс Mock или MagicMock, который копирует аргументы (с помощью copy.deepcopy()). Вот пример реализации:

>>> from copy import deepcopy
>>> class CopyingMock(MagicMock):
...     def __call__(self, *args, **kwargs):
...         args = deepcopy(args)
...         kwargs = deepcopy(kwargs)
...         return super(CopyingMock, self).__call__(*args, **kwargs)
...
>>> c = CopyingMock(return_value=None)
>>> arg = set()
>>> c(arg)
>>> arg.add(1)
>>> c.assert_called_with(set())
>>> c.assert_called_with(arg)
Traceback (most recent call last):
    ...
AssertionError: Expected call: mock({1})
Actual call: mock(set())
>>> c.foo
<CopyingMock name='mock.foo' id='...'>

При создании подкласса Mock или MagicMock все динамически создаваемые атрибуты и return_value будут автоматически использовать ваш подкласс. Это означает, что все дочерние объекты CopyingMock также будут иметь тип CopyingMock.

26.5.3.8. Вложение патчей¶Nesting Patches

Использовать patch как менеджер контекста удобно, но при множественных подстановках можно получить вложенные операторы with, уходящие всё дальше вправо с отступами:

>>> class MyTest(TestCase):
...
...     def test_foo(self):
...         with patch('mymodule.Foo') as mock_foo:
...             with patch('mymodule.Bar') as mock_bar:
...                 with patch('mymodule.Spam') as mock_spam:
...                     assert mymodule.Foo is mock_foo
...                     assert mymodule.Bar is mock_bar
...                     assert mymodule.Spam is mock_spam
...
>>> original = mymodule.Foo
>>> MyTest('test_foo').test_foo()
>>> assert mymodule.Foo is original

С помощью функций cleanup из unittest cleanup и методов patch: start и stop можно добиться того же эффекта без вложенных отступов. Простой вспомогательный метод create_patch устанавливает патч и возвращает созданный мок:

>>> class MyTest(TestCase):
...
...     def create_patch(self, name):
...         patcher = patch(name)
...         thing = patcher.start()
...         self.addCleanup(patcher.stop)
...         return thing
...
...     def test_foo(self):
...         mock_foo = self.create_patch('mymodule.Foo')
...         mock_bar = self.create_patch('mymodule.Bar')
...         mock_spam = self.create_patch('mymodule.Spam')
...
...         assert mymodule.Foo is mock_foo
...         assert mymodule.Bar is mock_bar
...         assert mymodule.Spam is mock_spam
...
>>> original = mymodule.Foo
>>> MyTest('test_foo').run()
>>> assert mymodule.Foo is original

26.5.3.9. Мокирование словаря с помощью MagicMock¶Mocking a dictionary with MagicMock

Может потребоваться заменить словарь (или другой контейнер) mock'ом, записывающим все обращения к нему, но при этом сохраняющим поведение словаря.

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

Когда вызываются методы __getitem__() и __setitem__() нашего MagicMock (обычный доступ к словарю), side_effect вызывается с ключом (а в случае __setitem__ – также со значением). Также можно управлять возвращаемым значением.

После использования MagicMock можно применить атрибуты, такие как call_args_list, чтобы проверить, как использовался словарь:

>>> my_dict = {'a': 1, 'b': 2, 'c': 3}
>>> def getitem(name):
...      return my_dict[name]
...
>>> def setitem(name, val):
...     my_dict[name] = val
...
>>> mock = MagicMock()
>>> mock.__getitem__.side_effect = getitem
>>> mock.__setitem__.side_effect = setitem

>>> mock = Mock()
>>> mock.__getitem__ = Mock(side_effect=getitem)
>>> mock.__setitem__ = Mock(side_effect=setitem)

>>> mock = MagicMock(spec_set=dict)
>>> mock.__getitem__.side_effect = getitem
>>> mock.__setitem__.side_effect = setitem

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

>>> mock['a']
1
>>> mock['c']
3
>>> mock['d']
Traceback (most recent call last):
    ...
KeyError: 'd'
>>> mock['b'] = 'fish'
>>> mock['d'] = 'eggs'
>>> mock['b']
'fish'
>>> mock['d']
'eggs'

После использования можно делать утверждения о доступе, используя обычные методы и атрибуты mock:

>>> mock.__getitem__.call_args_list
[call('a'), call('c'), call('d'), call('b'), call('d')]
>>> mock.__setitem__.call_args_list
[call('b', 'fish'), call('d', 'eggs')]
>>> my_dict
{'a': 1, 'c': 3, 'b': 'fish', 'd': 'eggs'}

26.5.3.10. Подклассы Mock и их атрибуты¶Mock subclasses and their attributes

Есть разные причины, по которым может потребоваться создать подкласс Mock. Одна из причин – добавление вспомогательных методов. Вот глупый пример:

>>> class MyMock(MagicMock):
...     def has_been_called(self):
...         return self.called
...
>>> mymock = MyMock(return_value=None)
>>> mymock
<MyMock id='...'>
>>> mymock.has_been_called()
False
>>> mymock()
>>> mymock.has_been_called()
True

Стандартное поведение для экземпляров Mock заключается в том, что атрибуты и возвращаемое значение моков имеют тот же тип, что и мок, к которому они относятся. Это гарантирует, что атрибуты Mock являются Mocks, а атрибуты MagicMock – MagicMocks [2]. Поэтому, если вы создаёте подкласс для добавления вспомогательных методов, они также будут доступны для атрибутов и возвращаемого значения моков экземпляров вашего подкласса.

>>> mymock.foo
<MyMock name='mock.foo' id='...'>
>>> mymock.foo.has_been_called()
False
>>> mymock.foo()
<MyMock name='mock.foo()' id='...'>
>>> mymock.foo.has_been_called()
True

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

Mock (во всех его разновидностях) использует метод _get_child_mock для создания этих «под-заглушек» для атрибутов и возвращаемых значений. Чтобы предотвратить использование вашего подкласса для атрибутов, можно переопределить этот метод. Его сигнатура такова: он принимает произвольные именованные аргументы (**kwargs), которые затем передаются конструктору заглушки:

>>> class Subclass(MagicMock):
...     def _get_child_mock(self, **kwargs):
...         return MagicMock(**kwargs)
...
>>> mymock = Subclass()
>>> mymock.foo
<MagicMock name='mock.foo' id='...'>
>>> assert isinstance(mymock, Subclass)
>>> assert not isinstance(mymock.foo, Subclass)
>>> assert not isinstance(mymock(), Subclass)

26.5.3.11. Имитация импорта с помощью patch.dict¶Mocking imports with patch.dict

Одна из ситуаций, где имитация сложна – локальный импорт внутри функции. Такие импорты труднее подменить, потому что они не используют объект из пространства имён модуля, который можно замокать.

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

Кроме того, существует способ использовать mock для влияния на результаты импорта. Импорт извлекает объект из словаря sys.modules. Обратите внимание, что он извлекает объект, который не обязательно является модулем. При первом импорте модуля в sys.modules помещается объект модуля, так что обычно при импорте чего-либо вы получаете модуль. Однако это не обязательно так.

Это означает, что вы можете использовать patch.dict() для временного размещения заглушки в sys.modules. Любой импорт во время действия этой заплатки будет извлекать заглушку. Когда заплатка завершена (декорированная функция завершается, тело оператора with завершено или вызывается patcher.stop()), все, что было там ранее, будет безопасно восстановлено.

Вот пример, который имитирует модуль 'fooble'.

>>> mock = Mock()
>>> with patch.dict('sys.modules', {'fooble': mock}):
...    import fooble
...    fooble.blob()
...
<Mock name='mock.blob()' id='...'>
>>> assert 'fooble' not in sys.modules
>>> mock.blob.assert_called_once_with()

Как видите, import fooble выполняется успешно, но при выходе в sys.modules не остаётся никакого ‘fooble’.

Это также работает для формы from module import name:

>>> mock = Mock()
>>> with patch.dict('sys.modules', {'fooble': mock}):
...    from fooble import blob
...    blob.blip()
...
<Mock name='mock.blob.blip()' id='...'>
>>> mock.blob.blip.assert_called_once_with()

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

>>> mock = Mock()
>>> modules = {'package': mock, 'package.module': mock.module}
>>> with patch.dict('sys.modules', modules):
...    from package.module import fooble
...    fooble()
...
<Mock name='mock.module.fooble()' id='...'>
>>> mock.module.fooble.assert_called_once_with()

26.5.3.12. Отслеживание порядка вызовов и менее многословные утверждения о вызовах¶Tracking order of calls and less verbose call assertions

Класс Mock позволяет отслеживать порядок вызовов методов для объектов-заглушек через атрибут method_calls. Это не позволяет отслеживать порядок вызовов между отдельными объектами-заглушками, однако мы можем использовать mock_calls для достижения того же эффекта.

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

>>> manager = Mock()
>>> mock_foo = manager.foo
>>> mock_bar = manager.bar

>>> mock_foo.something()
<Mock name='mock.foo.something()' id='...'>
>>> mock_bar.other.thing()
<Mock name='mock.bar.other.thing()' id='...'>

>>> manager.mock_calls
[call.foo.something(), call.bar.other.thing()]

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

>>> expected_calls = [call.foo.something(), call.bar.other.thing()]
>>> manager.mock_calls == expected_calls
True

Если patch создает и устанавливает ваши заглушки, то вы можете прикрепить их к менеджеру-заглушке с помощью метода attach_mock(). После прикрепления вызовы будут записываться в mock_calls менеджера.

>>> manager = MagicMock()
>>> with patch('mymodule.Class1') as MockClass1:
...     with patch('mymodule.Class2') as MockClass2:
...         manager.attach_mock(MockClass1, 'MockClass1')
...         manager.attach_mock(MockClass2, 'MockClass2')
...         MockClass1().foo()
...         MockClass2().bar()
...
<MagicMock name='mock.MockClass1().foo()' id='...'>
<MagicMock name='mock.MockClass2().bar()' id='...'>
>>> manager.mock_calls
[call.MockClass1(),
 call.MockClass1().foo(),
 call.MockClass2(),
 call.MockClass2().bar()]

Если было сделано много вызовов, но вас интересует только определенная их последовательность, то альтернативой является использование метода assert_has_calls(). Он принимает список вызовов (созданных с помощью объекта call). Если эта последовательность вызовов присутствует в mock_calls, то утверждение проходит успешно.

>>> m = MagicMock()
>>> m().foo().bar().baz()
<MagicMock name='mock().foo().bar().baz()' id='...'>
>>> m.one().two().three()
<MagicMock name='mock.one().two().three()' id='...'>
>>> calls = call.one().two().three().call_list()
>>> m.assert_has_calls(calls)

Даже если цепочка вызовов m.one().two().three() не является единственными вызовами, сделанными к заглушке, утверждение всё равно проходит успешно.

Иногда к заглушке может быть сделано несколько вызовов, и вас интересуют только утверждения о некоторых из этих вызовов. Вас может даже не волновать порядок. В этом случае можно передать any_order=True в assert_has_calls:

>>> m = MagicMock()
>>> m(1), m.two(2, 3), m.seven(7), m.fifty('50')
(...)
>>> calls = [call.fifty('50'), call(1), call.seven(7)]
>>> m.assert_has_calls(calls, any_order=True)

26.5.3.13. Более сложное сопоставление аргументов¶More complex argument matching

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

Предположим, мы ожидаем, что некоторый объект будет передан заглушке, и этот объект по умолчанию сравнивается по идентичности (что является стандартным для Python для пользовательских классов). Чтобы использовать assert_called_with(), нам нужно передать точно тот же самый объект. Если нас интересуют только некоторые атрибуты этого объекта, то мы можем создать сопоставитель, который будет проверять эти атрибуты за нас.

В этом примере можно увидеть, как «стандартный» вызов assert_called_with недостаточен:

>>> class Foo:
...     def __init__(self, a, b):
...         self.a, self.b = a, b
...
>>> mock = Mock(return_value=None)
>>> mock(Foo(1, 2))
>>> mock.assert_called_with(Foo(1, 2))
Traceback (most recent call last):
    ...
AssertionError: Expected: call(<__main__.Foo object at 0x...>)
Actual call: call(<__main__.Foo object at 0x...>)

Функция сравнения для нашего класса Foo может выглядеть примерно так:

>>> def compare(self, other):
...     if not type(self) == type(other):
...         return False
...     if self.a != other.a:
...         return False
...     if self.b != other.b:
...         return False
...     return True
...

А объект-сопоставитель, который может использовать такие функции сравнения для операции равенства, будет выглядеть примерно так:

>>> class Matcher:
...     def __init__(self, compare, some_obj):
...         self.compare = compare
...         self.some_obj = some_obj
...     def __eq__(self, other):
...         return self.compare(self.some_obj, other)
...

Собираем всё вместе:

>>> match_foo = Matcher(compare, Foo(1, 2))
>>> mock.assert_called_with(match_foo)

Matcher создаётся с нашей функцией сравнения и объектом Foo, с которым мы хотим сравнивать. В assert_called_with будет вызван метод равенства Matcher, который сравнивает объект, с которым была вызвана заглушка, с тем, с которым мы создали наш сопоставитель. Если они совпадают, то assert_called_with проходит, а если нет, то возбуждается AssertionError:

>>> match_wrong = Matcher(compare, Foo(3, 4))
>>> mock.assert_called_with(match_wrong)
Traceback (most recent call last):
    ...
AssertionError: Expected: ((<Matcher object at 0x...>,), {})
Called with: ((<Foo object at 0x...>,), {})

С помощью небольшой доработки можно заставить функцию сравнения напрямую возбуждать AssertionError и предоставлять более полезное сообщение об ошибке.

Начиная с версии 1.5, библиотека тестирования Python PyHamcrest предоставляет аналогичную функциональность, которая может быть полезна здесь, в виде средства сравнения на равенство (hamcrest.library.integration.match_equality).