参数通过点（'...'）传递时的部分匹配混乱

Question

我一直在研究一个 R 包，它只是一个图形数据库的 REST API 包装器。我有一个函数createNode，它返回一个类node和entity的对象：

# Connect to the db.
graph = startGraph("http://localhost:7474/db/data/")

# Create two nodes in the db.
alice = createNode(graph, name = "Alice")
bob = createNode(graph, name = "Bob")

> class(alice)
[1] "node"   "entity"
> class(bob)
[1] "node"   "entity"

我有另一个函数createRel，它在数据库中的两个节点之间创建关系。具体如下：

createRel = function(fromNode, type, toNode, ...) {
  UseMethod("createRel")
}

createRel.default = function(fromNode, ...) {
  stop("Invalid object. Must supply node object.")
}

createRel.node = function(fromNode, type, toNode, ...) {
  params = list(...)

  # Check if toNode is a node.
  stopifnot("node" %in% class(toNode))

  # Making REST API calls through RCurl and stuff.
}

... 允许用户以 key = value 的形式向关系中添加任意数量的属性。例如，

rel = createRel(alice, "KNOWS", bob, since = 2000, through = "Work")

这会在数据库中创建一个 (Alice)-[KNOWS]->(Bob) 关系，其中包含属性 since 和 through 及其各自的值。但是，如果用户在 ... 参数中使用键 from 或 to 指定属性，R 就会对 fromNode 和 toNode 的类感到困惑。

使用键 from 指定属性会混淆 fromNode 的类。它正在使用createRel.default:

> createRel(alice, "KNOWS", bob, from = "Work")

Error in createRel.default(alice, "KNOWS", bob, from = "Work") : 
Invalid object. Must supply node object. 
3 stop("Invalid object. Must supply node object.") 
2 createRel.default(alice, "KNOWS", bob, from = "Work") 
1 createRel(alice, "KNOWS", bob, from = "Work")

类似地，如果用户指定一个带有键 to 的属性，则会混淆 toNode 的类，并在 stopifnot() 处停止：

Error: "node" %in% class(toNode) is not TRUE 
4 stop(sprintf(ngettext(length(r), "%s is not TRUE", "%s are not all TRUE"), 
  ch), call. = FALSE, domain = NA) 
3 stopifnot("node" %in% class(toNode)) 
2 createRel.node(alice, "KNOWS", bob, to = "Something") 
1 createRel(alice, "KNOWS", bob, to = "Something")

我发现在createRel 中显式设置参数可以正常工作：

rel = createRel(fromNode = alice,
                type = "KNOWS",
                toNode = bob,
                from = "Work",
                to = "Something")
# OK

但我想知道如何编辑我的 createRel 函数，以便以下语法可以正常工作：

rel = createRel(alice, "KNOWS", bob, from = "Work", to = "Something")
# Errors galore.

打开该问题的 GitHub 用户提到，它很可能与调度时的 setAs 发生冲突，其参数名为 from 和 to。一种解决方案是去掉 ... 并将 createRel 更改为以下内容：

createRel = function(fromNode, type, toNode, params = list()) {
  UseMethod("createRel")
}

createRel.default = function(fromNode, ...) {
  stop("Invalid object. Must supply node object.")
}

createRel.node = function(fromNode, type, toNode, params = list()) {
  # Check if toNode is a node.
  stopifnot("node" %in% class(toNode))

  # Making REST API calls through RCurl and stuff.
}

但是，在进行此更改之前，我想看看我是否还有其他选择。

Answer 1

不是真正的答案，但是...

问题在于用户提供的参数“from”正在（部分）与形式参数“fromNode”匹配。

f = function(fromNode, ...) fromNode
f(1, from=2)
## [1] 2

规则在RShowDoc('R-lang') 的第 4.3.2 节中进行了概述，其中命名参数是完全匹配的，然后是部分匹配的，然后未命名的参数是按位置分配的。

除了使用单字母参数名称之外，很难知道如何强制执行精确匹配！实际上，对于泛型来说，这可能不像听起来那么陈词滥调——x 是一个非常通用的变量名。如果 'from' 和 'to' 是...的常见参数，您可以将参数列表更改为“fromNode, , ..., from, to”，检查函数体中是否缺少（from），然后采取行动因此;我不认为这会令人愉快，而且用户总是会提供一个“来回”的论点。

虽然通过设置全局 options() 来强制执行精确匹配（和错误，通过警告 = 2）可能有助于调试（虽然到那时你可能知道你在寻找什么！）它对包没有帮助试图编写代码以供一般用户使用的作者。

在 R-devel 邮件列表上询问是否是时候改变这种行为可能是合理的（在“几个版本”的时间范围内）；部分匹配的日期可能是制表符完成前几天的“方便”。