> **Источник:** https://python-all.ru/3.3/library/unittest.mock.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# 26.4. [`unittest.mock`](https://python-all.ru/3.3/library/unittest.mock.html#module-unittest.mock) – библиотека mock-объектов

Новое в версии 3.3.

[`unittest.mock`](https://python-all.ru/3.3/library/unittest.mock.html#module-unittest.mock) – библиотека для тестирования в Python. С её помощью можно заменять части тестируемой системы mock-объектами и проверять, как они использовались.

*unittest.mock* предоставляет основной класс [`Mock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock), устраняющий необходимость создавать множество заглушек в тестовом наборе. После выполнения действия можно проверять, какие методы/атрибуты использовались и с какими аргументами они вызывались. Также можно задавать возвращаемые значения и устанавливать нужные атрибуты обычным способом.

Кроме того, mock предоставляет декоратор [`patch()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.patch), который подменяет атрибуты модулей и классов в пределах теста, а также [`sentinel`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.sentinel) для создания уникальных объектов. Примеры использования [https://python-all.ru/3.3/library/unittest.mock.html#quick-guide](https://python-all.ru/3.3/library/unittest.mock.html#quick-guide), и см. в кратком руководстве.

Mock очень прост в использовании и предназначен для работы с [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest). Mock основан на шаблоне «действие -\> проверка», а не на *«запись -\> воспроизведение»*, используемом многими фреймворками для моков.

Существует обратный порт *unittest.mock* для более старых версий Python, доступный как [mock на PyPI](https://python-all.ru/3.3/library/unittest.mock.html).

**Исходный код:** [Lib/unittest/mock.py](https://python-all.ru/src/3.3/Lib/unittest/mock.py)

## 26.4.1. Краткое руководство

Объекты [`Mock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock) и [`MagicMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.MagicMock) создают все атрибуты и методы по мере обращения к ним и запоминают подробности их использования. Можно настраивать их, задавая возвращаемые значения или ограничивая доступные атрибуты, а затем проверять, как они использовались:

```python
>>> from unittest.mock import MagicMock
>>> thing = ProductionClass()
>>> thing.method = MagicMock(return_value=3)
>>> thing.method(3, 4, 5, key='value')
3
>>> thing.method.assert_called_with(3, 4, 5, key='value')
```

`side_effect` позволяет выполнять побочные действия, в том числе вызывать исключение при вызове mock-объекта:

```python
>>> mock = Mock(side_effect=KeyError('foo'))
>>> mock()
Traceback (most recent call last):
 ...
KeyError: 'foo'
```

```python
>>> values = {'a': 1, 'b': 2, 'c': 3}
>>> def side_effect(arg):
...     return values[arg]
...
>>> mock.side_effect = side_effect
>>> mock('a'), mock('b'), mock('c')
(1, 2, 3)
>>> mock.side_effect = [5, 4, 3, 2, 1]
>>> mock(), mock(), mock()
(5, 4, 3)
```

Mock имеет много других способов настройки и управления его поведением. Например, аргумент *spec* настраивает mock на использование спецификации другого объекта. Попытка доступа к атрибутам или методам mock, которых нет в спецификации, приведет к *AttributeError*.

Декоратор/менеджер контекста [`patch()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.patch) упрощает подмену классов или объектов в тестируемом модуле. Указанный объект заменяется mock-объектом (или другим объектом) на время теста и восстанавливается после его завершения:

```python
>>> from unittest.mock import patch
>>> @patch('module.ClassName2')
... @patch('module.ClassName1')
... def test(MockClass1, MockClass2):
...     module.ClassName1()
...     module.ClassName2()
...     assert MockClass1 is module.ClassName1
...     assert MockClass2 is module.ClassName2
...     assert MockClass1.called
...     assert MockClass2.called
...
>>> test()
```

> **Примечание**
>
> При вложении декораторов patch моки передаются в декорируемую функцию в том же порядке, в котором они применяются (обычный *python*-порядок применения декораторов). То есть снизу вверх, поэтому в примере выше mock для *module.ClassName1* передаётся первым.
>
> При использовании *patch* важно патчить объекты в том пространстве имён, где они ищутся. Обычно это очевидно, но для быстрого ознакомления прочитайте [*где патчить*](https://python-all.ru/3.3/library/unittest.mock.html#where-to-patch).

Помимо декоратора, *patch* можно использовать как менеджер контекста в операторе with:

```python
>>> with patch.object(ProductionClass, 'method', return_value=None) as mock_method:
...     thing = ProductionClass()
...     thing.method(1, 2, 3)
...
>>> mock_method.assert_called_once_with(1, 2, 3)
```

Существует также [`patch.dict()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.patch.dict) для установки значений в словаре только в пределах области видимости с последующим восстановлением исходного состояния словаря после завершения теста:

```python
>>> foo = {'key': 'value'}
>>> original = foo.copy()
>>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True):
...     assert foo == {'newkey': 'newvalue'}
...
>>> assert foo == original
```

Mock поддерживает имитацию [*магических методов*](https://python-all.ru/3.3/library/unittest.mock.html#magic-methods) Python. Самый простой способ использования магических методов – класс [`MagicMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.MagicMock). Он позволяет делать, например, следующее:

```python
>>> mock = MagicMock()
>>> mock.__str__.return_value = 'foobarbaz'
>>> str(mock)
'foobarbaz'
>>> mock.__str__.assert_called_with()
```

Mock позволяет назначать функции (или другие экземпляры Mock) магическим методам, и они будут вызываться соответствующим образом. Класс *MagicMock* – это просто вариант Mock, у которого все магические методы уже предсозданы (ну, по крайней мере все полезные).

Далее приведён пример использования магических методов с обычным классом Mock:

```python
>>> mock = Mock()
>>> mock.__str__ = Mock(return_value='wheeeeee')
>>> str(mock)
'wheeeeee'
```

Чтобы mock-объекты в тестах имели тот же API, что и заменяемые объекты, можно использовать [*автоспецификацию*](https://python-all.ru/3.3/library/unittest.mock.html#auto-speccing). Автоспецификацию можно задать через аргумент *autospec* у patch или с помощью функции [`create_autospec()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.create_autospec). Автоспецификация создаёт mock-объекты, имеющие те же атрибуты и методы, что и заменяемые объекты, а любые функции и методы (включая конструкторы) имеют ту же сигнатуру вызова, что и реальный объект.

Благодаря этому заглушки будут вести себя так же, как рабочий код, если их использовать неправильно:

```python
>>> from unittest.mock import create_autospec
>>> def function(a, b, c):
...     pass
...
>>> mock_function = create_autospec(function, return_value='fishy')
>>> mock_function(1, 2, 3)
'fishy'
>>> mock_function.assert_called_once_with(1, 2, 3)
>>> mock_function('wrong arguments')
Traceback (most recent call last):
 ...
TypeError: <lambda>() takes exactly 3 arguments (1 given)
```

*create\_autospec* также можно использовать с классами – в этом случае он копирует сигнатуру метода *\_\_init\_\_*, а с вызываемыми объектами – сигнатуру метода *\_\_call\_\_*.

## 26.4.2. Класс Mock

*Mock* – это гибкий mock-объект, предназначенный для замены заглушек и тестовых дублёров в вашем коде. Моки вызываемы и при обращении к ним создают атрибуты как новые моки [\[1\]](https://python-all.ru/3.3/library/unittest.mock.html#id3). Обращение к одному и тому же атрибуту всегда возвращает один и тот же mock. Моки записывают, как вы их используете, позволяя проверять, что ваш код с ними сделал.

[`MagicMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.MagicMock) – это подкласс *Mock* со всеми предсозданными и готовыми к использованию магическими методами. Существуют также невызываемые варианты, полезные при имитации объектов, которые не являются вызываемыми: [`NonCallableMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.NonCallableMock) и [`NonCallableMagicMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.NonCallableMagicMock)

Декоратор [`patch()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.patch) упрощает временную замену классов в определённом модуле объектом *Mock*. По умолчанию *patch* создаёт *MagicMock*. Можно указать альтернативный класс *Mock* с помощью аргумента *new\_callable* для *patch*.

#### `class unittest.mock.Mock(spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, **kwargs)`

Создаёт новый объект *Mock*. *Mock* принимает несколько необязательных аргументов, задающих поведение объекта Mock:

- *spec*: Это может быть либо список строк, либо существующий объект (класс или экземпляр), который служит спецификацией для mock-объекта. Если передать объект, то список строк формируется вызовом dir для этого объекта (за исключением неподдерживаемых магических атрибутов и методов). Доступ к любому атрибуту, не входящему в этот список, приведёт к *AttributeError*.

  Если *spec* является объектом (а не списком строк), то [`__class__`](https://python-all.ru/3.3/library/stdtypes.html#instance.__class__) возвращает класс объекта спецификации. Это позволяет мокам проходить проверки *isinstance*.
- *spec\_set*: Более строгий вариант *spec*. При его использовании попытка *установить* или получить атрибут mock, которого нет в объекте, переданном как *spec\_set*, приведёт к *AttributeError*.
- *side\_effect*: функция, вызываемая при каждом вызове Mock. См. атрибут [`side_effect`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.side_effect). Полезен для генерации исключений или динамического изменения возвращаемых значений. Функция вызывается с теми же аргументами, что и mock, и если она не возвращает [`DEFAULT`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.DEFAULT), то возвращаемое значение этой функции используется как возвращаемое значение.

  Альтернативно *side\_effect* может быть классом исключения или экземпляром. В этом случае исключение будет возбуждено при вызове заглушки.

  Если *side\_effect* является итерируемым, то каждый вызов заглушки будет возвращать следующее значение из итерируемого.

  *side\_effect* можно сбросить, установив его в *None*.
- *return\_value*: значение, возвращаемое при вызове mock-объекта. По умолчанию это новый Mock (создаётся при первом обращении). См. атрибут [`return_value`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.return_value).
- *wraps*: Объект, который будет обёрнут mock-объектом. Если *wraps* не равен None, то вызов Mock передаёт вызов обёрнутому объекту (возвращая реальный результат). Доступ к атрибуту mock возвращает объект Mock, который обёртывает соответствующий атрибут обёрнутого объекта (поэтому попытка доступа к несуществующему атрибуту вызовет *AttributeError*).

  Если для заглушки явно задан *return\_value*, то вызовы не передаются обёрнутому объекту, а возвращается значение *return\_value*.
- *name*: если у заглушки есть имя, оно будет использоваться в repr заглушки. Это может быть полезно для отладки. Имя распространяется на дочерние заглушки.

Mock-объекты также можно вызывать с произвольными именованными аргументами. Они будут использованы для установки атрибутов mock'а после его создания. Подробнее см. метод [`configure_mock()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.configure_mock).

#### `assert_called_with(*args, **kwargs)`

Этот метод – удобный способ проверить, что вызовы сделаны определённым образом:

```python
>>> mock = Mock()
>>> mock.method(1, 2, 3, test='wow')
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called_with(1, 2, 3, test='wow')
```

#### `assert_called_once_with(*args, **kwargs)`

Утверждает, что mock был вызван ровно один раз и с указанными аргументами.

```python
>>> mock = Mock(return_value=None)
>>> mock('foo', bar='baz')
>>> mock.assert_called_once_with('foo', bar='baz')
>>> mock('foo', bar='baz')
>>> mock.assert_called_once_with('foo', bar='baz')
Traceback (most recent call last):
  ...
AssertionError: Expected 'mock' to be called once. Called 2 times.
```

#### `assert_any_call(*args, **kwargs)`

Утверждает, что заглушка вызывалась с указанными аргументами.

Утверждение проходит, если mock *когда-либо* был вызван, в отличие от [`assert_called_with()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.assert_called_with) и [`assert_called_once_with()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.assert_called_once_with), которые проходят только в том случае, если вызов был последним.

```python
>>> mock = Mock(return_value=None)
>>> mock(1, 2, arg='thing')
>>> mock('some', 'thing', 'else')
>>> mock.assert_any_call(1, 2, arg='thing')
```

#### `assert_has_calls(calls, any_order=False)`

Проверяет, что mock был вызван с указанными вызовами. Проверяется список *mock\_calls*.

Если *any\_order* равно false (значение по умолчанию), то вызовы должны быть последовательными. Допускаются дополнительные вызовы до или после указанных вызовов.

Если *any\_order* равен true, то вызовы могут быть в любом порядке, но все они должны присутствовать в [`mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls).

```python
>>> mock = Mock(return_value=None)
>>> mock(1)
>>> mock(2)
>>> mock(3)
>>> mock(4)
>>> calls = [call(2), call(3)]
>>> mock.assert_has_calls(calls)
>>> calls = [call(4), call(2), call(3)]
>>> mock.assert_has_calls(calls, any_order=True)
```

#### `reset_mock()`

Метод reset\_mock сбрасывает все атрибуты вызовов у макета:

```python
>>> mock = Mock(return_value=None)
>>> mock('hello')
>>> mock.called
True
>>> mock.reset_mock()
>>> mock.called
False
```

Это может быть полезно, когда нужно выполнить серию проверок, используя один и тот же объект. Обратите внимание: *reset\_mock* *не* очищает возвращаемое значение, [`side_effect`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.side_effect) или любые дочерние атрибуты, установленные обычным присваиванием. Дочерние моки и mock возвращаемого значения (если есть) также сбрасываются.

#### `mock_add_spec(spec, spec_set=False)`

Добавляет спецификацию к макету. *spec* может быть объектом или списком строк. Только атрибуты, указанные в *spec*, можно получить как атрибуты макета.

Если *spec\_set* равен *True*, то можно устанавливать только атрибуты, входящие в спецификацию.

#### `attach_mock(mock, attribute)`

Присоединяет mock в качестве атрибута данного mock'а, заменяя его имя и родителя. Вызовы присоединённого mock'а будут записываться в атрибутах [`method_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.method_calls) и [`mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls) данного объекта.

#### `configure_mock(**kwargs)`

Устанавливает атрибуты макета через именованные аргументы.

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

```python
>>> mock = Mock()
>>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError}
>>> mock.configure_mock(**attrs)
>>> mock.method()
3
>>> mock.other()
Traceback (most recent call last):
  ...
KeyError
```

То же самое можно сделать в вызове конструктора макетов:

```python
>>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError}
>>> mock = Mock(some_attribute='eggs', **attrs)
>>> mock.some_attribute
'eggs'
>>> mock.method()
3
>>> mock.other()
Traceback (most recent call last):
  ...
KeyError
```

*configure\_mock* существует для упрощения настройки после создания mock.

#### `__dir__()`

Объекты *Mock* ограничивают результаты *dir(some\_mock)* только полезными результатами. Для моков с *spec* это включает все разрешённые атрибуты для этого мока.

См. [`FILTER_DIR`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.FILTER_DIR), чтобы узнать, что делает эта фильтрация и как её отключить.

#### `_get_child_mock(**kw)`

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

Для невызываемых макетов будет использоваться вызываемый вариант (а не пользовательский подкласс).

#### `called`

Логическое значение, указывающее, был ли вызван mock-объект:

```python
>>> mock = Mock(return_value=None)
>>> mock.called
False
>>> mock()
>>> mock.called
True
```

#### `call_count`

Целое число, показывающее, сколько раз был вызван mock-объект:

```python
>>> mock = Mock(return_value=None)
>>> mock.call_count
0
>>> mock()
>>> mock()
>>> mock.call_count
2
```

#### `return_value`

Установите это, чтобы настроить значение, возвращаемое при вызове mock:

```python
>>> mock = Mock()
>>> mock.return_value = 'fish'
>>> mock()
'fish'
```

Значение по умолчанию – это mock-объект, и его можно настроить обычным способом:

```python
>>> mock = Mock()
>>> mock.return_value.attribute = sentinel.Attribute
>>> mock.return_value()
<Mock name='mock()()' id='...'>
>>> mock.return_value.assert_called_with()
```

*return\_value* также можно задать в конструкторе:

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

#### `side_effect`

Это может быть либо функция, вызываемая при вызове мока, либо исключение (класс или экземпляр), которое будет возбуждено.

Если передать функцию, она будет вызвана с теми же аргументами, что и mock, и если функция не вернёт синглтон [`DEFAULT`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.DEFAULT), то вызов mock'а вернёт то, что вернула функция. Если функция возвращает [`DEFAULT`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.DEFAULT), то mock вернёт своё обычное значение (из [`return_value`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.return_value)).

Пример mock-объекта, возбуждающего исключение (для проверки обработки исключений API):

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

Использование *side\_effect* для возврата последовательности значений:

```python
>>> mock = Mock()
>>> mock.side_effect = [3, 2, 1]
>>> mock(), mock(), mock()
(3, 2, 1)
```

Функция *side\_effect* вызывается с теми же аргументами, что и мок (поэтому разумно, чтобы она принимала произвольные позиционные и ключевые аргументы), и то, что она возвращает, используется как возвращаемое значение вызова. Исключение составляет случай, когда *side\_effect* возвращает [`DEFAULT`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.DEFAULT), – тогда используется обычное [`return_value`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.return_value).

```python
>>> mock = Mock(return_value=3)
>>> def side_effect(*args, **kwargs):
...     return DEFAULT
...
>>> mock.side_effect = side_effect
>>> mock()
3
```

*side\_effect* можно задать в конструкторе. Ниже пример, который прибавляет единицу к значению, с которым был вызван мок, и возвращает его:

```python
>>> side_effect = lambda value: value + 1
>>> mock = Mock(side_effect=side_effect)
>>> mock(3)
4
>>> mock(-8)
-7
```

Установка *side\_effect* в *None* очищает его:

```python
>>> m = Mock(side_effect=KeyError, return_value=3)
>>> m()
Traceback (most recent call last):
 ...
KeyError
>>> m.side_effect = None
>>> m()
3
```

#### `call_args`

Это либо *None* (если мок ещё не вызывался), либо аргументы, с которыми мок был вызван в последний раз. Значение будет представлять собой кортеж: первый элемент – это позиционные аргументы, с которыми был вызван мок (или пустой кортеж), а второй элемент – ключевые аргументы (или пустой словарь).

```python
>>> mock = Mock(return_value=None)
>>> print mock.call_args
None
>>> mock()
>>> mock.call_args
call()
>>> mock.call_args == ()
True
>>> mock(3, 4)
>>> mock.call_args
call(3, 4)
>>> mock.call_args == ((3, 4),)
True
>>> mock(3, 4, 5, key='fish', next='w00t!')
>>> mock.call_args
call(3, 4, 5, key='fish', next='w00t!')
```

*call\_args*, а также элементы списков [`call_args_list`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args_list), [`method_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.method_calls) и [`mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls) являются объектами [`call`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.call). Это кортежи, поэтому их можно распаковать, чтобы получить отдельные аргументы и составлять более сложные утверждения. См. [*вызовы как кортежи*](https://python-all.ru/3.3/library/unittest.mock.html#calls-as-tuples).

#### `call_args_list`

Это список всех вызовов, сделанных к объекту-моку, в порядке их выполнения (поэтому длина списка равна количеству вызовов). До того, как были сделаны какие-либо вызовы, он представляет собой пустой список. Объект [`call`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.call) можно использовать для удобного построения списков вызовов для сравнения с *call\_args\_list*.

```python
>>> mock = Mock(return_value=None)
>>> mock()
>>> mock(3, 4)
>>> mock(key='fish', next='w00t!')
>>> mock.call_args_list
[call(), call(3, 4), call(key='fish', next='w00t!')]
>>> expected = [(), ((3, 4),), ({'key': 'fish', 'next': 'w00t!'},)]
>>> mock.call_args_list == expected
True
```

Элементами *call\_args\_list* являются объекты [`call`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.call). Их можно распаковать как кортежи, чтобы получить отдельные аргументы. См. [*вызовы как кортежи*](https://python-all.ru/3.3/library/unittest.mock.html#calls-as-tuples).

#### `method_calls`

Помимо отслеживания собственных вызовов, mock-объекты также отслеживают вызовы методов и атрибутов, а также *их* методов и атрибутов:

```python
>>> mock = Mock()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.property.method.attribute()
<Mock name='mock.property.method.attribute()' id='...'>
>>> mock.method_calls
[call.method(), call.property.method.attribute()]
```

Элементами *method\_calls* являются объекты [`call`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.call). Их можно распаковать как кортежи, чтобы получить отдельные аргументы. См. [*вызовы как кортежи*](https://python-all.ru/3.3/library/unittest.mock.html#calls-as-tuples).

#### `mock_calls`

*mock\_calls* записывает *все* вызовы объекта-мока, его методов, магических методов *и* моков возвращаемого значения.

```python
>>> mock = MagicMock()
>>> result = mock(1, 2, 3)
>>> mock.first(a=3)
<MagicMock name='mock.first()' id='...'>
>>> mock.second()
<MagicMock name='mock.second()' id='...'>
>>> int(mock)
1
>>> result(1)
<MagicMock name='mock()()' id='...'>
>>> expected = [call(1, 2, 3), call.first(a=3), call.second(),
... call.__int__(), call()(1)]
>>> mock.mock_calls == expected
True
```

Элементами *mock\_calls* являются объекты [`call`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.call). Их можно распаковать как кортежи, чтобы получить отдельные аргументы. См. [*вызовы как кортежи*](https://python-all.ru/3.3/library/unittest.mock.html#calls-as-tuples).

#### `__class__`

Обычно атрибут *\_\_class\_\_* объекта возвращает его тип. Для объекта-мока с *spec* *\_\_class\_\_* возвращает класс спецификации вместо этого. Это позволяет объектам-мокам проходить проверки *isinstance* для объекта, который они заменяют или маскируют под:

```python
>>> mock = Mock(spec=3)
>>> isinstance(mock, int)
True
```

Атрибуту *\_\_class\_\_* можно присваивать значение, что позволяет моку проходить проверку *isinstance* без необходимости использовать spec:

```python
>>> mock = Mock()
>>> mock.__class__ = dict
>>> isinstance(mock, dict)
True
```

#### `class unittest.mock.NonCallableMock(spec=None, wraps=None, name=None, spec_set=None, **kwargs)`

Невызываемая версия *Mock*. Параметры конструктора имеют тот же смысл, что и у *Mock*, за исключением *return\_value* и *side\_effect*, которые не имеют смысла для невызываемого мока.

Объекты-моки, использующие класс или экземпляр в качестве *spec* или *spec\_set*, способны проходить проверки *isinstance*:

```python
>>> mock = Mock(spec=SomeClass)
>>> isinstance(mock, SomeClass)
True
>>> mock = Mock(spec_set=SomeClass())
>>> isinstance(mock, SomeClass)
True
```

Классы *Mock* поддерживают имитацию магических методов. Полные подробности см. в разделе [*магические методы*](https://python-all.ru/3.3/library/unittest.mock.html#magic-methods).

Классы моков и декораторы [`patch()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.patch) принимают произвольные ключевые аргументы для настройки. Для декораторов *patch* ключевые слова передаются конструктору создаваемого мока. Ключевые аргументы предназначены для настройки атрибутов мока:

```python
>>> m = MagicMock(attribute=3, other='fish')
>>> m.attribute
3
>>> m.other
'fish'
```

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

```python
>>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError}
>>> mock = Mock(some_attribute='eggs', **attrs)
>>> mock.some_attribute
'eggs'
>>> mock.method()
3
>>> mock.other()
Traceback (most recent call last):
  ...
KeyError
```

#### `class unittest.mock.PropertyMock(*args, **kwargs)`

Макет, предназначенный для использования в качестве свойства или другого дескриптора в классе. *PropertyMock* предоставляет методы *\_\_get\_\_* и *\_\_set\_\_*, чтобы можно было указать возвращаемое значение при его получении.

Получение экземпляра *PropertyMock* из объекта вызывает макет без аргументов. Установка значения вызывает макет с устанавливаемым значением.

```python
>>> class Foo:
...     @property
...     def foo(self):
...         return 'something'
...     @foo.setter
...     def foo(self, value):
...         pass
...
>>> with patch('__main__.Foo.foo', new_callable=PropertyMock) as mock_foo:
...     mock_foo.return_value = 'mockity-mock'
...     this_foo = Foo()
...     print this_foo.foo
...     this_foo.foo = 6
...
mockity-mock
>>> mock_foo.mock_calls
[call(), call(6)]
```

Из-за особенностей хранения атрибутов макета невозможно напрямую присоединить *PropertyMock* к объекту макета. Вместо этого его можно присоединить к объекту типа макета:

```python
>>> m = MagicMock()
>>> p = PropertyMock(return_value=3)
>>> type(m).foo = p
>>> m.foo
3
>>> p.assert_called_once_with()
```

### 26.4.2.1. Вызов

Объекты-макеты вызываемы. Вызов возвращает значение, установленное в атрибуте [`return_value`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.return_value). По умолчанию возвращаемое значение – новый объект Mock; он создаётся при первом обращении к возвращаемому значению (явном или через вызов макета), но затем сохраняется и возвращается при каждом последующем вызове.

Вызовы объекта будут записаны в таких атрибутах, как [`call_args`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args) и [`call_args_list`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args_list).

Если задан [`side_effect`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.side_effect), он будет вызван после того, как вызов будет записан, так что если *side\_effect* вызывает исключение, вызов всё равно записывается.

Простейший способ заставить макет возбуждать исключение при вызове – сделать [`side_effect`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.side_effect) классом или экземпляром исключения:

```python
>>> m = MagicMock(side_effect=IndexError)
>>> m(1, 2, 3)
Traceback (most recent call last):
  ...
IndexError
>>> m.mock_calls
[call(1, 2, 3)]
>>> m.side_effect = KeyError('Bang!')
>>> m('two', 'three', 'four')
Traceback (most recent call last):
  ...
KeyError: 'Bang!'
>>> m.mock_calls
[call(1, 2, 3), call('two', 'three', 'four')]
```

Если *side\_effect* – это функция, то вызовы макета возвращают то, что возвращает эта функция. Функция *side\_effect* вызывается с теми же аргументами, что и макет. Это позволяет динамически изменять возвращаемое значение вызова в зависимости от входных данных:

```python
>>> def side_effect(value):
...     return value + 1
...
>>> m = MagicMock(side_effect=side_effect)
>>> m(1)
2
>>> m(2)
3
>>> m.mock_calls
[call(1), call(2)]
```

Если требуется, чтобы макет по-прежнему возвращал значение по умолчанию (новый макет) или любое заданное возвращаемое значение, есть два способа: либо вернуть *mock.return\_value* изнутри *side\_effect*, либо вернуть [`DEFAULT`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.DEFAULT):

```python
>>> m = MagicMock()
>>> def side_effect(*args, **kwargs):
...     return m.return_value
...
>>> m.side_effect = side_effect
>>> m.return_value = 3
>>> m()
3
>>> def side_effect(*args, **kwargs):
...     return DEFAULT
...
>>> m.side_effect = side_effect
>>> m()
3
```

Чтобы удалить *side\_effect* и вернуться к поведению по умолчанию, установите *side\_effect* в *None*:

```python
>>> m = MagicMock(return_value=6)
>>> def side_effect(*args, **kwargs):
...     return 3
...
>>> m.side_effect = side_effect
>>> m()
3
>>> m.side_effect = None
>>> m()
6
```

*side\_effect* также может быть любым итерируемым объектом. Повторные вызовы макета будут возвращать значения из итератора (пока он не исчерпается и не будет возбуждено *StopIteration*):

```python
>>> m = MagicMock(side_effect=[1, 2, 3])
>>> m()
1
>>> m()
2
>>> m()
3
>>> m()
Traceback (most recent call last):
  ...
StopIteration
```

Если какие-либо элементы итератора являются исключениями, они будут вызваны вместо того, чтобы быть возвращёнными:

```python
>>> iterable = (33, ValueError, 66)
>>> m = MagicMock(side_effect=iterable)
>>> m()
33
>>> m()
Traceback (most recent call last):
 ...
ValueError
>>> m()
66
```

### 26.4.2.2. Удаление атрибутов

Объекты Mock создают атрибуты по запросу. Это позволяет им притворяться объектами любого типа.

Может потребоваться, чтобы объект макета возвращал *False* на вызов *hasattr* или возбуждал *AttributeError* при получении атрибута. Это можно сделать, предоставив объект в качестве *spec* для макета, но это не всегда удобно.

Атрибуты «блокируются» их удалением. После удаления при обращении к атрибуту будет возбуждено *AttributeError*.

```python
>>> mock = MagicMock()
>>> hasattr(mock, 'm')
True
>>> del mock.m
>>> hasattr(mock, 'm')
False
>>> del mock.f
>>> mock.f
Traceback (most recent call last):
    ...
AttributeError: f
```

### 26.4.2.3. Имена mock'ов и атрибут name

Поскольку «name» – это аргумент конструктора [`Mock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock), если требуется, чтобы mock-объект имел атрибут «name», его нельзя просто передать при создании. Есть две альтернативы. Один из вариантов – использовать [`configure_mock()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.configure_mock):

```python
>>> mock = MagicMock()
>>> mock.configure_mock(name='my_name')
>>> mock.name
'my_name'
```

Более простой вариант – просто установить атрибут «name» после создания макета:

```python
>>> mock = MagicMock()
>>> mock.name = "foo"
```

### 26.4.2.4. Прикрепление моков в качестве атрибутов

Когда mock прикрепляется как атрибут другого mock (или как возвращаемое значение), он становится «дочерним» по отношению к этому mock. Вызовы к дочернему объекту записываются в атрибуты [`method_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.method_calls) и [`mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls) родительского объекта. Это полезно для настройки дочерних mock'ов и последующего их прикрепления к родительскому, или для прикрепления mock'ов к родительскому, который записывает все вызовы к дочерним и позволяет делать утверждения о порядке вызовов между mock'ами:

```python
>>> parent = MagicMock()
>>> child1 = MagicMock(return_value=None)
>>> child2 = MagicMock(return_value=None)
>>> parent.child1 = child1
>>> parent.child2 = child2
>>> child1(1)
>>> child2(2)
>>> parent.mock_calls
[call.child1(1), call.child2(2)]
```

Исключение составляет случай, когда у макета есть имя. Это позволяет предотвратить «родительскую связь», если по какой-то причине вы не хотите, чтобы это происходило.

```python
>>> mock = MagicMock()
>>> not_a_child = MagicMock(name='not-a-child')
>>> mock.attribute = not_a_child
>>> mock.attribute()
<MagicMock name='not-a-child()' id='...'>
>>> mock.mock_calls
[]
```

Mock'ы, создаваемые [`patch()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.patch), автоматически получают имена. Чтобы прикрепить именованные mock'и к родительскому, используется метод [`attach_mock()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.attach_mock):

```python
>>> thing1 = object()
>>> thing2 = object()
>>> parent = MagicMock()
>>> with patch('__main__.thing1', return_value=None) as child1:
...     with patch('__main__.thing2', return_value=None) as child2:
...         parent.attach_mock(child1, 'child1')
...         parent.attach_mock(child2, 'child2')
...         child1('one')
...         child2('two')
...
>>> parent.mock_calls
[call.child1('one'), call.child2('two')]
```

| [\[1\]](https://python-all.ru/3.3/library/unittest.mock.html#id1) | Исключение составляют только магические методы и атрибуты (те, что имеют двойное подчёркивание в начале и конце). Макет не создаёт их, а вместо этого возбуждает `AttributeError`. Это связано с тем, что интерпретатор часто неявно запрашивает эти методы и *сильно* путается, получая новый объект Mock, когда ожидает магический метод. Если требуется поддержка магических методов, см. [*магические методы*](https://python-all.ru/3.3/library/unittest.mock.html#magic-methods). |
| --- | --- |

## 26.4.3. Патчеры

Декораторы patch используются для патчинга объектов только в пределах области видимости функции, которую они декорируют. Они автоматически обрабатывают отмену патчинга, даже если возникают исключения. Все эти функции также могут использоваться в операторах with или в качестве декораторов классов.

### 26.4.3.1. patch

> **Примечание**
>
> *patch* прост в использовании. Ключевой момент – выполнять подмену в правильном пространстве имён. См. раздел [где подменять](https://python-all.ru/3.3/library/unittest.mock.html#id4).

#### `unittest.mock.patch(target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)`

*patch* работает как декоратор функции, декоратор класса или менеджер контекста. Внутри тела функции или блока with целевой объект *target* подменяется объектом *new*. При выходе из функции/блока with подмена отменяется.

Если *new* опущен, целевой объект заменяется на [`MagicMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.MagicMock). Если *patch* используется как декоратор и *new* опущен, созданный макет передаётся как дополнительный аргумент декорированной функции. Если *patch* используется как менеджер контекста, созданный макет возвращается менеджером контекста.

*target* должен быть строкой вида *'package.module.ClassName'*. *target* импортируется, и указанный объект заменяется объектом *new*, поэтому *target* должен быть импортируем из среды, из которой вызывается *patch*. Целевой объект импортируется при выполнении декорированной функции, а не во время декорирования.

Именованные аргументы *spec* и *spec\_set* передаются в *MagicMock*, если patch создаёт его для вас.

Кроме того, можно передать *spec=True* или *spec\_set=True*, что заставит patch передать в качестве объекта spec/spec\_set сам подменяемый объект.

*new\_callable* позволяет указать другой класс или вызываемый объект, который будет вызван для создания объекта *new*. По умолчанию используется *MagicMock*.

Более мощная форма *spec* – это *autospec*. Если задать *autospec=True*, макет будет создан со спецификацией, взятой у заменяемого объекта. Все атрибуты макета также будут иметь спецификацию соответствующего атрибута заменяемого объекта. У методов и функций, которые подменяются, будут проверяться аргументы, и при вызове с неправильной сигнатурой будет возбуждено *TypeError*. Для макетов, заменяющих класс, их возвращаемое значение («экземпляр») будет иметь ту же спецификацию, что и класс. См. функцию [`create_autospec()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.create_autospec) и [*Автоспецификация*](https://python-all.ru/3.3/library/unittest.mock.html#auto-speccing).

Вместо *autospec=True* можно передать *autospec=some\_object*, чтобы использовать произвольный объект в качестве спецификации вместо заменяемого.

По умолчанию *patch* не сможет заменить несуществующие атрибуты. Если передать *create=True*, и атрибут не существует, patch создаст его при вызове подменённой функции и удалит после. Это полезно для написания тестов на атрибуты, которые создаёт рабочий код во время выполнения. По умолчанию эта возможность отключена, так как может быть опасной. С её включением можно писать успешные тесты для API, которых на самом деле не существует!

Patch можно использовать как декоратор класса *TestCase*. Он работает, декорируя каждый тестовый метод в классе. Это уменьшает шаблонный код, когда тестовые методы используют общий набор подмен. *patch* находит тесты, ища имена методов, начинающиеся с *patch.TEST\_PREFIX*. По умолчанию это *test*, что соответствует тому, как *unittest* находит тесты. Можно указать альтернативный префикс, задав *patch.TEST\_PREFIX*.

Patch можно использовать как менеджер контекста с оператором with. В этом случае подмена применяется к вложенному блоку после with. Если использовать «as», подменённый объект будет связан с именем после «as»; это очень удобно, если *patch* создаёт объект макета.

*patch* принимает произвольные именованные аргументы. Они будут переданы в *Mock* (или *new\_callable*) при создании.

*patch.dict(...)*, *patch.multiple(...)* и *patch.object(...)* доступны для других сценариев использования.

*patch* как декоратор функции, создающий макет и передающий его в декорированную функцию:

```python
>>> @patch('__main__.SomeClass')
... def function(normal_argument, mock_class):
...     print(mock_class is SomeClass)
...
>>> function(None)
True
```

Подмена класса заменяет класс экземпляром *MagicMock* *instance*. Если класс инстанцируется в тестируемом коде, то будет использоваться [`return_value`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.return_value) макета.

Если класс инстанциируется несколько раз, можно использовать [`side_effect`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.side_effect), чтобы каждый раз возвращать новый mock. В качестве альтернативы можно установить *return\_value* в любое значение.

Чтобы настроить возвращаемые значения методов экземпляров *instances* подменённого класса, необходимо сделать это на *return\_value*. Например:

```python
>>> class Class:
...     def method(self):
...         pass
...
>>> with patch('__main__.Class') as MockClass:
...     instance = MockClass.return_value
...     instance.method.return_value = 'foo'
...     assert Class() is instance
...     assert Class().method() == 'foo'
...
```

Если используется *spec* или *spec\_set*, и *patch* заменяет *класс*, то возвращаемое значение созданного макета будет иметь ту же спецификацию.

```python
>>> Original = Class
>>> patcher = patch('__main__.Class', spec=True)
>>> MockClass = patcher.start()
>>> instance = MockClass()
>>> assert isinstance(instance, Original)
>>> patcher.stop()
```

Аргумент *new\_callable* полезен, когда требуется использовать альтернативный класс вместо [`MagicMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.MagicMock) для создаваемого mock. Например, если нужно, чтобы использовался [`NonCallableMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.NonCallableMock):

```python
>>> thing = object()
>>> with patch('__main__.thing', new_callable=NonCallableMock) as mock_thing:
...     assert thing is mock_thing
...     thing()
...
Traceback (most recent call last):
  ...
TypeError: 'NonCallableMock' object is not callable
```

Ещё один вариант использования – замена объекта экземпляром *io.StringIO*:

```python
>>> from io import StringIO
>>> def foo():
...     print 'Something'
...
>>> @patch('sys.stdout', new_callable=StringIO)
... def test(mock_stdout):
...     foo()
...     assert mock_stdout.getvalue() == 'Something\n'
...
>>> test()
```

Когда *patch* создаёт mock за вас, обычно первым делом нужно настроить этот mock. Часть этой настройки можно выполнить в самом вызове patch. Любые произвольные ключевые слова, переданные в вызов, будут использованы для установки атрибутов созданного mock:

```python
>>> patcher = patch('__main__.thing', first='one', second='two')
>>> mock_thing = patcher.start()
>>> mock_thing.first
'one'
>>> mock_thing.second
'two'
```

Кроме атрибутов создаваемого mock, можно также настроить атрибуты дочерних mock, такие как [`return_value`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.return_value) и [`side_effect`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.side_effect). Их нельзя передать напрямую как ключевые аргументы, но словарь с такими ключами можно развернуть в вызов *patch* с помощью *\*\**:

```python
>>> config = {'method.return_value': 3, 'other.side_effect': KeyError}
>>> patcher = patch('__main__.thing', **config)
>>> mock_thing = patcher.start()
>>> mock_thing.method()
3
>>> mock_thing.other()
Traceback (most recent call last):
  ...
KeyError
```

### 26.4.3.2. patch.object

#### `patch.object(target, attribute, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)`

Заменяет именованный член (*атрибут*) объекта (*цель*) на мок-объект.

*patch.object* может использоваться как декоратор, декоратор класса или контекстный менеджер. Аргументы *new*, *spec*, *create*, *spec\_set*, *autospec* и *new\_callable* имеют тот же смысл, что и для *patch*. Как и *patch*, *patch.object* принимает произвольные ключевые аргументы для настройки создаваемого им mock-объекта.

При использовании в качестве декоратора класса *patch.object* учитывает *patch.TEST\_PREFIX* для выбора методов, которые следует обернуть.

*patch.object* можно вызывать с тремя или двумя аргументами. Форма с тремя аргументами принимает объект, который нужно заменить, имя атрибута и объект, на который нужно заменить атрибут.

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

```python
>>> @patch.object(SomeClass, 'class_method')
... def test(mock_method):
...     SomeClass.class_method(3)
...     mock_method.assert_called_with(3)
...
>>> test()
```

*spec*, *create* и остальные аргументы *patch.object* имеют тот же смысл, что и для *patch*.

### 26.4.3.3. patch.dict

#### `patch.dict(in_dict, values=(), clear=False, **kwargs)`

Исправляет словарь или подобный словарю объект и восстанавливает его исходное состояние после завершения теста.

*in\_dict* может быть словарём или контейнером, подобным отображению. Если это отображение, оно должно как минимум поддерживать получение, установку и удаление элементов, а также итерацию по ключам.

*in\_dict* также может быть строкой, задающей имя словаря, который затем будет получен через импорт.

*values* может быть словарём значений, которые нужно установить в словаре. *values* также может быть итерируемым объектом, состоящим из пар *(key, value)*.

Если *clear* равен true, то словарь будет очищен перед установкой новых значений.

*patch.dict* также можно вызывать с произвольными ключевыми аргументами для установки значений в словаре.

*patch.dict* может использоваться как контекстный менеджер, декоратор или декоратор класса. При использовании в качестве декоратора класса *patch.dict* учитывает *patch.TEST\_PREFIX* для выбора методов, которые следует обернуть.

*patch.dict* можно использовать для добавления элементов в словарь или просто чтобы позволить тесту изменить словарь и гарантировать его восстановление после завершения теста.

```python
>>> foo = {}
>>> with patch.dict(foo, {'newkey': 'newvalue'}):
...     assert foo == {'newkey': 'newvalue'}
...
>>> assert foo == {}
```

```python
>>> import os
>>> with patch.dict('os.environ', {'newkey': 'newvalue'}):
...     print os.environ['newkey']
...
newvalue
>>> assert 'newkey' not in os.environ
```

Ключевые слова можно использовать в вызове *patch.dict* для установки значений в словаре:

```python
>>> mymodule = MagicMock()
>>> mymodule.function.return_value = 'fish'
>>> with patch.dict('sys.modules', mymodule=mymodule):
...     import mymodule
...     mymodule.function('some', 'args')
...
'fish'
```

*patch.dict* можно использовать с объектами, похожими на словарь, но не являющимися словарями. Как минимум они должны поддерживать получение, установку и удаление элементов, а также итерацию или проверку вхождения. Это соответствует магическим методам *\_\_getitem\_\_*, *\_\_setitem\_\_*, *\_\_delitem\_\_* и *\_\_iter\_\_* или *\_\_contains\_\_*.

```python
>>> class Container:
...     def __init__(self):
...         self.values = {}
...     def __getitem__(self, name):
...         return self.values[name]
...     def __setitem__(self, name, value):
...         self.values[name] = value
...     def __delitem__(self, name):
...         del self.values[name]
...     def __iter__(self):
...         return iter(self.values)
...
>>> thing = Container()
>>> thing['one'] = 1
>>> with patch.dict(thing, one=2, two=3):
...     assert thing['one'] == 2
...     assert thing['two'] == 3
...
>>> assert thing['one'] == 1
>>> assert list(thing) == ['one']
```

### 26.4.3.4. patch.multiple

#### `patch.multiple(target, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)`

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

```python
with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'):
    ...
```

Используйте [`DEFAULT`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.DEFAULT) в качестве значения, если нужно, чтобы *patch.multiple* создал заглушки за вас. В этом случае созданные заглушки передаются в декорированную функцию по ключевому слову, а словарь возвращается, когда *patch.multiple* используется как контекстный менеджер.

*patch.multiple* может использоваться как декоратор, декоратор класса или контекстный менеджер. Аргументы *spec*, *spec\_set*, *create*, *autospec* и *new\_callable* имеют тот же смысл, что и для *patch*. Эти аргументы будут применены ко *всем* подменам, выполняемым с помощью *patch.multiple*.

При использовании в качестве декоратора класса *patch.multiple* учитывает *patch.TEST\_PREFIX* для выбора методов, которые следует обернуть.

Если вы хотите, чтобы *patch.multiple* создал заглушки за вас, вы можете использовать [`DEFAULT`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.DEFAULT) в качестве значения. Если вы используете *patch.multiple* как декоратор, созданные заглушки передаются в декорированную функцию по ключевому слову.

```python
>>> thing = object()
>>> other = object()
```

```python
>>> @patch.multiple('__main__', thing=DEFAULT, other=DEFAULT)
... def test_function(thing, other):
...     assert isinstance(thing, MagicMock)
...     assert isinstance(other, MagicMock)
...
>>> test_function()
```

*patch.multiple* может быть вложен с другими декораторами *patch*, но аргументы, переданные по ключевому слову, ставьте *после* любых стандартных аргументов, создаваемых *patch*:

```python
>>> @patch('sys.exit')
... @patch.multiple('__main__', thing=DEFAULT, other=DEFAULT)
... def test_function(mock_exit, other, thing):
...     assert 'other' in repr(other)
...     assert 'thing' in repr(thing)
...     assert 'exit' in repr(mock_exit)
...
>>> test_function()
```

Если *patch.multiple* используется как контекстный менеджер, возвращаемое значение – это словарь, в котором ключами служат имена созданных заглушек:

```python
>>> with patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) as values:
...     assert 'other' in repr(values['other'])
...     assert 'thing' in repr(values['thing'])
...     assert values['thing'] is thing
...     assert values['other'] is other
...
```

### 26.4.3.5. Методы patch: start и stop

Все объекты-подмены имеют методы *start* и *stop*. Они упрощают выполнение подмен в методах *setUp* или в ситуациях, когда требуется выполнить несколько подмен без вложенных декораторов или операторов with.

Чтобы их использовать, вызовите *patch*, *patch.object* или *patch.dict* как обычно и сохраните ссылку на возвращаемый объект *patcher*. Затем можно вызвать *start* для применения подмены и *stop* для её отмены.

Если вы используете *patch* для создания mock за вас, то этот mock будет возвращён вызовом *patcher.start*.

```python
>>> patcher = patch('package.module.ClassName')
>>> from package import module
>>> original = module.ClassName
>>> new_mock = patcher.start()
>>> assert module.ClassName is not original
>>> assert module.ClassName is new_mock
>>> patcher.stop()
>>> assert module.ClassName is original
>>> assert module.ClassName is not new_mock
```

Типичный пример использования – выполнение нескольких подмен в методе *setUp* класса *TestCase*:

```python
>>> class MyTest(TestCase):
...     def setUp(self):
...         self.patcher1 = patch('package.module.Class1')
...         self.patcher2 = patch('package.module.Class2')
...         self.MockClass1 = self.patcher1.start()
...         self.MockClass2 = self.patcher2.start()
...
...     def tearDown(self):
...         self.patcher1.stop()
...         self.patcher2.stop()
...
...     def test_something(self):
...         assert package.module.Class1 is self.MockClass1
...         assert package.module.Class2 is self.MockClass2
...
>>> MyTest('test_something').run()
```

> **Внимание**
>
> Если вы используете этот приём, необходимо гарантировать, что подмена будет «отменена» вызовом *stop*. Это может быть сложнее, чем кажется, потому что если в `setUp` возникнет исключение, `tearDown` не будет вызван. [`unittest.TestCase.addCleanup()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.addCleanup) упрощает это:
>
> ```python
> >>> class MyTest(TestCase):
> ...     def setUp(self):
> ...         patcher = patch('package.module.Class')
> ...         self.MockClass = patcher.start()
> ...         self.addCleanup(patcher.stop)
> ...
> ...     def test_something(self):
> ...         assert package.module.Class is self.MockClass
> ...
> ```
>
> Вдобавок больше не нужно хранить ссылку на объект *patcher*.

Также можно остановить все запущенные подмены с помощью *patch.stopall*.

#### `patch.stopall()`

Останавливает все активные патчи. Останавливает только патчи, запущенные с помощью *start*.

### 26.4.3.6. TEST\_PREFIX

Все патчеры могут использоваться как декораторы классов. При таком использовании они оборачивают каждый тестовый метод класса. Патчеры распознают методы, начинающиеся с *test*, как тестовые. Это тот же способ, которым [`unittest.TestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader) по умолчанию находит тестовые методы.

Возможно, вы захотите использовать другой префикс для своих тестов. Вы можете сообщить патчерам другой префикс, установив *patch.TEST\_PREFIX*:

```python
>>> patch.TEST_PREFIX = 'foo'
>>> value = 3
>>>
>>> @patch('__main__.value', 'not three')
... class Thing:
...     def foo_one(self):
...         print value
...     def foo_two(self):
...         print value
...
>>>
>>> Thing().foo_one()
not three
>>> Thing().foo_two()
not three
>>> value
3
```

### 26.4.3.7. Вложение декораторов патчей

Если нужно выполнить несколько замен, можно просто наложить декораторы друг на друга.

Можно накладывать несколько декораторов патча, используя такой шаблон:

```python
>>> @patch.object(SomeClass, 'class_method')
... @patch.object(SomeClass, 'static_method')
... def test(mock1, mock2):
...     assert SomeClass.static_method is mock1
...     assert SomeClass.class_method is mock2
...     SomeClass.static_method('foo')
...     SomeClass.class_method('bar')
...     return mock1, mock2
...
>>> mock1, mock2 = test()
>>> mock1.assert_called_once_with('foo')
>>> mock2.assert_called_once_with('bar')
```

Обратите внимание: декораторы применяются снизу вверх. Это стандартный порядок применения декораторов в Python. Порядок созданных заглушек, передаваемых в тестовую функцию, соответствует этому порядку.

### 26.4.3.8. Где патчить

*patch* работает, (временно) заменяя объект, на который указывает *имя*, другим объектом. На один объект может указывать множество имён, поэтому для корректной работы патчинга необходимо убедиться, что патчится именно то имя, которое используется тестируемой системой.

Основной принцип: патч применяется там, где объект *ищется*, а это не обязательно то же место, где он определён. Несколько примеров помогут прояснить это.

Представим проект, который нужно протестировать, со следующей структурой:

```python
a.py
    -> Defines SomeClass

b.py
    -> from a import SomeClass
    -> some_function instantiates SomeClass
```

Теперь мы хотим протестировать *some\_function*, но хотим замокать *SomeClass* с помощью *patch*. Проблема в том, что когда мы импортируем модуль b (а нам придётся это сделать), он импортирует *SomeClass* из модуля a. Если мы используем *patch* для мока *a.SomeClass*, это не повлияет на наш тест: модуль b уже содержит ссылку на *настоящий* *SomeClass*, и создаётся впечатление, что патчинг не сработал.

Ключ в том, чтобы патчить *SomeClass* там, где он используется (или где он ищется). В данном случае *some\_function* на самом деле будет искать *SomeClass* в модуле b, куда мы его импортировали. Патчинг должен выглядеть так:

```python
@patch('b.SomeClass')
```

Однако рассмотрим альтернативный сценарий, когда вместо *from a import SomeClass* модуль b использует *import a* и *some\_function* использует *a.SomeClass*. Обе формы импорта распространены. В этом случае класс, который мы хотим замокать, ищется в модуле a, поэтому мы должны патчить *a.SomeClass*:

```python
@patch('a.SomeClass')
```

### 26.4.3.9. Патчинг дескрипторов и прокси-объектов

И [patch](https://python-all.ru/3.3/library/unittest.mock.html#patch), и [patch.object](https://python-all.ru/3.3/library/unittest.mock.html#patch-object) корректно заменяют и восстанавливают дескрипторы: методы класса, статические методы и свойства. Заменять их следует на *классе*, а не на экземпляре. Они также работают с *некоторыми* объектами, проксирующими доступ к атрибутам, например, [объект настроек Django](https://python-all.ru/3.3/library/unittest.mock.html).

## 26.4.4. MagicMock и поддержка магических методов

### 26.4.4.1. Подмена магических методов

[`Mock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock) поддерживает подмену методов протоколов Python, также известных как «магические методы». Это позволяет мок-объектам заменять контейнеры или другие объекты, реализующие протоколы Python.

Поскольку магические методы ищутся иначе, чем обычные методы [\[2\]](https://python-all.ru/3.3/library/unittest.mock.html#id7), эта поддержка была реализована специально. Это означает, что поддерживаются только определённые магические методы. Список поддерживаемых методов включает *почти* все. Если каких-то не хватает, пожалуйста, сообщите.

Магические методы подменяются установкой нужного метода в функцию или экземпляр мока. Если используется функция, она *обязана* принимать `self` в качестве первого аргумента [\[3\]](https://python-all.ru/3.3/library/unittest.mock.html#id8).

```python
>>> def __str__(self):
...     return 'fooble'
...
>>> mock = Mock()
>>> mock.__str__ = __str__
>>> str(mock)
'fooble'
```

```python
>>> mock = Mock()
>>> mock.__str__ = Mock()
>>> mock.__str__.return_value = 'fooble'
>>> str(mock)
'fooble'
```

```python
>>> mock = Mock()
>>> mock.__iter__ = Mock(return_value=iter([]))
>>> list(mock)
[]
```

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

```python
>>> mock = Mock()
>>> mock.__enter__ = Mock(return_value='foo')
>>> mock.__exit__ = Mock(return_value=False)
>>> with mock as m:
...     assert m == 'foo'
...
>>> mock.__enter__.assert_called_with()
>>> mock.__exit__.assert_called_with(None, None, None)
```

Вызовы магических методов не отображаются в [`method_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.method_calls), но записываются в [`mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls).

> **Примечание**
>
> Если при создании мока используется именованный аргумент *spec*, то попытка установить магический метод, отсутствующий в спецификации, вызовет *AttributeError*.

Полный список поддерживаемых магических методов:

- `__hash__`, `__sizeof__`, `__repr__` и `__str__`
- `__dir__`, `__format__` и `__subclasses__`
- `__floor__`, `__trunc__` и `__ceil__`
- Сравнения: `__cmp__`, `__lt__`, `__gt__`, `__le__`, `__ge__`, `__eq__` и `__ne__`
- Методы контейнера: `__getitem__`, `__setitem__`, `__delitem__`, `__contains__`, `__len__`, `__iter__`, `__getslice__`, `__setslice__`, `__reversed__` и `__missing__`
- Контекстный менеджер: `__enter__` и `__exit__`
- Унарные числовые методы: `__neg__`, `__pos__` и `__invert__`
- Числовые методы (включая правосторонние и варианты с изменением объекта): `__add__`, `__sub__`, `__mul__`, `__div__`, `__floordiv__`, `__mod__`, `__divmod__`, `__lshift__`, `__rshift__`, `__and__`, `__xor__`, `__or__` и `__pow__`
- Методы числового преобразования: `__complex__`, `__int__`, `__float__`, `__index__` и `__coerce__`
- Методы дескрипторов: `__get__`, `__set__` и `__delete__`
- Сериализация (pickle): `__reduce__`, `__reduce_ex__`, `__getinitargs__`, `__getnewargs__`, `__getstate__` и `__setstate__`

Следующие методы существуют, но *не* поддерживаются, так как либо используются в mock, либо не могут быть установлены динамически, либо могут вызывать проблемы:

- `__getattr__`, `__setattr__`, `__init__` и `__new__`
- `__prepare__`, `__instancecheck__`, `__subclasscheck__`, `__del__`

### 26.4.4.2. Magic Mock

Существует два варианта *MagicMock*: *MagicMock* и *NonCallableMagicMock*.

#### `class unittest.mock.MagicMock(*args, **kw)`

`MagicMock` – это подкласс [`Mock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock) с реализациями по умолчанию большинства магических методов. Можно использовать `MagicMock`, не настраивая магические методы вручную.

Параметры конструктора имеют тот же смысл, что и для [`Mock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock).

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

#### `class unittest.mock.NonCallableMagicMock(*args, **kw)`

Невызываемая версия *MagicMock*.

Параметры конструктора имеют тот же смысл, что и для [`MagicMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.MagicMock), за исключением *return\_value* и *side\_effect*, которые не имеют смысла для невызываемого мока.

Магические методы настраиваются с помощью объектов *MagicMock*, поэтому их можно конфигурировать и использовать обычным образом:

```python
>>> mock = MagicMock()
>>> mock[3] = 'fish'
>>> mock.__setitem__.assert_called_with(3, 'fish')
>>> mock.__getitem__.return_value = 'result'
>>> mock[2]
'result'
```

По умолчанию многие методы протокола должны возвращать объекты определенного типа. Эти методы предварительно настроены с возвращаемым значением по умолчанию, так что их можно использовать, ничего не делая, если возвращаемое значение не интересует. Вы всё еще можете *установить* возвращаемое значение вручную, если хотите изменить значение по умолчанию.

Методы и их значения по умолчанию:

- `__lt__`: NotImplemented
- `__gt__`: NotImplemented
- `__le__`: NotImplemented
- `__ge__`: NotImplemented
- `__int__`: 1
- `__contains__`: False
- `__len__`: 1
- `__iter__`: iter(\[\])
- `__exit__`: False
- `__complex__`: 1j
- `__float__`: 1.0
- `__bool__`: True
- `__index__`: 1
- `__hash__`: хэш по умолчанию для мока
- `__str__`: строковое представление по умолчанию для мока
- `__sizeof__`: размер по умолчанию для мока

Например:

```python
>>> mock = MagicMock()
>>> int(mock)
1
>>> len(mock)
0
>>> list(mock)
[]
>>> object() in mock
False
```

Два метода сравнения на равенство, *\_\_eq\_\_* и *\_\_ne\_\_*, особые. По умолчанию они сравнивают объекты по идентичности, используя побочный эффект, если только не изменить их возвращаемое значение, чтобы оно возвращало что-то другое:

```python
>>> MagicMock() == 3
False
>>> MagicMock() != 3
True
>>> mock = MagicMock()
>>> mock.__eq__.return_value = True
>>> mock == 3
True
```

Возвращаемое значение *MagicMock.\_\_iter\_\_* может быть любым итерируемым объектом и не обязано быть итератором:

```python
>>> mock = MagicMock()
>>> mock.__iter__.return_value = ['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']
```

Если возвращаемое значение *является* итератором, то однократная итерация по нему израсходует его, и последующие итерации приведут к пустому списку:

```python
>>> mock.__iter__.return_value = iter(['a', 'b', 'c'])
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
[]
```

У `MagicMock` настроены все поддерживаемые магические методы, за исключением некоторых устаревших и редко используемых. При желании их можно настроить.

Магические методы, которые поддерживаются, но не настроены по умолчанию в `MagicMock`:

- `__subclasses__`
- `__dir__`
- `__format__`
- `__get__`, `__set__` и `__delete__`
- `__reversed__` и `__missing__`
- `__reduce__`, `__reduce_ex__`, `__getinitargs__`, `__getnewargs__`, `__getstate__` и `__setstate__`
- `__getformat__` и `__setformat__`

| [\[2\]](https://python-all.ru/3.3/library/unittest.mock.html#id5) | Магические методы *должны* искаться в классе, а не в экземпляре. Разные версии Python непоследовательны в применении этого правила. Поддерживаемые методы протокола должны работать во всех поддерживаемых версиях Python. |
| --- | --- |

| [\[3\]](https://python-all.ru/3.3/library/unittest.mock.html#id6) | Функция фактически прикрепляется к классу, но каждый экземпляр `Mock` остаётся изолированным от других. |
| --- | --- |

## 26.4.5. Вспомогательные объекты

### 26.4.5.1. sentinel

#### `unittest.mock.sentinel`

Объект `sentinel` предоставляет удобный способ создания уникальных объектов для тестов.

Атрибуты создаются по запросу при обращении к ним по имени. Обращение к одному и тому же атрибуту всегда возвращает один и тот же объект. Возвращаемые объекты имеют понятное строковое представление (repr), чтобы сообщения об ошибках тестов были читаемыми.

Иногда при тестировании нужно проверить, что определённый объект передаётся в качестве аргумента другому методу или возвращается из него. Часто для этого создают именованные sentinel-объекты. *sentinel* предоставляет удобный способ создания и проверки идентичности таких объектов.

В этом примере мы подменяем (monkey-patch) *method*, чтобы он возвращал *sentinel.some\_object*:

```python
>>> real = ProductionClass()
>>> real.method = Mock(name="method")
>>> real.method.return_value = sentinel.some_object
>>> result = real.method()
>>> assert result is sentinel.some_object
>>> sentinel.some_object
sentinel.some_object
```

### 26.4.5.2. DEFAULT

#### `unittest.mock.DEFAULT`

Объект *DEFAULT* – это предварительно созданный sentinel (на самом деле *sentinel.DEFAULT*). Он может использоваться функциями [`side_effect`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.side_effect) для указания того, что следует использовать обычное возвращаемое значение.

### 26.4.5.3. call

#### `unittest.mock.call(*args, **kwargs)`

*call* – это вспомогательный объект для создания более простых утверждений, для сравнения с [`call_args`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args), [`call_args_list`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args_list), [`mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls) и [`method_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.method_calls). *call* также может использоваться с [`assert_has_calls()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.assert_has_calls).

```python
>>> m = MagicMock(return_value=None)
>>> m(1, 2, a='foo', b='bar')
>>> m()
>>> m.call_args_list == [call(1, 2, a='foo', b='bar'), call()]
True
```

#### `call.call_list()`

Для объекта call, представляющего несколько вызовов, *call\_list* возвращает список всех промежуточных вызовов, а также конечного вызова.

*call\_list* особенно полезен для создания утверждений по поводу «цепочечных вызовов». Цепочечный вызов – это несколько вызовов в одной строке кода. Это приводит к появлению нескольких записей в [`mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls) у мока. Ручное построение последовательности вызовов может быть утомительным.

[`call_list()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.call.call_list) может построить последовательность вызовов из того же цепочечного вызова:

```python
>>> m = MagicMock()
>>> m(1).method(arg='foo').other('bar')(2.0)
<MagicMock name='mock().method().other()()' id='...'>
>>> kall = call(1).method(arg='foo').other('bar')(2.0)
>>> kall.call_list()
[call(1),
 call().method(arg='foo'),
 call().method().other('bar'),
 call().method().other()(2.0)]
>>> m.mock_calls == kall.call_list()
True
```

Объект *call* представляет собой кортеж либо из (позиционные аргументы, именованные аргументы), либо (имя, позиционные аргументы, именованные аргументы) в зависимости от способа его создания. Когда вы создаёте их самостоятельно, это не особенно интересно, но объекты *call*, находящиеся в атрибутах [`Mock.call_args`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args), [`Mock.call_args_list`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args_list) и [`Mock.mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls), можно исследовать, чтобы извлечь содержащиеся в них отдельные аргументы.

Объекты *call* в [`Mock.call_args`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args) и [`Mock.call_args_list`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args_list) представляют собой двойки (позиционные аргументы, именованные аргументы), тогда как объекты *call* в [`Mock.mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls), а также те, которые вы создаёте сами, являются тройками (имя, позиционные аргументы, именованные аргументы).

Вы можете использовать их «кортежность», чтобы извлекать отдельные аргументы для более сложной интроспекции и проверок. Позиционные аргументы – это кортеж (пустой кортеж, если позиционных аргументов нет), а именованные аргументы – это словарь:

```python
>>> m = MagicMock(return_value=None)
>>> m(1, 2, 3, arg='one', arg2='two')
>>> kall = m.call_args
>>> args, kwargs = kall
>>> args
(1, 2, 3)
>>> kwargs
{'arg2': 'two', 'arg': 'one'}
>>> args is kall[0]
True
>>> kwargs is kall[1]
True
```

```python
>>> m = MagicMock()
>>> m.foo(4, 5, 6, arg='two', arg2='three')
<MagicMock name='mock.foo()' id='...'>
>>> kall = m.mock_calls[0]
>>> name, args, kwargs = kall
>>> name
'foo'
>>> args
(4, 5, 6)
>>> kwargs
{'arg2': 'three', 'arg': 'two'}
>>> name is m.mock_calls[0][0]
True
```

### 26.4.5.4. create\_autospec

#### `unittest.mock.create_autospec(spec, spec_set=False, instance=False, **kwargs)`

Создаёт макет-объект, используя другой объект в качестве спецификации. Атрибуты макета будут использовать соответствующий атрибут объекта *spec* в качестве своей спецификации.

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

Если *spec\_set* равно *True*, то попытка установить атрибуты, которых нет в объекте спецификации, вызовет *AttributeError*.

Если класс используется в качестве спецификации, то возвращаемое значение мока (экземпляр класса) будет иметь ту же спецификацию. Класс можно использовать в качестве спецификации для объекта-экземпляра, передав *instance=True*. Возвращаемый мок будет вызываемым, только если экземпляры мока являются вызываемыми.

*create\_autospec* также принимает произвольные именованные аргументы, которые передаются конструктору создаваемого мока.

Смотрите [*Autospeccing*](https://python-all.ru/3.3/library/unittest.mock.html#auto-speccing) с примерами использования автоспецификации с *create\_autospec* и аргументом *autospec* функции [`patch()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.patch).

### 26.4.5.5. ANY

#### `unittest.mock.ANY`

Иногда требуется проверять только *некоторые* из аргументов в вызове mock, либо не обращать внимания на часть аргументов, либо извлекать их по отдельности из [`call_args`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.call_args) и выполнять более сложные проверки.

Чтобы игнорировать определённые аргументы, можно передавать объекты, которые сравниваются равными *чему угодно*. Тогда вызовы [`assert_called_with()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.assert_called_with) и [`assert_called_once_with()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.assert_called_once_with) будут успешными независимо от того, что было передано.

```python
>>> mock = Mock(return_value=None)
>>> mock('foo', bar=object())
>>> mock.assert_called_once_with('foo', bar=ANY)
```

*ANY* также можно использовать при сравнении со списками вызовов, например [`mock_calls`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.mock_calls):

```python
>>> m = MagicMock(return_value=None)
>>> m(1)
>>> m(1, 2)
>>> m(object())
>>> m.mock_calls == [call(1), call(1, 2), ANY]
True
```

### 26.4.5.6. FILTER\_DIR

#### `unittest.mock.FILTER_DIR`

*FILTER\_DIR* – это переменная уровня модуля, которая управляет тем, как mock-объекты реагируют на *dir* (только для Python 2.6 или новее). По умолчанию *True*, что приводит к использованию фильтрации, описанной ниже, для отображения только полезных членов. Если вам не нравится эта фильтрация или нужно отключить её для диагностики, установите *mock.FILTER\_DIR = False*.

При включённой фильтрации *dir(some\_mock)* показывает только полезные атрибуты и включает любые динамически созданные атрибуты, которые обычно не отображаются. Если mock был создан с *spec* (или, конечно, *autospec*), то отображаются все атрибуты оригинала, даже если к ним ещё не обращались:

```python
>>> dir(Mock())
['assert_any_call',
 'assert_called_once_with',
 'assert_called_with',
 'assert_has_calls',
 'attach_mock',
 ...
>>> from urllib import request
>>> dir(Mock(spec=request))
['AbstractBasicAuthHandler',
 'AbstractDigestAuthHandler',
 'AbstractHTTPHandler',
 'BaseHandler',
 ...
```

Многие не очень полезные (приватные для *Mock*, а не для имитируемого объекта) атрибуты с префиксом из одного или двух подчёркиваний отфильтровываются из результата вызова *dir* на *Mock*. Если вам не нравится такое поведение, вы можете отключить его, установив переключатель уровня модуля *FILTER\_DIR*:

```python
>>> from unittest import mock
>>> mock.FILTER_DIR = False
>>> dir(mock.Mock())
['_NonCallableMock__get_return_value',
 '_NonCallableMock__get_side_effect',
 '_NonCallableMock__return_value_doc',
 '_NonCallableMock__set_return_value',
 '_NonCallableMock__set_side_effect',
 '__call__',
 '__class__',
 ...
```

В качестве альтернативы можно просто использовать *vars(my\_mock)* (члены экземпляра) и *dir(type(my\_mock))* (члены типа), чтобы обойти фильтрацию независимо от *mock.FILTER\_DIR*.

### 26.4.5.7. mock\_open

#### `unittest.mock.mock_open(mock=None, read_data=None)`

Вспомогательная функция для создания mock-объекта, заменяющего использование *open*. Она работает для *open*, вызываемого напрямую или используемого в качестве контекстного менеджера.

Аргумент *mock* – это настраиваемый mock-объект. Если *None* (по умолчанию), для вас будет создан *MagicMock* с API, ограниченным методами и атрибутами, доступными в стандартных файловых дескрипторах.

*read\_data* – это строка, которую должен возвращать метод *~io.IOBase.read* файлового дескриптора. По умолчанию это пустая строка.

Использование *open* в качестве контекстного менеджера – отличный способ гарантировать правильное закрытие файловых дескрипторов, и становится всё более распространённым:

```python
with open('/some/path', 'w') as f:
    f.write('something')
```

Проблема в том, что даже если вы имитируете вызов *open*, именно *возвращаемый объект* используется в качестве контекстного менеджера (и у него вызываются *\_\_enter\_\_* и *\_\_exit\_\_*).

Создание моков для контекстных менеджеров с помощью [`MagicMock`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.MagicMock) – достаточно распространённая и сложная задача, поэтому вспомогательная функция оказывается полезной.

```python
>>> m = mock_open()
>>> with patch('__main__.open', m, create=True):
...     with open('foo', 'w') as h:
...         h.write('some stuff')
...
>>> m.mock_calls
[call('foo', 'w'),
 call().__enter__(),
 call().write('some stuff'),
 call().__exit__(None, None, None)]
>>> m.assert_called_once_with('foo', 'w')
>>> handle = m()
>>> handle.write.assert_called_once_with('some stuff')
```

А для чтения файлов:

```python
>>> with patch('__main__.open', mock_open(read_data='bibble'), create=True) as m:
...     with open('foo') as h:
...         result = h.read()
...
>>> m.assert_called_once_with('foo')
>>> assert result == 'bibble'
```

### 26.4.5.8. Autospeccing

Автоспецификация основана на существующей функции *spec* в mock. Она ограничивает API mock-объектов API исходного объекта (спецификации), но является рекурсивной (реализована лениво), так что атрибуты mock-объектов имеют только тот же API, что и атрибуты спецификации. Кроме того, имитируемые функции/методы имеют ту же сигнатуру вызова, что и оригинал, поэтому они вызывают *TypeError* при неправильном вызове.

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

*Mock* – это очень мощный и гибкий объект, но у него есть два недостатка при использовании для имитации объектов в тестируемой системе. Один из этих недостатков специфичен для API *Mock*, а другой – более общая проблема использования mock-объектов.

Сначала проблема, специфичная для *Mock*. *Mock* имеет два чрезвычайно удобных метода проверки: [`assert_called_with()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.assert_called_with) и [`assert_called_once_with()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.Mock.assert_called_once_with).

```python
>>> mock = Mock(name='Thing', return_value=None)
>>> mock(1, 2, 3)
>>> mock.assert_called_once_with(1, 2, 3)
>>> mock(1, 2, 3)
>>> mock.assert_called_once_with(1, 2, 3)
Traceback (most recent call last):
 ...
AssertionError: Expected 'mock' to be called once. Called 2 times.
```

Поскольку mock-объекты автоматически создают атрибуты по требованию и позволяют вызывать их с произвольными аргументами, опечатка в имени одного из этих методов проверок приводит к тому, что проверка просто исчезает:

```pycon
>>> mock = Mock(name='Thing', return_value=None)
>>> mock(1, 2, 3)
>>> mock.assret_called_once_with(4, 5, 6)
```

Из-за опечатки тесты могут проходить молча и неправильно.

The second issue is more general to mocking. If you refactor some of your code, rename members and so on, any tests for code that is still using the *old api* but uses mocks instead of the real objects will still pass. This means your tests can all pass even though your code is broken.

Обратите внимание, что это ещё одна причина, по которой нужны интеграционные тесты, а не только модульные. Тестировать всё изолированно – это хорошо, но если вы не тестируете, как ваши модули «соединены вместе», всё ещё остаётся много места для ошибок, которые тесты могли бы выявить.

*mock* уже предоставляет функцию для решения этой проблемы, называемую speccing (спецификация). Если использовать класс или экземпляр в качестве *spec* для mock, то можно будет обращаться только к тем атрибутам mock, которые существуют в реальном классе:

```python
>>> from urllib import request
>>> mock = Mock(spec=request.Request)
>>> mock.assret_called_with
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'assret_called_with'
```

Spec применяется только к самому mock, поэтому у нас всё ещё есть та же проблема с любыми методами на mock:

```pycon
>>> mock.has_data()
<mock.Mock object at 0x...>
>>> mock.has_data.assret_called_with()
```

Автоспецификация решает эту проблему. Вы можете либо передать *autospec=True* в *patch* / *patch.object*, либо использовать функцию *create\_autospec* для создания mock с спецификацией. Если использовать аргумент *autospec=True* в *patch*, то заменяемый объект будет использоваться в качестве объекта спецификации. Поскольку спецификация выполняется «лениво» (спецификация создаётся по мере обращения к атрибутам mock), вы можете использовать её с очень сложными или глубоко вложенными объектами (например, модулями, которые импортируют модули, которые импортируют модули) без значительного снижения производительности.

Вот пример его использования:

```python
>>> from urllib import request
>>> patcher = patch('__main__.request', autospec=True)
>>> mock_request = patcher.start()
>>> request is mock_request
True
>>> mock_request.Request
<MagicMock name='request.Request' spec='Request' id='...'>
```

Видно, что *request.Request* имеет спецификацию. *request.Request* принимает два аргумента в конструкторе (один из которых – *self*). Вот что произойдёт, если попытаться вызвать его неправильно:

```python
>>> req = request.Request()
Traceback (most recent call last):
 ...
TypeError: <lambda>() takes at least 2 arguments (1 given)
```

Spec также применяется к инстанцированным классам (т.е. возвращаемому значению specced-моков):

```python
>>> req = request.Request('foo')
>>> req
<NonCallableMagicMock name='request.Request()' spec='Request' id='...'>
```

Объекты *Request* не являются вызываемыми, поэтому возвращаемое значение при создании экземпляра нашего имитированного *request.Request* – это невызываемый mock. При наличии спецификации любые опечатки в наших проверках вызовут правильную ошибку:

```python
>>> req.add_header('spam', 'eggs')
<MagicMock name='request.Request().add_header()' id='...'>
>>> req.add_header.assret_called_with
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'assret_called_with'
>>> req.add_header.assert_called_with('spam', 'eggs')
```

Во многих случаях вы сможете просто добавить *autospec=True* в существующие вызовы *patch* и тем самым защититься от ошибок, вызванных опечатками и изменениями API.

Помимо использования *autospec* через *patch*, существует [`create_autospec()`](https://python-all.ru/3.3/library/unittest.mock.html#unittest.mock.create_autospec) для непосредственного создания макетов с автоспецификацией:

```python
>>> from urllib import request
>>> mock_request = create_autospec(request)
>>> mock_request.Request('foo', 'bar')
<NonCallableMagicMock name='mock.Request()' spec='Request' id='...'>
```

Однако у этого подхода есть оговорки и ограничения, поэтому он не используется по умолчанию. Чтобы узнать, какие атрибуты доступны у объекта спецификации, autospec должен интроспектировать (получать доступ к атрибутам) спецификацию. Когда вы обращаетесь к атрибутам мока, под капотом происходит аналогичный обход оригинального объекта. Если у каких-то из ваших специфицированных объектов есть свойства или дескрипторы, которые могут запускать выполнение кода, то использовать autospec может не получиться. С другой стороны, гораздо лучше проектировать объекты так, чтобы интроспекция была безопасной [\[4\]](https://python-all.ru/3.3/library/unittest.mock.html#id10).

Более серьёзная проблема заключается в том, что атрибуты экземпляра часто создаются в методе *\_\_init\_\_* и вообще не существуют в классе. *autospec* не может знать о динамически создаваемых атрибутах и ограничивает API видимыми атрибутами.

```python
>>> class Something:
...   def __init__(self):
...     self.a = 33
...
>>> with patch('__main__.Something', autospec=True):
...   thing = Something()
...   thing.a
...
Traceback (most recent call last):
  ...
AttributeError: Mock object has no attribute 'a'
```

Существует несколько способов решить эту проблему. Самый простой (хотя и не обязательно наименее раздражающий) – просто установить нужные атрибуты на моке после его создания. То, что *autospec* не позволяет получать атрибуты, которых нет в спецификации, не мешает вам их устанавливать:

```python
>>> with patch('__main__.Something', autospec=True):
...   thing = Something()
...   thing.a = 33
...
```

Существует более строгая версия как *spec*, так и *autospec*, которая *не позволяет* устанавливать несуществующие атрибуты. Это полезно, если вы хотите гарантировать, что ваш код *устанавливает* только допустимые атрибуты, но, очевидно, это блокирует данный конкретный сценарий:

```python
>>> with patch('__main__.Something', autospec=True, spec_set=True):
...   thing = Something()
...   thing.a = 33
...
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'a'
```

Вероятно, лучший способ решения проблемы – добавить атрибуты класса в качестве значений по умолчанию для членов экземпляра, инициализируемых в *\_\_init\_\_*. Обратите внимание, что если вы устанавливаете только атрибуты по умолчанию в *\_\_init\_\_*, то предоставление их через атрибуты класса (которые, конечно, разделяются между экземплярами) также быстрее. Например:

```python
class Something:
    a = 33
```

This brings up another issue. It is relatively common to provide a default value of *None* for members that will later be an object of a different type. *None* would be useless as a spec because it wouldn’t let you access *any* attributes or methods on it. As *None* is *never* going to be useful as a spec, and probably indicates a member that will normally of some other type, *autospec* doesn’t use a spec for members that are set to *None*. These will just be ordinary mocks (well - *MagicMocks*):

```python
>>> class Something:
...     member = None
...
>>> mock = create_autospec(Something)
>>> mock.member.foo.bar.baz()
<MagicMock name='mock.member.foo.bar.baz()' id='...'>
```

Если изменение рабочих классов для добавления значений по умолчанию вам не подходит, есть и другие варианты. Один из них – просто использовать экземпляр в качестве спецификации вместо класса. Другой – создать подкласс рабочего класса и добавить значения по умолчанию в подкласс, не затрагивая рабочий класс. В обоих случаях требуется использовать альтернативный объект в качестве спецификации. К счастью, *patch* поддерживает это – можно просто передать альтернативный объект в качестве аргумента *autospec*:

```python
>>> class Something:
...   def __init__(self):
...     self.a = 33
...
>>> class SomethingForTest(Something):
...   a = 33
...
>>> p = patch('__main__.Something', autospec=SomethingForTest)
>>> mock = p.start()
>>> mock.a
<NonCallableMagicMock name='Something.a' spec='int' id='...'>
```

| [\[4\]](https://python-all.ru/3.3/library/unittest.mock.html#id9) | Это применимо только к классам или уже созданным экземплярам. Вызов имитированного класса для создания mock-экземпляра *не* создаёт реальный экземпляр. Выполняются только поиск атрибутов и вызовы *dir*. |
| --- | --- |