a =_?l@sdZddlmZddlZddlZddlZddlZddlZddl Z dZ ddgZ Gdddej Z Gd d d eZGd d d ee ZGd ddee ZddZdddZdddZdddZdS)aA file interface to nodes for PyTables databases. The FileNode module provides a file interface for using inside of PyTables database files. Use the new_node() function to create a brand new file node which can be read and written as any ordinary Python file. Use the open_node() function to open an existing (i.e. created with new_node()) node for read-only or read-write access. Read acces is always available. Write access (enabled on new files and files opened with mode 'a+') only allows appending data to a file node. Currently only binary I/O is supported. See :ref:`filenode_usersguide` for instructions on use. .. versionchanged:: 3.0 In version 3.0 the module as been completely rewritten to be fully compliant with the interfaces defined in the :mod:`io` module. )absolute_importNfilecseZdZdZdddddgZd0fdd Zedd Zd d Zd1d dZ ddZ ddZ fddZ ddZ d2ddZddZddZddZd3d d!Zd"d#Zfd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/ZZS)4 RawPyTablesIOz;Base class for raw binary I/O on HDF5 files using PyTables.NcCs|dfS)Nrlrr4lib/python3.9/site-packages/tables/nodes/filenode.py9zRawPyTablesIO.cCs|fSNrrrrr r :r cstt||||||dur4|jj}n|||||jj||_ ||_ d|_ t |j j|_|j|j|_|jjjj|_dS)Nr)superr__init__ _check_node_check_attributes_v_filemode _check_mode_cross_check_mode_node_mode_posintattrsNODE_TYPE_VERSION_version_size_to_shape_vshapeatomdtypebasetype_vtype)selfnoder __class__rr r=s    zRawPyTablesIO.__init__cCs|jS)z File mode.rr$rrr rQszRawPyTablesIO.modecCs||jS)zReturn current stream position.) _checkClosedrr)rrr tellXszRawPyTablesIO.tellrcCs|z |}Wnty.tdYn0|dkrV|dkrNtd|f||_nB|dkrrtd|j||_n&|dkrtd|jj||_ntd|jS)aChange stream position. Change the stream position to byte offset offset. offset is interpreted relative to the position indicated by whence. Values for whence are: * 0 -- start of stream (the default); offset should be zero or positive * 1 -- current stream position; offset may be negative * 2 -- end of stream; offset is usually negative Return the new absolute position. zan integer is requiredrznegative seek position %rrrzinvalid whence value) r* __index__AttributeError TypeError ValueErrorrmaxrnrows)r$poswhencerrr seek_s  zRawPyTablesIO.seekcCsdS)zReturn whether object supports random access. If False, seek(), tell() and truncate() will raise IOError. This method may need to do a test seek(). Trr)rrr seekableszRawPyTablesIO.seekablecCs||jjdS)zReturns underlying file descriptor if one exists. An IOError is raised if the IO object does not use a file descriptor. N)r*rrfilenor)rrr r6szRawPyTablesIO.filenocsH|js"t|jdddur"tdztt|Wd|_nd|_0dS)zjFlush and close the IO object. This method has no effect if the file is already closed. rN%host PyTables file is already closed!)closedgetattrrwarningswarnrrcloser)r&rr r<s  zRawPyTablesIO.closecCs||jdS)zvFlush write buffers, if applicable. This is not implemented for read-only and non-blocking streams. N)r*rflushr)rrr r=szRawPyTablesIO.flushcCsf|||dur |j}n|dkr6td|f||jjkrJtd|||jj||S)a Truncate file to size bytes. Size defaults to the current IO position as reported by tell(). Return the new size. Currently, this method only makes sense to grow the file node, since data can not be rewritten nor deleted. Nrznegative truncate position %rz-truncating is only allowed for growing a file) r*_checkWritablerr/rr1IOError _append_zerosr4)r$r2rrr truncates  zRawPyTablesIO.truncatecCs|j}d|vpd|vS)zeReturn whether object was opened for reading. If False, read() will raise IOError. r+r(r$rrrr readableszRawPyTablesIO.readablecCs|j}d|vpd|vpd|vS)zuReturn whether object was opened for writing. If False, write() and truncate() will raise IOError. warCr(rDrrr writableszRawPyTablesIO.writablecCs|||j|jjkr"dSt|}|j}|j|}||jjkrV|jj}||}|j|||d|<|j|7_|S)zRead up to len(b) bytes into b. Returns number of bytes read (0 for EOF), or None if the object is set not to block as has no data to read. rN)r*_checkReadablerrr1lenreadZtostring)r$bnstartstoprrr readintos  zRawPyTablesIO.readintoc Csx|||jjr$|jjdnd}d}t|}|}g}d}|sn|dkrZ||}n|t||}t|} || 8}| |kr||} n | dkrd}q@n||d}q@| dkr| || } | dkr|d| } | | d|| 7}n|} d}nT|dkrJ|dks|dkrJ|d| d} | | dd||d7}n|} || |dkr@|dkr@d}q@d |S) a*Read and return a line from the stream. If limit is specified, at most limit bytes will be read. The line terminator is always ``\n`` for binary files; for text files, the newlines argument to open can be used to select the line terminator(s) recognized. rrQ FTNrr ) r*rIrZ chunkshaperJrKminfindappendr4join) r$limitZ chunksizeZlsepZlseplenZremsizepartialZfinishedZibuffZibufflenZeolindexZtrailingZobuffrrr readline sN       zRawPyTablesIO.readlinecCs||t|tr"tdt|}|dkr6dS|j}||jj}|dkrZ| ||j t j ||j ||d|j|7_|S)zWrite the given buffer to the IO stream. Returns the number of bytes written, which may be less than len(b). z can't write str to binary streamr)bufferr shape)r*r> isinstancestrr.rJrrr1r@rUnpZndarrayr#r)r$rLrMr2Zend2offrrr writeZs    zRawPyTablesIO.writecs,tt|t|jdddur(tddS)zChecks if file node is open. Checks whether the file node is open or has been closed. In the second case, a ValueError is raised. If the host PyTables has been closed, ValueError is also raised. rNr7)rrr*r9rr/r)r&rr r*|s zRawPyTablesIO._checkClosedcCs.t|tjstdt|jtjs*tddS)Nz.the "node" parameter should be a tables.EArrayz,only nodes with atom "UInt8Atom" are allowed)r\tablesEArrayr.r UInt8Atomr$r%rrr rs zRawPyTablesIO._check_nodecCst|tstd|t|}|tds:t|t|krFtd|d|v}d|v}d|v}d|v}d|v}d|vr|s~|rtd d }|r|rtd |||d krtd |s|s|stddS)Nzinvalid mode: %rzarwb+tUrBrFrGtrLUz$can't use U and writing mode at onceTz'can't have text and binary mode at oncerz)can't have read/write/append mode at oncez/must have exactly one of read/write/append mode)r\r]r.setrJr/)r$rZmodesZreadingZwritingZ appendingtextZbinaryrrr rs(    zRawPyTablesIO._check_modecCsLtd|vpd|vpd|v}td|vp4d|vp4d|v}|rH|sHtddS)NrFrGrCzURawPyTablesIO can't be open in write mode if the underlying hdf5 file is not writable)boolr/)r$rZ h5filemoderHZ h5writablerrr rs zRawPyTablesIO._cross_check_modecCsN|j}t|dd}t|dd}|tkr4td|f|tvrJtd|fdS)aChecks file node-specific attributes. Checks for the presence and validity of the system attributes 'NODE_TYPE' and 'NODE_TYPE_VERSION' in the specified PyTables node (leaf). ValueError is raised if an attribute is missing or incorrect. NODE_TYPENrzinvalid type of node object: %sz+unsupported type version of node object: %s)rr9NodeTyper/NodeTypeVersions)r$r%rZltypeZltypeverrrr rs   zRawPyTablesIO._check_attributescCs.|dkr dS|jtj|j||ddS)z_append_zeros(size) -> None. Appends a string of zeros. Appends a string of 'size' zeros to the array, without moving the file pointer. rN)r r[)rrUr^Zzerosr#r)r$sizerrr r@s zRawPyTablesIO._append_zeros)N)r)N)rQ)__name__ __module__ __qualname____doc__rrpropertyrr+r4r5r6r<r=rArErHrPrYr_r*rrrrr@ __classcell__rrr&r r3s4  #     $ Q" rc@s6eZdZdZddZddZddZeeeedZd S) FileNodeMixina+Mixin class for FileNode objects. It provides access to the attribute set of the node that becomes available via the attrs property. You can add attributes there, but try to avoid attribute names in all caps or starting with '_', since they may clash with internal attributes. cCs|jjS)z+Returns the attribute set of the file node.)rrr)rrr _get_attrsszFileNodeMixin._get_attrscCs tddS)z.set_attrs(string) -> None. Raises ValueError.z/changing the whole attribute set is not allowedNr/)r$valuerrr _set_attrsszFileNodeMixin._set_attrscCs tddS)z(del_attrs() -> None. Raises ValueError.z/deleting the whole attribute set is not allowedNrur)rrr _del_attrsszFileNodeMixin._del_attrsz:A property pointing to the attribute set of the file node.N) rmrnrorprtrwrxrqrrrrr rss rsc@s$eZdZdZddZeddZdS) ROFileNodeaCreates a new read-only file node. Creates a new read-only file node associated with the specified PyTables node, providing a standard Python file interface to it. The node has to have been created on a previous occasion using the new_node() function. The node used as storage is also made available via the read-only attribute node. Please do not tamper with this object if it's avoidable, since you may break the operation of the file node object. The constructor is not intended to be used directly. Use the open_node() function in read-only mode ('r') instead. :Version 1: implements the file storage as a UInt8 uni-dimensional EArray. :Version 2: uses an UInt8 N vector EArray. .. versionchanged:: 3.0 The offset attribute is no more available, please use seek/tell methods instead. .. versionchanged:: 3.0 The line_separator property is no more available. The only line separator used for binary I/O is ``\n``. cCst||d|dS)NrB)rrrIrcrrr r%szROFileNode.__init__cCs|jSr rr)rrr r%)szROFileNode.nodeN)rmrnrorprrqr%rrrr rysryc@s<eZdZdZgdZgdZddZeddZdd Z d S) RAFileNodea*Creates a new read-write file node. The first syntax opens the specified PyTables node, while the second one creates a new node in the specified PyTables file. In the second case, additional named arguments 'where' and 'name' must be passed to specify where the file node is to be created. Other named arguments such as 'title' and 'filters' may also be passed. The special named argument 'expectedsize', indicating an estimate of the file size in bytes, may also be passed. Write access means reading as well as appending data is allowed. The node used as storage is also made available via the read-only attribute node. Please do not tamper with this object if it's avoidable, since you may break the operation of the file node object. The constructor is not intended to be used directly. Use the new_node() or open_node() functions instead. :Version 1: implements the file storage as a UInt8 uni-dimensional EArray. :Version 2: uses an UInt8 N vector EArray. .. versionchanged:: 3.0 The offset attribute is no more available, please use seek/tell methods instead. .. versionchanged:: 3.0 The line_separator property is no more available. The only line separator used for binary I/O is ``\n``. )N)rr)r)wherenametitlefilters expectedsizecKs|dur|||jj|_n|dur|D]}||jvr*tdt|q*d|vrp|d}|}|d=||d<td|_|j |j}|j ft |d|}z| |Wn(ty||d|dYn0t||d||dS) Nz"%s keyword argument is not allowedr expectedrowsrQ)rr[r|r}a+)rrrr _RAFileNode__allowed_init_kwargsr.reprcopyrk _byte_shapeZ create_earrayr`rb_set_attributes RuntimeError remove_noderrrIr>)r$r%h5filekwargskwargrr[rrr r[s:       zRAFileNode.__init__cCs|jSr rzr)rrr r%szRAFileNode.nodecCs|j}t|_td|_dS)z_set_attributes(node) -> None. Adds file node-specific attributes. Sets the system attributes 'NODE_TYPE' and 'NODE_TYPE_VERSION' in the specified PyTables node (leaf). rQN)rrjrirkr)r$r%rrrr rszRAFileNode._set_attributesN) rmrnrorprrrrqr%rrrrr r{.s#& r{cKstd|fi|S)aCreates a new file node object in the specified PyTables file object. Additional named arguments where and name must be passed to specify where the file node is to be created. Other named arguments such as title and filters may also be passed. The special named argument expectedsize, indicating an estimate of the file size in bytes, may also be passed. It returns the file node object. N)r{)rrrrr new_nodes rrBcCs4|dkrt|S|dkr"t|dStd|fdS)aeOpens an existing file node. Returns a file node object from the existing specified PyTables node. If mode is not specified or it is 'r', the file can only be read, and the pointer is positioned at the beginning of the file. If mode is 'a+', the file can be read and appended, and the pointer is positioned at the end of the file. rBrNzinvalid mode: %s)ryr{r?)r%rrrr open_nodes  rFc Cst|tjstd|t|tjjr@|jdkr@td|j |durt|tj j rftj |d}t|tr|drtj |d}n(| d}dd|dd}|d}tj j|stdd td d |}t|tjj }|rt|d n|} z4| j||d } |s0|r"| td | j WntjyHYn0t|d} | } Wdn1st0Yz| j||d WntjyYn0t| ||||d} | | tj |d| j_| |r| dS)aSave a file's contents to a filenode inside a PyTables file. .. versionadded:: 3.2 Parameters ---------- h5file The PyTables file to be written to; can be either a string giving the file's location or a :class:`File` object. If a file with name *h5file* already exists, it will be opened in mode ``a``. filename Path of the file which shall be stored within the PyTables file. where, name Location of the filenode where the data shall be stored. If *name* is not given, and *where* is either a :class:`Group` object or a string ending on ``/``, the leaf name will be set to the file name of *filename*. The *name* will be modified to adhere to Python's natural naming convention; the original filename will be preserved in the filenode's *_filename* attribute. overwrite Whether or not a possibly existing filenode of the specified name shall be overwritten. title A description for this node (it sets the ``TITLE`` HDF5 attribute on disk). filters An instance of the :class:`Filters` class that provides information about the desired I/O filters to be applied during the life of this object. zThe file '%s' could not be readrBz!The file '%s' is opened read-onlyNr/rQz(?![a-zA-Z0-9_])._z^(?![a-zA-Z_]).rGr|r}z*Specified node already exists in file '%s'rb)r|r}r~r)osaccessR_OKr?r\r`rFilerfilenamegroupZGrouppathsplitr]endswithrVZ _python_id_rematchresubget_noder<NoSuchNodeErroropenrKrrr_r _filename)rrr|r} overwriter~rZnodepath new_h5filefrMfddatafnoderrr save_to_filenodesR)       ( rc Cst|tjj }|r t|dn|}zt|j||d}Wnftjyd}|j|ddD]} | jj |kr\t| }qzq\|dur| td||fYn0t j |s|t j jrzt j ||jjj }Wn$tyt j ||jj}Yn0t |t jr*|s*|r| td||r`t j t j |ds`t t j |dt t j |dt js|r| td ||} | t|d } | | Wdn1s0Y~ |r| dS) aRead a filenode from a PyTables file and write its contents to a file. .. versionadded:: 3.2 Parameters ---------- h5file The PyTables file to be read from; can be either a string giving the file's location or a :class:`File` object. filename Path of the file where the contents of the filenode shall be written to. If *filename* points to a directory or ends with ``/`` (``\`` on Windows), the filename will be set to the *_filename* (if present; otherwise the *name*) attribute of the read filenode. where, name Location of the filenode where the data shall be read from. If no node *name* can be found at *where*, the first node at *where* whose *_filename* attribute matches *name* will be read. overwrite Whether or not a possibly existing file of the specified *filename* shall be overwritten. create_target Whether or not the folder hierarchy needed to accomodate the given target ``filename`` will be created. rBrNra)r|Z classnamez'A filenode '%s' cannot be found at '%s'zThe file '%s' already existsrz"The file '%s' cannot be written towb)r\r`rrrrrZ walk_nodesrrr<rrisdirrseprVr% Exceptionr}rrr?rmakedirsW_OKrKrr_) rrr|r}rZ create_targetrrrrMrrrrr read_from_filenodesJ!       *r)rB)NFrN)NFF)rpZ __future__riorrr:Znumpyr^r`rjrk RawIOBaserobjectrsryr{rrrrrrrr  s0 3$'e  b