Merge pull request #28 from dahong67/drop-bson-mod

Set compat for BSON and drop bson_mod

Author: dahong67

Project.toml

@@ -15,7 +15,7 @@ Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 
 [compat]
-BSON = "0.3.4"
+BSON = "0.3.9"
 Dates = "1.10"
 ExpressionExplorer = "1.1.3"
 JLD2 = "0.6.3"

README.md

@@ -207,18 +207,6 @@ end
 end
 ```
 
-The module context for loading BSON files can be set via the `bson_mod` keyword argument:
-
-```julia
-cache("data.bson"; bson_mod = @__MODULE__) do
-    # cached computations
-end
-```
-
-This may be useful when working in modules or in Pluto notebooks
-(see the [BSON.jl documentation](https://github.com/JuliaIO/BSON.jl?tab=readme-ov-file#loading-custom-data-types-within-modules)
-for more detail).
-
 ## Example: Caching the results of a sweep
 
 It can be common to need to cache the results of a large sweep (e.g., over parameters or trials of a simulation).

src/function.jl

@@ -1,7 +1,7 @@
 # Function form
 
 """
-    cache(f, path; overwrite=false, bson_mod=Main)
+    cache(f, path; overwrite=false)
 
 Cache the output of running `f()` in a cache file at `path`.
 The output is loaded if the file exists and is saved otherwise.
@@ -20,7 +20,6 @@ e.g., to only cache a sweep when the full set is ready.
 
 If `overwrite` is set to true, existing cache files will be overwritten
 with the results (and metadata) from a "fresh" call to `f()`.
-If necessary, the module to use for BSON can be set with `bson_mod`.
 
 Tip: Use a `do...end` block to cache the results of a block of code.
 
@@ -54,7 +53,7 @@ julia> cache(nothing) do
 (a = "a very time-consuming quantity to compute", b = "a very long simulation to run")
 ```
 """
-function cache(@nospecialize(f), path::AbstractString; overwrite = false, bson_mod = Main)
+function cache(@nospecialize(f), path::AbstractString; overwrite = false)
     # Check file extension
     ext = splitext(path)[2]
     (ext == ".bson" || ext == ".jld2") ||
@@ -102,7 +101,7 @@ function cache(@nospecialize(f), path::AbstractString; overwrite = false, bson_m
     else
         # Load metadata and output
         if ext == ".bson"
-            data = BSON.load(path, bson_mod)
+            data = BSON.load(path)
             version = data[:version]
             whenrun = data[:whenrun]
             runtime = data[:runtime]

src/macro.jl

@@ -1,7 +1,7 @@
 # Macro form
 
 """
-    @cache path begin ... end [overwrite=true, bson_mod=@__MODULE__]
+    @cache path begin ... end [overwrite=true]
 
 Cache the variables assigned in the `begin...end` block as well as the final result.
 Cached values are loaded if the file exists; the code is run and values are saved if not.
@@ -79,7 +79,7 @@ end
 
 function _cache_block(mod, path, block, kwexprs...)
     # Process keyword arguments
-    kwdict = Dict(:overwrite => false, :bson_mod => :(@__MODULE__))
+    kwdict = Dict{Symbol,Any}(:overwrite => false)
     for expr in kwexprs
         if @capture(expr, lhs_ = rhs_) && haskey(kwdict, lhs)
             kwdict[lhs] = rhs

test/items/general.jl

@@ -50,7 +50,7 @@ end
             rm(modpath)
 
             # 5. Save and check the output
-            out = cache(modpath; bson_mod = @__MODULE__) do
+            out = cache(modpath) do
                 return DataFrame(; a = 1:10, b = 'a':'j')
             end
             @test out == DataFrame(; a = 1:10, b = 'a':'j')
@@ -59,7 +59,7 @@ end
             out = nothing
 
             # 7. Load and check the output
-            out = cache(modpath; bson_mod = @__MODULE__) do
+            out = cache(modpath) do
                 return DataFrame(; a = 1:10, b = 'a':'j')
             end
             @test out == DataFrame(; a = 1:10, b = 'a':'j')