/usr/lib/python2.7/dist-packages/h5py/h5l.pyx is in python-h5py 2.2.1-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 | # This file is part of h5py, a Python interface to the HDF5 library.
#
# http://www.h5py.org
#
# Copyright 2008-2013 Andrew Collette and contributors
#
# License: Standard 3-clause BSD; see "license.txt" for full license terms
# and contributor agreement.
"""
API for the "H5L" family of link-related operations. Defines the class
LinkProxy, which comes attached to GroupID objects as <obj>.links.
"""
from _objects cimport pdefault
from h5p cimport PropID
from h5g cimport GroupID
from utils cimport emalloc, efree
# === Public constants ========================================================
TYPE_HARD = H5L_TYPE_HARD
TYPE_SOFT = H5L_TYPE_SOFT
TYPE_EXTERNAL = H5L_TYPE_EXTERNAL
cdef class LinkInfo:
cdef H5L_info_t infostruct
property type:
""" Integer type code for link (h5l.TYPE_*) """
def __get__(self):
return <int>self.infostruct.type
property corder_valid:
""" Indicates if the creation order is valid """
def __get__(self):
return <bint>self.infostruct.corder_valid
property corder:
""" Creation order """
def __get__(self):
return self.infostruct.corder
property cset:
""" Integer type code for character set (h5t.CSET_*) """
def __get__(self):
return self.infostruct.cset
property u:
""" Either the address of a hard link or the size of a soft/UD link """
def __get__(self):
if self.infostruct.type == H5L_TYPE_HARD:
return self.infostruct.u.address
else:
return self.infostruct.u.val_size
cdef class _LinkVisitor:
""" Helper class for iteration callback """
cdef object func
cdef object retval
cdef LinkInfo info
def __init__(self, func):
self.func = func
self.retval = None
self.info = LinkInfo()
cdef herr_t cb_link_iterate(hid_t grp, char* name, H5L_info_t *istruct, void* data) except 2:
# Standard iteration callback for iterate/visit routines
cdef _LinkVisitor it = <_LinkVisitor?>data
it.info.infostruct = istruct[0]
it.retval = it.func(name, it.info)
if (it.retval is None) or (not it.retval):
return 0
return 1
cdef herr_t cb_link_simple(hid_t grp, char* name, H5L_info_t *istruct, void* data) except 2:
# Simplified iteration callback which only provides the name
cdef _LinkVisitor it = <_LinkVisitor?>data
it.retval = it.func(name)
if (it.retval is None) or (not it.retval):
return 0
return 1
cdef class LinkProxy:
"""
Proxy class which provides access to the HDF5 "H5L" API.
These come attached to GroupID objects as "obj.links". Since every
H5L function operates on at least one group, the methods provided
operate on their parent group identifier. For example::
>>> g = h5g.open(fid, '/')
>>> g.links.exists("MyGroup")
True
>>> g.links.exists("FooBar")
False
* Hashable: No
* Equality: Undefined
"""
def __init__(self, hid_t id_):
# The identifier in question is the hid_t for the parent GroupID.
# We "borrow" this reference.
self.id = id_
def __richcmp__(self, object other, int how):
return NotImplemented
def __hash__(self):
raise TypeError("Link proxies are unhashable; use the parent group instead.")
def create_hard(self, char* new_name, GroupID cur_loc not None,
char* cur_name, PropID lcpl=None, PropID lapl=None):
""" (STRING new_name, GroupID cur_loc, STRING cur_name,
PropID lcpl=None, PropID lapl=None)
Create a new hard link in this group pointing to an existing link
in another group.
"""
H5Lcreate_hard(cur_loc.id, cur_name, self.id, new_name,
pdefault(lcpl), pdefault(lapl))
def create_soft(self, char* new_name, char* target,
PropID lcpl=None, PropID lapl=None):
"""(STRING new_name, STRING target, PropID lcpl=None, PropID lapl=None)
Create a new soft link in this group, with the given string value.
The link target does not need to exist.
"""
H5Lcreate_soft(target, self.id, new_name,
pdefault(lcpl), pdefault(lapl))
def create_external(self, char* link_name, char* file_name, char* obj_name,
PropID lcpl=None, PropID lapl=None):
"""(STRING link_name, STRING file_name, STRING obj_name,
PropLCID lcpl=None, PropLAID lapl=None)
Create a new external link, pointing to an object in another file.
"""
H5Lcreate_external(file_name, obj_name, self.id, link_name,
pdefault(lcpl), pdefault(lapl))
def get_val(self, char* name, PropID lapl=None):
"""(STRING name, PropLAID lapl=None) => STRING or TUPLE(file, obj)
Get the string value of a soft link, or a 2-tuple representing
the contents of an external link.
"""
cdef hid_t plist = pdefault(lapl)
cdef H5L_info_t info
cdef size_t buf_size
cdef char* buf = NULL
cdef char* ext_file_name = NULL
cdef char* ext_obj_name = NULL
cdef unsigned int wtf = 0
H5Lget_info(self.id, name, &info, plist)
if info.type != H5L_TYPE_SOFT and info.type != H5L_TYPE_EXTERNAL:
raise TypeError("Link must be either a soft or external link")
buf_size = info.u.val_size
buf = <char*>emalloc(buf_size)
try:
H5Lget_val(self.id, name, buf, buf_size, plist)
if info.type == H5L_TYPE_SOFT:
py_retval = buf
else:
H5Lunpack_elink_val(buf, buf_size, &wtf, &ext_file_name, &ext_obj_name)
py_retval = (bytes(ext_file_name), bytes(ext_obj_name))
finally:
efree(buf)
return py_retval
def move(self, char* src_name, GroupID dst_loc not None, char* dst_name,
PropID lcpl=None, PropID lapl=None):
""" (STRING src_name, GroupID dst_loc, STRING dst_name)
Move a link to a new location in the file.
"""
H5Lmove(self.id, src_name, dst_loc.id, dst_name, pdefault(lcpl),
pdefault(lapl))
def exists(self, char* name):
""" (STRING name) => BOOL
Check if a link of the specified name exists in this group.
"""
return <bint>(H5Lexists(self.id, name, H5P_DEFAULT))
def get_info(self, char* name, int index=-1, *, PropID lapl=None):
"""(STRING name=, INT index=, **kwds) => LinkInfo instance
Get information about a link, either by name or its index.
Keywords:
"""
cdef LinkInfo info = LinkInfo()
H5Lget_info(self.id, name, &info.infostruct, pdefault(lapl))
return info
def visit(self, object func, *,
int idx_type=H5_INDEX_NAME, int order=H5_ITER_NATIVE,
char* obj_name='.', PropID lapl=None, bint info=0):
"""(CALLABLE func, **kwds) => <Return value from func>
Iterate a function or callable object over all groups below this
one. Your callable should conform to the signature::
func(STRING name) => Result
or if the keyword argument "info" is True::
func(STRING name, LinkInfo info) => Result
Returning None or a logical False continues iteration; returning
anything else aborts iteration and returns that value.
BOOL info (False)
Provide a LinkInfo instance to callback
STRING obj_name (".")
Visit this subgroup instead
PropLAID lapl (None)
Link access property list for "obj_name"
INT idx_type (h5.INDEX_NAME)
INT order (h5.ITER_NATIVE)
"""
cdef _LinkVisitor it = _LinkVisitor(func)
cdef H5L_iterate_t cfunc
if info:
cfunc = cb_link_iterate
else:
cfunc = cb_link_simple
H5Lvisit_by_name(self.id, obj_name, <H5_index_t>idx_type,
<H5_iter_order_t>order, cfunc, <void*>it, pdefault(lapl))
return it.retval
def iterate(self, object func, *,
int idx_type=H5_INDEX_NAME, int order=H5_ITER_NATIVE,
char* obj_name='.', PropID lapl=None, bint info=0,
hsize_t idx=0):
"""(CALLABLE func, **kwds) => <Return value from func>, <index to restart at>
Iterate a function or callable object over all groups in this
one. Your callable should conform to the signature::
func(STRING name) => Result
or if the keyword argument "info" is True::
func(STRING name, LinkInfo info) => Result
Returning None or a logical False continues iteration; returning
anything else aborts iteration and returns that value.
BOOL info (False)
Provide a LinkInfo instance to callback
STRING obj_name (".")
Visit this subgroup instead
PropLAID lapl (None)
Link access property list for "obj_name"
INT idx_type (h5.INDEX_NAME)
INT order (h5.ITER_NATIVE)
hsize_t idx (0)
The index to start iterating at
"""
cdef _LinkVisitor it = _LinkVisitor(func)
cdef H5L_iterate_t cfunc
if info:
cfunc = cb_link_iterate
else:
cfunc = cb_link_simple
H5Literate_by_name(self.id, obj_name, <H5_index_t>idx_type,
<H5_iter_order_t>order, &idx,
cfunc, <void*>it, pdefault(lapl))
return it.retval, idx
|