PragTob

PragTob

Passing in options: Maps vs. Keyword lists

Hey everyone, this has been on my mind for some time and I’d love your input on it!

TLDR: I feel like maps are superioer for storing and working with configuration options as compared to keyword lists and am wondering what I might be missing :slight_smile:

So, in Elixir it seems like Keyword lists are the de facto standard for passing options around. It’s what Mix.Config does and sort of advocates, to my understanding. Also it is advocated in the guides

These characteristics are what prompted keyword lists to be the default mechanism for passing options to functions in Elixir

The special characteristics mentioned are:

  • Keys must be atoms
  • Keys are ordered, as specified by the developer.
  • Keys can be given more than once

While I agree that the first one is cool/important for options, I don’t see the value of the other two for options as I see them. Given options there is only ever one option and there should be one key/value pair for it (e.g. should this print a warning? How long should this run?) and I don’t care about the ordering of the keys as I just want to get my specific value.

I can clearly see the value of these properties (and therefore Keyword lists) for DSLs like Ecto (as mentioned in the docs as well) but not for options.

In practice I found keyword lists awkward to deal with when used as options. My two main pain points are:

  • keys might occur twice while I want exactly one (when I override the value of that one key I probably want it)
  • pattern matching is hard (you gotta match on the length of the list and the order of keys) - while I love to pattern match on configuration options

To elaborate on the last point, I found it to be quite nice to pattern match on configuration options to handle them which reads very nice imo:

  defp print_configuration_information(_, %{print: %{configuration: false}}) do
    nil
  end
  defp print_configuration_information(jobs, config) do
    # do printing magic
  end

This is also why I use maps for configuration in benchee.

So in short, I feel like maps are superior for storing and working with configuration options but at the same time I somehow feel like I’m not writing idiomatic elixir and that I’m missing some great advantage of keyword lists.

Opinions/Advice/Insights? :slight_smile:

Thanks!
Tobi

Marked As Solved

josevalim

josevalim

Creator of Elixir

There are situations where the latter two properties are very handy. Ecto’s query syntax and Elixir’s OptionParser are situations where you need both. The import special form also leverages the last property (keys can be given more than once). I am pretty sure there are more examples but those are three from the top of my mind.

One of the reasons I also like to use keywords list for options is because we have a well defined dichotomy where keyword lists are used for incomplete sets (you do not need to pass all keys) while maps expect all keys to be there. This allows me to use the assertive map.key syntax when using maps. It doesn’t need to be an OR choice though. I agree pattern matching on maps is really handy and for such cases I would likely accept a keyword list but convert it to a map with defaults:

map = Enum.into(user_options, %{key: "default", other_key: false, ...})

This way the API is consistent with Elixir and you can still leverage the map properties when you don’t care about duplicates nor ordering.

25
Post #2

Also Liked

BartOtten

BartOtten

The Erlang Team has changed the default in favor of maps. Not sure if Elixir will follow.

10
Post #6
dsissitka

dsissitka

Have you seen how, for example, System.cmd/3 does it?

https://github.com/elixir-lang/elixir/blob/87710cd49521fc396f3f04fa8615f05e7f57ecc0/lib/elixir/lib/system.ex#L578-L603

BartOtten

BartOtten

In his talk at the virtual DevsForUkraine conference, José Valim addressed the question.

TLDL; he still favors lists

But when we want him to reconsider, all we need to say is: José, I think there is a performance issue with using lists for config. He will then benchmark it extensively, re-read every line involved, find 4 unrelated bugs, write fixes, push them to master and finally answer. All within 15 minutes.

Last Post!

PragTob

PragTob

Thanks for summarizing it!

I was actually the one asking José that question there, thanks to this thread :grin:

Link to the moment in the Q&A for future reference: https://www.youtube.com/watch?v=2Vhd5fw59UY&t=1116s

As a bit of input here, I don’t think performance is or will be an issue. Even erlang maps are internally represented as lists until there is a map size of 32 iirc. Reason being, hashing is expensive and so for small maps a linear search is actually faster. Since I don’t hope many people pass along more than 30 (I hope more than 5) options, performance should be the same/comparable.

Where Next?

Trending in Discussions Top

AstonJ
As the title says, please share what you’ve been up to with Elixir. Whether that’s been learning it, looking into it, making stuff with i...
2976 91332 914
New
f0rest8
Hi everyone :waving_hand: Posting here to showcase and announce that Metamorphic is now officially live on a public-facing domain at htt...
New
andrielfn
Hey there :waving_hand: I want to introduce Fluxon UI, a modern UI component library for Phoenix LiveView that I have been working on fo...
New
byu
@chrismccord : I just saw the Extract AGENTS.md from Phoenix.new into phx.new generator commit to the phoenix project. My initial shotgu...
New
arcanemachine
I was working on an Ecto migration and I needed a timestamp. So, for the nth time, I looked up the different data types for timestamps, a...
New
AstonJ
Just a general thread to post chat/news/info relating to AI/ML stuff that may be relevant for Nx now or in the future. Got anything to sh...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
New
JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
New
webofbits
Squid Mesh is an open source workflow automation runtime for Elixir applications. It is aimed at Phoenix and OTP apps that want to defin...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
kip
In 2021 I started a new library called Tempo with the objective of modelling time as a set of intervals - not as instants. In 2022 I gave...
New

We're in Beta

About us Mission Statement