B i\l5@sdZddlmZddlZddlZddlmZddlmZddl m Z ddl m Z ddl Z ddlZd d ZGd d d eZe jGd ddejeZe jGdddejeZdS)a Create links in the HDF5 file. This module implements containers for soft and external links. Hard links doesn't need a container as such as they are the same as regular nodes (groups or leaves). Classes: SoftLink ExternalLink Functions: Misc variables: )absolute_importN) linkextension)Node)lazyattr) AttributeSetcCs t||S)zGuess the link class.)rZ_get_link_class)Z parent_idnamer *lib/python3.7/site-packages/tables/link.py_g_get_link_class)sr cs\eZdZdZeddZdfdd Zddd Zdd d Zd d Z dddZ ddZ Z S)LinkaAbstract base class for all PyTables links. A link is a node that refers to another node. The Link class inherits from Node class and the links that inherits from Link are SoftLink and ExternalLink. There is not a HardLink subclass because hard links behave like a regular Group or Leaf. Contrarily to other nodes, links cannot have HDF5 attributes. This is an HDF5 library limitation that might be solved in future releases. See :ref:`LinksTutorial` for a small tutorial on how to work with links. .. rubric:: Link attributes .. attribute:: target The path string to the pointed node. cCsGdddt}||S)z A *NoAttrs* instance replacing the typical *AttributeSet* instance of other node objects. The purpose of *NoAttrs* is to make clear that HDF5 attributes are not supported in link nodes. c@s$eZdZddZddZddZdS)zLink._v_attrs..NoAttrscSstd|jjdS)Nz1you cannot get attributes from this `%s` instance)KeyError __class____name__)selfrr r r __getattr__Msz*Link._v_attrs..NoAttrs.__getattr__cSstd|jjdS)Nz/you cannot set attributes to this `%s` instance)r rr)rrvaluer r r __setattr__Qsz*Link._v_attrs..NoAttrs.__setattr__cSsdS)Nr )rr r r _g_closeUsz'Link._v_attrs..NoAttrs._g_closeN)r __module__ __qualname__rrrr r r r NoAttrsLsr)r)rrr r r _v_attrsEs z Link._v_attrsNFcs(|dk |_||_tt||||dS)N)Z_v_newtargetsuperr __init__)r parentnoderr_log)rr r rYs z Link.__init__cCs&|j||||d}|j||d|S)zCopy this link and return the new one. See :meth:`Node._f_copy` for a complete explanation of the arguments. Please note that there is no recursive flag since links do not have child nodes. ) newparentnewname overwrite createparentsT)Z_f_copy _v_parentZ _g_refnode)rrrr r!Znewnoder r r copyas z Link.copycCs|j|||dS)zrMove or rename this link. See :meth:`Node._f_move` for a complete explanation of the arguments. )rrr )Z_f_move)rrrr r r r moversz Link.movecCs|S)z$Remove this link from the hierarchy.)Z _f_remove)rr r r remove|sz Link.removecCs|j||dS)zuRename this link in place. See :meth:`Node._f_rename` for a complete explanation of the arguments. )rr )Z _f_rename)rrr r r r renamesz Link.renamecCst|S)N)str)rr r r __repr__sz Link.__repr__)NF)NNFF)NNF)NF) rrr__doc__rrrr#r$r%r&r( __classcell__r r )rr r 0s    r c@s\eZdZdZdZdZdZddZddZd d Z d d Z d dZ ddZ ddZ ddZdS)SoftLinka,Represents a soft link (aka symbolic link). A soft link is a reference to another node in the *same* file hierarchy. Provided that the target node exists, its attributes and methods can be accessed directly from the softlink using the normal `.` syntax. Softlinks also have the following public methods/attributes: * `target` * `dereference()` * `copy()` * `move()` * `remove()` * `rename()` * `is_dangling()` Note that these will override any correspondingly named methods/attributes of the target node. For backwards compatibility, it is also possible to obtain the target node via the `__call__()` special method (this action is called *dereferencing*; see below) Examples -------- :: >>> f = tables.open_file('/tmp/test_softlink.h5', 'w') >>> a = f.create_array('/', 'A', np.arange(10)) >>> link_a = f.create_soft_link('/', 'link_A', target='/A') # transparent read/write access to a softlinked node >>> link_a[0] = -1 >>> print(link_a[:], link_a.dtype) (array([-1, 1, 2, 3, 4, 5, 6, 7, 8, 9]), dtype('int64')) # dereferencing a softlink using the __call__() method >>> print(link_a() is a) True # SoftLink.remove() overrides Array.remove() >>> link_a.remove() >>> print(link_a) >>> print(a[:], a.dtype) (array([-1, 1, 2, 3, 4, 5, 6, 7, 8, 9]), dtype('int64')) ZSOFTLINK) r dereference is_danglingr#r$r%r&r__str__r(Z __unicode__r__dict__)Z_f_Z_c_Z_g_Z_v_cCs|S)a;Dereference `self.target` and return the object. Examples -------- :: >>> f=tables.open_file('data/test.h5') >>> print(f.root.link0) /link0 (SoftLink) -> /another/path >>> print(f.root.link0()) /another/path (Group) '' )r,)rr r r __call__szSoftLink.__call__cCs:|jr2|j}|jds&|j|j}|j|SdSdS)N/) _v_isopenr startswithr"_g_join_v_file _get_node)rrr r r r,s   zSoftLink.dereferencecCsx|tjks|ddtjkr(t||S|js:tdn:|rFdS| }y ||St k rr| |SXdS)Nzthe node object is closed) r+_link_attrnames_link_attrprefixesobject__getattribute__r2tablesClosedNodeErrorr-r,AttributeErrorr)rattrnameZ target_noder r r r;s    zSoftLink.__getattribute__cCsd|tjks|ddtjkr,t|||n4|js>tdn"|rPt dn| ||dS)Nr7zthe node object is closedzsoftlink target does not exist) r+r8r9r:rr2r<r=r- ValueErrorr,)rr?rr r r rs   zSoftLink.__setattr__cCs6|jstdn |r$tdn||SdS)zd__getitem__ must be defined in the SoftLink class in order for array indexing syntax to workzthe node object is closedzsoftlink target does not existN)r2r<r=r-r@r, __getitem__)rkeyr r r rAs   zSoftLink.__getitem__cCs8|jstdn"|r$tdn|||dS)zd__setitem__ must be defined in the SoftLink class in order for array indexing syntax to workzthe node object is closedzsoftlink target does not existN)r2r<r=r-r@r, __setitem__)rrBrr r r rCs   zSoftLink.__setitem__cCs||jkS)N)r,r5)rr r r r-%szSoftLink.is_danglingcCsf|jj}t|j}|jds,|j|j}|jr8d}nd}||jkrLd}nd}d||j ||j|fS)zReturn a short string representation of the link. Examples -------- :: >>> f=tables.open_file('data/test.h5') >>> print(f.root.link0) /link0 (SoftLink) -> /path/to/node r1zclosed z (dangling)z%s%s (%s) -> %s%s) rrr'rr3r"r4r2r5 _v_pathname)r classnamerclosedZdanglingr r r r.)s    zSoftLink.__str__N)rrrr) _c_classidr8r9r0r,r;rrArCr-r.r r r r r+s3   r+csReZdZdZdZdfdd ZddZd d Zd d Zfd dZ ddZ Z S) ExternalLinkaRepresents an external link. An external link is a reference to a node in *another* file. Getting access to the pointed node (this action is called *dereferencing*) is done via the :meth:`__call__` special method (see below). .. rubric:: ExternalLink attributes .. attribute:: extfile The external file handler, if the link has been dereferenced. In case the link has not been dereferenced yet, its value is None. Z EXTERNALLINKNFcs d|_tt|||||dS)N)extfilerrIr)rrrrr)rr r r_szExternalLink.__init__cCs|jd\}}|d|fS)z=Return the external filename and nodepath from `self.target`.z:/r1)rsplit)rfilenamerr r r _get_filename_nodefszExternalLink._get_filename_nodecKs|\}}tj|s6tj|jj}tj||}|jdksH|jj sZt j |f||_n(|jj|ksjt |jj |ddkst |j|S)aDereference self.target and return the object. You can pass all the arguments supported by the :func:`open_file` function (except filename, of course) so as to open the referenced external file. Examples -------- :: >>> f=tables.open_file('data1/test1.h5') >>> print(f.root.link2) /link2 (ExternalLink) -> data2/test2.h5:/path/to/node >>> plink2 = f.root.link2('a') # open in 'a'ppend mode >>> print(plink2) /path/to/node (Group) '' >>> print(plink2._v_filename) 'data2/test2.h5' # belongs to referenced file Nmoder)rMospathisabsdirnamer5rLjoinrJisopenr<Z open_fileAssertionErrorrNgetr6)rkwargsrLrZbase_directoryr r r r0ms  zExternalLink.__call__cCs&|j}|dk r"|jr"|d|_dS)z'Safely unmount self.extfile, if opened.N)rJrUclose)rrJr r r umountszExternalLink.umountcs|tt|dS)z#Especific close for external links.N)rZrrI_f_close)r)rr r r[szExternalLink._f_closecCs|jj}d|j||jfS)aReturn a short string representation of the link. Examples -------- :: >>> f=tables.open_file('data1/test1.h5') >>> print(f.root.link2) /link2 (ExternalLink) -> data2/test2.h5:/path/to/node z %s (%s) -> %s)rrrEr)rrFr r r r.szExternalLink.__str__)NF) rrrr)rHrrMr0rZr[r.r*r r )rr rIHs( rI)r)Z __future__rrPr<rDrZnoderZutilsrZ attributesetrZsixZ tables.filer r Zpython_2_unicode_compatibler+rIr r r r s      ^ :