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
|
.. currentmodule:: tables
File manipulation class
=======================
.. _FileClassDescr:
The File Class
--------------
.. autoclass:: File
.. These are defined in the class docstring.
This is necessary because attributes created in a class's
__init__ method can't be documented with autoattribute.
See Sphinx bug #904.
https://bitbucket.org/birkenfeld/sphinx/issue/904
Attributes
~~~~~~~~~~
.. autoattribute:: File.filename
.. autoattribute:: File.format_version
.. autoattribute:: File.isopen
.. autoattribute:: File.mode
.. autoattribute:: File.root
.. autoattribute:: File.root_uep
File properties
~~~~~~~~~~~~~~~
.. autoattribute:: File.title
.. autoattribute:: File.filters
File methods - file handling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automethod:: File.close
.. automethod:: File.copy_file
.. automethod:: File.flush
.. automethod:: File.fileno
.. automethod:: File.__enter__
.. automethod:: File.__exit__
.. automethod:: File.__str__
.. automethod:: File.__repr__
.. automethod:: File.get_file_image
.. automethod:: File.get_filesize
.. automethod:: File.get_userblock_size
File methods - hierarchy manipulation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automethod:: File.copy_children
.. automethod:: File.copy_node
.. automethod:: File.create_array
.. automethod:: File.create_carray
.. automethod:: File.create_earray
.. automethod:: File.create_external_link
.. automethod:: File.create_group
.. automethod:: File.create_hard_link
.. automethod:: File.create_soft_link
.. automethod:: File.create_table
.. automethod:: File.create_vlarray
.. automethod:: File.move_node
.. automethod:: File.remove_node
.. automethod:: File.rename_node
File methods - tree traversal
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automethod:: File.get_node
.. automethod:: File.is_visible_node
.. automethod:: File.iter_nodes
.. automethod:: File.list_nodes
.. automethod:: File.walk_groups
.. automethod:: File.walk_nodes
.. automethod:: File.__contains__
.. automethod:: File.__iter__
File methods - Undo/Redo support
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automethod:: File.disable_undo
.. automethod:: File.enable_undo
.. automethod:: File.get_current_mark
.. automethod:: File.goto
.. automethod:: File.is_undo_enabled
.. automethod:: File.mark
.. automethod:: File.redo
.. automethod:: File.undo
File methods - attribute handling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automethod:: File.copy_node_attrs
.. automethod:: File.del_node_attr
.. automethod:: File.get_node_attr
.. automethod:: File.set_node_attr
|
