Mercurial Repositories > Rope Refactoring / file comparison

comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands.html

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands.html

changeset 321
d51e810107ec
parent 204
b4bf79b956bc
child 354
a967ff16629a
equal deleted inserted replaced
320:91b171fdd85f 321:d51e810107ec
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands</h1> 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands</h1>
24
23 <p> 25 <p>
24 Module implementing file system commands for rope. 26 Module implementing file system commands for rope.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#E5FileSystemCommands">E5FileSystemCommands</a></td> 38 <td><a href="#E5FileSystemCommands">E5FileSystemCommands</a></td>
34 <td>Class implementing file system commands for rope.</td> 39 <td>Class implementing file system commands for rope.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#RefactoringClientFileSystemCommands">RefactoringClientFileSystemCommands</a></td> 42 <td><a href="#RefactoringClientFileSystemCommands">RefactoringClientFileSystemCommands</a></td>
37 <td>Class implementing the client side of the rope file system commands.</td> 43 <td>Class implementing the client side of the rope file system commands.</td>
38 </tr> 44 </tr>
39 </table> 45 </table>
40 <h3>Functions</h3> 46 <h3>Functions</h3>
41 <table> 47
42 <tr><td>None</td></tr> 48 <table>
43 </table> 49 <tr><td>None</td></tr>
44 <hr /><hr /> 50 </table>
51 <hr />
52 <hr />
45 <a NAME="E5FileSystemCommands" ID="E5FileSystemCommands"></a> 53 <a NAME="E5FileSystemCommands" ID="E5FileSystemCommands"></a>
46 <h2>E5FileSystemCommands</h2> 54 <h2>E5FileSystemCommands</h2>
55
47 <p> 56 <p>
48 Class implementing file system commands for rope. 57 Class implementing file system commands for rope.
49 </p> 58 </p>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 object 60 object
52 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
62
53 <table> 63 <table>
54 <tr><td>None</td></tr> 64 <tr><td>None</td></tr>
55 </table> 65 </table>
56 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Methods</h3> 71 <h3>Methods</h3>
61 <table> 72
73 <table>
74
62 <tr> 75 <tr>
63 <td><a href="#E5FileSystemCommands.__init__">E5FileSystemCommands</a></td> 76 <td><a href="#E5FileSystemCommands.__init__">E5FileSystemCommands</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#E5FileSystemCommands.__createFile">__createFile</a></td> 80 <td><a href="#E5FileSystemCommands.__createFile">__createFile</a></td>
67 <td>Private method called by rope to create a new file.</td> 81 <td>Private method called by rope to create a new file.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#E5FileSystemCommands.__createFolder">__createFolder</a></td> 84 <td><a href="#E5FileSystemCommands.__createFolder">__createFolder</a></td>
70 <td>Private method called by rope to create a new directory.</td> 85 <td>Private method called by rope to create a new directory.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#E5FileSystemCommands.__move">__move</a></td> 88 <td><a href="#E5FileSystemCommands.__move">__move</a></td>
73 <td>Private method called by rope to rename a file or directory.</td> 89 <td>Private method called by rope to rename a file or directory.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#E5FileSystemCommands.__remove">__remove</a></td> 92 <td><a href="#E5FileSystemCommands.__remove">__remove</a></td>
76 <td>Private method called by rope to remove a file or directory.</td> 93 <td>Private method called by rope to remove a file or directory.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#E5FileSystemCommands.processFileSystemCommand">processFileSystemCommand</a></td> 96 <td><a href="#E5FileSystemCommands.processFileSystemCommand">processFileSystemCommand</a></td>
79 <td>Public method to process rope file system commands.</td> 97 <td>Public method to process rope file system commands.</td>
80 </tr> 98 </tr>
81 </table> 99 </table>
82 <h3>Static Methods</h3> 100 <h3>Static Methods</h3>
83 <table> 101
84 <tr><td>None</td></tr> 102 <table>
85 </table> 103 <tr><td>None</td></tr>
104 </table>
105
86 <a NAME="E5FileSystemCommands.__init__" ID="E5FileSystemCommands.__init__"></a> 106 <a NAME="E5FileSystemCommands.__init__" ID="E5FileSystemCommands.__init__"></a>
87 <h4>E5FileSystemCommands (Constructor)</h4> 107 <h4>E5FileSystemCommands (Constructor)</h4>
88 <b>E5FileSystemCommands</b>(<i>project</i>) 108 <b>E5FileSystemCommands</b>(<i>project</i>)
109
89 <p> 110 <p>
90 Constructor 111 Constructor
91 </p><dl> 112 </p>
113 <dl>
114
92 <dt><i>project</i> (Project.Project)</dt> 115 <dt><i>project</i> (Project.Project)</dt>
93 <dd> 116 <dd>
94 reference to the eric project object 117 reference to the eric project object
95 </dd> 118 </dd>
96 </dl><a NAME="E5FileSystemCommands.__createFile" ID="E5FileSystemCommands.__createFile"></a> 119 </dl>
120 <a NAME="E5FileSystemCommands.__createFile" ID="E5FileSystemCommands.__createFile"></a>
97 <h4>E5FileSystemCommands.__createFile</h4> 121 <h4>E5FileSystemCommands.__createFile</h4>
98 <b>__createFile</b>(<i>path</i>) 122 <b>__createFile</b>(<i>path</i>)
123
99 <p> 124 <p>
100 Private method called by rope to create a new file. 125 Private method called by rope to create a new file.
101 </p><dl> 126 </p>
127 <dl>
128
102 <dt><i>path</i> (str)</dt> 129 <dt><i>path</i> (str)</dt>
103 <dd> 130 <dd>
104 new filename 131 new filename
105 </dd> 132 </dd>
106 </dl><a NAME="E5FileSystemCommands.__createFolder" ID="E5FileSystemCommands.__createFolder"></a> 133 </dl>
134 <a NAME="E5FileSystemCommands.__createFolder" ID="E5FileSystemCommands.__createFolder"></a>
107 <h4>E5FileSystemCommands.__createFolder</h4> 135 <h4>E5FileSystemCommands.__createFolder</h4>
108 <b>__createFolder</b>(<i>path</i>) 136 <b>__createFolder</b>(<i>path</i>)
137
109 <p> 138 <p>
110 Private method called by rope to create a new directory. 139 Private method called by rope to create a new directory.
111 </p><dl> 140 </p>
141 <dl>
142
112 <dt><i>path</i> (str)</dt> 143 <dt><i>path</i> (str)</dt>
113 <dd> 144 <dd>
114 new directory 145 new directory
115 </dd> 146 </dd>
116 </dl><a NAME="E5FileSystemCommands.__move" ID="E5FileSystemCommands.__move"></a> 147 </dl>
148 <a NAME="E5FileSystemCommands.__move" ID="E5FileSystemCommands.__move"></a>
117 <h4>E5FileSystemCommands.__move</h4> 149 <h4>E5FileSystemCommands.__move</h4>
118 <b>__move</b>(<i>path, new_location</i>) 150 <b>__move</b>(<i>path, new_location</i>)
151
119 <p> 152 <p>
120 Private method called by rope to rename a file or directory. 153 Private method called by rope to rename a file or directory.
121 </p><dl> 154 </p>
155 <dl>
156
122 <dt><i>path</i> (str)</dt> 157 <dt><i>path</i> (str)</dt>
123 <dd> 158 <dd>
124 old file/directory name 159 old file/directory name
125 </dd><dt><i>new_location</i> (str)</dt> 160 </dd>
161 <dt><i>new_location</i> (str)</dt>
126 <dd> 162 <dd>
127 new file/directory name 163 new file/directory name
128 </dd> 164 </dd>
129 </dl><a NAME="E5FileSystemCommands.__remove" ID="E5FileSystemCommands.__remove"></a> 165 </dl>
166 <a NAME="E5FileSystemCommands.__remove" ID="E5FileSystemCommands.__remove"></a>
130 <h4>E5FileSystemCommands.__remove</h4> 167 <h4>E5FileSystemCommands.__remove</h4>
131 <b>__remove</b>(<i>path</i>) 168 <b>__remove</b>(<i>path</i>)
169
132 <p> 170 <p>
133 Private method called by rope to remove a file or directory. 171 Private method called by rope to remove a file or directory.
134 </p><dl> 172 </p>
173 <dl>
174
135 <dt><i>path</i></dt> 175 <dt><i>path</i></dt>
136 <dd> 176 <dd>
137 name of file/directory to remove (string) 177 name of file/directory to remove (string)
138 </dd> 178 </dd>
139 </dl><a NAME="E5FileSystemCommands.processFileSystemCommand" ID="E5FileSystemCommands.processFileSystemCommand"></a> 179 </dl>
180 <a NAME="E5FileSystemCommands.processFileSystemCommand" ID="E5FileSystemCommands.processFileSystemCommand"></a>
140 <h4>E5FileSystemCommands.processFileSystemCommand</h4> 181 <h4>E5FileSystemCommands.processFileSystemCommand</h4>
141 <b>processFileSystemCommand</b>(<i>params</i>) 182 <b>processFileSystemCommand</b>(<i>params</i>)
183
142 <p> 184 <p>
143 Public method to process rope file system commands. 185 Public method to process rope file system commands.
144 </p><dl> 186 </p>
187 <dl>
188
145 <dt><i>params</i> (dict)</dt> 189 <dt><i>params</i> (dict)</dt>
146 <dd> 190 <dd>
147 dictionary containing the command and relevant data 191 dictionary containing the command and relevant data
148 </dd> 192 </dd>
149 </dl> 193 </dl>
150 <div align="right"><a href="#top">Up</a></div> 194 <div align="right"><a href="#top">Up</a></div>
151 <hr /><hr /> 195 <hr />
196 <hr />
152 <a NAME="RefactoringClientFileSystemCommands" ID="RefactoringClientFileSystemCommands"></a> 197 <a NAME="RefactoringClientFileSystemCommands" ID="RefactoringClientFileSystemCommands"></a>
153 <h2>RefactoringClientFileSystemCommands</h2> 198 <h2>RefactoringClientFileSystemCommands</h2>
199
154 <p> 200 <p>
155 Class implementing the client side of the rope file system commands. 201 Class implementing the client side of the rope file system commands.
156 </p> 202 </p>
157 <h3>Derived from</h3> 203 <h3>Derived from</h3>
158 object 204 object
159 <h3>Class Attributes</h3> 205 <h3>Class Attributes</h3>
206
160 <table> 207 <table>
161 <tr><td>None</td></tr> 208 <tr><td>None</td></tr>
162 </table> 209 </table>
163 <h3>Class Methods</h3> 210 <h3>Class Methods</h3>
211
164 <table> 212 <table>
165 <tr><td>None</td></tr> 213 <tr><td>None</td></tr>
166 </table> 214 </table>
167 <h3>Methods</h3> 215 <h3>Methods</h3>
168 <table> 216
217 <table>
218
169 <tr> 219 <tr>
170 <td><a href="#RefactoringClientFileSystemCommands.__init__">RefactoringClientFileSystemCommands</a></td> 220 <td><a href="#RefactoringClientFileSystemCommands.__init__">RefactoringClientFileSystemCommands</a></td>
171 <td>Constructor</td> 221 <td>Constructor</td>
172 </tr><tr> 222 </tr>
223 <tr>
173 <td><a href="#RefactoringClientFileSystemCommands.create_file">create_file</a></td> 224 <td><a href="#RefactoringClientFileSystemCommands.create_file">create_file</a></td>
174 <td>Public method called by rope to create a new file.</td> 225 <td>Public method called by rope to create a new file.</td>
175 </tr><tr> 226 </tr>
227 <tr>
176 <td><a href="#RefactoringClientFileSystemCommands.create_folder">create_folder</a></td> 228 <td><a href="#RefactoringClientFileSystemCommands.create_folder">create_folder</a></td>
177 <td>Public method called by rope to create a new directory.</td> 229 <td>Public method called by rope to create a new directory.</td>
178 </tr><tr> 230 </tr>
231 <tr>
179 <td><a href="#RefactoringClientFileSystemCommands.move">move</a></td> 232 <td><a href="#RefactoringClientFileSystemCommands.move">move</a></td>
180 <td>Public method called by rope to rename a file or directory.</td> 233 <td>Public method called by rope to rename a file or directory.</td>
181 </tr><tr> 234 </tr>
235 <tr>
182 <td><a href="#RefactoringClientFileSystemCommands.remove">remove</a></td> 236 <td><a href="#RefactoringClientFileSystemCommands.remove">remove</a></td>
183 <td>Public method called by rope to remove a file or directory.</td> 237 <td>Public method called by rope to remove a file or directory.</td>
184 </tr><tr> 238 </tr>
239 <tr>
185 <td><a href="#RefactoringClientFileSystemCommands.write">write</a></td> 240 <td><a href="#RefactoringClientFileSystemCommands.write">write</a></td>
186 <td>Public method called by rope to write data to a file.</td> 241 <td>Public method called by rope to write data to a file.</td>
187 </tr> 242 </tr>
188 </table> 243 </table>
189 <h3>Static Methods</h3> 244 <h3>Static Methods</h3>
190 <table> 245
191 <tr><td>None</td></tr> 246 <table>
192 </table> 247 <tr><td>None</td></tr>
248 </table>
249
193 <a NAME="RefactoringClientFileSystemCommands.__init__" ID="RefactoringClientFileSystemCommands.__init__"></a> 250 <a NAME="RefactoringClientFileSystemCommands.__init__" ID="RefactoringClientFileSystemCommands.__init__"></a>
194 <h4>RefactoringClientFileSystemCommands (Constructor)</h4> 251 <h4>RefactoringClientFileSystemCommands (Constructor)</h4>
195 <b>RefactoringClientFileSystemCommands</b>(<i>client</i>) 252 <b>RefactoringClientFileSystemCommands</b>(<i>client</i>)
253
196 <p> 254 <p>
197 Constructor 255 Constructor
198 </p><dl> 256 </p>
257 <dl>
258
199 <dt><i>client</i> (RefactoringClient)</dt> 259 <dt><i>client</i> (RefactoringClient)</dt>
200 <dd> 260 <dd>
201 reference to the refactoring client 261 reference to the refactoring client
202 </dd> 262 </dd>
203 </dl><a NAME="RefactoringClientFileSystemCommands.create_file" ID="RefactoringClientFileSystemCommands.create_file"></a> 263 </dl>
264 <a NAME="RefactoringClientFileSystemCommands.create_file" ID="RefactoringClientFileSystemCommands.create_file"></a>
204 <h4>RefactoringClientFileSystemCommands.create_file</h4> 265 <h4>RefactoringClientFileSystemCommands.create_file</h4>
205 <b>create_file</b>(<i>path</i>) 266 <b>create_file</b>(<i>path</i>)
267
206 <p> 268 <p>
207 Public method called by rope to create a new file. 269 Public method called by rope to create a new file.
208 </p><dl> 270 </p>
271 <dl>
272
209 <dt><i>path</i> (str)</dt> 273 <dt><i>path</i> (str)</dt>
210 <dd> 274 <dd>
211 new filename 275 new filename
212 </dd> 276 </dd>
213 </dl><a NAME="RefactoringClientFileSystemCommands.create_folder" ID="RefactoringClientFileSystemCommands.create_folder"></a> 277 </dl>
278 <a NAME="RefactoringClientFileSystemCommands.create_folder" ID="RefactoringClientFileSystemCommands.create_folder"></a>
214 <h4>RefactoringClientFileSystemCommands.create_folder</h4> 279 <h4>RefactoringClientFileSystemCommands.create_folder</h4>
215 <b>create_folder</b>(<i>path</i>) 280 <b>create_folder</b>(<i>path</i>)
281
216 <p> 282 <p>
217 Public method called by rope to create a new directory. 283 Public method called by rope to create a new directory.
218 </p><dl> 284 </p>
285 <dl>
286
219 <dt><i>path</i> (str)</dt> 287 <dt><i>path</i> (str)</dt>
220 <dd> 288 <dd>
221 new directory 289 new directory
222 </dd> 290 </dd>
223 </dl><a NAME="RefactoringClientFileSystemCommands.move" ID="RefactoringClientFileSystemCommands.move"></a> 291 </dl>
292 <a NAME="RefactoringClientFileSystemCommands.move" ID="RefactoringClientFileSystemCommands.move"></a>
224 <h4>RefactoringClientFileSystemCommands.move</h4> 293 <h4>RefactoringClientFileSystemCommands.move</h4>
225 <b>move</b>(<i>path, new_location</i>) 294 <b>move</b>(<i>path, new_location</i>)
295
226 <p> 296 <p>
227 Public method called by rope to rename a file or directory. 297 Public method called by rope to rename a file or directory.
228 </p><dl> 298 </p>
299 <dl>
300
229 <dt><i>path</i> (str)</dt> 301 <dt><i>path</i> (str)</dt>
230 <dd> 302 <dd>
231 old file/directory name 303 old file/directory name
232 </dd><dt><i>new_location</i> (str)</dt> 304 </dd>
305 <dt><i>new_location</i> (str)</dt>
233 <dd> 306 <dd>
234 new file/directory name 307 new file/directory name
235 </dd> 308 </dd>
236 </dl><a NAME="RefactoringClientFileSystemCommands.remove" ID="RefactoringClientFileSystemCommands.remove"></a> 309 </dl>
310 <a NAME="RefactoringClientFileSystemCommands.remove" ID="RefactoringClientFileSystemCommands.remove"></a>
237 <h4>RefactoringClientFileSystemCommands.remove</h4> 311 <h4>RefactoringClientFileSystemCommands.remove</h4>
238 <b>remove</b>(<i>path</i>) 312 <b>remove</b>(<i>path</i>)
313
239 <p> 314 <p>
240 Public method called by rope to remove a file or directory. 315 Public method called by rope to remove a file or directory.
241 </p><dl> 316 </p>
317 <dl>
318
242 <dt><i>path</i> (str)</dt> 319 <dt><i>path</i> (str)</dt>
243 <dd> 320 <dd>
244 name of file/directory to remove 321 name of file/directory to remove
245 </dd> 322 </dd>
246 </dl><a NAME="RefactoringClientFileSystemCommands.write" ID="RefactoringClientFileSystemCommands.write"></a> 323 </dl>
324 <a NAME="RefactoringClientFileSystemCommands.write" ID="RefactoringClientFileSystemCommands.write"></a>
247 <h4>RefactoringClientFileSystemCommands.write</h4> 325 <h4>RefactoringClientFileSystemCommands.write</h4>
248 <b>write</b>(<i>path, data</i>) 326 <b>write</b>(<i>path, data</i>)
327
249 <p> 328 <p>
250 Public method called by rope to write data to a file. 329 Public method called by rope to write data to a file.
251 </p><dl> 330 </p>
331 <dl>
332
252 <dt><i>path</i> (str)</dt> 333 <dt><i>path</i> (str)</dt>
253 <dd> 334 <dd>
254 filename of file to write to 335 filename of file to write to
255 </dd><dt><i>data</i></dt> 336 </dd>
337 <dt><i>data</i></dt>
256 <dd> 338 <dd>
257 data to be written 339 data to be written
258 </dd> 340 </dd>
259 </dl> 341 </dl>
260 <div align="right"><a href="#top">Up</a></div> 342 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: Rope Refactoring

eric ide

mercurial