Deprecate exists to haskey and names to keys and bump minor version in prep for HDF5 release (#156)

* Deprecate exists to haskey

* Deprecate names -> keys as well

* Maintain link through common binding while deprecating

Co-authored-by: Justin Willmert <[email protected]>

Author: musm

Project.toml

@@ -1,6 +1,6 @@
 name = "MAT"
 uuid = "23992714-dd62-5051-b70f-ba57cb901cac"
-version = "0.9.2"
+version = "0.10.0"
 
 [deps]
 BufferedStreams = "e1450e63-4bb3-523b-b2a4-4ffa8c0fd77d"

README.md

@@ -68,7 +68,7 @@ To check for the presence of a variable name in a MAT file:
 
 ```julia
 file = matopen("matfile.mat")
-if exists(file, "variable")
+if haskey(file, "variable")
     # something
 end
 close(file)

src/MAT.jl

@@ -25,14 +25,13 @@
 module MAT
 
 using HDF5, SparseArrays
-import HDF5: exists
 
 include("MAT_HDF5.jl")
 include("MAT_v5.jl")
 
 using .MAT_HDF5, .MAT_v5
 
-export matopen, matread, matwrite, exists, @read, @write
+export matopen, matread, matwrite, @read, @write
 
 # Open a MATLAB file
 const HDF5_HEADER = UInt8[0x89, 0x48, 0x44, 0x46, 0x0d, 0x0a, 0x1a, 0x0a]
@@ -116,7 +115,7 @@ read or write without creation or truncation.
 Compression on reading is detected/handled automatically; the compress
 keyword argument only affects write operations.
 
-Use with `read`, `write`, `close`, `names`, and `exists`.
+Use with `read`, `write`, `close`, `keys`, and `haskey`.
 """
 matopen
 
@@ -161,5 +160,20 @@ function matwrite(filename::AbstractString, dict::AbstractDict{S, T}; compress::
         close(file)
     end
 end
+
+###
+### v0.10.0 deprecations
+###
+
+import HDF5: exists
+export exists
+@noinline function exists(matfile::Union{MAT_v5.Matlabv5File,MAT_HDF5.MatlabHDF5File}, varname::String)
+    Base.depwarn("`exists(matfile, varname)` is deprecated, use `haskey(matfile, varname)` instead.", :exists)
+    return haskey(matfile, varname)
+end
+@noinline function Base.names(matfile::Union{MAT_v5.Matlabv5File,MAT_HDF5.MatlabHDF5File})
+    Base.depwarn("`names(matfile)` is deprecated, use `keys(matfile)` instead.", :names)
+    return keys(matfile)
 end
 
+end

src/MAT_HDF5.jl

@@ -29,9 +29,6 @@
 module MAT_HDF5
 
 using HDF5, SparseArrays
-# deprecated for HDF5 v0.14+, but use deprecated binding to have common function with
-# e.g. JLD.jl
-import HDF5: exists
 
 import Base: names, read, write, close
 import HDF5: Reference
@@ -269,25 +266,21 @@ function read(f::MatlabHDF5File, name::String)
 end
 
 """
-    names(matfile_handle) -> Vector{String}
+    keys(matfile_handle) -> Vector{String}
 
 Return a list of variables in an opened Matlab file.
 
 See `matopen`.
 """
-names(f::MatlabHDF5File) = keys(f)
+Base.keys(f::MatlabHDF5File) = filter!(x -> x!="#refs#" && x!="#subsystem#", keys(f.plain))
 
 """
-    exists(matfile_handle, varname) -> Bool
+    haskey(matfile_handle, varname) -> Bool
 
 Return true if a variable is present in an opened Matlab file.
 
 See `matopen`.
 """
-exists(p::MatlabHDF5File, path::String) = haskey(p, path)
-
-# HDF5v0.14+ H5DataStore uses keys/haskey
-Base.keys(f::MatlabHDF5File) = filter!(x -> x!="#refs#" && x!="#subsystem#", keys(f.plain))
 Base.haskey(p::MatlabHDF5File, path::String) = haskey(p.plain, path)
 
 ### Writing

src/MAT_v5.jl

@@ -27,10 +27,7 @@
 
 module MAT_v5
 using CodecZlib, BufferedStreams, HDF5, SparseArrays
-import Base: names, read, write, close
-# deprecated for HDF5 v0.14+, but use deprecated binding to have common function with
-# e.g. JLD.jl
-import HDF5: exists
+import Base: read, write, close
 
 round_uint8(data) = round.(UInt8, data)
 complex_array(a, b) = complex.(a, b)
@@ -401,9 +398,6 @@ function getvarnames(matfile::Matlabv5File)
     matfile.varnames
 end
 
-exists(matfile::Matlabv5File, varname::String) = haskey(matfile, varname)
-names(matfile::Matlabv5File) = keys(matfile)
-# HDF5v0.14+ DataFile uses keys/haskey
 Base.haskey(matfile::Matlabv5File, varname::String) =
     haskey(getvarnames(matfile), varname)
 Base.keys(matfile::Matlabv5File) =

test/read.jl

@@ -3,7 +3,7 @@ using MAT, Test
 function check(filename, result)
     matfile = matopen(filename)
     for (k, v) in result
-        @test exists(matfile, k)
+        @test haskey(matfile, k)
         got = read(matfile, k)
         if !isequal(got, v) || (typeof(got) != typeof(v) && (!isa(got, String) || !(isa(v, String))))
             close(matfile)
@@ -20,7 +20,7 @@ function check(filename, result)
                 """)
         end
     end
-    @test union!(Set(), names(matfile)) == union!(Set(), keys(result))
+    @test union!(Set(), keys(matfile)) == union!(Set(), keys(result))
     close(matfile)
 
     mat = matread(filename)