/usr/share/doc/python-dbus-doc/api/dbus.decorators-module.html is in python-dbus-doc 1.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>dbus.decorators</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="dbus-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="dbus-module.html">Package dbus</a> ::
Module decorators
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="dbus.decorators-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module decorators</h1><p class="nomargin-top"><span class="codelink"><a href="dbus.decorators-pysrc.html">source code</a></span></p>
Service-side D-Bus decorators.
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="dbus.decorators-module.html#method" class="summary-sig-name">method</a>(<span class="summary-sig-arg">dbus_interface</span>,
<span class="summary-sig-arg">in_signature</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">out_signature</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">async_callbacks</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">sender_keyword</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">path_keyword</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">destination_keyword</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">message_keyword</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">connection_keyword</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">byte_arrays</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">rel_path_keyword</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Factory for decorators used to mark methods of a <a href="dbus.service.Object-class.html" class="link">dbus.service.Object</a>
to be exported on the D-Bus.</td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.decorators-pysrc.html#method">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="dbus.decorators-module.html#signal" class="summary-sig-name">signal</a>(<span class="summary-sig-arg">dbus_interface</span>,
<span class="summary-sig-arg">signature</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">path_keyword</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">rel_path_keyword</span>=<span class="summary-sig-default">None</span>)</span><br />
Factory for decorators used to mark methods of a <a href="dbus.service.Object-class.html" class="link">dbus.service.Object</a>
to emit signals on the D-Bus.</td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.decorators-pysrc.html#signal">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'dbus'"><code class="variable-quote">'</code><code class="variable-string">dbus</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="method"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">method</span>(<span class="sig-arg">dbus_interface</span>,
<span class="sig-arg">in_signature</span>=<span class="sig-default">None</span>,
<span class="sig-arg">out_signature</span>=<span class="sig-default">None</span>,
<span class="sig-arg">async_callbacks</span>=<span class="sig-default">None</span>,
<span class="sig-arg">sender_keyword</span>=<span class="sig-default">None</span>,
<span class="sig-arg">path_keyword</span>=<span class="sig-default">None</span>,
<span class="sig-arg">destination_keyword</span>=<span class="sig-default">None</span>,
<span class="sig-arg">message_keyword</span>=<span class="sig-default">None</span>,
<span class="sig-arg">connection_keyword</span>=<span class="sig-default">None</span>,
<span class="sig-arg">byte_arrays</span>=<span class="sig-default">False</span>,
<span class="sig-arg">rel_path_keyword</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="dbus.decorators-pysrc.html#method">source code</a></span>
</td>
</tr></table>
<p>Factory for decorators used to mark methods of a <a href="dbus.service.Object-class.html" class="link">dbus.service.Object</a>
to be exported on the D-Bus.</p>
<p>The decorated method will be exported over D-Bus as the method of the
same name on the given D-Bus interface.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>dbus_interface</code></strong> (str) - Name of a D-Bus interface</li>
<li><strong class="pname"><code>in_signature</code></strong> (str or None) - If not None, the signature of the method parameters in the usual
D-Bus notation</li>
<li><strong class="pname"><code>out_signature</code></strong> (str or None) - If not None, the signature of the return value in the usual
D-Bus notation</li>
<li><p><strong class="pname"><code>async_callbacks</code></strong> (tuple containing (str,str), or None) - If None (default) the decorated method is expected to return
values matching the <code class="link">out_signature</code> as usual, or raise
an exception on error. If not None, the following applies:</p>
<p><code class="link">async_callbacks</code> contains the names of two keyword arguments to
the decorated function, which will be used to provide a success
callback and an error callback (in that order).</p>
<p>When the decorated method is called via the D-Bus, its normal
return value will be ignored; instead, a pair of callbacks are
passed as keyword arguments, and the decorated method is
expected to arrange for one of them to be called.</p>
<p>On success the success callback must be called, passing the
results of this method as positional parameters in the format
given by the <code class="link">out_signature</code>.</p>
<p>On error the decorated method may either raise an exception
before it returns, or arrange for the error callback to be
called with an Exception instance as parameter.</p></li>
<li><strong class="pname"><code>sender_keyword</code></strong> (str or None) - If not None, contains the name of a keyword argument to the
decorated function, conventionally <tt class="rst-docutils literal">'sender'</tt>. When the
method is called, the sender's unique name will be passed as
this keyword argument.</li>
<li><p><strong class="pname"><code>path_keyword</code></strong> (str or None) - If not None (the default), the decorated method will receive
the destination object path as a keyword argument with this
name. Normally you already know the object path, but in the
case of "fallback paths" you'll usually want to use the object
path in the method's implementation.</p>
<p>For fallback objects, <code class="link">rel_path_keyword</code> (new in 0.82.2) is
likely to be more useful.</p></li>
<li><strong class="pname"><code>rel_path_keyword</code></strong> (str or None) - If not None (the default), the decorated method will receive
the destination object path, relative to the path at which the
object was exported, as a keyword argument with this
name. For non-fallback objects the relative path will always be
'/'.</li>
<li><strong class="pname"><code>destination_keyword</code></strong> (str or None) - If not None (the default), the decorated method will receive
the destination bus name as a keyword argument with this name.
Included for completeness - you shouldn't need this.</li>
<li><strong class="pname"><code>message_keyword</code></strong> (str or None) - If not None (the default), the decorated method will receive
the <a href="dbus.lowlevel.MethodCallMessage-class.html" class="link">dbus.lowlevel.MethodCallMessage</a> as a keyword argument
with this name.</li>
<li><strong class="pname"><code>connection_keyword</code></strong> (str or None) - If not None (the default), the decorated method will receive
the <a href="dbus.connection.Connection-class.html" class="link">dbus.connection.Connection</a> as a keyword argument
with this name. This is generally only useful for objects
that are available on more than one connection.</li>
<li><p><strong class="pname"><code>utf8_strings</code></strong> (bool) - If False (default), D-Bus strings are passed to the decorated
method as objects of class dbus.String, a unicode subclass.</p>
<p>If True, D-Bus strings are passed to the decorated method
as objects of class dbus.UTF8String, a str subclass guaranteed
to be encoded in UTF-8.</p>
<p>This option does not affect object-paths and signatures, which
are always 8-bit strings (str subclass) encoded in ASCII.</p></li>
<li><p><strong class="pname"><code>byte_arrays</code></strong> (bool) - If False (default), a byte array will be passed to the decorated
method as an <a href="dbus.Array-class.html" class="link">Array</a> (a list subclass) of <a href="dbus.Byte-class.html" class="link">Byte</a> objects.</p>
<p>If True, a byte array will be passed to the decorated method as
a <a href="dbus.ByteArray-class.html" class="link">ByteArray</a>, a str subclass. This is usually what you want,
but is switched off by default to keep dbus-python's API
consistent.</p></li>
</ul></dd>
</dl>
<div class="fields"> <strong>Since:</strong>
<ul class="nomargin-top">
<li>
0.80.0?
</li>
<li>
0.82.2
</li>
<li>
0.80.0?
</li>
<li>
0.80.0?
</li>
<li>
0.82.0
</li>
<li>
0.80.0
</li>
<li>
0.80.0
</li>
</ul>
</div></td></tr></table>
</div>
<a name="signal"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">signal</span>(<span class="sig-arg">dbus_interface</span>,
<span class="sig-arg">signature</span>=<span class="sig-default">None</span>,
<span class="sig-arg">path_keyword</span>=<span class="sig-default">None</span>,
<span class="sig-arg">rel_path_keyword</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="dbus.decorators-pysrc.html#signal">source code</a></span>
</td>
</tr></table>
<p>Factory for decorators used to mark methods of a <a href="dbus.service.Object-class.html" class="link">dbus.service.Object</a>
to emit signals on the D-Bus.</p>
<p>Whenever the decorated method is called in Python, after the method
body is executed, a signal with the same name as the decorated method,
with the given D-Bus interface, will be emitted from this object.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>dbus_interface</code></strong> (str) - The D-Bus interface whose signal is emitted</li>
<li><strong class="pname"><code>signature</code></strong> (str) - The signature of the signal in the usual D-Bus notation</li>
<li><p><strong class="pname"><code>path_keyword</code></strong> (str or None) - A keyword argument to the decorated method. If not None,
that argument will not be emitted as an argument of
the signal, and when the signal is emitted, it will appear
to come from the object path given by the keyword argument.</p>
<p>Note that when calling the decorated method, you must always
pass in the object path as a keyword argument, not as a
positional argument.</p>
<p>This keyword argument cannot be used on objects where
the class attribute <tt class="rst-docutils literal">SUPPORTS_MULTIPLE_OBJECT_PATHS</tt> is true.</p></li>
<li><p><strong class="pname"><code>rel_path_keyword</code></strong> (str or None) - A keyword argument to the decorated method. If not None,
that argument will not be emitted as an argument of
the signal.</p>
<p>When the signal is emitted, if the named keyword argument is given,
the signal will appear to come from the object path obtained by
appending the keyword argument to the object's object path.
This is useful to implement "fallback objects" (objects which
own an entire subtree of the object-path tree).</p>
<p>If the object is available at more than one object-path on the
same or different connections, the signal will be emitted at
an appropriate object-path on each connection - for instance,
if the object is exported at /abc on connection 1 and at
/def and /x/y/z on connection 2, and the keyword argument is
/foo, then signals will be emitted from /abc/foo and /def/foo
on connection 1, and /x/y/z/foo on connection 2.</p></li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Deprecated:</strong>
since 0.82.0. Use <code class="link">rel_path_keyword</code> instead.
</p>
<p><strong>Since:</strong>
0.82.0
</p>
</div></td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="dbus-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Jun 3 19:32:21 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|