Skip to content

Commit 10fa2c2

Browse files
committed
Rename public functions (JuliaIO#699)
1 parent 412bc69 commit 10fa2c2

File tree

3 files changed

+54
-18
lines changed

3 files changed

+54
-18
lines changed

src/HDF5.jl

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,23 @@ using Compat
1111

1212
export
1313
@read, @write,
14-
h5open, h5read, h5rewrite, h5writeattr, h5readattr, h5write,
15-
a_create, a_delete, a_open, a_read, a_write, attrs,
16-
d_create, d_create_external, d_open, d_read, d_write,
17-
g_create, g_open,
18-
o_copy, o_delete, o_open,
19-
t_create, t_commit,
20-
p_create, get_access_properties, get_create_properties,
21-
dataspace, datatype,
22-
file, filename, name,
23-
get_chunk, get_datasets,
24-
iscontiguous, ishdf5, ismmappable,
25-
root, readmmap, set_dims!
14+
h5open, h5read, h5write, h5rewrite, h5writeattr, h5readattr,
15+
dataspace, datatype, # unexport
16+
file, filename, name, # unexport
17+
get_chunk, get_datasets, # unexport
18+
iscontiguous, ishdf5, ismmappable, # unexport
19+
root, readmmap, set_dims!, # unexport
20+
get_access_properties, get_create_properties # unexport
2621
# Note: Public API requires module scoping
2722
### Public Functions:
28-
# g_info, o_info
23+
# create_attribute, open_attribute. delete_attribute, read_attribute, write_attribute, attributes,
24+
# create_dataset, create_external_dataset, open_dataset, read_dataset, write_dataset,
25+
# create_group, open_group,
26+
# copy_object, open_object,delete_object,
27+
# create_datatype, commit_datatype,
28+
# create_property
29+
30+
# group_info, object_info
2931
### Types:
3032
# H5DataStore, Attribute, File, Group, Dataset, Datatype, Opaque,
3133
# Dataspace, Object, Properties, VLen, ChunkStorage, Reference
@@ -910,11 +912,11 @@ Base.haskey(attr::Attributes, path::AbstractString) = h5a_exists(checkvalid(attr
910912
Base.haskey(dset::Union{Dataset,Datatype}, path::AbstractString) = h5a_exists(checkvalid(dset), path)
911913

912914
# Querying items in the file
913-
g_info(obj::Union{Group,File}) = h5g_get_info(checkvalid(obj))
914-
o_info(obj::Union{File,Object}) = h5o_get_info(checkvalid(obj))
915+
group_info(obj::Union{Group,File}) = h5g_get_info(checkvalid(obj))
916+
object_info(obj::Union{File,Object}) = h5o_get_info(checkvalid(obj))
915917

916918
Base.length(obj::Union{Group,File}) = h5g_get_num_objs(checkvalid(obj))
917-
Base.length(x::Attributes) = o_info(x.parent).num_attrs
919+
Base.length(x::Attributes) = object_info(x.parent).num_attrs
918920

919921
Base.isempty(x::Union{Dataset,Group,File}) = length(x) == 0
920922
function Base.size(obj::Union{Dataset,Attribute})

src/deprecated.jl

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -372,5 +372,35 @@ function g_create(f::Function, parent::Union{File,Group}, args...)
372372
end
373373
end
374374

375-
@deprecate info(obj::Union{Group,File}) g_info(obj) false
376-
@deprecate objinfo(obj::Union{File,Object}) o_info(obj) false
375+
376+
377+
### Changed in PR#696
378+
379+
@deprecate info(obj::Union{Group,File}) group_info(obj)
380+
@deprecate objinfo(obj::Union{File,Object}) object_info(obj)
381+
382+
# - rename bindings
383+
@deprecate a_create HDF5.create_attribute
384+
@deprecate a_delete HDF5.delete_attribute
385+
@deprecate a_open HDF5.open_attribute
386+
@deprecate a_read HDF5.read_attribute
387+
@deprecate a_write HDF5.write_attribute
388+
@deprecate attrs HDF5.attributes
389+
390+
@deprecate d_create HDF5.create_dataset
391+
@deprecate d_create_external HDF5.create_external_dataset
392+
@deprecate d_open HDF5.open_dataset
393+
@deprecate d_read HDF5.read_dataset
394+
@deprecate d_write HDF5.write_dataset
395+
396+
@deprecate g_create HDF5.create_group
397+
@deprecate g_open HDF5.open_group
398+
399+
@deprecate o_copy HDF5.copy_object
400+
@deprecate o_delete HDF5.delete_object
401+
@deprecate o_open HDF5.open_object
402+
403+
@deprecate p_create HDF5.create_property
404+
405+
@deprecate t_create HDF5.create_datatype
406+
@deprecate t_commit HDF5.commit_datatype

test/runtests.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,9 @@ try
2525
include("mpio.jl")
2626
catch
2727
end
28+
<<<<<<< HEAD
2829

30+
=======
31+
32+
>>>>>>> dd196c2 (Wrap all tests in a testset (#733))
2933
end

0 commit comments

Comments
 (0)