当存在可变参数时设置 :arglists 元数据

Question

考虑无参数的函数


(defn aarg {:arglists '([fake])} [])
=> {:ns cljs.user,
 :name aarg,
 :file nil,
 :end-column 11,
 :column 1,
 :line 1,
 :end-line 1,
 :arglists ([fake]),
 :doc nil,
 :test nil}


所有工作都如预期进行，但是当引入可变参数时


(defn aarg {:arglists '([fake])} [& env])
(meta #'aarg)
=> {:ns cljs.user,
 :name aarg,
 :file nil,
 :end-column 11,
 :top-fn {:variadic true,
          :max-fixed-arity 0,
          :method-params [(env)],
          :arglists ([& env]),
          :arglists-meta (nil)},
 :column 1,
 :line 1,
 :end-line 1,
 :arglists ([& env]),
 :doc nil,
 :test nil}


:arglists 不受影响。

Answer 1

评论者：hlolli

我只提交了一个补丁，之前从未使用过 jira 补丁系统，撇开这个不谈，该补丁将使编译器在用户提供时尊重 :arglists 元数据。希望得到反馈并合并：）

Answer 2

评论者：dnolen

谢谢，你提交了 Clojure CA 吗？

Answer 3

评论者：dnolen

补丁审查，我并不真正理解更改 variadic-fn 的可变参数量和添加此新标志的目的。难道不能直接将逻辑放入 variadic-fn 中吗？

Answer 4

评论者：hlolli

是的，我会为我的补丁找到一个更好的解决方案，只是第 3176 行 let 绑定中的 `m` 符号。

m (conj {:arglists (core/list 'quote (sigs fdecl))} m)

合并 arglists 后，在此点之后就无法知道 :arglists 是否来自提供的元数据。但我会重命名 let 符号，避免添加参数量，我今天晚些时候会做另一个补丁。

我还没有提交我的 Clojure 输出者协议，我现在正在填写...

Answer 5

评论者：hlolli

昨天我签署了 Clojure CA
"Rich Hickey 和 Hlöðver Sigurðsson 之间的 Clojure CA 已签署并归档！"

代码
用于元数据的符号名 m (m) 已不是很好，但我只是添加了一个逗号来区分 vararg-fn 的情况和其他情况。

在我测试这个功能时，我发现多参数函数的 arglist 元数据在与或不添加 arglists 时均不起作用。如果是这样，我可以为该问题打开另一个 jira 任务。

Answer 6

参考：https://clojure.atlassian.net/browse/CLJS-2351（由 hlolli 报告）

Answer 7

这也适用于多参数函数

(defn bar {:arglists '([foo bar])}
  ([x] 1)
  ([x y] 2))

(meta #'bar)
;;=> {:ns cljs.user,
 :name bar,
 :file nil,
 :end-column 10,
 :top-fn
 {:variadic? false,
  :fixed-arity 2,
  :max-fixed-arity 2,
  :method-params ([x] [x y]),
  :arglists ([x] [x y]),
  :arglists-meta (nil nil)},
 :column 1,
 :line 1, 
 :end-line 1, 
 :arglists ([x] [x y]), 
 :doc nil, 
 :test nil}

而单参数函数工作得很好

(defn foo {:arglists '([foo])} [x] 1)
(meta #'foo)
;; => {:ns cljs.user,
 :name foo,
 :file nil,
 :end-column 10,
 :column 1,
 :line 1, 
 :end-line 1, 
 :arglists ([foo]), 
 :doc nil, 
 :test nil}

我认为这可以通过检查在 multi-arity-fn 定义和 variadic-arity-fn 中元数据上是否已存在 :arglists 键来解决。

我很希望看到这个问题得到修复，如果需要多参数函数修复的补丁，请告知。

Answer 8

这份工单缺少解释为什么需要进行这个更改？这个更改有必要/有用吗？

修改 :arglists 会直接影响到编译器生成的代码。如果元数据与实际的函数定义不完全匹配，这可能会导致变数调用失败，甚至某些参数数量的调用被“丢弃”。

Comments

我注意到在 Clojure 和 ClojureScript 中，`eduction` 的定义都覆盖了其 :arglists 元数据。

---

在 Clojure 中，至少，提供 :arglists 元数据以向编辑器和 REPL 提供有用的提示是相当常见的，而且 :arglists 元数据根本不影响语义：它只是提供对人类友好的提示。

以下代码在 Clojure 中有效：

dev=> (defn foo {:arglists '([foo bar])} ([x]) ([x y]))

#'dev/foo

dev=> (meta #'foo)

{:arglists ([foo bar]), :line 1, :column 1, :file "/home/seanc/.clojure/dev.clj", :name "foo", :ns #object[clojure.lang.Namespace 0x34e700f4 "dev"]}

---

正如我所说，有几个地方 `:arglists` 元数据可能会影响生成的代码（例如 [CLJS-1871](。)

用来进行文档用途应该是没有问题的，但是这一点在工单描述中并不清楚。

---

对于我的情况，这纯粹是文档目的，虽然我不太熟悉CLJS代码库，但提出的补丁让我有些担忧。与其覆盖内部的`arglists`变量，我宁愿在组装元数据时覆盖它，这样就不会有下游的影响。

---

对于我的情况，这纯粹是文档目的。这对此非常重要，否则编辑器提示将显示gensyms而不是正确名称。

我不太熟悉CLJS代码库，但提出的补丁让我有些担忧。与其覆盖内部的`arglists`变量，我怀疑是否仅在组装元数据时覆盖它会有帮助，这样就不会有下游的影响。

```
meta     (assoc meta
                               :top-fn
                               {:variadic? variadic?
                                :fixed-arity mfa
                                :max-fixed-arity mfa
                                :method-params (core/cond-> sigs macro? elide-implicit-macro-args)
                                ;; 修正：类似这样
                                :arglists (或 (:arglists meta))
                                                       (core/cond-> arglists macro? elide-implicit-macro-args))
                                :arglists-meta (if (:arglists meta)
                                                 (doall (map meta (:arglists meta))))
                                                 (doall (map meta arglists)))})
```