RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient</h1>

<p>
Module implementing the code assist client interface to rope.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>modulePath</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#CodeAssistClient">CodeAssistClient</a></td>
<td>Class implementing the code assist client interface to rope.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="CodeAssistClient" ID="CodeAssistClient"></a>
<h2>CodeAssistClient</h2>

<p>
    Class implementing the code assist client interface to rope.
</p>
<h3>Derived from</h3>
EricJsonClient
<h3>Class Attributes</h3>

<table>
<tr><td>IdProject</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#CodeAssistClient.__init__">CodeAssistClient</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__closeProject">__closeProject</a></td>
<td>Private slot to validate the project.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__configChanged">__configChanged</a></td>
<td>Private method to handle a change of the configuration file.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__getCallTips">__getCallTips</a></td>
<td>Private method to calculate possible calltips.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__getCompletions">__getCompletions</a></td>
<td>Private method to calculate possible completions.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__getConfig">__getConfig</a></td>
<td>Private method to send some configuration data to the server.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__getDocumentation">__getDocumentation</a></td>
<td>Private method to get some source code documentation.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__getObjectTypeAndName">__getObjectTypeAndName</a></td>
<td>Private method to determine an object type and name for the given location.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__getReferences">__getReferences</a></td>
<td>Private method to get the places a parameter is referenced.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__gotoDefinition">__gotoDefinition</a></td>
<td>Private method to handle the Goto Definition action.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__handleRopeError">__handleRopeError</a></td>
<td>Private method to process a rope error.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__processDocumentation">__processDocumentation</a></td>
<td>Private method to process the call-tips and documentation.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.__reportChanged">__reportChanged</a></td>
<td>Private method to register some changed sources.</td>
</tr>
<tr>
<td><a href="#CodeAssistClient.handleCall">handleCall</a></td>
<td>Public method to handle a method call from the server.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="CodeAssistClient.__init__" ID="CodeAssistClient.__init__"></a>
<h4>CodeAssistClient (Constructor)</h4>
<b>CodeAssistClient</b>(<i>host, port, idString, projectPath</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>host</i> (str)</dt>
<dd>
ip address the background service is listening
</dd>
<dt><i>port</i> (int)</dt>
<dd>
port of the background service
</dd>
<dt><i>idString</i> (str)</dt>
<dd>
assigned client id to be sent back to the server in
            order to identify the connection
</dd>
<dt><i>projectPath</i> (str)</dt>
<dd>
path to the project
</dd>
</dl>
<a NAME="CodeAssistClient.__closeProject" ID="CodeAssistClient.__closeProject"></a>
<h4>CodeAssistClient.__closeProject</h4>
<b>__closeProject</b>(<i>params</i>)

<p>
        Private slot to validate the project.
</p>
<dl>

<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
            the server
</dd>
</dl>
<a NAME="CodeAssistClient.__configChanged" ID="CodeAssistClient.__configChanged"></a>
<h4>CodeAssistClient.__configChanged</h4>
<b>__configChanged</b>(<i>params</i>)

<p>
        Private method to handle a change of the configuration file.
</p>
<dl>

<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
            the server
</dd>
</dl>
<a NAME="CodeAssistClient.__getCallTips" ID="CodeAssistClient.__getCallTips"></a>
<h4>CodeAssistClient.__getCallTips</h4>
<b>__getCallTips</b>(<i>params</i>)

<p>
        Private method to calculate possible calltips.
</p>
<dl>

<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters
</dd>
</dl>
<a NAME="CodeAssistClient.__getCompletions" ID="CodeAssistClient.__getCompletions"></a>
<h4>CodeAssistClient.__getCompletions</h4>
<b>__getCompletions</b>(<i>params</i>)

<p>
        Private method to calculate possible completions.
</p>
<dl>

<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters
</dd>
</dl>
<a NAME="CodeAssistClient.__getConfig" ID="CodeAssistClient.__getConfig"></a>
<h4>CodeAssistClient.__getConfig</h4>
<b>__getConfig</b>(<i>params</i>)

<p>
        Private method to send some configuration data to the server.
</p>
<dl>

<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
            the server
</dd>
</dl>
<a NAME="CodeAssistClient.__getDocumentation" ID="CodeAssistClient.__getDocumentation"></a>
<h4>CodeAssistClient.__getDocumentation</h4>
<b>__getDocumentation</b>(<i>params</i>)

<p>
        Private method to get some source code documentation.
</p>
<dl>

<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters
</dd>
</dl>
<a NAME="CodeAssistClient.__getObjectTypeAndName" ID="CodeAssistClient.__getObjectTypeAndName"></a>
<h4>CodeAssistClient.__getObjectTypeAndName</h4>
<b>__getObjectTypeAndName</b>(<i>project, sourceCode, offset, resource=None, maxfixes=1</i>)

<p>
        Private method to determine an object type and name for the given
        location.
</p>
<dl>

<dt><i>project</i> (rope.base.project.Project)</dt>
<dd>
reference to the rope project object
</dd>
<dt><i>sourceCode</i> (str)</dt>
<dd>
source code
</dd>
<dt><i>offset</i> (int)</dt>
<dd>
offset to base the calculation on
</dd>
<dt><i>resource</i> (rope.base.resources.Resource)</dt>
<dd>
reference to the rope resource object
</dd>
<dt><i>maxfixes</i> (int)</dt>
<dd>
number of fixes to be done
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
tuple containing the object type and name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str)
</dd>
</dl>
<a NAME="CodeAssistClient.__getReferences" ID="CodeAssistClient.__getReferences"></a>
<h4>CodeAssistClient.__getReferences</h4>
<b>__getReferences</b>(<i>params</i>)

<p>
        Private method to get the places a parameter is referenced.
</p>
<dl>

<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
            the server
</dd>
</dl>
<a NAME="CodeAssistClient.__gotoDefinition" ID="CodeAssistClient.__gotoDefinition"></a>
<h4>CodeAssistClient.__gotoDefinition</h4>
<b>__gotoDefinition</b>(<i>params</i>)

<p>
        Private method to handle the Goto Definition action.
</p>
<dl>

<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
            the server
</dd>
</dl>
<a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a>
<h4>CodeAssistClient.__handleRopeError</h4>
<b>__handleRopeError</b>(<i>err</i>)

<p>
        Private method to process a rope error.
</p>
<dl>

<dt><i>err</i> (Exception)</dt>
<dd>
rope exception object
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
dictionary containing the error information
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="CodeAssistClient.__processDocumentation" ID="CodeAssistClient.__processDocumentation"></a>
<h4>CodeAssistClient.__processDocumentation</h4>
<b>__processDocumentation</b>(<i>cts, documentation, typeName</i>)

<p>
        Private method to process the call-tips and documentation.
</p>
<dl>

<dt><i>cts</i> (str)</dt>
<dd>
call-tips
</dd>
<dt><i>documentation</i> (str)</dt>
<dd>
extracted source code documentation
</dd>
<dt><i>typeName</i> (tuple of (str, str))</dt>
<dd>
type and name of the object
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
dictionary containing document information
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dictionary with keys "name", "argspec", "module" and
            "docstring"
</dd>
</dl>
<a NAME="CodeAssistClient.__reportChanged" ID="CodeAssistClient.__reportChanged"></a>
<h4>CodeAssistClient.__reportChanged</h4>
<b>__reportChanged</b>(<i>params</i>)

<p>
        Private method to register some changed sources.
</p>
<dl>

<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
            the server
</dd>
</dl>
<a NAME="CodeAssistClient.handleCall" ID="CodeAssistClient.handleCall"></a>
<h4>CodeAssistClient.handleCall</h4>
<b>handleCall</b>(<i>method, params</i>)

<p>
        Public method to handle a method call from the server.
</p>
<dl>

<dt><i>method</i> (str)</dt>
<dd>
requested method name
</dd>
<dt><i>params</i> (dict)</dt>
<dd>
dictionary with method specific parameters
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>