`unittest.mock-examples.md`

1099 строк · 67.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/unittest.mock-examples.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 26.6. [`unittest.mock`](https://python-all.ru/3.6/library/unittest.mock.html#module-unittest.mock) – начало работы89Новое в версии 3.3.1011## 26.6.1. Использование Mock1213### 26.6.1.1. Методы подмены с Mock1415Типичные случаи использования объектов [`Mock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock):1617- Подмена методов18- Запись вызовов методов объектов1920Возможно, потребуется заменить метод объекта, чтобы проверить, что другая часть системы вызывает его с правильными аргументами:2122```python23>>> real = SomeClass()24>>> real.method = MagicMock(name='method')25>>> real.method(3, 4, 5, key='value')26<MagicMock name='method()' id='...'>27```2829После того как mock был использован (в данном примере `real.method`), он содержит методы и атрибуты, с помощью которых можно проверять, как именно он использовался.3031> **Примечание**32>33> В большинстве этих примеров классы [`Mock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock) и [`MagicMock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.MagicMock) взаимозаменяемы. Поскольку `MagicMock` – более функциональный класс, его имеет смысл использовать по умолчанию.3435После вызова mock его атрибут [`called`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.called) устанавливается в `True`. Что более важно, можно использовать метод [`assert_called_with()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.assert_called_with) или [`assert_called_once_with()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.assert_called_once_with), чтобы проверить, что он был вызван с правильными аргументами.3637Этот пример проверяет, что вызов `ProductionClass().method` приводит к вызову метода `something`:3839```python40>>> class ProductionClass:41...     def method(self):42...         self.something(1, 2, 3)43...     def something(self, a, b, c):44...         pass45...46>>> real = ProductionClass()47>>> real.something = MagicMock()48>>> real.method()49>>> real.something.assert_called_once_with(1, 2, 3)50```5152### 26.6.1.2. Mock для вызовов методов объекта5354В последнем примере мы напрямую подменили метод объекта, чтобы проверить, что он был вызван корректно. Другой типичный случай – передать объект в метод (или какую-то часть тестируемой системы), а затем проверить, что он используется правильным образом.5556Простой класс `ProductionClass` ниже имеет метод `closer`. Если его вызвать с объектом, то он вызовет `close` у этого объекта.5758```python59>>> class ProductionClass:60...     def closer(self, something):61...         something.close()62...63```6465Итак, чтобы протестировать это, нужно передать объект с методом `close` и проверить, что он был вызван корректно.6667```python68>>> real = ProductionClass()69>>> mock = Mock()70>>> real.closer(mock)71>>> mock.close.assert_called_with()72```7374Нам не нужно прилагать усилий, чтобы предоставить метод 'close' в нашем mock. Обращение к close создаёт его. Поэтому, если 'close' ещё не был вызван, то обращение к нему в тесте создаст его, но [`assert_called_with()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.assert_called_with) вызовет исключение, указывающее на ошибку.7576### 26.6.1.3. Мокирование классов7778Типичный сценарий – подменить классы, которые инстанциируются тестируемым кодом. При подмене класса он заменяется mock. Экземпляры создаются *вызовом класса*. Это значит, что «экземпляр mock» доступен через возвращаемое значение подменённого класса.7980В примере ниже есть функция `some_function`, которая создаёт экземпляр `Foo` и вызывает его метод. Вызов [`patch()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch) заменяет класс `Foo` на mock. Экземпляр `Foo` – это результат вызова mock, поэтому он настраивается путём изменения mock [`return_value`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.return_value).8182```python83>>> def some_function():84...     instance = module.Foo()85...     return instance.method()86...87>>> with patch('module.Foo') as mock:88...     instance = mock.return_value89...     instance.method.return_value = 'the result'90...     result = some_function()91...     assert result == 'the result'92```9394### 26.6.1.4. Именование имитаций9596Полезно давать вашим mock имена. Имя отображается в repr mock и может помочь, когда mock фигурирует в сообщениях об ошибках тестов. Имя также распространяется на атрибуты и методы mock:9798```python99>>> mock = MagicMock(name='foo')100>>> mock101<MagicMock name='foo' id='...'>102>>> mock.method103<MagicMock name='foo.method' id='...'>104```105106### 26.6.1.5. Отслеживание всех вызовов107108Атрибут [`mock_calls`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.mock_calls) записывает все вызовы дочерних атрибутов mock – а также их дочерних атрибутов.109110```python111>>> mock = MagicMock()112>>> mock.method()113<MagicMock name='mock.method()' id='...'>114>>> mock.attribute.method(10, x=53)115<MagicMock name='mock.attribute.method()' id='...'>116>>> mock.mock_calls117[call.method(), call.attribute.method(10, x=53)]118```119120Если сделать проверку относительно `mock_calls` и были вызваны какие-либо непредвиденные методы, то проверка не пройдёт. Это полезно, поскольку помимо проверки того, что ожидаемые вызовы были сделаны, вы также проверяете, что они были сделаны в правильном порядке и без дополнительных вызовов:121122Объект [`call`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.call) используется для создания списков, которые затем сравниваются с `mock_calls`:123124```python125>>> expected = [call.method(), call.attribute.method(10, x=53)]126>>> mock.mock_calls == expected127True128```129130Однако параметры вызовов, возвращающих макеты, не записываются, а значит, невозможно отслеживать вложенные вызовы, в которых важны параметры, использованные для создания родительских объектов:131132```python133>>> m = Mock()134>>> m.factory(important=True).deliver()135<Mock name='mock.factory().deliver()' id='...'>136>>> m.mock_calls[-1] == call.factory(important=False).deliver()137True138```139140### 26.6.1.6. Установка возвращаемых значений и атрибутов141142Установка возвращаемых значений для mock-объекта очень проста:143144```python145>>> mock = Mock()146>>> mock.return_value = 3147>>> mock()1483149```150151Конечно, то же самое можно сделать для методов mock:152153```python154>>> mock = Mock()155>>> mock.method.return_value = 3156>>> mock.method()1573158```159160Возвращаемое значение также можно задать в конструкторе:161162```python163>>> mock = Mock(return_value=3)164>>> mock()1653166```167168Если требуется задать атрибут на mock, сделайте это:169170```python171>>> mock = Mock()172>>> mock.x = 3173>>> mock.x1743175```176177Иногда требуется имитировать более сложную ситуацию, например `mock.connection.cursor().execute("SELECT 1")`. Если нужно, чтобы этот вызов возвращал список, то придётся настроить результат вложенного вызова.178179Можно использовать [`call`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.call), чтобы построить набор вызовов в виде «цепочки вызовов», как здесь, для удобной последующей проверки утверждений:180181```python182>>> mock = Mock()183>>> cursor = mock.connection.cursor.return_value184>>> cursor.execute.return_value = ['foo']185>>> mock.connection.cursor().execute("SELECT 1")186['foo']187>>> expected = call.connection.cursor().execute("SELECT 1").call_list()188>>> mock.mock_calls189[call.connection.cursor(), call.connection.cursor().execute('SELECT 1')]190>>> mock.mock_calls == expected191True192```193194Именно вызов `.call_list()` превращает наш объект вызова в список вызовов, представляющих цепочку.195196### 26.6.1.7. Вызов исключений с помощью имитаций197198Полезный атрибут – [`side_effect`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.side_effect). Если присвоить ему класс исключения или экземпляр, то при вызове мока будет возбуждено это исключение.199200```python201>>> mock = Mock(side_effect=Exception('Boom!'))202>>> mock()203Traceback (most recent call last):204  ...205Exception: Boom!206```207208### 26.6.1.8. Функции и итерируемые объекты для побочных эффектов209210`side_effect` также можно установить в функцию или итерируемый объект. Сценарий использования `side_effect` в качестве итерируемого объекта – когда мок будет вызываться несколько раз, и каждый вызов должен возвращать другое значение. Если `side_effect` присвоен итерируемый объект, каждый вызов мока возвращает следующий элемент из этого итерируемого объекта:211212```python213>>> mock = MagicMock(side_effect=[4, 5, 6])214>>> mock()2154216>>> mock()2175218>>> mock()2196220```221222Для более продвинутых сценариев, например динамического изменения возвращаемых значений в зависимости от того, с чем вызывается мок, `side_effect` может быть функцией. Функция будет вызвана с теми же аргументами, что и мок. Что бы функция ни вернула, то и будет результатом вызова:223224```python225>>> vals = {(1, 2): 1, (2, 3): 2}226>>> def side_effect(*args):227...     return vals[args]228...229>>> mock = MagicMock(side_effect=side_effect)230>>> mock(1, 2)2311232>>> mock(2, 3)2332234```235236### 26.6.1.9. Создание Mock на основе существующего объекта237238Одна из проблем чрезмерного использования мокирования – это связывание тестов с реализацией моков, а не с реальным кодом. Предположим, есть класс, реализующий `some_method`. В тесте для другого класса вы предоставляете мок этого объекта, который *также* предоставляет `some_method`. Если позже вы реорганизуете первый класс так, что он больше не содержит `some_method`, то тесты продолжат проходить, хотя код уже сломан!239240[`Mock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock) позволяет передать объект в качестве спецификации для мока, используя именованный аргумент *spec*. Обращение к методам/атрибутам мока, отсутствующим в объекте спецификации, немедленно вызовет ошибку атрибута. Если изменить реализацию спецификации, то тесты, использующие этот класс, сразу начнут падать без необходимости создавать экземпляр класса в этих тестах.241242```python243>>> mock = Mock(spec=SomeClass)244>>> mock.old_method()245Traceback (most recent call last):246   ...247AttributeError: object has no attribute 'old_method'248```249250Использование спецификации также позволяет более интеллектуально сопоставлять вызовы, сделанные к моку, независимо от того, переданы ли некоторые параметры как позиционные или именованные аргументы:251252```python253>>> def f(a, b, c): pass254...255>>> mock = Mock(spec=f)256>>> mock(1, 2, 3)257<Mock name='mock()' id='140161580456576'>258>>> mock.assert_called_with(a=1, b=2, c=3)259```260261Если нужно, чтобы такое интеллектуальное сопоставление работало и для вызовов методов мока, можно воспользоваться [авто-спецификацией (auto-speccing)](https://python-all.ru/3.6/library/unittest.mock.html#auto-speccing).262263Если нужна более строгая форма спецификации, запрещающая как установку произвольных атрибутов, так и их получение, можно использовать *spec\_set* вместо *spec*.264265## 26.6.2. Декораторы patch266267> **Примечание**268>269> При использовании [`patch()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch) важно подменять объекты в том пространстве имён, где они выполняются. Обычно это очевидно, но для краткого руководства прочитайте [where to patch](https://python-all.ru/3.6/library/unittest.mock.html#where-to-patch).270271Частая потребность в тестах – подменить атрибут класса или модуля, например, встроенную функцию или класс в модуле, чтобы проверить, что он инстанциируется. Модули и классы по сути глобальны, поэтому подмену на них нужно отменять после теста, иначе она останется и в других тестах, вызывая труднодиагностируемые проблемы.272273mock предоставляет три удобных декоратора для этого: [`patch()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch), [`patch.object()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch.object) и [`patch.dict()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch.dict). `patch` принимает одну строку вида `package.module.Class.attribute` для указания подменяемого атрибута. Также опционально принимает значение, на которое нужно заменить атрибут (или класс, или что-то ещё). ‘patch.object’ принимает объект и имя атрибута для подмены, плюс опционально значение для подмены.274275`patch.object`:276277```python278>>> original = SomeClass.attribute279>>> @patch.object(SomeClass, 'attribute', sentinel.attribute)280... def test():281...     assert SomeClass.attribute == sentinel.attribute282...283>>> test()284>>> assert SomeClass.attribute == original285```286287```python288>>> @patch('package.module.attribute', sentinel.attribute)289... def test():290...     from package.module import attribute291...     assert attribute is sentinel.attribute292...293>>> test()294```295296Если вы подменяете модуль (включая [`builtins`](https://python-all.ru/3.6/library/builtins.html#module-builtins)), то используйте [`patch()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch) вместо [`patch.object()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch.object):297298```python299>>> mock = MagicMock(return_value=sentinel.file_handle)300>>> with patch('builtins.open', mock):301...     handle = open('filename', 'r')302...303>>> mock.assert_called_with('filename', 'r')304>>> assert handle == sentinel.file_handle, "incorrect file handle returned"305```306307Имя модуля может быть точечным, в форме `package.module`, если необходимо:308309```python310>>> @patch('package.module.ClassName.attribute', sentinel.attribute)311... def test():312...     from package.module import ClassName313...     assert ClassName.attribute == sentinel.attribute314...315>>> test()316```317318Удобный подход – декорировать непосредственно сами тестовые методы:319320```python321>>> class MyTest(unittest.TestCase):322...     @patch.object(SomeClass, 'attribute', sentinel.attribute)323...     def test_something(self):324...         self.assertEqual(SomeClass.attribute, sentinel.attribute)325...326>>> original = SomeClass.attribute327>>> MyTest('test_something').test_something()328>>> assert SomeClass.attribute == original329```330331Если нужно подменить с помощью Mock, можно использовать [`patch()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch) с одним аргументом (или [`patch.object()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch.object) с двумя аргументами). Мок будет создан автоматически и передан в тестовую функцию/метод:332333```python334>>> class MyTest(unittest.TestCase):335...     @patch.object(SomeClass, 'static_method')336...     def test_something(self, mock_method):337...         SomeClass.static_method()338...         mock_method.assert_called_with()339...340>>> MyTest('test_something').test_something()341```342343Можно накладывать несколько декораторов патча, используя такой шаблон:344345```python346>>> class MyTest(unittest.TestCase):347...     @patch('package.module.ClassName1')348...     @patch('package.module.ClassName2')349...     def test_something(self, MockClass2, MockClass1):350...         self.assertIs(package.module.ClassName1, MockClass1)351...         self.assertIs(package.module.ClassName2, MockClass2)352...353>>> MyTest('test_something').test_something()354```355356При вложении декораторов patch mock-объекты передаются в декорируемую функцию в том же порядке, в котором они применяются (обычный *python*-порядок применения декораторов). Это означает снизу вверх, поэтому в примере выше mock для `test_module.ClassName2` передаётся первым.357358Также есть [`patch.dict()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch.dict) для установки значений в словаре только в пределах области видимости и восстановления словаря в исходное состояние после завершения теста:359360```python361>>> foo = {'key': 'value'}362>>> original = foo.copy()363>>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True):364...     assert foo == {'newkey': 'newvalue'}365...366>>> assert foo == original367```368369`patch`, `patch.object` и `patch.dict` могут использоваться как контекстные менеджеры.370371При использовании [`patch()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch) для создания мока можно получить ссылку на мок с помощью формы with с ключевым словом “as”:372373```python374>>> class ProductionClass:375...     def method(self):376...         pass377...378>>> with patch.object(ProductionClass, 'method') as mock_method:379...     mock_method.return_value = None380...     real = ProductionClass()381...     real.method(1, 2, 3)382...383>>> mock_method.assert_called_with(1, 2, 3)384```385386В качестве альтернативы `patch`, `patch.object` и `patch.dict` можно использовать как декораторы классов. При таком использовании это равносильно применению декоратора к каждому методу, имя которого начинается с “test”.387388## 26.6.3. Дополнительные примеры389390Вот ещё несколько примеров для немного более сложных сценариев.391392### 26.6.3.1. Мокирование цепочек вызовов393394Мокирование цепочечных вызовов на самом деле не представляет сложности с mock, если разобраться с атрибутом [`return_value`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.return_value). Когда мок вызывается впервые (или вы обращаетесь к его `return_value` до вызова), создаётся новый [`Mock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock).395396Это означает, что вы можете увидеть, как использовался объект, возвращённый из вызова мокированного объекта, запросив мок `return_value`:397398```python399>>> mock = Mock()400>>> mock().foo(a=2, b=3)401<Mock name='mock().foo()' id='...'>402>>> mock.return_value.foo.assert_called_with(a=2, b=3)403```404405Отсюда один шаг до настройки и проверки утверждений о цепочечных вызовах. Конечно, другая альтернатива – изначально писать код более тестируемым способом…406407Итак, предположим, у нас есть код, который выглядит примерно так:408409```python410>>> class Something:411...     def __init__(self):412...         self.backend = BackendProvider()413...     def method(self):414...         response = self.backend.get_endpoint('foobar').create_call('spam', 'eggs').start_call()415...         # ещё код416```417418Предполагая, что `BackendProvider` уже хорошо протестирован, как нам тестировать `method()`? В частности, мы хотим проверить, что участок кода `# more code` использует объект ответа правильным образом.419420Поскольку эта цепочка вызовов строится из атрибута экземпляра, мы можем применить monkey-patch к атрибуту `backend` на экземпляре `Something`. В данном конкретном случае нас интересует только возвращаемое значение из последнего вызова `start_call`, поэтому нам не нужно много настраивать. Допустим, возвращаемый объект является «файлоподобным», поэтому мы обеспечим, чтобы наш объект ответа использовал встроенный [`open()`](https://python-all.ru/3.6/library/functions.html#open) в качестве его `spec`.421422Для этого мы создаём экземпляр мока в качестве нашего мок-бэкенда и создаём для него мок-объект ответа. Чтобы установить ответ как возвращаемое значение для этого последнего `start_call`, мы можем сделать так:423424```python425mock_backend.get_endpoint.return_value.create_call.return_value.start_call.return_value = mock_response426```427428Мы можем сделать это чуть более элегантно, используя метод [`configure_mock()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.configure_mock) для прямой установки возвращаемого значения:429430```python431>>> something = Something()432>>> mock_response = Mock(spec=open)433>>> mock_backend = Mock()434>>> config = {'get_endpoint.return_value.create_call.return_value.start_call.return_value': mock_response}435>>> mock_backend.configure_mock(**config)436```437438С их помощью мы применяем monkey-patch к «mock backend» и можем выполнить реальный вызов:439440```python441>>> something.backend = mock_backend442>>> something.method()443```444445Используя [`mock_calls`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.mock_calls), мы можем проверить цепочечный вызов одним assert. Цепочечный вызов – это несколько вызовов в одной строке кода, поэтому в `mock_calls` будет несколько записей. Мы можем использовать [`call.call_list()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.call.call_list) для создания этого списка вызовов:446447```python448>>> chained = call.get_endpoint('foobar').create_call('spam', 'eggs').start_call()449>>> call_list = chained.call_list()450>>> assert mock_backend.mock_calls == call_list451```452453### 26.6.3.2. Частичное мокирование454455В некоторых тестах я хотел подменить вызов [`datetime.date.today()`](https://python-all.ru/3.6/library/datetime.html#datetime.date.today), чтобы он возвращал известную дату, но не хотел мешать тестируемому коду создавать новые объекты даты. К сожалению, [`datetime.date`](https://python-all.ru/3.6/library/datetime.html#datetime.date) написан на C, и я не мог просто обезьяньим патчем заменить статический метод `date.today()`.456457Я нашел простой способ сделать это: обернуть класс date в mock, но передавать вызовы конструктора настоящему классу (и возвращать настоящие экземпляры).458459Здесь [`patch decorator`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch) используется для мокирования класса `date` в тестируемом модуле. Затем атрибут `side_effect` на мок-классе даты устанавливается в лямбда-функцию, возвращающую реальную дату. При вызове мок-класса даты будет создана и возвращена реальная дата с помощью `side_effect`.460461```python462>>> from datetime import date463>>> with patch('mymodule.date') as mock_date:464...     mock_date.today.return_value = date(2010, 10, 8)465...     mock_date.side_effect = lambda *args, **kw: date(*args, **kw)466...467...     assert mymodule.date.today() == date(2010, 10, 8)468...     assert mymodule.date(2009, 6, 8) == date(2009, 6, 8)469...470```471472Обратите внимание: мы не патчим [`datetime.date`](https://python-all.ru/3.6/library/datetime.html#datetime.date) глобально, мы патчим `date` в модуле, который его *использует*. См. [где патчить](https://python-all.ru/3.6/library/unittest.mock.html#where-to-patch).473474При вызове `date.today()` возвращается известная дата, но вызовы конструктора `date(...)` по-прежнему возвращают обычные даты. Без этого вам пришлось бы вычислять ожидаемый результат, используя тот же алгоритм, что и тестируемый код, что является классическим антипаттерном тестирования.475476Вызовы конструктора даты записываются в атрибуты `mock_date` (`call_count` и другие), что также может быть полезно для ваших тестов.477478Альтернативный способ мокирования дат или других встроенных классов описан в [этой записи блога](https://python-all.ru/3.6/library/unittest.mock-examples.html).479480### 26.6.3.3. Мокирование метода-генератора481482Генератор Python – это функция или метод, использующие оператор [`yield`](https://python-all.ru/3.6/reference/simple_stmts.html#yield) для возврата серии значений при итерации по [1](https://python-all.ru/3.6/library/unittest.mock-examples.html#id3).483484Метод/функция-генератор вызывается для возврата объекта-генератора. Затем итерируются именно по объекту-генератору. Протокольный метод для итерации – [`__iter__()`](https://python-all.ru/3.6/library/stdtypes.html#container.__iter__), поэтому мы можем замокировать его с помощью [`MagicMock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.MagicMock).485486Вот пример класса с методом “iter”, реализованным как генератор:487488```python489>>> class Foo:490...     def iter(self):491...         for i in [1, 2, 3]:492...             yield i493...494>>> foo = Foo()495>>> list(foo.iter())496[1, 2, 3]497```498499Как бы мы мокировали этот класс и, в частности, его метод “iter”?500501Чтобы настроить значения, возвращаемые из итерации (неявно в вызове [`list`](https://python-all.ru/3.6/library/stdtypes.html#list)), нам нужно настроить объект, возвращаемый вызовом `foo.iter()`.502503```python504>>> mock_foo = MagicMock()505>>> mock_foo.iter.return_value = iter([1, 2, 3])506>>> list(mock_foo.iter())507[1, 2, 3]508```509510**[1](https://python-all.ru/3.6/library/unittest.mock-examples.html#id2)**511512Существуют также генераторные выражения и более [продвинутые применения](https://python-all.ru/3.6/library/unittest.mock-examples.html) генераторов, но здесь они нас не интересуют. Очень хорошее введение в генераторы и их мощь: [Generator Tricks for Systems Programmers](https://python-all.ru/3.6/library/unittest.mock-examples.html).513514### 26.6.3.4. Применение одного и того же patch к каждому тестовому методу515516If you want several patches in place for multiple test methods the obvious way is to apply the patch decorators to every method. This can feel like unnecessary repetition. For Python 2.6 or more recent you can use [`patch()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch) (in all its various forms) as a class decorator. This applies the patches to all test methods on the class. A test method is identified by methods whose names start with `test`:517518```python519>>> @patch('mymodule.SomeClass')520... class MyTest(TestCase):521...522...     def test_one(self, MockSomeClass):523...         self.assertIs(mymodule.SomeClass, MockSomeClass)524...525...     def test_two(self, MockSomeClass):526...         self.assertIs(mymodule.SomeClass, MockSomeClass)527...528...     def not_a_test(self):529...         return 'something'530...531>>> MyTest('test_one').test_one()532>>> MyTest('test_two').test_two()533>>> MyTest('test_two').not_a_test()534'something'535```536537Альтернативный способ управления подстановками – использовать [методы patch: start и stop](https://python-all.ru/3.6/library/unittest.mock.html#start-and-stop). Они позволяют перенести подстановку в ваши методы `setUp` и `tearDown`.538539```python540>>> class MyTest(TestCase):541...     def setUp(self):542...         self.patcher = patch('mymodule.foo')543...         self.mock_foo = self.patcher.start()544...545...     def test_foo(self):546...         self.assertIs(mymodule.foo, self.mock_foo)547...548...     def tearDown(self):549...         self.patcher.stop()550...551>>> MyTest('test_foo').run()552```553554Если используется этот приём, необходимо убедиться, что подстановка «отменена» вызовом `stop`. Это может быть сложнее, чем кажется, потому что если в setUp возникнет исключение, to tearDown не вызывается. [`unittest.TestCase.addCleanup()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.addCleanup) упрощает задачу:555556```python557>>> class MyTest(TestCase):558...     def setUp(self):559...         patcher = patch('mymodule.foo')560...         self.addCleanup(patcher.stop)561...         self.mock_foo = patcher.start()562...563...     def test_foo(self):564...         self.assertIs(mymodule.foo, self.mock_foo)565...566>>> MyTest('test_foo').run()567```568569### 26.6.3.5. Мокирование несвязанных методов570571Сегодня при написании тестов мне понадобилось подменить *несвязанный метод* (подменить метод на классе, а не на экземпляре). Мне нужно было, чтобы self передавался в качестве первого аргумента, потому что я хотел делать утверждения о том, какие объекты вызывали этот конкретный метод. Проблема в том, что для этого нельзя использовать mock при подмене, потому что если заменить несвязанный метод на mock, он не станет связанным методом при получении из экземпляра, и поэтому self не будет передан. Обходной путь – подменить несвязанный метод настоящей функцией. Декоратор [`patch()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch) делает подмену методов с помощью mock настолько простой, что необходимость создавать настоящую функцию становится обузой.572573Если передать `autospec=True` в patch, то подмена будет выполнена с помощью *настоящего* объекта-функции. Этот объект-функция имеет ту же сигнатуру, что и заменяемая функция, но делегирует вызовы mock'у под капотом. Mock по-прежнему создаётся автоматически точно так же, как и раньше. Однако это означает, что если использовать его для подмены несвязанного метода в классе, то подменённая функция превратится в связанный метод при получении из экземпляра. В качестве первого аргумента будет передан `self`, что как раз и было нужно:574575```python576>>> class Foo:577...   def foo(self):578...     pass579...580>>> with patch.object(Foo, 'foo', autospec=True) as mock_foo:581...   mock_foo.return_value = 'foo'582...   foo = Foo()583...   foo.foo()584...585'foo'586>>> mock_foo.assert_called_once_with(foo)587```588589Если не использовать `autospec=True`, то несвязанный метод подменяется экземпляром Mock и не вызывается с `self`.590591### 26.6.3.6. Проверка множественных вызовов с помощью mock592593У mock есть удобный API для проверки того, как используются объекты mock.594595```python596>>> mock = Mock()597>>> mock.foo_bar.return_value = None598>>> mock.foo_bar('baz', spam='eggs')599>>> mock.foo_bar.assert_called_with('baz', spam='eggs')600```601602Если mock вызывается только один раз, можно использовать метод `assert_called_once_with()`, который дополнительно проверяет, что `call_count` равен единице.603604```python605>>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')606>>> mock.foo_bar()607>>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')608Traceback (most recent call last):609    ...610AssertionError: Expected to be called once. Called 2 times.611```612613И `assert_called_with`, и `assert_called_once_with` проверяют *последний* вызов. Если mock будет вызываться несколько раз и нужно проверить *все* эти вызовы, можно использовать [`call_args_list`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.call_args_list):614615```python616>>> mock = Mock(return_value=None)617>>> mock(1, 2, 3)618>>> mock(4, 5, 6)619>>> mock()620>>> mock.call_args_list621[call(1, 2, 3), call(4, 5, 6), call()]622```623624Вспомогательная функция [`call`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.call) упрощает проверку этих вызовов. Можно сформировать список ожидаемых вызовов и сравнить его с `call_args_list`. Это выглядит очень похоже на строковое представление `call_args_list`:625626```python627>>> expected = [call(1, 2, 3), call(4, 5, 6), call()]628>>> mock.call_args_list == expected629True630```631632### 26.6.3.7. Работа с изменяемыми аргументами633634Ещё одна, хоть и редкая, ситуация, которая может доставить неприятности, – когда mock вызывается с изменяемыми аргументами. `call_args` и `call_args_list` хранят *ссылки* на аргументы. Если аргументы изменяются тестируемым кодом, то становится невозможно проверить, какими были значения на момент вызова mock.635636Вот пример кода, демонстрирующий проблему. Предположим, в 'mymodule' определены следующие функции:637638```python639def frob(val):640    pass641642def grob(val):643    "First frob and then clear val"644    frob(val)645    val.clear()646```647648При попытке проверить, что `grob` вызывает `frob` с правильным аргументом, происходит следующее:649650```python651>>> with patch('mymodule.frob') as mock_frob:652...     val = {6}653...     mymodule.grob(val)654...655>>> val656set()657>>> mock_frob.assert_called_with({6})658Traceback (most recent call last):659    ...660AssertionError: Expected: (({6},), {})661Called with: ((set(),), {})662```663664Одним из возможных решений было бы копирование аргументов, передаваемых в mock. Однако это может вызвать проблемы, если проверки полагаются на тождественность объектов для сравнения.665666Вот одно из решений, использующее функциональность `side_effect`. Если предоставить функцию `side_effect` для mock, то `side_effect` будет вызываться с теми же аргументами, что и mock. Это даёт возможность скопировать аргументы и сохранить их для последующих проверок. В этом примере используется *другой* mock для хранения аргументов, чтобы можно было задействовать методы mock для проверки. Опять же, вспомогательная функция настраивает это:667668```python669>>> from copy import deepcopy670>>> from unittest.mock import Mock, patch, DEFAULT671>>> def copy_call_args(mock):672...     new_mock = Mock()673...     def side_effect(*args, **kwargs):674...         args = deepcopy(args)675...         kwargs = deepcopy(kwargs)676...         new_mock(*args, **kwargs)677...         return DEFAULT678...     mock.side_effect = side_effect679...     return new_mock680...681>>> with patch('mymodule.frob') as mock_frob:682...     new_mock = copy_call_args(mock_frob)683...     val = {6}684...     mymodule.grob(val)685...686>>> new_mock.assert_called_with({6})687>>> new_mock.call_args688call({6})689```690691`copy_call_args` вызывается с mock'ом, который будет вызван. Она возвращает новый mock, на котором выполняется проверка. Функция `side_effect` создаёт копию аргументов и вызывает наш `new_mock` с этой копией.692693> **Примечание**694>695> Если mock используется только один раз, есть более простой способ проверки аргументов в момент вызова. Можно просто выполнить проверку внутри функции `side_effect`.696>697> ```python698> >>> def side_effect(arg):699> ...     assert arg == {6}700> ...701> >>> mock = Mock(side_effect=side_effect)702> >>> mock({6})703> >>> mock(set())704> Traceback (most recent call last):705>     ...706> AssertionError707> ```708709Альтернативный подход – создать подкласс [`Mock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock) или [`MagicMock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.MagicMock), который копирует аргументы (с помощью [`copy.deepcopy()`](https://python-all.ru/3.6/library/copy.html#copy.deepcopy)). Вот пример реализации:710711```python712>>> from copy import deepcopy713>>> class CopyingMock(MagicMock):714...     def __call__(self, *args, **kwargs):715...         args = deepcopy(args)716...         kwargs = deepcopy(kwargs)717...         return super(CopyingMock, self).__call__(*args, **kwargs)718...719>>> c = CopyingMock(return_value=None)720>>> arg = set()721>>> c(arg)722>>> arg.add(1)723>>> c.assert_called_with(set())724>>> c.assert_called_with(arg)725Traceback (most recent call last):726    ...727AssertionError: Expected call: mock({1})728Actual call: mock(set())729>>> c.foo730<CopyingMock name='mock.foo' id='...'>731```732733При создании подкласса `Mock` или `MagicMock` все динамически создаваемые атрибуты и `return_value` будут автоматически использовать ваш подкласс. Это означает, что все дочерние элементы `CopyingMock` также будут иметь тип `CopyingMock`.734735### 26.6.3.8. Вложение патчей736737Использовать patch как менеджер контекста удобно, но при множественных подстановках можно получить вложенные операторы with, уходящие всё дальше вправо с отступами:738739```python740>>> class MyTest(TestCase):741...742...     def test_foo(self):743...         with patch('mymodule.Foo') as mock_foo:744...             with patch('mymodule.Bar') as mock_bar:745...                 with patch('mymodule.Spam') as mock_spam:746...                     assert mymodule.Foo is mock_foo747...                     assert mymodule.Bar is mock_bar748...                     assert mymodule.Spam is mock_spam749...750>>> original = mymodule.Foo751>>> MyTest('test_foo').test_foo()752>>> assert mymodule.Foo is original753```754755С помощью функций unittest `cleanup` и [методов patch: start и stop](https://python-all.ru/3.6/library/unittest.mock.html#start-and-stop) можно добиться того же эффекта без вложенных отступов. Простой вспомогательный метод `create_patch` устанавливает подстановку и возвращает созданный mock:756757```python758>>> class MyTest(TestCase):759...760...     def create_patch(self, name):761...         patcher = patch(name)762...         thing = patcher.start()763...         self.addCleanup(patcher.stop)764...         return thing765...766...     def test_foo(self):767...         mock_foo = self.create_patch('mymodule.Foo')768...         mock_bar = self.create_patch('mymodule.Bar')769...         mock_spam = self.create_patch('mymodule.Spam')770...771...         assert mymodule.Foo is mock_foo772...         assert mymodule.Bar is mock_bar773...         assert mymodule.Spam is mock_spam774...775>>> original = mymodule.Foo776>>> MyTest('test_foo').run()777>>> assert mymodule.Foo is original778```779780### 26.6.3.9. Мокирование словаря с помощью MagicMock781782Может потребоваться заменить словарь (или другой контейнер) mock'ом, записывающим все обращения к нему, но при этом сохраняющим поведение словаря.783784Это можно сделать с помощью [`MagicMock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.MagicMock), который будет вести себя как словарь, и [`side_effect`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.side_effect), делегирующего доступ к словарю реальному нижележащему словарю, находящемуся под нашим контролем.785786Когда методы [`__getitem__()`](https://python-all.ru/3.6/reference/datamodel.html#object.__getitem__) и [`__setitem__()`](https://python-all.ru/3.6/reference/datamodel.html#object.__setitem__) объекта `MagicMock` вызываются (обычный доступ к словарю), то `side_effect` вызывается с ключом (а в случае `__setitem__` – и со значением). Также можно управлять возвращаемым значением.787788После использования `MagicMock` можно применять атрибуты, такие как [`call_args_list`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.call_args_list), чтобы проверить, как использовался словарь:789790```python791>>> my_dict = {'a': 1, 'b': 2, 'c': 3}792>>> def getitem(name):793...      return my_dict[name]794...795>>> def setitem(name, val):796...     my_dict[name] = val797...798>>> mock = MagicMock()799>>> mock.__getitem__.side_effect = getitem800>>> mock.__setitem__.side_effect = setitem801```802803> **Примечание**804>805> Альтернатива использованию `MagicMock` – применить `Mock` и предоставить *только* те магические методы, которые нужны:806>807> ```python808> >>> mock = Mock()809> >>> mock.__getitem__ = Mock(side_effect=getitem)810> >>> mock.__setitem__ = Mock(side_effect=setitem)811> ```812>813> *Третий* вариант – использовать `MagicMock`, передавая `dict` в качестве аргумента *spec* (или *spec\_set*), чтобы созданный `MagicMock` имел только магические методы словаря:814>815> ```python816> >>> mock = MagicMock(spec_set=dict)817> >>> mock.__getitem__.side_effect = getitem818> >>> mock.__setitem__.side_effect = setitem819> ```820821С такими функциями бокового эффекта `mock` будет вести себя как обычный словарь, но записывать обращения. Он даже вызовет исключение [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError), если попытаться обратиться к несуществующему ключу.822823```python824>>> mock['a']8251826>>> mock['c']8273828>>> mock['d']829Traceback (most recent call last):830    ...831KeyError: 'd'832>>> mock['b'] = 'fish'833>>> mock['d'] = 'eggs'834>>> mock['b']835'fish'836>>> mock['d']837'eggs'838```839840После использования можно делать утверждения о доступе, используя обычные методы и атрибуты mock:841842```python843>>> mock.__getitem__.call_args_list844[call('a'), call('c'), call('d'), call('b'), call('d')]845>>> mock.__setitem__.call_args_list846[call('b', 'fish'), call('d', 'eggs')]847>>> my_dict848{'a': 1, 'c': 3, 'b': 'fish', 'd': 'eggs'}849```850851### 26.6.3.10. Подклассы Mock и их атрибуты852853Есть разные причины, по которым может потребоваться создать подкласс [`Mock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock). Одна из причин – добавление вспомогательных методов. Вот тривиальный пример:854855```python856>>> class MyMock(MagicMock):857...     def has_been_called(self):858...         return self.called859...860>>> mymock = MyMock(return_value=None)861>>> mymock862<MyMock id='...'>863>>> mymock.has_been_called()864False865>>> mymock()866>>> mymock.has_been_called()867True868```869870Стандартное поведение для экземпляров `Mock` заключается в том, что атрибуты и возвращаемые значения mock имеют тот же тип, что и mock, к которому они обращаются. Это гарантирует, что атрибуты `Mock` будут `Mocks`, а атрибуты `MagicMock` – `MagicMocks` [2](https://python-all.ru/3.6/library/unittest.mock-examples.html#id5). Поэтому если вы создаёте подкласс для добавления вспомогательных методов, они также будут доступны в атрибутах и возвращаемых значениях экземпляров вашего подкласса.871872```python873>>> mymock.foo874<MyMock name='mock.foo' id='...'>875>>> mymock.foo.has_been_called()876False877>>> mymock.foo()878<MyMock name='mock.foo()' id='...'>879>>> mymock.foo.has_been_called()880True881```882883Иногда это неудобно. Например, [один пользователь](https://python-all.ru/3.6/library/unittest.mock-examples.html) создаёт подкласс mock для [адаптера Twisted](https://python-all.ru/3.6/library/unittest.mock-examples.html). Применение этого же поведения к атрибутам приводит к ошибкам.884885`Mock` (во всех его вариантах) использует метод `_get_child_mock` для создания «под-mock» для атрибутов и возвращаемых значений. Вы можете предотвратить использование вашего подкласса для атрибутов, переопределив этот метод. Сигнатура такова: он принимает произвольные именованные аргументы (`**kwargs`), которые затем передаются конструктору mock.886887```python888>>> class Subclass(MagicMock):889...     def _get_child_mock(self, **kwargs):890...         return MagicMock(**kwargs)891...892>>> mymock = Subclass()893>>> mymock.foo894<MagicMock name='mock.foo' id='...'>895>>> assert isinstance(mymock, Subclass)896>>> assert not isinstance(mymock.foo, Subclass)897>>> assert not isinstance(mymock(), Subclass)898```899900**[2](https://python-all.ru/3.6/library/unittest.mock-examples.html#id4)**901902Исключение из этого правила – невызываемые имитации. Атрибуты используют вызываемый вариант, потому что иначе невызываемые имитации не могли бы иметь вызываемые методы.903904### 26.6.3.11. Мокирование импортов с помощью patch.dict905906Одна из ситуаций, где имитация сложна – локальный импорт внутри функции. Такие импорты труднее подменить, потому что они не используют объект из пространства имён модуля, который можно замокать.907908В целом локальных импортов следует избегать. Иногда их используют для предотвращения циклических зависимостей, для чего *обычно* есть гораздо лучшее решение (рефакторинг кода), или для снижения «начальных затрат» путём отложенного импорта. Эту проблему также можно решить лучше, чем безусловный локальный импорт (сохранить модуль как атрибут класса или модуля и выполнять импорт только при первом использовании).909910Помимо этого, существует способ использовать `mock` для влияния на результаты импорта. Импорт извлекает *объект* из словаря [`sys.modules`](https://python-all.ru/3.6/library/sys.html#sys.modules). Обратите внимание: он извлекает *объект*, который не обязательно должен быть модулем. При первом импорте модуля создаётся объект модуля, помещаемый в *sys.modules*. Поэтому обычно при импорте чего-либо возвращается модуль. Однако это не обязательно так.911912Это означает, что можно использовать [`patch.dict()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.patch.dict), чтобы *временно* поместить mock в [`sys.modules`](https://python-all.ru/3.6/library/sys.html#sys.modules). Любые импорты, выполняемые, пока активен этот patch, будут извлекать mock. Когда patch завершается (декорированная функция завершается, тело with-инструкции выполнено или вызывается `patcher.stop()`), то, что было там ранее, будет безопасно восстановлено.913914Вот пример, который имитирует модуль 'fooble'.915916```python917>>> mock = Mock()918>>> with patch.dict('sys.modules', {'fooble': mock}):919...    import fooble920...    fooble.blob()921...922<Mock name='mock.blob()' id='...'>923>>> assert 'fooble' not in sys.modules924>>> mock.blob.assert_called_once_with()925```926927Как видите, `import fooble` успешно выполняется, но при выходе в [`sys.modules`](https://python-all.ru/3.6/library/sys.html#sys.modules) не остаётся 'fooble'.928929Это также работает для формы `from module import name`:930931```python932>>> mock = Mock()933>>> with patch.dict('sys.modules', {'fooble': mock}):934...    from fooble import blob935...    blob.blip()936...937<Mock name='mock.blob.blip()' id='...'>938>>> mock.blob.blip.assert_called_once_with()939```940941Немного больше усилий, и можно также имитировать импорт пакетов:942943```python944>>> mock = Mock()945>>> modules = {'package': mock, 'package.module': mock.module}946>>> with patch.dict('sys.modules', modules):947...    from package.module import fooble948...    fooble()949...950<Mock name='mock.module.fooble()' id='...'>951>>> mock.module.fooble.assert_called_once_with()952```953954### 26.6.3.12. Отслеживание порядка вызовов и компактные проверки вызовов955956Класс [`Mock`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock) позволяет отслеживать *порядок* вызовов методов на объектах mock через атрибут [`method_calls`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.method_calls). Это не позволяет отслеживать порядок вызовов между разными объектами mock, но мы можем использовать [`mock_calls`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.mock_calls) для достижения того же эффекта.957958Поскольку mock отслеживают вызовы дочерних mock в `mock_calls`, а обращение к произвольному атрибуту mock создаёт дочерний mock, мы можем создать отдельные mock из родительского. Вызовы этих дочерних mock будут записаны по порядку в `mock_calls` родителя:959960```python961>>> manager = Mock()962>>> mock_foo = manager.foo963>>> mock_bar = manager.bar964```965966```python967>>> mock_foo.something()968<Mock name='mock.foo.something()' id='...'>969>>> mock_bar.other.thing()970<Mock name='mock.bar.other.thing()' id='...'>971```972973```python974>>> manager.mock_calls975[call.foo.something(), call.bar.other.thing()]976```977978Затем можно делать утверждения о вызовах, включая порядок, сравнивая с атрибутом `mock_calls` управляющего mock:979980```python981>>> expected_calls = [call.foo.something(), call.bar.other.thing()]982>>> manager.mock_calls == expected_calls983True984```985986Если `patch` создаёт и размещает ваши mock, вы можете прикрепить их к управляющему mock с помощью метода [`attach_mock()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.attach_mock). После прикрепления вызовы будут записаны в `mock_calls` управляющего.987988```python989>>> manager = MagicMock()990>>> with patch('mymodule.Class1') as MockClass1:991...     with patch('mymodule.Class2') as MockClass2:992...         manager.attach_mock(MockClass1, 'MockClass1')993...         manager.attach_mock(MockClass2, 'MockClass2')994...         MockClass1().foo()995...         MockClass2().bar()996...997<MagicMock name='mock.MockClass1().foo()' id='...'>998<MagicMock name='mock.MockClass2().bar()' id='...'>999>>> manager.mock_calls1000[call.MockClass1(),1001 call.MockClass1().foo(),1002 call.MockClass2(),1003 call.MockClass2().bar()]1004```10051006Если было много вызовов, но вас интересует только определённая последовательность, можно использовать метод [`assert_has_calls()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.assert_has_calls). Он принимает список вызовов (созданный с помощью объекта [`call`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.call)). Если эта последовательность вызовов есть в [`mock_calls`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.mock_calls), утверждение проходит.10071008```python1009>>> m = MagicMock()1010>>> m().foo().bar().baz()1011<MagicMock name='mock().foo().bar().baz()' id='...'>1012>>> m.one().two().three()1013<MagicMock name='mock.one().two().three()' id='...'>1014>>> calls = call.one().two().three().call_list()1015>>> m.assert_has_calls(calls)1016```10171018Даже если цепочка вызовов `m.one().two().three()` – не единственные вызовы, сделанные к mock, утверждение всё равно проходит.10191020Иногда mock получает несколько вызовов, а вас интересуют утверждения только о *некоторых* из них. Возможно, вас не волнует порядок. В этом случае можно передать `any_order=True` в `assert_has_calls`:10211022```python1023>>> m = MagicMock()1024>>> m(1), m.two(2, 3), m.seven(7), m.fifty('50')1025(...)1026>>> calls = [call.fifty('50'), call(1), call.seven(7)]1027>>> m.assert_has_calls(calls, any_order=True)1028```10291030### 26.6.3.13. Более сложное сопоставление аргументов10311032Используя ту же базовую концепцию, что и [`ANY`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.ANY), можно реализовать сопоставители для более сложных утверждений об объектах, передаваемых имитациям в качестве аргументов.10331034Предположим, мы ожидаем, что mock будет передан некоторый объект, который по умолчанию сравнивается по идентичности (это поведение Python по умолчанию для пользовательских классов). Чтобы использовать [`assert_called_with()`](https://python-all.ru/3.6/library/unittest.mock.html#unittest.mock.Mock.assert_called_with), нужно передать точно такой же объект. Если нас интересуют только некоторые атрибуты этого объекта, можно создать сопоставитель, который будет проверять эти атрибуты.10351036В этом примере видно, что «стандартного» вызова `assert_called_with` недостаточно:10371038```python1039>>> class Foo:1040...     def __init__(self, a, b):1041...         self.a, self.b = a, b1042...1043>>> mock = Mock(return_value=None)1044>>> mock(Foo(1, 2))1045>>> mock.assert_called_with(Foo(1, 2))1046Traceback (most recent call last):1047    ...1048AssertionError: Expected: call(<__main__.Foo object at 0x...>)1049Actual call: call(<__main__.Foo object at 0x...>)1050```10511052Функция сравнения для класса `Foo` может выглядеть примерно так:10531054```python1055>>> def compare(self, other):1056...     if not type(self) == type(other):1057...         return False1058...     if self.a != other.a:1059...         return False1060...     if self.b != other.b:1061...         return False1062...     return True1063...1064```10651066А объект-сопоставитель, который может использовать такие функции сравнения для операции равенства, будет выглядеть примерно так:10671068```python1069>>> class Matcher:1070...     def __init__(self, compare, some_obj):1071...         self.compare = compare1072...         self.some_obj = some_obj1073...     def __eq__(self, other):1074...         return self.compare(self.some_obj, other)1075...1076```10771078Собираем всё вместе:10791080```python1081>>> match_foo = Matcher(compare, Foo(1, 2))1082>>> mock.assert_called_with(match_foo)1083```10841085`Matcher` создаётся с нашей функцией сравнения и объектом `Foo`, с которым мы хотим сравнивать. В `assert_called_with` будет вызван метод равенства `Matcher`, который сравнивает объект, с которым был вызван mock, с тем, с которым мы создали наш сопоставитель. Если они совпадают, `assert_called_with` проходит, иначе возбуждается [`AssertionError`](https://python-all.ru/3.6/library/exceptions.html#AssertionError):10861087```python1088>>> match_wrong = Matcher(compare, Foo(3, 4))1089>>> mock.assert_called_with(match_wrong)1090Traceback (most recent call last):1091    ...1092AssertionError: Expected: ((<Matcher object at 0x...>,), {})1093Called with: ((<Foo object at 0x...>,), {})1094```10951096При небольшой доработке можно заставить функцию сравнения напрямую возбуждать [`AssertionError`](https://python-all.ru/3.6/library/exceptions.html#AssertionError) и выдавать более полезное сообщение об ошибке.10971098Начиная с версии 1.5, библиотека тестирования Python [PyHamcrest](https://python-all.ru/3.6/library/unittest.mock-examples.html) предоставляет аналогичную функциональность, которая может быть полезна здесь, в виде средства сравнения на равенство ([hamcrest.library.integration.match\_equality](https://python-all.ru/3.6/library/unittest.mock-examples.html)).1099