如何以人性化方式为Elixir Guard编写Typespec？

背景 #

我正在研究Guard，希望为Guard定义添加typespec：

defmodule AuctionHouse.Shared.ExtraGuards do
  @moduledoc """
  Contains additional guards to use in functions.
  """

  defguard is_pos_integer(value) when is_integer(value) and value > 0
end

问题 #

现在我有了这个简单的Guard，想要为它添加spec，但Dialyzer给出的建议可读性很差：

@spec is_pos_integer(any) ::
          {:__block__ | {:., [], [:andalso | :erlang, ...]}, [],
           [{:= | {any, any, any}, list, [...]}, ...]}
defguard is_pos_integer(value) when is_integer(value) and value > 0

我认为它的参数类型是any，但返回类型难以理解，猜测它类似宏会生成Erlang代码，但无法明确含义。

疑问 #

1. 该返回类型的含义是什么？
2. 是否有方法让它更具可读性？如果有，具体怎么做？

解答 #

1. 返回类型的含义 #

Dialyzer给出的复杂元组结构，本质是Elixir抽象语法树（AST）的表示。因为defguard本质是宏，它在编译阶段会将guard表达式转换为对应的Erlang布尔判断代码，所以Dialyzer推导的返回类型就是这个宏展开后生成的AST节点结构，这个结构描述了is_integer(value) and value > 0对应的编译期语法树。

2. 让spec更可读的方法 #

你不需要手动维护Dialyzer生成的复杂AST类型，有两种更简洁的处理方式：

• 无需手动添加@spec：Elixir的defguard本身是专门用于 guard 表达式的宏，Dialyzer能够自动识别并推导其逻辑，不需要额外为它添加typespec，直接使用即可。
• 使用内置的Macro.t()类型：如果一定要显式标注spec，Elixir提供了Macro.t()这个内置类型来统一表示所有AST节点，这样spec会更简洁清晰：

  @spec is_pos_integer(any) :: Macro.t()
  defguard is_pos_integer(value) when is_integer(value) and value > 0
  

内容的提问来源于stack exchange，提问作者Flame_Phoenix