Fl4m3Ph03n1x

Fl4m3Ph03n1x

Does dyalizer need @spec when a function has @impl?

Background

I have a module that is a GenStage. I am trying to make this module dyalizer compliant but I am not sure if I am going overboard with @spec.

Code

Imagine we have the following code:

@impl GenStage
def init(args) do
  {:producer_consumer, nil}
end

This code is the init callback of a GenStage (called after running start_link).

I wonder if I should let it be (because it is clear that it is already using the behaviour) or if I should add further information:

@spec init(any) :: {:producer_consumer, nil}
@impl GenStage
def init(args) do
  {:producer_consumer, nil}
end

Questions

  1. Which of the two version is correct?
  2. Which version would be better for dialyzer? (does it make a difference at all?)

Marked As Solved

NobbZ

NobbZ

If the spec is a subset of what is described per the callback, then it doesn’t clash. I’m not sure though how dialyzer looks at it, also, as the interface is defined from the outside world, I’d not try to re(de)fine the spec.

Also Liked

sasajuric

sasajuric

Author of Elixir In Action

You can provide a typespec for behaviour callback functions. If you do so, and some arg or the return type in your spec is not a subtype of the callback spec, dialyzer will emit a corresponding warning. The same will happen if the types inferred from the callback code do not match spec types.

So e.g. the following GenServer code:

@type state :: %{foo: integer}
@spec handle_call(:foo, GenServer.from(), state) :: {:reply, :ok, state}
def handle_call(:foo, _from, state) do
  {:reply, :ok, %{state | bar: 1}}
end

Will lead to a dialyzer warning:

Invalid type specification for function 'Elixir.TestServer':handle_call/3. 
The success typing is 
          ('foo', _, #{'bar' := _, _ => _}) ->
             {'reply', 'ok', #{'bar' := 1, _ => _}}

which means that either the spec or the impl is wrong.

So far, I didn’t got into a habit of writing specs for callbacks, but I’ve been toying with this idea for some time. I think it would help documenting expected callback args, and might help catching some errors.

Last Post!

Fl4m3Ph03n1x

Fl4m3Ph03n1x

I’ve been toying with this idea as well, but I left it because overall in my current environment people feel it’s duplicated documentation that adds more noise and makes the code harder to maintain (that’s why I created this post).

Overall I like the idea of specifying the sub-type of the callback I am about to return for clarity’s sake, but if there is also the chance of causing dialyzer conflicts (as @NobbZ pointed out) then I am ok with leaving it be until I or someone else better understands how dialyzer works inside.

Where Next?

Popular in Questions Top

jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
hariharasudhan94
I would like to know what is the best IDE for elixir development?
New
lessless
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
New
jay1
Why is it that the mnesia database isn’t the most preferred database for use in Elixir/Phoenix?
New
komlanvi
Hi everyone, I was playing with phoenix liveView but I run into an issue. I have a form and want to validate each input text when the te...
New
aalberti333
As the title describes, I’m trying to run Enum.map() over a list of key/value pairs, where the value is a map. My data looks like this: ...
New
fayddelight
I tried installing elixir 1.11.2 erlang 23.3.4 via asdf in my zsh shell. Enabled the versions locally and globally. When I list them ...
New

Other popular topics Top

vertexbuffer
Hello, can anybody help here..? I have a list of players and I what to delete an element, but every for loop the list is reverting to ori...
New
jononomo
For some reason my phoenix channels are working for me in my local dev environment, but as soon as I deploy via Docker, I get a 403 error...
New
Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New
axelson
This post is a wiki (feel free to hit the edit button near the bottom right of this post to add your own changes!) This post collects co...
239 49134 226
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New

We're in Beta

About us Mission Statement