Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.protoclbr.html
eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.protoclbr.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Utilities.ClassBrowsers.protoclbr</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>eric6.Utilities.ClassBrowsers.protoclbr</h1> | |
| 23 <p> | |
| 24 Parse a ProtoBuf protocol file and retrieve messages, enums, services and | |
| 25 rpc methods. | |
| 26 </p><p> | |
| 27 It is based on the Python class browser found in this package. | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 <table> | |
| 31 <tr><td>SUPPORTED_TYPES</td></tr><tr><td>_commentsub</td></tr><tr><td>_getnext</td></tr><tr><td>_modules</td></tr><tr><td>_normalize</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 <table> | |
| 35 <tr> | |
| 36 <td><a href="#Enum">Enum</a></td> | |
| 37 <td>Class to represent a ProtoBuf Enum.</td> | |
| 38 </tr><tr> | |
| 39 <td><a href="#Message">Message</a></td> | |
| 40 <td>Class to represent a ProtoBuf Message.</td> | |
| 41 </tr><tr> | |
| 42 <td><a href="#Service">Service</a></td> | |
| 43 <td>Class to represent a ProtoBuf Service.</td> | |
| 44 </tr><tr> | |
| 45 <td><a href="#ServiceMethod">ServiceMethod</a></td> | |
| 46 <td>Class to represent a ProtoBuf Service Method.</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#VisibilityMixin">VisibilityMixin</a></td> | |
| 49 <td>Mixin class implementing the notion of visibility.</td> | |
| 50 </tr> | |
| 51 </table> | |
| 52 <h3>Functions</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#readmodule_ex">readmodule_ex</a></td> | |
| 56 <td>Read a ProtoBuf protocol file and return a dictionary of messages, enums, services and rpc methods.</td> | |
| 57 </tr> | |
| 58 </table> | |
| 59 <hr /><hr /> | |
| 60 <a NAME="Enum" ID="Enum"></a> | |
| 61 <h2>Enum</h2> | |
| 62 <p> | |
| 63 Class to represent a ProtoBuf Enum. | |
| 64 </p> | |
| 65 <h3>Derived from</h3> | |
| 66 ClbrBaseClasses.Enum, VisibilityMixin | |
| 67 <h3>Class Attributes</h3> | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 <h3>Class Methods</h3> | |
| 72 <table> | |
| 73 <tr><td>None</td></tr> | |
| 74 </table> | |
| 75 <h3>Methods</h3> | |
| 76 <table> | |
| 77 <tr> | |
| 78 <td><a href="#Enum.__init__">Enum</a></td> | |
| 79 <td>Constructor</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 <table> | |
| 84 <tr><td>None</td></tr> | |
| 85 </table> | |
| 86 <a NAME="Enum.__init__" ID="Enum.__init__"></a> | |
| 87 <h4>Enum (Constructor)</h4> | |
| 88 <b>Enum</b>(<i>module, name, file, lineno</i>) | |
| 89 <p> | |
| 90 Constructor | |
| 91 </p><dl> | |
| 92 <dt><i>module</i> (str)</dt> | |
| 93 <dd> | |
| 94 name of the module containing this enum | |
| 95 </dd><dt><i>name</i> (str)</dt> | |
| 96 <dd> | |
| 97 name of this enum | |
| 98 </dd><dt><i>file</i> (str)</dt> | |
| 99 <dd> | |
| 100 filename containing this enum | |
| 101 </dd><dt><i>lineno</i> (int)</dt> | |
| 102 <dd> | |
| 103 linenumber of the message enum | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <div align="right"><a href="#top">Up</a></div> | |
| 107 <hr /><hr /> | |
| 108 <a NAME="Message" ID="Message"></a> | |
| 109 <h2>Message</h2> | |
| 110 <p> | |
| 111 Class to represent a ProtoBuf Message. | |
| 112 </p> | |
| 113 <h3>Derived from</h3> | |
| 114 ClbrBaseClasses.Module, VisibilityMixin | |
| 115 <h3>Class Attributes</h3> | |
| 116 <table> | |
| 117 <tr><td>None</td></tr> | |
| 118 </table> | |
| 119 <h3>Class Methods</h3> | |
| 120 <table> | |
| 121 <tr><td>None</td></tr> | |
| 122 </table> | |
| 123 <h3>Methods</h3> | |
| 124 <table> | |
| 125 <tr> | |
| 126 <td><a href="#Message.__init__">Message</a></td> | |
| 127 <td>Constructor</td> | |
| 128 </tr> | |
| 129 </table> | |
| 130 <h3>Static Methods</h3> | |
| 131 <table> | |
| 132 <tr><td>None</td></tr> | |
| 133 </table> | |
| 134 <a NAME="Message.__init__" ID="Message.__init__"></a> | |
| 135 <h4>Message (Constructor)</h4> | |
| 136 <b>Message</b>(<i>module, name, file, lineno</i>) | |
| 137 <p> | |
| 138 Constructor | |
| 139 </p><dl> | |
| 140 <dt><i>module</i> (str)</dt> | |
| 141 <dd> | |
| 142 name of the module containing this message | |
| 143 </dd><dt><i>name</i> (str)</dt> | |
| 144 <dd> | |
| 145 name of this message | |
| 146 </dd><dt><i>file</i> (str)</dt> | |
| 147 <dd> | |
| 148 filename containing this message | |
| 149 </dd><dt><i>lineno</i> (int)</dt> | |
| 150 <dd> | |
| 151 linenumber of the message definition | |
| 152 </dd> | |
| 153 </dl> | |
| 154 <div align="right"><a href="#top">Up</a></div> | |
| 155 <hr /><hr /> | |
| 156 <a NAME="Service" ID="Service"></a> | |
| 157 <h2>Service</h2> | |
| 158 <p> | |
| 159 Class to represent a ProtoBuf Service. | |
| 160 </p> | |
| 161 <h3>Derived from</h3> | |
| 162 ClbrBaseClasses.Class, VisibilityMixin | |
| 163 <h3>Class Attributes</h3> | |
| 164 <table> | |
| 165 <tr><td>None</td></tr> | |
| 166 </table> | |
| 167 <h3>Class Methods</h3> | |
| 168 <table> | |
| 169 <tr><td>None</td></tr> | |
| 170 </table> | |
| 171 <h3>Methods</h3> | |
| 172 <table> | |
| 173 <tr> | |
| 174 <td><a href="#Service.__init__">Service</a></td> | |
| 175 <td>Constructor</td> | |
| 176 </tr> | |
| 177 </table> | |
| 178 <h3>Static Methods</h3> | |
| 179 <table> | |
| 180 <tr><td>None</td></tr> | |
| 181 </table> | |
| 182 <a NAME="Service.__init__" ID="Service.__init__"></a> | |
| 183 <h4>Service (Constructor)</h4> | |
| 184 <b>Service</b>(<i>module, name, file, lineno</i>) | |
| 185 <p> | |
| 186 Constructor | |
| 187 </p><dl> | |
| 188 <dt><i>module</i> (str)</dt> | |
| 189 <dd> | |
| 190 name of the module containing this service | |
| 191 </dd><dt><i>name</i> (str)</dt> | |
| 192 <dd> | |
| 193 name of this service | |
| 194 </dd><dt><i>file</i> (str)</dt> | |
| 195 <dd> | |
| 196 filename containing this service | |
| 197 </dd><dt><i>lineno</i> (int)</dt> | |
| 198 <dd> | |
| 199 linenumber of the service definition | |
| 200 </dd> | |
| 201 </dl> | |
| 202 <div align="right"><a href="#top">Up</a></div> | |
| 203 <hr /><hr /> | |
| 204 <a NAME="ServiceMethod" ID="ServiceMethod"></a> | |
| 205 <h2>ServiceMethod</h2> | |
| 206 <p> | |
| 207 Class to represent a ProtoBuf Service Method. | |
| 208 </p> | |
| 209 <h3>Derived from</h3> | |
| 210 ClbrBaseClasses.Function, VisibilityMixin | |
| 211 <h3>Class Attributes</h3> | |
| 212 <table> | |
| 213 <tr><td>None</td></tr> | |
| 214 </table> | |
| 215 <h3>Class Methods</h3> | |
| 216 <table> | |
| 217 <tr><td>None</td></tr> | |
| 218 </table> | |
| 219 <h3>Methods</h3> | |
| 220 <table> | |
| 221 <tr> | |
| 222 <td><a href="#ServiceMethod.__init__">ServiceMethod</a></td> | |
| 223 <td>Constructor</td> | |
| 224 </tr> | |
| 225 </table> | |
| 226 <h3>Static Methods</h3> | |
| 227 <table> | |
| 228 <tr><td>None</td></tr> | |
| 229 </table> | |
| 230 <a NAME="ServiceMethod.__init__" ID="ServiceMethod.__init__"></a> | |
| 231 <h4>ServiceMethod (Constructor)</h4> | |
| 232 <b>ServiceMethod</b>(<i>name, file, lineno, signature, returns</i>) | |
| 233 <p> | |
| 234 Constructor | |
| 235 </p><dl> | |
| 236 <dt><i>name</i> (str)</dt> | |
| 237 <dd> | |
| 238 name of this service method | |
| 239 </dd><dt><i>file</i> (str)</dt> | |
| 240 <dd> | |
| 241 filename containing this service method | |
| 242 </dd><dt><i>lineno</i> (int)</dt> | |
| 243 <dd> | |
| 244 linenumber of the service method definition | |
| 245 </dd><dt><i>signature</i> (str)</dt> | |
| 246 <dd> | |
| 247 parameter list of the service method | |
| 248 </dd><dt><i>returns</i> (str)</dt> | |
| 249 <dd> | |
| 250 return type of the service method | |
| 251 </dd> | |
| 252 </dl> | |
| 253 <div align="right"><a href="#top">Up</a></div> | |
| 254 <hr /><hr /> | |
| 255 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a> | |
| 256 <h2>VisibilityMixin</h2> | |
| 257 <p> | |
| 258 Mixin class implementing the notion of visibility. | |
| 259 </p> | |
| 260 <h3>Derived from</h3> | |
| 261 ClbrBaseClasses.ClbrVisibilityMixinBase | |
| 262 <h3>Class Attributes</h3> | |
| 263 <table> | |
| 264 <tr><td>None</td></tr> | |
| 265 </table> | |
| 266 <h3>Class Methods</h3> | |
| 267 <table> | |
| 268 <tr><td>None</td></tr> | |
| 269 </table> | |
| 270 <h3>Methods</h3> | |
| 271 <table> | |
| 272 <tr> | |
| 273 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> | |
| 274 <td>Constructor</td> | |
| 275 </tr> | |
| 276 </table> | |
| 277 <h3>Static Methods</h3> | |
| 278 <table> | |
| 279 <tr><td>None</td></tr> | |
| 280 </table> | |
| 281 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> | |
| 282 <h4>VisibilityMixin (Constructor)</h4> | |
| 283 <b>VisibilityMixin</b>(<i></i>) | |
| 284 <p> | |
| 285 Constructor | |
| 286 </p> | |
| 287 <div align="right"><a href="#top">Up</a></div> | |
| 288 <hr /><hr /> | |
| 289 <a NAME="readmodule_ex" ID="readmodule_ex"></a> | |
| 290 <h2>readmodule_ex</h2> | |
| 291 <b>readmodule_ex</b>(<i>module, path=None</i>) | |
| 292 <p> | |
| 293 Read a ProtoBuf protocol file and return a dictionary of messages, enums, | |
| 294 services and rpc methods. | |
| 295 </p><dl> | |
| 296 <dt><i>module</i> (str)</dt> | |
| 297 <dd> | |
| 298 name of the ProtoBuf protocol file | |
| 299 </dd><dt><i>path</i> (list of str)</dt> | |
| 300 <dd> | |
| 301 path the file should be searched in | |
| 302 </dd> | |
| 303 </dl><dl> | |
| 304 <dt>Returns:</dt> | |
| 305 <dd> | |
| 306 the resulting dictionary | |
| 307 </dd> | |
| 308 </dl><dl> | |
| 309 <dt>Return Type:</dt> | |
| 310 <dd> | |
| 311 dict | |
| 312 </dd> | |
| 313 </dl> | |
| 314 <div align="right"><a href="#top">Up</a></div> | |
| 315 <hr /> | |
| 316 </body></html> |
