File: helper_classes.rst

package info (click to toggle)
pytables 3.3.0-5
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 14,972 kB
  • ctags: 16,919
  • sloc: python: 59,339; ansic: 46,596; cpp: 1,463; sh: 476; makefile: 428
file content (152 lines) | stat: -rw-r--r-- 2,813 bytes parent folder | download | duplicates (4)
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
.. currentmodule:: tables


Helper classes
==============
This section describes some classes that do not fit in any other
section and that mainly serve for ancillary purposes.


.. _FiltersClassDescr:

The Filters class
-----------------
.. autoclass:: Filters

..  These are defined in the class docstring.
    Filters instance variables
    ^^^^^^^^^^^^^^^^^^^^^^^^^^
    .. autoattribute:: Filters.bitshuffle
    .. autoattribute:: Filters.fletcher32
    .. autoattribute:: Filters.complevel
    .. autoattribute:: Filters.complib
    .. autoattribute:: Filters.shuffle


Filters methods
~~~~~~~~~~~~~~~
.. automethod:: Filters.copy


.. _IndexClassDescr:

The Index class
---------------
.. autoclass:: tables.index.Index

..  This is defined in the class docstring
    .. autoattribute:: tables.index.Index.nelements

Index instance variables
~~~~~~~~~~~~~~~~~~~~~~~~
.. autoattribute:: tables.index.Index.column

.. autoattribute:: tables.index.Index.dirty

.. autoattribute:: tables.index.Index.filters

.. autoattribute:: tables.index.Index.is_csi

.. attribute:: tables.index.Index.nelements

    The number of currently indexed rows for this column.


Index methods
~~~~~~~~~~~~~
.. automethod:: tables.index.Index.read_sorted

.. automethod:: tables.index.Index.read_indices


Index special methods
~~~~~~~~~~~~~~~~~~~~~
.. automethod:: tables.index.Index.__getitem__


The IndexArray class
--------------------

.. autoclass:: tables.indexes.IndexArray
    :members:


.. _EnumClassDescr:

The Enum class
--------------
.. autoclass:: tables.misc.enum.Enum


Enum special methods
~~~~~~~~~~~~~~~~~~~~
.. automethod:: Enum.__call__

.. automethod:: Enum.__contains__

.. automethod:: Enum.__eq__

.. automethod:: Enum.__getattr__

.. automethod:: Enum.__getitem__

.. automethod:: Enum.__iter__

.. automethod:: Enum.__len__

.. automethod:: Enum.__repr__


.. _UnImplementedClassDescr:

The UnImplemented class
-----------------------
.. autoclass:: UnImplemented
    :members:


The Unknown class
-----------------
.. autoclass:: Unknown
    :members:


.. _ExceptionsDescr:

Exceptions module
-----------------
In the :mod:`exceptions` module exceptions and warnings that are specific
to PyTables are declared.

.. autoexception:: HDF5ExtError
    :members:

.. autoexception:: ClosedNodeError

.. autoexception:: ClosedFileError

.. autoexception:: FileModeError

.. autoexception:: NodeError

.. autoexception:: NoSuchNodeError

.. autoexception:: UndoRedoError

.. autoexception:: UndoRedoWarning

.. autoexception:: NaturalNameWarning

.. autoexception:: PerformanceWarning

.. autoexception:: FlavorError

.. autoexception:: FlavorWarning

.. autoexception:: FiltersWarning

.. autoexception:: OldIndexWarning

.. autoexception:: DataTypeWarning

.. autoexception:: ExperimentalFeatureWarning