blob: e80684ddf946a2bb7c75e6771ad585bcf25090b9 (
plain)
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
|
.. _api:
API Documentation
=================
All public API members can (and should) be imported from ``blinker``::
from blinker import ANY, signal
.. currentmodule:: blinker.base
Basic Signals
-------------
.. autoattribute:: blinker.base.ANY
.. autoattribute:: blinker.base.receiver_connected
.. autoclass:: Signal
:members:
:undoc-members:
Named Signals
-------------
.. function:: signal(name, doc=None)
Return the :class:`NamedSignal` *name*, creating it if required.
Repeated calls to this function will return the same signal object.
Signals are created in a global :class:`Namespace`.
.. autoclass:: NamedSignal
:show-inheritance:
:members:
.. autoclass:: Namespace
:show-inheritance:
:members: signal
|