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

<!DOCTYPE html>
<html><head>
<title>Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands</h1>
<p>
Module implementing file system commands for rope.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#E5FileSystemCommands">E5FileSystemCommands</a></td>
<td>Class implementing file system commands for rope.</td>
</tr><tr>
<td><a href="#RefactoringClientFileSystemCommands">RefactoringClientFileSystemCommands</a></td>
<td>Class implementing the client side of the rope file system commands.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="E5FileSystemCommands" ID="E5FileSystemCommands"></a>
<h2>E5FileSystemCommands</h2>
<p>
    Class implementing file system commands for rope.
</p>
<h3>Derived from</h3>
object
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#E5FileSystemCommands.__init__">E5FileSystemCommands</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#E5FileSystemCommands.__createFile">__createFile</a></td>
<td>Private method called by rope to create a new file.</td>
</tr><tr>
<td><a href="#E5FileSystemCommands.__createFolder">__createFolder</a></td>
<td>Private method called by rope to create a new directory.</td>
</tr><tr>
<td><a href="#E5FileSystemCommands.__move">__move</a></td>
<td>Private method called by rope to rename a file or directory.</td>
</tr><tr>
<td><a href="#E5FileSystemCommands.__remove">__remove</a></td>
<td>Private method called by rope to remove a file or directory.</td>
</tr><tr>
<td><a href="#E5FileSystemCommands.processFileSystemCommand">processFileSystemCommand</a></td>
<td>Public method to process rope file system commands.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="E5FileSystemCommands.__init__" ID="E5FileSystemCommands.__init__"></a>
<h4>E5FileSystemCommands (Constructor)</h4>
<b>E5FileSystemCommands</b>(<i>project</i>)
<p>
        Constructor
</p><dl>
<dt><i>project</i> (Project.Project)</dt>
<dd>
reference to the eric project object
</dd>
</dl><a NAME="E5FileSystemCommands.__createFile" ID="E5FileSystemCommands.__createFile"></a>
<h4>E5FileSystemCommands.__createFile</h4>
<b>__createFile</b>(<i>path</i>)
<p>
        Private method called by rope to create a new file.
</p><dl>
<dt><i>path</i> (str)</dt>
<dd>
new filename
</dd>
</dl><a NAME="E5FileSystemCommands.__createFolder" ID="E5FileSystemCommands.__createFolder"></a>
<h4>E5FileSystemCommands.__createFolder</h4>
<b>__createFolder</b>(<i>path</i>)
<p>
        Private method called by rope to create a new directory.
</p><dl>
<dt><i>path</i> (str)</dt>
<dd>
new directory
</dd>
</dl><a NAME="E5FileSystemCommands.__move" ID="E5FileSystemCommands.__move"></a>
<h4>E5FileSystemCommands.__move</h4>
<b>__move</b>(<i>path, new_location</i>)
<p>
        Private method called by rope to rename a file or directory.
</p><dl>
<dt><i>path</i> (str)</dt>
<dd>
old file/directory name
</dd><dt><i>new_location</i> (str)</dt>
<dd>
new file/directory name
</dd>
</dl><a NAME="E5FileSystemCommands.__remove" ID="E5FileSystemCommands.__remove"></a>
<h4>E5FileSystemCommands.__remove</h4>
<b>__remove</b>(<i>path</i>)
<p>
        Private method called by rope to remove a file or directory.
</p><dl>
<dt><i>path</i></dt>
<dd>
name of file/directory to remove (string)
</dd>
</dl><a NAME="E5FileSystemCommands.processFileSystemCommand" ID="E5FileSystemCommands.processFileSystemCommand"></a>
<h4>E5FileSystemCommands.processFileSystemCommand</h4>
<b>processFileSystemCommand</b>(<i>params</i>)
<p>
        Public method to process rope file system commands.
</p><dl>
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the command and relevant data
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="RefactoringClientFileSystemCommands" ID="RefactoringClientFileSystemCommands"></a>
<h2>RefactoringClientFileSystemCommands</h2>
<p>
    Class implementing the client side of the rope file system commands.
</p>
<h3>Derived from</h3>
object
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#RefactoringClientFileSystemCommands.__init__">RefactoringClientFileSystemCommands</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#RefactoringClientFileSystemCommands.create_file">create_file</a></td>
<td>Public method called by rope to create a new file.</td>
</tr><tr>
<td><a href="#RefactoringClientFileSystemCommands.create_folder">create_folder</a></td>
<td>Public method called by rope to create a new directory.</td>
</tr><tr>
<td><a href="#RefactoringClientFileSystemCommands.move">move</a></td>
<td>Public method called by rope to rename a file or directory.</td>
</tr><tr>
<td><a href="#RefactoringClientFileSystemCommands.remove">remove</a></td>
<td>Public method called by rope to remove a file or directory.</td>
</tr><tr>
<td><a href="#RefactoringClientFileSystemCommands.write">write</a></td>
<td>Public method called by rope to write data to a file.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="RefactoringClientFileSystemCommands.__init__" ID="RefactoringClientFileSystemCommands.__init__"></a>
<h4>RefactoringClientFileSystemCommands (Constructor)</h4>
<b>RefactoringClientFileSystemCommands</b>(<i>client</i>)
<p>
        Constructor
</p><dl>
<dt><i>client</i> (RefactoringClient)</dt>
<dd>
reference to the refactoring client
</dd>
</dl><a NAME="RefactoringClientFileSystemCommands.create_file" ID="RefactoringClientFileSystemCommands.create_file"></a>
<h4>RefactoringClientFileSystemCommands.create_file</h4>
<b>create_file</b>(<i>path</i>)
<p>
        Public method called by rope to create a new file.
</p><dl>
<dt><i>path</i> (str)</dt>
<dd>
new filename
</dd>
</dl><a NAME="RefactoringClientFileSystemCommands.create_folder" ID="RefactoringClientFileSystemCommands.create_folder"></a>
<h4>RefactoringClientFileSystemCommands.create_folder</h4>
<b>create_folder</b>(<i>path</i>)
<p>
        Public method called by rope to create a new directory.
</p><dl>
<dt><i>path</i> (str)</dt>
<dd>
new directory
</dd>
</dl><a NAME="RefactoringClientFileSystemCommands.move" ID="RefactoringClientFileSystemCommands.move"></a>
<h4>RefactoringClientFileSystemCommands.move</h4>
<b>move</b>(<i>path, new_location</i>)
<p>
        Public method called by rope to rename a file or directory.
</p><dl>
<dt><i>path</i> (str)</dt>
<dd>
old file/directory name
</dd><dt><i>new_location</i> (str)</dt>
<dd>
new file/directory name
</dd>
</dl><a NAME="RefactoringClientFileSystemCommands.remove" ID="RefactoringClientFileSystemCommands.remove"></a>
<h4>RefactoringClientFileSystemCommands.remove</h4>
<b>remove</b>(<i>path</i>)
<p>
        Public method called by rope to remove a file or directory.
</p><dl>
<dt><i>path</i> (str)</dt>
<dd>
name of file/directory to remove
</dd>
</dl><a NAME="RefactoringClientFileSystemCommands.write" ID="RefactoringClientFileSystemCommands.write"></a>
<h4>RefactoringClientFileSystemCommands.write</h4>
<b>write</b>(<i>path, data</i>)
<p>
        Public method called by rope to write data to a file.
</p><dl>
<dt><i>path</i> (str)</dt>
<dd>
filename of file to write to
</dd><dt><i>data</i></dt>
<dd>
data to be written
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>