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

В данном документе рассматриваются некоторые правила именования кода на 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 соглашению модуля, который они определяют. Например, 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.

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

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

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

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

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

is_ префикс (is_foo)

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

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

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

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

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

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

length и size

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

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

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

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

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