如何通过iex显示来自命名函数的typespec

时间:2017-12-20 10:38:28

标签: elixir iex typespec

您可以在iex上的模块检查中显示typespecs,即:

iex(1)> t Enum
@type t() :: Enumerable.t()
@type acc() :: any()
@type element() :: any()
@type index() :: integer()
@type default() :: any()

但是如何从例如Enum.reverse?

中看到typespecs

如果我转到源代码,那么我会看到

  @spec reverse(t) :: list
  def reverse(enumerable)

我认为t代表Enum本身@type t() :: Enumerable.t()并期望返回list

在python中,例如你可以使用??通过shell获取方法doc(python不实现typespecs,但你明白了)

In [1]: from urllib2 import urlparse
In [2]: urlparse??
def urlparse(url, scheme='', allow_fragments=True):
    """Parse a URL into 6 components:
    <scheme>://<netloc>/<path>;<params>?<query>#<fragment>
    Return a 6-tuple: (scheme, netloc, path, params, query, fragment).
    Note that we don't break the components up in smaller bits
    (e.g. netloc is a single string) and we don't expand % escapes."""

1 个答案:

答案 0 :(得分:2)

IEx.Helpers.h/1打印typespec以及函数文档:

iex(1)> h Enum.reverse/1

                            def reverse(enumerable)

    @spec reverse(t()) :: list()

Returns a list of elements in enumerable in reverse order.

## Examples

    iex> Enum.reverse([1, 2, 3])
    [3, 2, 1]

快速阅读IEx.Helpers模块后,我不认为有内置辅助函数只能打印函数的typespec。

编辑:@spec未在Elixir(1.5.3)的当前稳定版本中打印。 Elixir 1.6中的此功能will be present