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

Этот документ содержит руководство по правилам именования в Elixir, от регистров букв до знаков препинания.

Правило именования, по определению, является подмножеством синтаксиса Elixir. Это правило призвано следовать и устанавливать лучшие практики для языка и сообщества. Если вы хотите получить полное руководство по синтаксису 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

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

При размышлении о случаях ошибок для функций мы думаем строго об ошибках, которые происходят в их области, таких как невозможность открыть файл. Ошибки, возникающие из-за неверных типов аргументов, например, всегда должны вызывать исключение независимо от того, имеет ли функция восклицательный знак или нет. Исключением зачастую является ArgumentError или подробная FunctionClauseError:

iex(1)> File.read(123)
** (FunctionClauseError) no function clause matching in IO.chardata_to_string/1

    The following arguments were given to IO.chardata_to_string/1:

        # 1
        123

    Attempted function clauses (showing 2 out of 2):

        def chardata_to_string(string) when is_binary(string)
        def chardata_to_string(list) when is_list(list)

Другие примеры пар функций: 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. Мы подробно описываем эти случаи ниже.

длина и размер

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

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

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

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

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