R/pickle.R

Defines functions py_save_object py_load_object

Documented in py_load_object py_save_object

#' Save and load Python objects with pickle
#'
#' @param object Object to save
#' @param filename File name
#' @param pickle The implementation of pickle to use (defaults to "pickle" but
#'   could e.g. also be "cPickle")
#' @param ... Optional arguments to be passed to the `load()` function defined
#'   by the associated `pickle` module.
#'
#' @export
py_save_object <- function(object, filename, pickle = "pickle", ...) {
  builtins <- import_builtins()
  pickle <- import(pickle)
  handle <- builtins$open(filename, "wb")
  on.exit(handle$close(), add = TRUE)
  pickle$dump(object, handle, protocol = pickle$HIGHEST_PROTOCOL, ...)
}

#' @rdname py_save_object
#' @export
py_load_object <- function(filename, pickle = "pickle", ...) {
  builtins <- import_builtins()
  pickle <- import(pickle)
  handle <- builtins$open(filename, "rb")
  on.exit(handle$close(), add = TRUE)
  pickle$load(handle, ...)
}
merlingrace/reticulate1 documentation built on Nov. 4, 2019, 6:25 p.m.