Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html
- branch
- server_client_variant
- changeset 204
- b4bf79b956bc
- child 214
- ccc3918ac38c
equal
deleted
inserted
replaced
| 203:c38750e1bafd | 204:b4bf79b956bc |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient</h1> | |
| 23 <p> | |
| 24 Module implementing the code assist client interface to rope. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#CodeAssistClient">CodeAssistClient</a></td> | |
| 34 <td>Class implementing the code assist client interface to rope.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="CodeAssistClient" ID="CodeAssistClient"></a> | |
| 43 <h2>CodeAssistClient</h2> | |
| 44 <p> | |
| 45 Class implementing the code assist client interface to rope. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 JsonClient | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>PictureIDs</td></tr><tr><td>client</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#CodeAssistClient.__init__">CodeAssistClient</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#CodeAssistClient.__getCallTips">__getCallTips</a></td> | |
| 64 <td>Private method to calculate possible calltips.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#CodeAssistClient.__getCompletions">__getCompletions</a></td> | |
| 67 <td>Private method to calculate possible completions.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#CodeAssistClient.__handleRopeError">__handleRopeError</a></td> | |
| 70 <td>Private method to process a rope error.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#CodeAssistClient.__reportChanged">__reportChanged</a></td> | |
| 73 <td>Private method to register some changed sources.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#CodeAssistClient.handleCall">handleCall</a></td> | |
| 76 <td>Public method to handle a method call from the server.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <h3>Static Methods</h3> | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 <a NAME="CodeAssistClient.__init__" ID="CodeAssistClient.__init__"></a> | |
| 84 <h4>CodeAssistClient (Constructor)</h4> | |
| 85 <b>CodeAssistClient</b>(<i>host, port, idString, projectPath</i>) | |
| 86 <p> | |
| 87 Constructor | |
| 88 </p><dl> | |
| 89 <dt><i>host</i> (str)</dt> | |
| 90 <dd> | |
| 91 ip address the background service is listening | |
| 92 </dd><dt><i>port</i> (int)</dt> | |
| 93 <dd> | |
| 94 port of the background service | |
| 95 </dd><dt><i>idString</i> (str)</dt> | |
| 96 <dd> | |
| 97 assigned client id to be sent back to the server in | |
| 98 order to identify the connection | |
| 99 </dd><dt><i>projectPath</i> (str)</dt> | |
| 100 <dd> | |
| 101 path to the project | |
| 102 </dd> | |
| 103 </dl><a NAME="CodeAssistClient.__getCallTips" ID="CodeAssistClient.__getCallTips"></a> | |
| 104 <h4>CodeAssistClient.__getCallTips</h4> | |
| 105 <b>__getCallTips</b>(<i>params</i>) | |
| 106 <p> | |
| 107 Private method to calculate possible calltips. | |
| 108 </p><dl> | |
| 109 <dt><i>params</i> (dict)</dt> | |
| 110 <dd> | |
| 111 dictionary containing the method parameters | |
| 112 </dd> | |
| 113 </dl><a NAME="CodeAssistClient.__getCompletions" ID="CodeAssistClient.__getCompletions"></a> | |
| 114 <h4>CodeAssistClient.__getCompletions</h4> | |
| 115 <b>__getCompletions</b>(<i>params</i>) | |
| 116 <p> | |
| 117 Private method to calculate possible completions. | |
| 118 </p><dl> | |
| 119 <dt><i>params</i> (dict)</dt> | |
| 120 <dd> | |
| 121 dictionary containing the method parameters | |
| 122 </dd> | |
| 123 </dl><a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a> | |
| 124 <h4>CodeAssistClient.__handleRopeError</h4> | |
| 125 <b>__handleRopeError</b>(<i>err</i>) | |
| 126 <p> | |
| 127 Private method to process a rope error. | |
| 128 </p><dl> | |
| 129 <dt><i>err</i> (Exception)</dt> | |
| 130 <dd> | |
| 131 rope exception object | |
| 132 </dd> | |
| 133 </dl><dl> | |
| 134 <dt>Returns:</dt> | |
| 135 <dd> | |
| 136 dictionary containing the error information | |
| 137 </dd> | |
| 138 </dl><dl> | |
| 139 <dt>Return Type:</dt> | |
| 140 <dd> | |
| 141 dict | |
| 142 </dd> | |
| 143 </dl><a NAME="CodeAssistClient.__reportChanged" ID="CodeAssistClient.__reportChanged"></a> | |
| 144 <h4>CodeAssistClient.__reportChanged</h4> | |
| 145 <b>__reportChanged</b>(<i>params</i>) | |
| 146 <p> | |
| 147 Private method to register some changed sources. | |
| 148 </p><dl> | |
| 149 <dt><i>params</i> (dict)</dt> | |
| 150 <dd> | |
| 151 dictionary containing the method parameters sent by | |
| 152 the server | |
| 153 </dd> | |
| 154 </dl><a NAME="CodeAssistClient.handleCall" ID="CodeAssistClient.handleCall"></a> | |
| 155 <h4>CodeAssistClient.handleCall</h4> | |
| 156 <b>handleCall</b>(<i>method, params</i>) | |
| 157 <p> | |
| 158 Public method to handle a method call from the server. | |
| 159 </p><dl> | |
| 160 <dt><i>method</i> (str)</dt> | |
| 161 <dd> | |
| 162 requested method name | |
| 163 </dd><dt><i>params</i> (dict)</dt> | |
| 164 <dd> | |
| 165 dictionary with method specific parameters | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <div align="right"><a href="#top">Up</a></div> | |
| 169 <hr /> | |
| 170 </body></html> |
