在 package 代码中从其他包的命名空间中查找对象

Question

我正在重构一个导入许多其他包的完整命名空间的 package。 我相信其中许多依赖项用于单个 function 调用使用，使用 importFrom 可以更好地处理，或者是不再使用的孤立依赖项。

package 中有足够的代码，手动检查每一行以查找不熟悉的 function 调用会很乏味。

如何确定在 package 中使用导入命名空间中的对象的位置和次数？ 请注意，此 package 不包括单元测试。

这是一个可重现的示例：

DESCRIPTION文件：

Package: my_package
Title: title
Version: 0.0.1
Authors@R: person(
  given = "A",
  family = "Person",
  role = c("aut", "cre"),
  email = "person@company.com"
)
Description: Something
License: Some license
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
Imports: 
  dplyr,
  purrr,
  stringr

NAMESPACE文件：

import(dplyr)
import(purrr)
import(stringr)

my_package.R文件：

#' my_package
#' @docType package
#' @name my_package
NULL
#' @import dplyr
#' @import purrr
#' @import stringr
NULL

functions.R .R文件

#' add 1 to "banana" column and call it "apple"
#' @description demonstrate a variety of dplyr functions
#' @param x a data.frame object
#' @return a data.frame object with columns "apple" and "banana"
#' @examples
#' my_fruit <- data.frame(banana = c(1,2,3), pear = c(4,5,6))
#' my_function(my_fruit)
#' @export
my_function <- function(x) {
  x %>%
    mutate(apple = banana + 1) %>%
    select(apple, banana)
}

我正在寻找一种解决方案，该解决方案可以识别%>% 、 mutate和select是dplyr的导出， %>%是purrr的导出，并且附加的命名空间stringr没有使用过的导出。 对于从多个命名空间导出的%>%之类的函数，区分导出来自哪个命名空间对我来说并不重要（在示例中，两个%>%都是来自magrittr依赖项的重新导出），因为实际屏蔽发生的位置会发出警告加载 package 时生成。

Answer 1

这是一个基本解决方案

pkgs <- readLines("NAMESPACE")
pattern <- "^import\\((.*?)\\)$"
pkgs <- pkgs[grepl(pattern, pkgs)]
pkgs <- sub(pattern, "\\1", pkgs)
pkgs
#> [1] "dplyr"   "purrr"   "stringr"

exports <- sapply(pkgs, getNamespaceExports)
exports <- do.call(rbind, Map(data.frame, package = pkgs, fun = exports))
rownames(exports) <- NULL
head(exports)
#>   package         fun
#> 1   dplyr rows_upsert
#> 2   dplyr   src_local
#> 3   dplyr  db_analyze
#> 4   dplyr    n_groups
#> 5   dplyr    distinct
#> 6   dplyr  summarise_

code <- sapply(list.files("R", full.names = TRUE), parse)
funs <- sapply(code, function(x) setdiff(all.names(x), all.vars(x)))
funs <- funs[lengths(funs) > 0]
funs <- do.call(rbind, Map(data.frame, fun = funs, file = names(funs)))
rownames(funs) <- NULL
funs
#>        fun          file
#> 1       <- R/functions.R
#> 2 function R/functions.R
#> 3        { R/functions.R
#> 4      %>% R/functions.R
#> 5   mutate R/functions.R
#> 6        + R/functions.R
#> 7   select R/functions.R

最终 output：

merge(exports, funs)
#>      fun package          file
#> 1    %>% stringr R/functions.R
#> 2    %>%   purrr R/functions.R
#> 3    %>%   dplyr R/functions.R
#> 4 mutate   dplyr R/functions.R
#> 5 select   dplyr R/functions.R

它不是 100% 健壮的，例如 function function(x) {select<-identity; select(x)} function(x) {select<-identity; select(x)}将显示 select 取自 {dplyr}。

它还会遗漏未以fun()形式使用的函数，例如lapply(my_list, fun) 。

如果我们有 100% 的测试覆盖率，我们无法真正可靠地检测到那些可能让我们到达那里或至少更接近的方法，就是将这些导入的函数库化，以便它们在调用它们时告诉我们，然后运行测试.

你可能不需要这个。

Answer 2

您可以使用getParsedData获取 package 中使用的所有 function 调用，并将它们与NAMESPACE中的可用函数连接起来以找出它们的来源。

在可重现的示例my_package上进行了测试：

library(dplyr)
library(purrr)
library(stringr)

# List functions used in Package
path <- "./my_package"
files <- file.path(path,list.files(path= path, recursive = TRUE, pattern ='\\.R$'))

functions <- files %>% map_dfr(~{
  getParseData(parse(.x, keep.source=TRUE)) %>% 
          filter(token %in% c("SYMBOL_FUNCTION_CALL","SPECIAL")) %>%
          mutate(file = .x) %>%
          rename(fctname = text) %>%
          select(file, fctname) %>% unique })

# List of all possible functions imports
imports <- readLines(file.path(path,"NAMESPACE"))
imports <- str_match(imports, "import\\(\\s*(.*?)\\s*\\)")[,2]
imports <- imports[!is.na(imports)]

possible.imported.functions <- imports %>% map_dfr(~{
  data.frame(package.import = .x,fctname = getNamespaceExports(.x)) })

# Imported functions in use
inner_join(functions,possible.imported.functions, by = c('fctname'='fctname')) %>%
  arrange(package.import,fctname) %>%
  select(file,package.import,fctname)
#>                             file package.import fctname
#> 1 my_package/R/functions.R          dplyr     %>%
#> 2 my_package/R/functions.R          dplyr  mutate
#> 3 my_package/R/functions.R          dplyr  select
#> 4 my_package/R/functions.R          purrr     %>%
#> 5 my_package/R/functions.R        stringr     %>%