没有包的命名空间

Question

在重组我的代码库时，我想清理我的代码共享机制。到目前为止，我将source 用于许多小型、大部分独立的功能模块。

但是，这种方法存在许多问题，其中包括

• 缺乏循环测试（意外循环source 链），
• 正确指定包含路径所需的复杂语法（chdir=TRUE 参数，硬编码路径），
• 潜在的名称冲突（重新定义对象时）。

理想情况下，我想获得与 Python 模块机制类似的东西。 R 包机制在这里会有点矫枉过正：我确实不想要生成嵌套的路径层次结构、包含大量元数据的多个文件并手动构建包只是为了得到一个小的、自包含、可重用的代码模块。

现在我使用的是 sn-p 代码，它可以让我解决上面提到的前两个问题。包含的语法如下：

import(functional)
import(io)
import(strings)

... 并且模块被定义为驻留在本地路径中的简单源文件。 The definition of import is straightforward 但我无法解决第三点：我想将模块导入单独的命名空间，但据我所知，命名空间查找机制与包非常紧密。没错，我可以覆盖 `::` 或 getExportedValue 或者 asNamespace 和 isNamespace，但感觉很脏，并且有可能破坏其他包。

Answer 1

这是一个完全自动化包创建、编译和重新加载的函数。正如其他人所指出的那样，实用函数package.skeleton() 和devtools::load_all() 已经几乎 让您一路走好。这只是结合了它们的功能，使用package.skeleton() 在一个临时目录中创建源目录，当load_all() 完成处理它时会被清理。

您需要做的就是指向要从中读取函数的源文件，并为包命名：import() 为您完成其余的工作。

import <- function(srcFiles, pkgName) {
    require(devtools)
    dd <- tempdir()
    on.exit(unlink(file.path(dd, pkgName), recursive=TRUE))
    package.skeleton(name=pkgName, path = dd, code_files=srcFiles)
    load_all(file.path(dd, pkgName))
}

## Create a couple of example source files
cat("bar <- function() {print('Hello World')}", file="bar.R")
cat("baz <- function() {print('Goodbye, cruel world.')}", file="baz.R")

## Try it out
import(srcFiles=c("bar.R", "baz.R"), pkgName="foo")

## Check that it worked
head(search())
# [1] ".GlobalEnv"        "package:foo"       "package:devtools"
# [4] "package:stats"     "package:graphics"  "package:grDevices"
bar()
# [1] "Hello World"
foo::baz()
# [1] "Goodbye, cruel world."

Answer 2

康拉德，严肃地说，是对需求的回答

获得一个小型、独立、可重用的代码模块

是来创建一个包。这个福音已经在 SO 和其他地方重复了 无数次 次。事实上，你可以用最少的 fuzz 创建最少的包。

还有，运行后

 setwd("/tmp")
 package.skeleton("konrad")

删除一个临时文件，我就剩下了

 edd@max:/tmp$ tree konrad/
 konrad/
 ├── DESCRIPTION
 ├── man
 │   └── konrad-package.Rd
 └── NAMESPACE

 1 directory, 3 files
 edd@max:/tmp$ 

真的那么繁重吗？

Answer 3

包只是文件存储位置的约定（R/ 中的 R 文件，man/ 中的文档，src 中的编译代码，data/ 中的数据）：如果您有多个文件，你最好坚持既定的惯例。换句话说，使用包比不使用包更容易，因为你不需要思考：你可以利用现有的约定，每个 R 用户都会明白发生了什么。

一个最小的包真正需要的是一个DESCRIPTION 文件，它说明了包的作用，谁可以使用它（许可证），以及如果有问题可以联系谁（维护者）。这有点开销，但不是主要的。写完之后，您只需根据需要填写其他目录 - 无需笨拙的 package.skeleton()。

也就是说，用于处理包的内置工具很麻烦 - 您必须重新构建/重新安装包，重新启动 R 并重新加载包。这就是devtools::load_all() 和 Rstudio 的 build & reload 发挥作用的地方——它们对包使用相同的规范，但提供了从源代码更新包的更简单方法。您当然可以使用其他答案提供的代码 sn-ps，但为什么不使用数百（至少数十个）R 开发人员使用的经过良好测试的代码？

Answer 4

我对 OP 问题的评论不太正确，但我认为这种对 import 函数的重写可以解决问题。 foo.R 和 bar.R 是当前工作目录中的文件，其中包含一个函数 (baz)，可打印如下所示的输出。

import <- function (module) {
  module <- as.character(substitute(module))
  # Search path handling omitted for simplicity.
  filename <- paste(module, 'R', sep = '.')
  # create imports environment if it doesn't exist
  if ("imports" %in% search())
    imports <- as.environment(match("imports",search()))
  # otherwise get the imports environment
  else
    imports <- attach(NULL, name="imports")
  if (module %in% ls("imports"))
    return()
  # create a new environment (imports as parent)
  env <- new.env(parent=imports)
  # source file into env
  sys.source(filename, env)
  # ...and assign env to imports as "module name"
  assign(module, env, imports)
}
setwd(".")
import(foo)
import(bar)
foo$baz()
# [1] "Hello World"
bar$baz()
# [1] "Buh Bye"

请注意，baz() 本身不会被找到，但 OP 似乎无论如何都想要 :: 的明确性。

Answer 5

我完全赞同@Dirk 的回答。制作最小包所涉及的少量开销似乎值得遵循“标准方式”。

然而，我想到的一件事是source 的local 参数，让您可以将其作为environment 的来源，您可以像命名空间一样使用它，例如

assign(module, new.env(parent=baseenv()), envir=topenv())
source(filename, local=get(module, topenv()), chdir = TRUE)

要使用简单的语法访问这些导入的环境，请给这些导入环境一个新类（例如，'import'），并使:: 通用，当pkg 不存在时默认为getExportedValue。

import <- function (module) {
    module <- as.character(substitute(module))
    # Search path handling omitted for simplicity.
    filename <- paste(module, 'R', sep = '.')

    e <- new.env(parent=baseenv())
    class(e) <- 'import'
    assign(module, e, envir=topenv())
    source(filename, local=get(module, topenv()), chdir = TRUE)
}

'::.import' <- function(env, obj) get(as.character(substitute(obj)), env)
'::' <- function(pkg, name) {
    pkg <- as.character(substitute(pkg))
    name <- as.character(substitute(name))
    if (exists(pkg)) UseMethod('::')
    else getExportedValue(pkg, name)
}

更新

下面是一个更安全的选项，可以防止在加载的包包含与使用:: 访问的包同名的对象时出错。

'::' <- function(pkg, name) {
    pkg.chr <- as.character(substitute(pkg))
    name.chr <- as.character(substitute(name))
    if (exists(pkg.chr)) {
        if (class(pkg) == 'import')
            return(get(name.chr, pkg))
    }
    getExportedValue(pkg.chr, name.chr)
}

这将给出正确的结果，例如，如果您加载了data.table，然后尝试使用:: 访问其中一个对象。

Answer 6

我已经实现了一个综合解决方案并将其作为一个包发布，“box”。

在内部，“盒子”模块使用类似于包的方法；也就是说，它将代码加载到专用的命名空间环境中，然后将选定的符号导出到返回给用户的模块环境中，并可选择附加。与包的主要区别在于模块更轻量级且更易于编写（每个 R 文件 都是自己的模块），并且可以嵌套。

包的使用有详细说明on its website。