Функция assert в Python
В этом руководстве мы узнаем о ключевом слове assert в python. Он помогает нам отлаживать код. Если вы хотите смоделировать свой код, вы можете использовать в своем коде инструкции assert.
Ниже приведена базовая структура:
Вы также можете отправить информацию с оператором assert для лучшего понимания ошибки кода.
Ниже приведен способ отправки сообщения с помощью assert:
Утверждение Assert
Оператор assert в Python принимает условие, которое должно быть true. Если условие true, это означает, что утверждение значения переменной в порядке, тогда программа будет работать исправно, и будут выполнены следующие операторы. Но если условие false (это означает, что в нашем коде есть ошибка), возникает исключение.
Пример функции, которая возвращает частное от двух чисел
Мы хотим написать функцию, которая будет возвращать частное от двух чисел. Вот код:
Если мы запустим приведенный выше код, то результат будет следующим:
В третьей строке приведенного выше кода вы можете увидеть инструкцию assert. В этой строке проверяется, больше ли значение переменной num 2 0 или нет. Если больше нуля, т.е. условие true, то проблем не возникает, и мы получаем результат соответственно.
Но когда мы вызвали функцию Division() со вторым аргументом 0, тогда условие assert – false. Вот почему возникает AssertionError, и выдается сообщение «Divisor не может быть нулевым», которое мы написали в части сообщения.
Пример с заменой переменной
Рассмотрим следующий код, мы пытаемся найти квадратный корень из уравнения, скажем (b2 – 4ac).
Вот как мы можем использовать оператора assert для отладки и поиска ошибок в нашем коде на этапе тестирования. Вы можете узнать больше о тестировании кода, используя модуль unitest.
Встроенные исключения¶
Перечисленные ниже встроенные исключения могут быть созданы интерпретатором или встроенными функциями. Если не указано иное, у них есть «связанное значение», указывающее подробную причину ошибки. Это может быть строка или кортеж из нескольких элементов информации (например, код ошибки и строка, объясняющая код). Связанное значение обычно передаётся в качестве аргументов конструктору класса исключения.
Код пользователя может вызывать встроенные исключения. Это можно использовать для тестирования обработчика исключений или для сообщения об ошибке «точно так же, как» ситуация, в которой интерпретатор вызывает то же исключение; но имейте в виду, что нет ничего, что могло бы помешать пользовательскому коду вызвать недопустимую ошибку.
При возникновении (или повторном повышении) исключения в предложении except или finally __context__ автоматически устанавливается на последнее обнаруженное исключение; если новое исключение не обрабатывается, то отображаемая в конечном итоге обратная трассировка будет включать исходное(ые) исключение(я) и последнее исключение.
При создании нового исключения (вместо использования пустого raise для повторного вызова исключения, обрабатываемого в данный момент), неявный контекст исключения может быть дополнен явной причиной с помощью from с raise :
В любом случае само исключение всегда отображается после любых связанных исключений, так что последняя строка трассировки всегда показывает последнее возникшее исключение.
Базовые классы¶
Следующие исключения используются в основном как базовые классы для других исключений.
Базовый класс для всех встроенных исключений. Он не предназначен для непосредственного наследования пользовательскими классами (для этого используйте Exception ). Если str() вызывается для экземпляра этого класса, возвращается представление аргумента(ов) экземпляру или пустая строка, когда аргументов не было.
Кортеж аргументов, передаваемых конструктору исключения. Некоторые встроенные исключения (например, OSError ) ожидают определённого количества аргументов и придают особое значение элементам этого кортежа, в то время как другие обычно вызываются только с одной строкой, дающей сообщение об ошибке.
Этот метод устанавливает tb как новую трассировку для исключения и возвращает объект исключения. Обычно он используется в таком коде обработки исключений:
Все встроенные исключения, не связанные с выходом из системы, являются производными от этого класса. Все пользовательские исключения также должны быть производными от этого класса.
Конкретные исключения¶
Следующие исключения — это исключения, которые обычно возникают.
Возникает, когда функция input() достигает состояния конца файла (EOF) без чтения каких-либо данных. (Примечание: методы io.IOBase.read() и io.IOBase.readline() возвращают пустую строку при достижении EOF.)
В настоящее время не используется.
Атрибуты name и path можно установить, используя только ключевые аргументы. Когда они установлены, они представляют имя модуля, который пытались импортировать, и путь к любому файлу, который вызвал исключение, соответственно.
Добавлено в версии 3.6.
Возникает, когда ключ сопоставления (словаря) не найден в множестве существующих ключей.
Возникает, когда для операции не хватает памяти, но ситуацию можно исправить (удалив некоторые объекты). Связанное значение представляет собой строку, указывающую, для какой (внутренней) операции закончилась память. Обратите внимание, что из-за базовой архитектуры управления памятью (функция C malloc() ) интерпретатор не всегда может полностью выйти из этой ситуации; тем не менее, он вызывает исключение, чтобы можно было распечатать трассировку стека, если причиной была запущенная программа.
Возникает, когда локальное или глобальное имя не найдено. Это относится только к неквалифицированным именам. Связанное значение представляет собой сообщение об ошибке, которое включает имя, которое не удалось найти.
NotImplementedError и NotImplemented не взаимозаменяемы, даже если они имеют схожие названия и цели. См. NotImplemented для получения подробной информации о том, когда его использовать.
Это исключение возникает, когда системная функция возвращает ошибку, связанную с системой, включая сбои ввода-вывода, такие как «файл не найден» или «диск заполнен» (не для недопустимых типов аргументов или других случайных ошибок).
В Windows предоставляет собственный код ошибки Windows. Атрибут errno в этом случае является приблизительным переводом в терминах POSIX этого собственного кода ошибки.
В Windows, если аргумент конструктора winerror является целым числом, атрибут errno определяется из кода ошибки Windows, а аргумент errno игнорируется. На других платформах аргумент winerror игнорируется, а атрибут winerror не существует.
Соответствующее сообщение об ошибке, предоставляемое операционной системой. Он форматируется функциями C perror() в POSIX и FormatMessage() в Windows.
Для исключений, которые включают путь к файловой системе (например, open() или os.unlink() ), filename — это имя файла, переданное функции. Для функций, которые включают два пути к файловой системе (например, os.rename() ), filename2 соответствует второму имени файла, переданному в функцию.
Изменено в версии 3.4: Атрибут filename теперь является исходным именем файла, переданным функции, а не именем, закодированным или декодированным из кодировки файловой системы. Также был добавлен аргумент и атрибут конструктора filename2.
Возникает при обнаружении ошибки, не попадающей ни в одну из других категорий. Связанное значение представляет собой строку, указывающую, что именно пошло не так.
Изменено в версии 3.3: Добавлен атрибут value и возможность функций генератора использовать его для возврата значения.
Добавлено в версии 3.5.
Возникает, когда интерпретатор обнаруживает внутреннюю ошибку, но ситуация не выглядит настолько серьезной, чтобы терять всякую надежду. Связанное значение представляет собой строку, указывающую, что пошло не так (в терминах низкого уровня).
Вы должны сообщить об этом автору или сопровождающему вашего интерпретатора Python. Обязательно сообщите версию интерпретатора Python ( sys.version ; он также печатается в начале интерактивного сеанса Python), точное сообщение об ошибке (значение, связанное с исключением) и, если возможно, источник программы, вызвавшей ошибку.
Вызов sys.exit() преобразуется в исключение, чтобы можно было выполнить обработчики очистки (предложения finally операторов try ) и чтобы отладчик мог выполнить сценарий, не рискуя потерять контроль. Функцию os._exit() можно использовать, если абсолютно необходимо немедленно выйти (например, в дочернем процессе после вызова os.fork() ).
Возникает, когда операция или функция применяется к объекту несоответствующего типа. Связанное значение представляет собой строку с подробными сведениями о несоответствии типов.
Это исключение может быть вызвано пользовательским кодом, чтобы указать, что попытка выполнения операции над объектом не поддерживается и не предназначена для этого. Если объект предназначен для поддержки данной операции, но ещё не предоставил реализацию, NotImplementedError является правильным исключением для вызова.
У UnicodeError есть атрибуты, описывающие ошибку кодирования или декодирования. Например, err.object[err.start:err.end] предоставляет конкретный недопустимый ввод, на котором произошёл сбой кодека.
Имя кодировки, вызвавшей ошибку.
Строка, описывающая конкретную ошибку кодека.
Объект, который кодек пытался кодировать или декодировать.
Возникает, когда второй аргумент операции деления или операции по модулю равен нулю. Связанное значение представляет собой строку, указывающую тип операндов и операцию.
exception EnvironmentError ¶ exception IOError ¶ exception WindowsError ¶
Доступно только в Windows.
Исключения ОС¶
Базовый класс для проблем, связанных с подключением.
PEP 3151 — переработка иерархии исключений ОС и ввода-вывода
Предупреждения¶
Следующие исключения используются как категории предупреждений; см. документацию Категории предупреждений для получения более подробной информации.
Базовый класс для категорий предупреждений.
Базовый класс для предупреждений, генерируемых пользовательским кодом.
Базовый класс для предупреждений об устаревших функциях, когда эти предупреждения предназначены для других разработчиков Python.
Базовый класс для предупреждений об устаревших функциях, которые, как ожидается, будут исключены в будущем, но в настоящее время не являются устаревшими.
Этот класс используется редко, т. к. выдача предупреждения о предстоящем прекращении поддержки является необычным явлением, а DeprecationWarning предпочтительнее для уже активных прекращений поддержки.
Базовый класс для предупреждений о сомнительном синтаксисе.
Базовый класс для предупреждений о сомнительном поведении во время выполнения.
Базовый класс для предупреждений об устаревших функциях, когда эти предупреждения предназначены для конечных пользователей приложений, написанных на Python.
Базовый класс для предупреждений о возможных ошибках при импорте модулей.
Базовый класс для предупреждений, связанных с Юникодом.
Базовый класс для предупреждений, связанных с использованием ресурсов. Игнорируется фильтрами предупреждений по умолчанию.
Добавлено в версии 3.2.
Иерархия исключений¶
Иерархия классов для встроенных исключений:
Python Exception Handling: AssertionError
Making our way through our detailed Python Exception Handling series, today we’re going over the AssertionError. Like many programming languages, Python includes a built-in assert statement that allows you to create simple debug message outputs based on simple logical assertions. When such an assert statement fails (i.e. returns a False-y value), an AssertionError is raised.
In this article we’ll explore the AssertionError in more detail, starting with where it resides in the overall Python Exception Class Hierarchy. We’ll also dig into some functional Python code samples that illustrate how assert statements can be used, and how the failure of such a statement will raise an AssertionError that should be caught and handled, just like any other error. Let’s get to it!
The Technical Rundown
All Python exceptions inherit from the BaseException class, or extend from an inherited class therein. The full exception hierarchy of this error is:
Full Code Sample
Below is the full code sample we’ll be using in this article. It can be copied and pasted if you’d like to play with the code yourself and see how everything works.
This code sample also uses the Logging utility class, the source of which can be found here on GitHub.
When Should You Use It?
As discussed in the introduction, an AssertionError can only occur when an assert statement fails. Therefore, an AssertionError should never be a surprise or appear in a section of your application code that is unexpected — every time you write an assert statement, you should also provide appropriate exception handling code to deal with an inevitable assert failure.
To illustrate how assert statements work we’ll be performing some basic equivalence testing to determine if one object is equal to a second object. To make things a bit more interesting we’ve created a simple custom Book class that stores some basic information about each Book instance:
As usual, we perform our instance property assignment in the __init__(self, title: str = None, author: str = None, page_count: int = None, publication_date: datetime.date = None) method. Aside from that, the __eq__(self, other) method is worth noting, since this is the built-in method that will be called when attempting to check equivalence between a Book instance and another object. To handle this we’re using the __dict__ built-in property as a form of comparison (though we could opt for __str__(self) comparison or otherwise).
The code we’ll be using to test some object instances starts with the check_equality(a, b) method:
With everything setup we can test our assertion method by creating a couple Book instances, the_stand and the_stand_2 :
Passing both Book instances to check_equality(a, b) produces the following output:
As we can logically assume since all the arguments passed to both Book initializers were identical, our assert statement succeeded and we see the confirmation output in the log.
However, let’s see what happens if we try a second test with two slightly different Book objects, where one instance wasn’t passed a publication_date argument during initialization:
As you can probably guess, these two Book objects are not considered equal, since their underlying __dict__ properties are different from one another. Consequently, our assert statement fails and raises an AssertionError in the output:
Airbrake’s robust error monitoring software provides real-time error monitoring and automatic exception reporting for all your development projects. Airbrake’s state of the art web dashboard ensures you receive round-the-clock status updates on your application’s health and error rates. No matter what you’re working on, Airbrake easily integrates with all the most popular languages and frameworks. Plus, Airbrake makes it easy to customize exception parameters, while giving you complete control of the active error filter system, so you only gather the errors that matter most.
Check out Airbrake’s error monitoring software today and see for yourself why so many of the world’s best engineering teams use Airbrake to revolutionize their exception handling practices! Try Airbrake for free with a 30-day trial.
Monitor Your App Free for 30 Days
Discover the power of Airbrake by starting a free 30-day trial of Airbrake. Quick sign-up, no credit card required. Get started.
Грамотное использование assert в Python или прикрой свой з**!
Андрей Волков
Системное, сетевое администрирование +DBA. И немного программист!)) Профиль автора.
В этой статье я собираюсь дать вам представление об использовании assert в Python. Вы научитесь ее применять для автоматического обнаружения ошибок в программах Python. Эта инструкция сделает ваши программы надежнее и проще в отладке.
В этом месте вы, вероятно, заинтересуетесь: «Что такое assert и в чем ее прелесть?» Позвольте дать вам несколько ответов.
По своей сути инструкция Python assert представляет собой средство отладки, которое проверяет условие. Если условие утверждения assert истинно, то ничего не происходит и ваша программа продолжает выполняться как обычно. Но если же вычисление условия дает результат ложно, то вызывается исключение AssertionError с необязательным сообщением об ошибке.
Инструкция assert в Python — пример
Вот простой пример, чтобы дать вам понять, где утверждения assert могут пригодиться. Я попытался предоставить вам некоторое подобие реальной задачи, с которой вы можете столкнуться на практике в одной из своих программ.
Предположим, вы создаете интернет-магазин с помощью Python. Вы работаете над добавлением в систему функциональности скидочного купона, и в итоге вы пишете следующую функцию apply_discount :
Отлично, функция сработала безупречно. Теперь давайте попробуем применить несколько недопустимых скидок. Например, 200%-ную «скидку», которая вынудит нас отдать деньги покупателю:
Вы также можете видеть отчет об обратной трассировке этого исключения и то, как он указывает на точную строку исходного кода, содержащую вызвавшее сбой утверждение. Если во время проверки интернет-магазина вы (или другой разработчик в вашей команде) когда-нибудь столкнетесь с одной из таких ошибок, вы легко узнаете, что произошло, просто посмотрев на отчет об обратной трассировке исключения.
Почему просто не применить обычное исключение?
Теперь вы, вероятно, озадачитесь, почему в предыдущем примере я просто не применил инструкцию if и исключение.
Дело в том, что инструкция assert предназначена для того, чтобы сообщать разработчикам о неустранимых ошибках в программе. Инструкция assert не предназначена для того, чтобы сигнализировать об ожидаемых ошибочных условиях, таких как ошибка «Файл не найден», где пользователь может предпринять корректирующие действия или просто попробовать еще раз.
Инструкции призваны быть внутренними самопроверками (internal selfchecks) вашей программы. Они работают путем объявления неких условий, возникновение которых в вашем исходном коде невозможно. Если одно из таких условий не сохраняется, то это означает, что в программе есть ошибка.
А пока имейте в виду, что инструкция assert — это средство отладки, а не механизм обработки ошибок времени исполнения программы. Цель использования инструкции assert состоит в том, чтобы позволить разработчикам как можно скорее найти вероятную первопричину ошибки. Если в вашей программе ошибки нет, то исключение AssertionError никогда не должно возникнуть.
Давайте взглянем поближе на другие вещи, которые мы можем делать с инструкцией assert, а затем я покажу две распространенные ловушки, которые встречаются во время ее использования в реальных сценариях.
Прежде чем вы начнете применять какое-то функциональное средство языка, всегда неплохо подробнее познакомиться с тем, как оно практически реализуется в Python. Поэтому давайте бегло взглянем на синтаксис инструкции assert в соответствии с документацией Python :
В данном случае выражение1 — это условие, которое мы проверяем, а необязательное выражение2 — это сообщение об ошибке, которое выводится на экран, если утверждение дает сбой. Во время исполнения программы интерпретатор Python преобразовывает каждую инструкцию assert примерно в следующую ниже последовательность инструкций:
В этом фрагменте кода есть две интересные детали.
Распространенные ловушки, связанные с использованием инструкции assert в Python
Прежде чем вы пойдете дальше, есть два важных предостережения, на которые я хочу обратить ваше внимание. Они касаются использования инструкций assert в Python.
Звучит довольно ужасно (и потенциально таковым и является), поэтому вам, вероятно, следует как минимум просмотреть эти два предостережения хотя бы бегло.
Предостережение № 1: не используйте инструкции assert для проверки данных
Это преднамеренное проектное решение, которое используется схожим образом во многих других языках программирования. В качестве побочного эффекта оно приводит к тому, что становится чрезвычайно опасно использовать инструкции assert в виде быстрого и легкого способа проверки входных данных.
Поясню: если в вашей программе утверждения assert используются для проверки того, содержит ли аргумент функции «неправильное» или неожиданное значение, то это решение может быстро обернуться против вас и привести к ошибкам или дырам с точки зрения безопасности.
Давайте взглянем на простой пример, который демонстрирует эту проблему. И снова представьте, что вы создаете приложение Python с интернет-магазином. Где-то среди программного кода вашего приложения есть функция, которая удаляет товар по запросу пользователя.
В этом примере трехстрочной функции есть две серьезные проблемы, и они вызваны неправильным использованием инструкций assert:
Каким образом можно избежать этих проблем? Ответ таков: никогда не использовать утверждения assert для выполнения валидации данных. Вместо этого можно выполнять проверку обычными инструкциями if и при необходимости вызывать исключения валидации данных, как показано ниже:
Предостережение № 2: инструкции assert, которые никогда не дают сбоя
Когда в инструкцию assert в качестве первого аргумента передается кортеж, assert всегда возвращает True и по этой причине выполняется успешно.
Например, это утверждение никогда не будет давать сбой:
Между прочим, именно поэтому вам также всегда следует выполнять быстрый тест «на дым» при помощи своих модульных тестовых случаев. Прежде чем переходить к написанию следующего, убедитесь, что они действительно не срабатывают.
Несмотря на данные выше предостережения, я полагаю, что инструкции assert являются мощным инструментом отладки, который зачастую недостаточно используется разработчиками Python.
Понимание того, как работают инструкции assert и когда их применять, поможет писать программы Python, которые будет легче сопровождать и отлаживать.
Это великолепный навык, который стоит освоить, чтобы прокачать знания Python до более качественного уровня и стать всесторонним питонистом. Мне это позволило сэкономить бесконечные часы, которые приходилось тратить на отладку.
Оператор assert и вывод информации о проверках¶
Проверка с помощью оператора assert ¶
можно использовать, чтобы убедиться что ваша функция вернет определенное значение. Если assert упадет, вы сможете увидеть значение, возвращаемое вызванной функцией:
pytest поддерживает отображение значений наиболее распространенных операций, включая вызовы, параметры, сравнения, бинарные и унарные операции (см. Python: примеры отчетов об ошибках pytest ). Это позволяет использовать стандартные конструкции python без шаблонного кода, не теряя при этом информацию.
Однако, если вы укажете в assert текст сообщения об ошибке, например, вот так,
то никакая аналитическая информация выводиться не будет, и в трейсбэке вы увидите просто указанное сообщение об ошибке.
Проверка ожидаемых исключений¶
А если нужно получить доступ к фактической информации об исключении, можно использовать:
Чтобы проверить, что регулярное выражение соответствует строковому представлению исключения (аналогично методу TestCase.assertRaisesRegexp в unittest ), конекст-менеджеру можно передать параметр match :
В случае падения теста pytest выведет вам полезную информацию, например, о том, что исключение не вызвано (no exception) или вызвано неверное исключение (wrong exception).
Проверка ожидаемых предупреждений¶
Использование контекстно-зависимых сравнений¶
pytest выводит подробный анализ контекстно-зависимой информации, когда сталкивается со сравнениями. Например, в результате исполнения этого модуля
будет выведен следующий отчет:
Вывод результатов сравнения для отдельных случаев:
сравнение длинных строк: будут показаны различия
сравнение длинных последовательностей: будет показан индекс первого несоответствия
сравнение словарей: будут показаны различающиеся элементы
Определение собственных сообщений к упавшим assert ¶
Можно добавить свое подробное объяснение, реализовав хук (hook) pytest_assertrepr_compare (см. pytest_assertrepr_compare).
Для примера рассмотрим добавление в файл conftest.py хука, который устанавливает наше сообщение для сравниваемых объектов Foo :
Теперь напишем тестовый модуль:
Запустив тестовый модуль, получим сообщение, которое мы определили в файле conftest.py :
Детальный анализ неудачных проверок (assertion introspection)¶
Детальный анализ упавших проверок достигается переопределением операторов assert перед запуском. Переопределенные assert помещают аналитическую информацию в сообщение о неудачной проверке. pytest переопределяет только тестовые модули, обнаруженные им в процессе сборки (collecting) тестов, поэтому «assert«-ы в поддерживающих модулях, которые сами по себе не являются тестами, переопределены не будут.
Можно вручную включить возможность переопределения assert для импортируемого модуля, вызвав register-assert-rewrite перед его импортом (лучше это сделать в корневом файле«conftest.py«).
Дополнительную информацию можно найти в статье Бенджамина Петерсона: Behind the scenes of pytest’s new assertion rewriting.
Кэширование переопределенных файлов¶
Отключение переопределения assert ¶
На этот случай есть 2 опции:
Отключите переопределение для отдельного модуля, добавив строку PYTEST_DONT_REWRITE в docstring (строковую переменную для документирования модуля).
