Правила именования

В данном документе рассматриваются некоторые правила именования в коде Elixir, от регистров до знаков препинания.

Регистр

Разработчики Elixir должны использовать snake_case при определении переменных, имён функций, атрибутов модулей и т.п.:

some_map = %{this_is_a_key: "and a value"}
is_map(some_map)

Исключение составляют псевдонимы, часто используемые в качестве имён модулей, которые должны быть написаны с прописной буквы и в CamelCase, например OptionParser. Для псевдонимов заглавные буквы сохраняются в аббревиатурах, например ExUnit.CaptureIO или Mix.SCM.

Атомы могут быть написаны как в :snake_case, так и в :CamelCase, хотя в Elixir принято использовать snake case.

Как правило, имена файлов следуют snake_case соглашению модуля, который они определяют. Например, MyApp должен быть определён внутри файла my_app.ex. Однако это всего лишь соглашение. В конечном счёте можно использовать любое имя файла, так как они никак не влияют на скомпилированный код.

Подчеркивание (_foo)

Elixir использует подчеркивания в различных ситуациях.

Например, значение, которое не предназначено для использования, должно быть назначено _ или переменной, начинающейся с подчеркивания:

iex> {:ok, _contents} = File.read("README.md")

Имена функций также могут начинаться с подчеркивания. Такие функции никогда не импортируются по умолчанию:

iex> defmodule Example do
...>   def _wont_be_imported do
...>     :oops
...>   end
...> end

iex> import Example
iex> _wont_be_imported()
** (CompileError) iex:1: undefined function _wont_be_imported/0

Благодаря этому свойству, Elixir использует функции, начинающиеся с подчеркивания, для добавления метаданных на этапе компиляции к модулям. Такие функции чаще всего имеют формат __foo__. Например, каждый модуль в Elixir имеет функцию __info__/1:

iex> String.__info__(:functions)
[at: 2, capitalize: 1, chunk: 2, ...]

Elixir также включает пять специальных форм, которые следуют формату двойного подчеркивания: __CALLER__/0, __DIR__/0, __ENV__/0 и __MODULE__/0 извлекают информацию о текущей среде на этапе компиляции, а __STACKTRACE__/0 извлекает стек-трейс для текущего исключения.

Заключительный восклицательный знак (foo!)

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

Многие функции существуют парами, например File.read/1 и File.read!/1. File.read/1 вернёт кортеж успеха или неудачи, а File.read!/1 вернёт простое значение или же поднимет исключение:

iex> File.read("file.txt")
{:ok, "file contents"}
iex> File.read("no_such_file.txt")
{:error, :enoent}

iex> File.read!("file.txt")
"file contents"
iex> File.read!("no_such_file.txt")
** (File.Error) could not read file no_such_file.txt: no such file or directory

Версия без ! предпочтительнее, когда вы хотите обработать различные исходы с помощью сопоставления с образцом:

case File.read(file) do
  {:ok, body}      -> # do something with the `body`
  {:error, reason} -> # handle the error caused by `reason`
end

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

Другие примеры пар функций: Base.decode16/2 и Base.decode16!/2, File.cwd/0 и File.cwd!/0.

Также существуют некоторые функции без пар, без варианта без восклицательного знака. Восклицательный знак всё равно указывает, что функция поднимет исключение при неудаче. Пример: Protocol.assert_protocol!/1.

В макросах восклицательный знак в alias!/1 и var!/2 означает, что макросная гигиена отключается.

Заключительный вопросительный знак (foo?)

Функции, возвращающие булево значение, именуются с заключительным вопросительным знаком.

Примеры: Keyword.keyword?/1, Mix.debug?/0, String.contains?/2

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

is_ префикс (is_foo)

Проверки типов и другие булевы проверки, допускаемые в условиях гвард, именуются с is_ префиксом.

Примеры: Integer.is_even/1, is_list/1

Эти функции и макросы следуют соглашению Erlang о префиксе is_, а не заключительном вопросительном знаке, именно для указания, что они допустимы в условиях гвард.

Обратите внимание, что проверки типов, не допустимые в условиях гвард, не следуют этому соглашению. Например: Keyword.keyword?/1.

Специальные имена

Некоторые имена имеют определённое значение в Elixir. Ниже мы детализируем такие случаи.

length и size

Когда вы видите size в имени функции, это означает, что операция выполняется за константное время (также записывается как "O(1) время"), так как размер хранится вместе со структурой данных.

Примеры: map_size/1, tuple_size/1

Когда вы видите length, операция выполняется за линейное время ("O(n) время"), так как требуется проход по всей структуре данных.

Примеры: length/1, String.length/1

Другими словами, функции с "size" в имени будут выполнять одинаковое время независимо от размера структуры данных. Напротив, функции с "length" в имени будут тратить больше времени по мере увеличения размера структуры данных.