| 1 | <?xml version="1.0" encoding="ascii"?> |
|---|
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|---|
| 3 | "DTD/xhtml1-transitional.dtd"> |
|---|
| 4 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 5 | <head> |
|---|
| 6 | <title>pyinotify.Event</title> |
|---|
| 7 | <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|---|
| 8 | <script type="text/javascript" src="epydoc.js"></script> |
|---|
| 9 | </head> |
|---|
| 10 | |
|---|
| 11 | <body bgcolor="white" text="black" link="blue" vlink="#204080" |
|---|
| 12 | alink="#204080"> |
|---|
| 13 | <!-- ==================== NAVIGATION BAR ==================== --> |
|---|
| 14 | <table class="navbar" border="0" width="100%" cellpadding="0" |
|---|
| 15 | bgcolor="#a0c0ff" cellspacing="0"> |
|---|
| 16 | <tr valign="middle"> |
|---|
| 17 | <!-- Home link --> |
|---|
| 18 | <th> <a |
|---|
| 19 | href="pyinotify-module.html">Home</a> </th> |
|---|
| 20 | |
|---|
| 21 | <!-- Tree link --> |
|---|
| 22 | <th> <a |
|---|
| 23 | href="module-tree.html">Trees</a> </th> |
|---|
| 24 | |
|---|
| 25 | <!-- Index link --> |
|---|
| 26 | <th> <a |
|---|
| 27 | href="identifier-index.html">Indices</a> </th> |
|---|
| 28 | |
|---|
| 29 | <!-- Help link --> |
|---|
| 30 | <th> <a |
|---|
| 31 | href="help.html">Help</a> </th> |
|---|
| 32 | |
|---|
| 33 | <th class="navbar" width="100%"></th> |
|---|
| 34 | </tr> |
|---|
| 35 | </table> |
|---|
| 36 | <table width="100%" cellpadding="0" cellspacing="0"> |
|---|
| 37 | <tr valign="top"> |
|---|
| 38 | <td width="100%"> |
|---|
| 39 | <span class="breadcrumbs"> |
|---|
| 40 | <a href="pyinotify-module.html">Module pyinotify</a> :: |
|---|
| 41 | Class Event |
|---|
| 42 | </span> |
|---|
| 43 | </td> |
|---|
| 44 | <td> |
|---|
| 45 | <table cellpadding="0" cellspacing="0"> |
|---|
| 46 | <!-- hide/show private --> |
|---|
| 47 | <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|---|
| 48 | onclick="toggle_private();">hide private</a>]</span></td></tr> |
|---|
| 49 | <tr><td align="right"><span class="options" |
|---|
| 50 | >[<a href="frames.html" target="_top">frames</a |
|---|
| 51 | >] | <a href="pyinotify.Event-class.html" |
|---|
| 52 | target="_top">no frames</a>]</span></td></tr> |
|---|
| 53 | </table> |
|---|
| 54 | </td> |
|---|
| 55 | </tr> |
|---|
| 56 | </table> |
|---|
| 57 | <!-- ==================== CLASS DESCRIPTION ==================== --> |
|---|
| 58 | <h1 class="epydoc">Class Event</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#Event">source code</a></span></p> |
|---|
| 59 | <center> |
|---|
| 60 | <center> <map id="uml_class_diagram_for_pyinotif_7" name="uml_class_diagram_for_pyinotif_7"> |
|---|
| 61 | <area shape="rect" href="pyinotify.Event-class.html#__init__" title="Concretely, this is the raw event plus inferred infos." alt="" coords="17,110,124,129"/> |
|---|
| 62 | <area shape="rect" href="pyinotify.Event-class.html" title="This class contains all the useful informations about the observed event." alt="" coords="16,85,125,130"/> |
|---|
| 63 | <area shape="rect" href="pyinotify._Event-class.html#__repr__" title="Returns:  String representation." alt="" coords="28,36,113,54"/> |
|---|
| 64 | <area shape="rect" href="pyinotify._Event-class.html" title="Event structure, represent events raised by the system." alt="" coords="27,10,115,56"/> |
|---|
| 65 | </map> |
|---|
| 66 | <img src="uml_class_diagram_for_pyinotif_7.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_7" ismap="ismap" class="graph-without-title" /> |
|---|
| 67 | </center> |
|---|
| 68 | </center> |
|---|
| 69 | <hr /> |
|---|
| 70 | <p>This class contains all the useful informations about the observed |
|---|
| 71 | event. However, the incorporation of each field is not guaranteed and |
|---|
| 72 | depends on the type of event. In effect, some fields are irrelevant for |
|---|
| 73 | some kind of event (for example 'cookie' is meaningless for IN_CREATE |
|---|
| 74 | whereas it is useful for IN_MOVE_TO).</p> |
|---|
| 75 | <p>The possible fields are:</p> |
|---|
| 76 | <ul> |
|---|
| 77 | <li> |
|---|
| 78 | wd (int): Watch Descriptor. |
|---|
| 79 | </li> |
|---|
| 80 | <li> |
|---|
| 81 | mask (int): Mask. |
|---|
| 82 | </li> |
|---|
| 83 | <li> |
|---|
| 84 | maskname (str): Readable event name. |
|---|
| 85 | </li> |
|---|
| 86 | <li> |
|---|
| 87 | path (str): path of the file or directory being watched. |
|---|
| 88 | </li> |
|---|
| 89 | <li> |
|---|
| 90 | name (str): Basename of the file or directory against which the event |
|---|
| 91 | was raised, in case where the watched directory is the parent |
|---|
| 92 | directory. None if the event was raised on the watched item itself. |
|---|
| 93 | This field is always provided even if the string is ''. |
|---|
| 94 | </li> |
|---|
| 95 | <li> |
|---|
| 96 | pathname (str): absolute path of: path + name |
|---|
| 97 | </li> |
|---|
| 98 | <li> |
|---|
| 99 | cookie (int): Cookie. |
|---|
| 100 | </li> |
|---|
| 101 | <li> |
|---|
| 102 | dir (bool): is the event raised against directory. |
|---|
| 103 | </li> |
|---|
| 104 | </ul> |
|---|
| 105 | |
|---|
| 106 | <!-- ==================== INSTANCE METHODS ==================== --> |
|---|
| 107 | <a name="section-InstanceMethods"></a> |
|---|
| 108 | <table class="summary" border="1" cellpadding="3" |
|---|
| 109 | cellspacing="0" width="100%" bgcolor="white"> |
|---|
| 110 | <tr bgcolor="#70b0f0" class="table-header"> |
|---|
| 111 | <td colspan="2" class="table-header"> |
|---|
| 112 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|---|
| 113 | <tr valign="top"> |
|---|
| 114 | <td align="left"><span class="table-header">Instance Methods</span></td> |
|---|
| 115 | <td align="right" valign="top" |
|---|
| 116 | ><span class="options">[<a href="#section-InstanceMethods" |
|---|
| 117 | class="privatelink" onclick="toggle_private();" |
|---|
| 118 | >hide private</a>]</span></td> |
|---|
| 119 | </tr> |
|---|
| 120 | </table> |
|---|
| 121 | </td> |
|---|
| 122 | </tr> |
|---|
| 123 | <tr> |
|---|
| 124 | <td width="15%" align="right" valign="top" class="summary"> |
|---|
| 125 | <span class="summary-type"> </span> |
|---|
| 126 | </td><td class="summary"> |
|---|
| 127 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|---|
| 128 | <tr> |
|---|
| 129 | <td><span class="summary-sig"><a href="pyinotify.Event-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|---|
| 130 | <span class="summary-sig-arg">raw</span>)</span><br /> |
|---|
| 131 | Concretely, this is the raw event plus inferred infos.</td> |
|---|
| 132 | <td align="right" valign="top"> |
|---|
| 133 | <span class="codelink"><a href="pyinotify-pysrc.html#Event.__init__">source code</a></span> |
|---|
| 134 | |
|---|
| 135 | </td> |
|---|
| 136 | </tr> |
|---|
| 137 | </table> |
|---|
| 138 | |
|---|
| 139 | </td> |
|---|
| 140 | </tr> |
|---|
| 141 | <tr> |
|---|
| 142 | <td colspan="2" class="summary"> |
|---|
| 143 | <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyinotify._Event-class.html" onclick="show_private();">_Event</a></code></b>: |
|---|
| 144 | <code><a href="pyinotify._Event-class.html#__repr__">__repr__</a></code> |
|---|
| 145 | </p> |
|---|
| 146 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|---|
| 147 | <code>__delattr__</code>, |
|---|
| 148 | <code>__getattribute__</code>, |
|---|
| 149 | <code>__hash__</code>, |
|---|
| 150 | <code>__new__</code>, |
|---|
| 151 | <code>__reduce__</code>, |
|---|
| 152 | <code>__reduce_ex__</code>, |
|---|
| 153 | <code>__setattr__</code>, |
|---|
| 154 | <code>__str__</code> |
|---|
| 155 | </p> |
|---|
| 156 | </td> |
|---|
| 157 | </tr> |
|---|
| 158 | </table> |
|---|
| 159 | <!-- ==================== PROPERTIES ==================== --> |
|---|
| 160 | <a name="section-Properties"></a> |
|---|
| 161 | <table class="summary" border="1" cellpadding="3" |
|---|
| 162 | cellspacing="0" width="100%" bgcolor="white"> |
|---|
| 163 | <tr bgcolor="#70b0f0" class="table-header"> |
|---|
| 164 | <td colspan="2" class="table-header"> |
|---|
| 165 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|---|
| 166 | <tr valign="top"> |
|---|
| 167 | <td align="left"><span class="table-header">Properties</span></td> |
|---|
| 168 | <td align="right" valign="top" |
|---|
| 169 | ><span class="options">[<a href="#section-Properties" |
|---|
| 170 | class="privatelink" onclick="toggle_private();" |
|---|
| 171 | >hide private</a>]</span></td> |
|---|
| 172 | </tr> |
|---|
| 173 | </table> |
|---|
| 174 | </td> |
|---|
| 175 | </tr> |
|---|
| 176 | <tr> |
|---|
| 177 | <td colspan="2" class="summary"> |
|---|
| 178 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|---|
| 179 | <code>__class__</code> |
|---|
| 180 | </p> |
|---|
| 181 | </td> |
|---|
| 182 | </tr> |
|---|
| 183 | </table> |
|---|
| 184 | <!-- ==================== METHOD DETAILS ==================== --> |
|---|
| 185 | <a name="section-MethodDetails"></a> |
|---|
| 186 | <table class="details" border="1" cellpadding="3" |
|---|
| 187 | cellspacing="0" width="100%" bgcolor="white"> |
|---|
| 188 | <tr bgcolor="#70b0f0" class="table-header"> |
|---|
| 189 | <td colspan="2" class="table-header"> |
|---|
| 190 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|---|
| 191 | <tr valign="top"> |
|---|
| 192 | <td align="left"><span class="table-header">Method Details</span></td> |
|---|
| 193 | <td align="right" valign="top" |
|---|
| 194 | ><span class="options">[<a href="#section-MethodDetails" |
|---|
| 195 | class="privatelink" onclick="toggle_private();" |
|---|
| 196 | >hide private</a>]</span></td> |
|---|
| 197 | </tr> |
|---|
| 198 | </table> |
|---|
| 199 | </td> |
|---|
| 200 | </tr> |
|---|
| 201 | </table> |
|---|
| 202 | <a name="__init__"></a> |
|---|
| 203 | <div> |
|---|
| 204 | <table class="details" border="1" cellpadding="3" |
|---|
| 205 | cellspacing="0" width="100%" bgcolor="white"> |
|---|
| 206 | <tr><td> |
|---|
| 207 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|---|
| 208 | <tr valign="top"><td> |
|---|
| 209 | <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|---|
| 210 | <span class="sig-arg">raw</span>)</span> |
|---|
| 211 | <br /><em class="fname">(Constructor)</em> |
|---|
| 212 | </h3> |
|---|
| 213 | </td><td align="right" valign="top" |
|---|
| 214 | ><span class="codelink"><a href="pyinotify-pysrc.html#Event.__init__">source code</a></span> |
|---|
| 215 | </td> |
|---|
| 216 | </tr></table> |
|---|
| 217 | |
|---|
| 218 | <p>Concretely, this is the raw event plus inferred infos.</p> |
|---|
| 219 | <dl class="fields"> |
|---|
| 220 | <dt>Overrides: |
|---|
| 221 | object.__init__ |
|---|
| 222 | </dt> |
|---|
| 223 | </dl> |
|---|
| 224 | </td></tr></table> |
|---|
| 225 | </div> |
|---|
| 226 | <br /> |
|---|
| 227 | <!-- ==================== NAVIGATION BAR ==================== --> |
|---|
| 228 | <table class="navbar" border="0" width="100%" cellpadding="0" |
|---|
| 229 | bgcolor="#a0c0ff" cellspacing="0"> |
|---|
| 230 | <tr valign="middle"> |
|---|
| 231 | <!-- Home link --> |
|---|
| 232 | <th> <a |
|---|
| 233 | href="pyinotify-module.html">Home</a> </th> |
|---|
| 234 | |
|---|
| 235 | <!-- Tree link --> |
|---|
| 236 | <th> <a |
|---|
| 237 | href="module-tree.html">Trees</a> </th> |
|---|
| 238 | |
|---|
| 239 | <!-- Index link --> |
|---|
| 240 | <th> <a |
|---|
| 241 | href="identifier-index.html">Indices</a> </th> |
|---|
| 242 | |
|---|
| 243 | <!-- Help link --> |
|---|
| 244 | <th> <a |
|---|
| 245 | href="help.html">Help</a> </th> |
|---|
| 246 | |
|---|
| 247 | <th class="navbar" width="100%"></th> |
|---|
| 248 | </tr> |
|---|
| 249 | </table> |
|---|
| 250 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|---|
| 251 | <tr> |
|---|
| 252 | <td align="left" class="footer"> |
|---|
| 253 | Generated by Epydoc 3.0.1 on Tue Jan 6 22:57:23 2009 |
|---|
| 254 | </td> |
|---|
| 255 | <td align="right" class="footer"> |
|---|
| 256 | <a target="mainFrame" href="http://epydoc.sourceforge.net" |
|---|
| 257 | >http://epydoc.sourceforge.net</a> |
|---|
| 258 | </td> |
|---|
| 259 | </tr> |
|---|
| 260 | </table> |
|---|
| 261 | |
|---|
| 262 | <script type="text/javascript"> |
|---|
| 263 | <!-- |
|---|
| 264 | // Private objects are initially displayed (because if |
|---|
| 265 | // javascript is turned off then we want them to be |
|---|
| 266 | // visible); but by default, we want to hide them. So hide |
|---|
| 267 | // them unless we have a cookie that says to show them. |
|---|
| 268 | checkCookie(); |
|---|
| 269 | // --> |
|---|
| 270 | </script> |
|---|
| 271 | </body> |
|---|
| 272 | </html> |
|---|
