fireproofsocks
I’m confused… when grooming the docs for https://elixir-lang.org/getting-started/typespecs-and-behaviours.html I got the feedback that multiple function clauses require multiple @specs. But now that I’m digging into dialyzer, I’m getting errors in places where I’ve done that. E.g.
Overloaded contract for MyApp.some_function/1 has
overlapping domains; such contracts are currently unsupported and
are simply ignored.
Consider this module:
defmodule MyApp.Helpers do
alias Absinthe.Blueprint.Input.String, as: AbsintheString
alias Absinthe.Blueprint.Input.Integer, as: AbsintheInteger
alias Absinthe.Blueprint.Input.Float, as: AbsintheFloat
@spec parse_value(AbsintheString.t() | AbsintheInteger.t() | AbsintheFloat.t() | any()) :: {:ok, String.t()} | {:error, any()}
def parse_value(%AbsintheString{value: value}) do
{:ok, value}
end
def parse_value(%AbsintheInteger{value: value}) do
{:ok, Integer.to_string(value)}
end
def parse_value(%AbsintheFloat{value: value}) do
{:ok, Float.to_string(value)}
end
def parse_value(_) do
{:error, "Invalid value"}
end
end
Dialyzer seems happy when it has only a single combined @spec, but readability is better when each function clause has its own @spec, something more like this:
@spec parse_value(AbsintheString.t()) :: {:ok, String.t()}
def parse_value(%AbsintheString{value: value}) do
{:ok, value}
end
@spec parse_value(AbsintheInteger.t()) :: {:ok, String.t()}
def parse_value(%AbsintheInteger{value: value}) do
{:ok, Integer.to_string(value)}
end
# ... etc...
Which way is correct?
Trending in Questions
Hey guys,
I’ve got a huge CSV ( around 10 GB ) that needs to be processed hourly
Do you guys have any suggestions what is the best prac...
New
Hello!
Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app.
I creat...
New
I have what I’ve heard referred to as a “lookup table” in my database. This is a way of assigning codes to common values. One common lo...
New
Hello,
I’m developing a online persistent chat system (what’s app) like using elixir/dynamodb/aws for a mobile app(flutter).
The diffic...
New
What approach to take when sending live updates to “random” users Hi! I have a question, I have a little chat app, and when I create a DM...
New
Anyone here using Honeybadger?
My Honeybadger account is being overwhelmed with noise from some bots. Seeing a lot of
Bandit.HTTPError...
New
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
Other Trending Topics
Hobbes is a low-level distributed database for the Elixir programming language.
Hobbes provides a simple, safe, and scalable storage lay...
New
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve.
They are GUI (Emerge) and State management (S...
New
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
There are three potential reasons for members of this forum to have a look at https://vutuv.de
You are tired or annoyed of LinkedIn.
Yo...
New
Aludel - LLM Evaluation Workbench
Aludel is an embeddable Phoenix LiveView dashboard for evaluating and comparing LLM prompts across mult...
New
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #elixirconf
- #channels
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #blog-post
- #elixir-ls
- #ai
- #elixirconf-us
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #hex
- #security
- #metaprogramming










Showing Posts 1 to 6- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
NobbZ
Both are correct.
Use whichever you prefer, though having multiple specs can lead to “overlapping” specs, which are not allowed.
Also
... | ... | anycan be simplified toany.Last but not least, dialyzer will combine the second version into the first anyway.
fireproofsocks
What exactly are “overlapping specs”?
ityonemo
In the example you gave the two typepecs are quite literally identical, so the preimage and range of both “functions” trivially overlaps. Here’s a nonoverlapping typespec with associated function:
I prefer to group my typespecs for distinct function entry points (this is rare) together, and I personally organize spec, doc, function bodies. But these are stylistic choices.
fireproofsocks
AbsintheStringandAbsintheInteger(or any disparate structs) are identical?ityonemo
whoops, that detail missed me.
michallepicki
You’re only getting this warning because of the fallback function clause with
any. If types for all function arguments overlap, Dialyzer will show a warning (not an error AFAIK) and (I think?) it will use only the last version.Multiple specs are sometimes useful when you can have different argument types and maybe different return types for them. Separate
@speccan look cleaner than a big one with many| ... | ....But if specs are the same (or overlapping) I would probably use just one. Notice what
ex_docgenerates for the same specs: it will just list the same thing multiple times.