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

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

Mercurial Repository: Rope Refactoring

eric ide

mercurial