clojure

Clojure - named arguments


Does Clojure have named arguments? If so, can you please provide a small example of it?


Solution

  • In Clojure 1.2, you can destructure the rest argument just like you would destructure a map. This means you can do named non-positional keyword arguments. Here is an example:

    user> (defn blah [& {:keys [key1 key2 key3]}] (str key1 key2 key3))
    #'user/blah
    user> (blah :key1 "Hai" :key2 " there" :key3 10)
    "Hai there10"
    user> (blah :key1 "Hai" :key2 " there")
    "Hai there"
    user> (defn blah [& {:keys [key1 key2 key3] :as everything}] everything)
    #'user/blah
    user> (blah :key1 "Hai" :key2 " there")
    {:key2 " there", :key1 "Hai"}
    

    Anything you can do while destructuring a Clojure map can be done in a function's argument list as shown above. Including using :or to define defaults for the arguments like this:

    user> (defn blah [& {:keys [key1 key2 key3] :or {key3 10}}] (str key1 key2 key3))
    #'user/blah
    user> (blah :key1 "Hai" :key2 " there")
    "Hai there10"
    

    But this is in Clojure 1.2. Alternatively, in older versions, you can do this to simulate the same thing:

    user> (defn blah [& rest] (let [{:keys [key1 key2 key3] :or {key3 10}} (apply hash-map rest)] (str key1 key2 key3)))
    #'user/blah
    user> (blah :key1 "Hai" :key2 " there")
    "Hai there10"
    

    and that works generally the same way.

    And you can also have positional arguments that come before the keyword arguments:

    user> (defn blah [x y & {:keys [key1 key2 key3] :or {key3 10}}] (str x y key1 key2 key3))
    #'user/blah
    user> (blah "x" "Y" :key1 "Hai" :key2 " there")
    "xYHai there10"
    

    These are not optional and have to be provided.

    You can actually destructure the rest argument like you would any Clojure collection.

    user> (defn blah [& [one two & more]] (str one two "and the rest: " more))
    #'user/blah
    user> (blah 1 2 "ressssssst")
    "12and the rest: (\"ressssssst\")"
    

    You can do this sort of thing even in Clojure 1.1. The map-style destructuring for keyword arguments only came in 1.2 though.