1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
.. _hlfile:
============
File Objects
============
Opening & creating files
------------------------
HDF5 files work generally like standard Python file objects. They support
standard modes like r/w/a, and should be closed when they are no longer in
use. However, there is obviously no concept of "text" vs "binary" mode.
>>> f = h5py.File('myfile.hdf5','r')
The file name may be either ``str`` or ``unicode``. Valid modes are:
=== ================================================
r Readonly, file must exist
r+ Read/write, file must exist
w Create file, truncate if exists
w- Create file, fail if exists
a Read/write if exists, create otherwise (default)
=== ================================================
File drivers
------------
HDF5 ships with a variety of different low-level drivers, which map the logical
HDF5 address space to different storage mechanisms. You can specify which
driver you want to use when the file is opened::
>>> f = h5py.File('myfile.hdf5', driver=<driver name>, <driver_kwds>)
For example, the HDF5 "core" driver can be used to create a purely in-memory
HDF5 file, optionally written out to disk when it is closed. See the File
class documentation for an exhaustive list.
Reference
---------
In addition to the properties and methods defined here, File objects inherit
the full API of Group objects; in this case, the group in question is the
*root group* (/) of the file.
.. note::
Please note that unlike Python file objects, and h5py.File objects from
h5py 1.1, the attribute ``File.name`` does *not* refer to the file name
on disk. ``File.name`` gives the HDF5 name of the root group, "``/``". To
access the on-disk name, use ``File.filename``.
.. autoclass:: h5py.File
**File properties**
.. autoattribute:: h5py.File.filename
.. autoattribute:: h5py.File.mode
.. autoattribute:: h5py.File.driver
**File methods**
.. automethod:: h5py.File.close
.. automethod:: h5py.File.flush
**Properties common to all HDF5 objects:**
.. autoattribute:: h5py.File.file
.. autoattribute:: h5py.File.parent
.. autoattribute:: h5py.File.name
.. autoattribute:: h5py.File.id
.. autoattribute:: h5py.File.ref
.. autoattribute:: h5py.File.attrs
|
