Add ignore to savename #123 from xukai92/master

Author: Datseris

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.9.0
+* `savename` now has the `ignore` option.
+
 # 1.8.0
 * `@quickactivate` was enhanced to allow projects that also represent a module.
 * `initialize_project` no resolves the folder name for naming the project if the path is given as "." or ".."

Project.toml

@@ -1,9 +1,7 @@
 name = "DrWatson"
 uuid = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
 repo = "https://github.com/JuliaDynamics/DrWatson.jl.git"
-version = "1.8.1"
-
-
+version = "1.9.0"
 
 [deps]
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"

docs/src/name.md

@@ -18,20 +18,21 @@ Notice that this naming scheme integrates perfectly with Parameters.jl.
 Convenience functions are provided to shorten common function calls and easily create named tuples, dictionaries as well as switch between them:
 ```@docs
 @dict
-@savename
 @strdict
 @ntuple
+@savename
 ntuple2dict
 dict2ntuple
 ```
 
 ## Customizing `savename`
 You can customize [`savename`](@ref) for your own Types. For example you could make it so that it only uses some specific keys instead of all of them, only specific types, or you could make it access data in a different way (maybe even loading files!). You can even make it have a custom `prefix`!
 
-To do that you may extend the following functions:
+To do that you may extend any of the following functions:
 ```@docs
 DrWatson.allaccess
 DrWatson.access
+DrWatson.allingore
 DrWatson.default_allowed
 DrWatson.default_prefix
 DrWatson.default_expand

src/naming.jl

@@ -27,15 +27,19 @@ See [`default_prefix`](@ref) for more.
 
 `savename` can be very conveniently combined with
 [`@dict`](@ref) or [`@ntuple`](@ref).
-See also [`parse_savename`](@ref).
+See also [`parse_savename`](@ref) and [`@savename`](@ref).
 
 ## Keywords
 * `allowedtypes = default_allowed(c)` : Only values of type subtyping
   anything in `allowedtypes` are used in the name. By default
   this is `(Real, String, Symbol)`.
-* `accesses = allaccess(c)` : You can also specify which specific keys you want
+* `accesses = allaccess(c)` : pecify which specific keys you want
   to use with the keyword `accesses`. By default this is all possible
   keys `c` can be accessed with, see [`allaccess`](@ref).
+* `ignores = allignore(c)` : You can also specify keys that you want
+  to ignore with the keyword `ignores`. By default this is an empty
+  tuple, see [`allignore`](@ref).
+  (keys in `ignore` are ignored even if they are in `accesses`)
 * `digits = 3` : Floating point values are rounded to `digits`.
   In addition if the following holds:
   ```julia
@@ -44,7 +48,7 @@ See also [`parse_savename`](@ref).
   then the integer value is used in the name instead.
 * `scientific = nothing` : Number of significant digits used for rounding of
   floating point values using scientific notation (e.g. `1.65e-7`).
-  If `nothing`, normal rounding is done. 
+  If `nothing`, normal rounding is done.
 * `connector = "_"` : string used to connect the various entries.
 * `expand::Vector{String} = default_expand(c)` : keys that will be expanded
   to the `savename` of their contents, to allow for nested containers.
@@ -68,6 +72,7 @@ savename(d, allowedtypes = (String,)) == "mode=double"
 
 rick = (never = "gonna", give = "you", up = "!");
 savename(rick) == "give=you_never=gonna_up=!" # keys are sorted!
+savename(rick; ignores = ["up"]) == "give=you_never=gonna"
 ```
 """
 savename(c; kwargs...) = savename(default_prefix(c), c, ""; kwargs...)
@@ -76,7 +81,7 @@ savename(c::Any, suffix::String; kwargs...) =
 savename(prefix::String, c::Any; kwargs...) = savename(prefix, c, ""; kwargs...)
 function savename(prefix::String, c, suffix::String;
                   allowedtypes = default_allowed(c),
-                  accesses = allaccess(c), digits = 3,
+                  accesses = allaccess(c), ignores = allignore(c), digits = 3,
                   connector = "_", expand::Vector{String} = default_expand(c),
                   scientific::Union{Int,Nothing}=nothing)
 
@@ -86,13 +91,16 @@ function savename(prefix::String, c, suffix::String;
         prefix = joinpath(prefix, dpre)
     end
 
+    # Perform access and ignore logic and sort
     labels = vecstring(accesses) # make it vector of strings
+    ignored_labels = vecstring(ignores)
     p = sortperm(labels)
     first = prefix == "" || endswith(prefix, PATH_SEPARATOR)
     s = prefix
     for j ∈ p
-        val = access(c, accesses[j])
         label = labels[j]
+        label ∈ ignored_labels && continue
+        val = access(c, accesses[j])
         t = typeof(val)
         if any(x -> (t <: x), allowedtypes)
             val = roundval(val,digits=digits,scientific=scientific)
@@ -173,6 +181,13 @@ access(c, keys...) = access(access(c, keys[1]), Base.tail(keys)...)
 access(c::AbstractDict, key) = getindex(c, key)
 access(c, key) = getproperty(c, key)
 
+"""
+    allignore(c)
+Return all the keys `c` that will be ignored in [`savename`](@ref).
+This is an empty tuple by default.
+"""
+allignore(c::Any) = ()
+
 """
     default_allowed(c) = (Real, String, Symbol)
 Return the (super-)Types that will be used as `allowedtypes`

test/naming_tests.jl

@@ -14,6 +14,7 @@ d = (a = 0.153456453, b = 5.0, mode = "double")
 
 rick = (never = "gonna", give = "you", up = "!");
 @test savename(rick) == "give=you_never=gonna_up=!"
+@test savename(rick; ignores = ["up"]) == "give=you_never=gonna"
 
 x = 3; y = 5.0;
 d = Dict(:x => x, :y => y)
@@ -26,11 +27,15 @@ n = (x = x, y = y)
 
 z = "lala"
 d2 = Dict(:x => x, :y => y, :z => z)
-n2 = (x = x, y = y, z= z)
+n2 = (x = x, y = y, z = z)
 
 @test d2 == @dict x y z
 @test n2 == @ntuple x y z
 
+@test savename(n2; ignores=(:y,))  == "x=3_z=lala"
+@test savename(n2; ignores=("y",)) == "x=3_z=lala"
+@test savename(n2; accesses=(:x, :y), ignores=(:y,)) == "x=3"
+
 @test savename(@dict x y) == "x=3_y=5"
 @test savename(@ntuple x y) == "x=3_y=5"
 w = rand(50)