Исключение поведение

Функции для форматирования выбрасывания/перехвата/выхода и исключений.

Обратите внимание, что трассировки стека в Elixir обновляются при выбрасывании, ошибках и выходах. Например, в любой момент System.stacktrace/0 вернёт трассировку стека для последнего выбрасывания/ошибки/выхода, произошедшего в текущем процессе.

Не полагайтесь на конкретный формат, возвращаемый функциями format* в этом модуле. Они могут быть изменены в будущих выпусках, чтобы лучше соответствовать инструменту Elixir. Другими словами, используя функции в этом модуле, гарантируется, что вы будете форматировать исключения так же, как в текущей версии Elixir.

Краткое описание

Типы

kind(): Тип, обрабатываемый функциями форматирования
stacktrace()
stacktrace_entry()
t(): Тип исключения

Функции

blame(kind, error, stacktrace): Добавляет информацию к исключениям для дополнительной отладки
blame_mfa(module, function, args): Назначает вину вызову данного модуля, функции и аргументов
exception?(term): Возвращает true, если данный term является исключением
format(kind, payload, stacktrace \\ nil): Нормализует и форматирует выбрасывания/ошибки/выходы и трассировки стека
format_banner(kind, exception, stacktrace \\ nil): Нормализует и форматирует любое выбрасывание/ошибку/выход
format_exit(reason): Форматирует выход. Возвращает строку
format_fa(fun, arity): Принимает анонимную функцию и арность и форматирует её, как показано в трассировках стека. Арность также может быть списком аргументов
format_file_line(file, line, suffix \\ ""): Форматирует заданный file и line так, как показано в трассировках стека. Если какие-либо значения являются nil, они опускаются
format_mfa(module, fun, arity): Принимает модуль, функцию и арность и форматирует их, как показано в трассировках стека. Арность также может быть списком аргументов
format_stacktrace(trace \\ nil): Форматирует трассировку стека
format_stacktrace_entry(entry): Принимает элемент трассировки стека и форматирует его в строку
message(exception): Получает сообщение для exception
normalize(kind, payload, stacktrace \\ nil): Нормализует исключение, преобразуя Erlang-исключения в Elixir-исключения

Типы

kind()

kind() :: :error | non_error_kind()

Тип, обрабатываемый функциями форматирования

stacktrace()

stacktrace() :: [stacktrace_entry()]

stacktrace_entry()

stacktrace_entry() ::
  {module(), atom(), arity_or_args(), location()} |
  {(... -> any()), arity_or_args(), location()}

t()

t() :: %module(){:__exception__ => true, optional(atom()) => any()}

Тип исключения

Функции

blame(kind, error, stacktrace)

blame(:error, any(), stacktrace()) :: {t(), stacktrace()}

blame(non_error_kind(), payload, stacktrace()) :: {payload, stacktrace()} when payload: var

Добавляет информацию к исключениям для дополнительной отладки.

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

FunctionClauseError - аннотируется аргументами, используемыми при вызове, и доступными клаузами

blame_mfa(module, function, args)

blame_mfa(module(), function(), args :: [term()]) ::
  {:ok, :def | :defp | :defmacro | :defmacrop, [{args :: [term()], guards :: [term()]}]} |
  :error

Назначает вину вызову данного модуля, функции и аргументов.

Эта функция получит доступные клаузы из байткода и проверит их по заданным аргументам. Клаузы возвращаются как список пар {args, guards} где каждый аргумент и каждая верхнеуровневая условная часть в инструкции `guard` разделяются and/or и заключены в кортеж с метаданными вины.

Эта функция возвращает либо {:ok, definition, clauses} или :error. Где definition является :def, :defp, :defmacro или :defmacrop. Обратите внимание, что эта функциональность требует Erlang/OTP 20, иначе всегда возвращается %%%CODE_BLOCK_26%%.

exception?(term)

Возвращает true если данный term является исключением.

format(kind, payload, stacktrace \\ nil)

format(kind(), any(), stacktrace() | nil) :: String.t()

Нормализует и форматирует выбрасывания/ошибки/выходы и трассировки стека.

Она полагается на format_banner/3 и format_stacktrace/1 для генерации окончательного формата.

Обратите внимание, что {:EXIT, pid} не генерируют трассировку стека (так как они извлекаются как сообщения без трассировок стека).

format_banner(kind, exception, stacktrace \\ nil)

format_banner(kind(), any(), stacktrace() | nil) :: String.t()

Нормализует и форматирует любое выбрасывание/ошибку/выход.

Сообщение форматируется и отображается в том же формате, что и используется в командной строке Elixir.

Третий аргумент, трассировка стека, является необязательным. Если он не предоставлен, System.stacktrace/0 иногда будет использоваться для получения дополнительной информации об исключении kind :error. Если трассировка стека неизвестна и System.stacktrace/0 не вернёт трассировку стека, соответствующую исключению, используется пустая трассировка стека, [].

format_exit(reason)

format_exit(any()) :: String.t()

Форматирует выход. Возвращает строку.

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

format_fa(fun, arity)

Принимает анонимную функцию и арность и форматирует её, как показано в трассировках стека. Арность также может быть списком аргументов.

Примеры

Exception.format_fa(fn -> nil end, 1)
#=> "#Function<...>/1"

format_file_line(file, line, suffix \\ "")

Форматирует заданный file и line так, как показано в трассировках стека. Если какие-либо значения являются nil, они опускаются.

Примеры

iex> Exception.format_file_line("foo", 1)
"foo:1:"

iex> Exception.format_file_line("foo", nil)
"foo:"

iex> Exception.format_file_line(nil, nil)
""

format_mfa(module, fun, arity)

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

Примеры

iex> Exception.format_mfa Foo, :bar, 1
"Foo.bar/1"

iex> Exception.format_mfa Foo, :bar, []
"Foo.bar()"

iex> Exception.format_mfa nil, :bar, []
"nil.bar()"

Анонимные функции отображаются как -func/arity-anonfn-count-, где func — имя включающей функции. Преобразовать в «анонимная функция в func/арность»

format_stacktrace(trace \\ nil)

Форматирует трассировку стека.

Трассировка стека должна быть передана в качестве аргумента. Если нет, трассировка стека извлекается из Process.info/2.

format_stacktrace_entry(entry)

format_stacktrace_entry(stacktrace_entry()) :: String.t()

Принимает элемент трассировки стека и форматирует его в строку.

message(exception)

Получает сообщение для exception.

normalize(kind, payload, stacktrace \\ nil)

normalize(:error, any(), stacktrace()) :: t()

normalize(non_error_kind(), payload, stacktrace()) :: payload when payload: var

Нормализует исключение, преобразуя Erlang-исключения в Elixir-исключения.

Она принимает kind выброшенное catch как аргумент и нормализует только :error, возвращая неизменённый payload для других.

Обработчики событий

exception(term)

exception(term()) :: t()

message(t)

message(t()) :: String.t()