R包中基于vctrs实现pct类时vec_arith双重分派失效
核心原因
所有算术失效的现象,本质是打包后S3方法的注册不完整,和你的方法实现逻辑无关:
- 直接source代码时,所有函数都在全局环境,R的S3分发直接从全局找
vec_arith.pct方法,所以能正常运行 - 打成R包后,所有函数都在包的私有命名空间里,必须通过NAMESPACE文件的显式
S3method()声明,外部包(vctrs)的泛型调用才能访问到你写的方法 - 你测试时
1 + pct(0.5)能正常跑通,是因为这个操作触发的是vctrs自带的vec_arith.numeric泛型,你为这个泛型写的vec_arith.numeric.pct方法被roxygen自动识别并正确注册到了NAMESPACE,所以分发正常 - 反过来
pct(0.5) + 1或者pct + pct的操作,需要走vctrs核心vec_arith泛型的方法查找,定位到对应pct类的实现,但你的vec_arith.pct方法没有被roxygen识别为vec_arith泛型的S3方法,没有写入NAMESPACE的注册声明,因此分发时找不到对应方法,直接走到默认的vec_arith.default抛出错误 - 你用sloop能查到方法存在,是因为sloop是直接扫描包的函数环境定位对象,不依赖NAMESPACE的S3注册信息,和实际运行时的分发逻辑没有关系
修复步骤
只需要给vec_arith.pct方法补充显式的roxygen标记,明确告诉roxygen这是为vctrs核心vec_arith泛型编写的pct类方法即可:
- 修改
vec_arith.pct函数的roxygen标签,新增@method vctrs::vec_arith pct,修改后的标签片段如下:#' A vec_arith method to allow basic operations for pct #' @param op Arithmetic operation to do. #' @param x Pct object. #' @param y Second object. #' @method vctrs::vec_arith pct #' @export vec_arith.pct <- function(op, x, y, ...) { UseMethod("vec_arith.pct", y) } - 重新执行
document()更新文档和NAMESPACE文件,再运行load_all()重新加载包 - 可以打开包根目录下的NAMESPACE文件检查,确认存在一行
S3method(vctrs::vec_arith, pct)的声明,就说明注册成功
补充说明
- 你写的二次分派结构(第一层按x的类分派到
vec_arith.pct,第二层按y的类分派到具体的pct/pct、pct/numeric方法)完全符合vctrs的实现规范,不需要修改 - 其余三个方法(
vec_arith.pct.pct、vec_arith.pct.numeric、vec_arith.numeric.pct)对应的泛型是包内自定义的vec_arith.pct或者vctrs的vec_arith.numeric,roxygen会自动识别并正确注册,不需要额外添加标记 - 你观察到的
sum(pct(...) + pct(...))能正常运行的现象,也能被这个逻辑解释:sum触发的是vctrs的vec_math泛型,这个泛型对应的vec_math.pct方法已经被正确注册,因此执行不受vec_arith注册缺失的影响
内容的提问来源于stack exchange,提问作者Brice Nocenti
相关产品推荐
相关产品推荐

