U
RѰU? @ s d Z ddlmZ ddlmZ ddlmZmZmZm Z m
Z
m Z m Z e dZ
de
_ dZG dd deZed ZG d
d d eZG d d
d
eZG dd deZe jZdS )a+ Signals and events.
A small implementation of signals, inspired by a snippet of Django signal
API client code seen in a blog post. Signals are first-class objects and
each manages its own receivers and message emission.
The :func:`signal` function provides singleton behavior for named signals.
)warn)WeakValueDictionary) WeakTypescontextmanager defaultdicthashable_identity
lazy_property referencesymbolANYzToken for "any sender".c @ s e Zd ZdZeZedd Zedd Zd%ddZed fd
d Z d&d
dZ
e efddZ efddZ
dd Zdd Zdd ZefddZdd Zd d Zd d Zd!d" Zd#d$ ZdS )'SignalzA notification emitter.c C s
t ddS )zEmitted after each :meth:`connect`.
The signal sender is the signal instance, and the :meth:`connect`
arguments are passed through: *receiver*, *sender*, and *weak*.
.. versionadded:: 1.2
z"Emitted after a receiver connects.docr self r /base.pyreceiver_connected% s
zSignal.receiver_connectedc C s
t ddS )a Emitted after :meth:`disconnect`.
The sender is the signal instance, and the :meth:`disconnect` arguments
are passed through: *receiver* and *sender*.
Note, this signal is emitted **only** when :meth:`disconnect` is
called explicitly.
The disconnect signal can not be emitted by an automatic disconnect
(due to a weakly referenced receiver or sender going out of scope),
as the receiver and/or sender instances are no longer available for
use at the time this signal would be emitted.
An alternative approach is available by subscribing to
:attr:`receiver_connected` and setting up a custom weakref cleanup
callback on weak receivers and senders.
.. versionadded:: 1.2
z%Emitted after a receiver disconnects.r
r r r r r receiver_disconnected1 s z Signal.receiver_disconnectedNc C s. |r
|| _ i | _tt| _tt| _i | _dS )zt
:param doc: optional. If provided, will be assigned to the signal's
__doc__ attribute.
N)__doc__ receiversr set _by_receiver
_by_sender
_weak_senders)r r r r r __init__I s
zSignal.__init__Tc C sF t |}|r t|| j}||_n|}|tkr2t}nt |}| j|| | j| | | j
| | ~|tk r|| j krzt|| j }||_
W n tk
r Y nX | j || ~d| jkr| jjrz| jj| |||d W n | || Y nX tjrB| tk rBztj| |||d W n | || Y nX |S )aa Connect *receiver* to signal events sent by *sender*.
:param receiver: A callable. Will be invoked by :meth:`send` with
`sender=` as a single positional argument and any \*\*kwargs that
were provided to a call to :meth:`send`.
:param sender: Any object or :obj:`ANY`, defaults to ``ANY``.
Restricts notifications delivered to *receiver* to only those
:meth:`send` emissions sent by *sender*. If ``ANY``, the receiver
will always be notified. A *receiver* may be connected to
multiple *sender* values on the same Signal through multiple calls
to :meth:`connect`.
:param weak: If true, the Signal will hold a weakref to *receiver*
and automatically disconnect when *receiver* goes out of scope or
is garbage collected. Defaults to True.
r )receiversenderweak)Z receiver_argZ
sender_argZweak_arg)r r _cleanup_receiver receiver_idr ANY_IDr
setdefaultr addr r _cleanup_sender sender_id TypeError__dict__r send
disconnect)r r r r r! receiver_refr&
sender_refr r r connect\ sV
zSignal.connectFc s fdd}|S )aK Connect the decorated function as a receiver for *sender*.
:param sender: Any object or :obj:`ANY`. The decorated function
will only receive :meth:`send` emissions sent by *sender*. If
``ANY``, the receiver will always be notified. A function may be
decorated multiple times with differing *sender* values.
:param weak: If true, the Signal will hold a weakref to the
decorated function and automatically disconnect when *receiver*
goes out of scope or is garbage collected. Unlike
:meth:`connect`, this defaults to False.
The decorated function will be invoked by :meth:`send` with
`sender=` as a single positional argument and any \*\*kwargs that
were provided to the call to :meth:`send`.
.. versionadded:: 1.1
c s | | S N)r- )fnr r r r r decorator s z%Signal.connect_via.<locals>.decoratorr )r r r r1 r r0 r connect_via s zSignal.connect_viac c sB | j ||dd z
dV W n | | Y n X | | dS )a Execute a block with the signal temporarily connected to *receiver*.
:param receiver: a receiver callable
:param sender: optional, a sender to filter on
This is a context manager for use in the ``with`` statement. It can
be useful in unit tests. *receiver* is connected to the signal for
the duration of the ``with`` block, and will be disconnected
automatically when exiting the block:
.. testsetup::
from __future__ import with_statement
from blinker import Signal
on_ready = Signal()
receiver = lambda sender: None
.. testcode::
with on_ready.connected_to(receiver):
# do stuff
on_ready.send(123)
.. versionadded:: 1.1
F)r r N)r- r* r r r r r r connected_to s
zSignal.connected_toc C s t dt | ||S )ag An alias for :meth:`connected_to`.
:param receiver: a receiver callable
:param sender: optional, a sender to filter on
.. versionadded:: 0.9
.. versionchanged:: 1.1
Renamed to :meth:`connected_to`. ``temporarily_connected_to`` was
deprecated in 1.2 and will be removed in a subsequent version.
zAtemporarily_connected_to is deprecated; use connected_to instead.)r DeprecationWarningr4 r3 r r r temporarily_connected_to s
z Signal.temporarily_connected_toc s` t dkrdn&t dkr0tdt nd | jsBg S fdd| D S dS )a Emit this signal on behalf of *sender*, passing on \*\*kwargs.
Returns a list of 2-tuples, pairing receivers with their return
value. The ordering of receiver notification is undefined.
:param \*sender: Any object or ``None``. If omitted, synonymous
with ``None``. Only accepts one positional argument.
:param \*\*kwargs: Data to be sent to receivers.
r N z5send() accepts only one positional argument, %s givenc s g | ]}||f fqS r r ).0r kwargsr r r
<listcomp>
s z Signal.send.<locals>.<listcomp>)lenr' r
receivers_for)r r r: r r9 r r) s z Signal.sendc C s2 | j s
dS | jt rdS |tkr$dS t|| jkS )zTrue if there is probably a receiver for *sender*.
Performs an optimistic check only. Does not guarantee that all
weakly referenced receivers are still alive. See
:meth:`receivers_for` for a stronger search.
FT)r r r" r r )r r r r r has_receivers_for
s
zSignal.has_receivers_forc c s | j rt|}|| jkr.| jt | j| B }n| jt }|D ]J}| j |}|dkrZq@t|tr| }|dkr| |t q@|}|V q@dS )z2Iterate all live receivers listening for *sender*.N) r r r r" copyget
isinstancer _disconnect)r r r& Zidsr! r Zstrongr r r r= s$
zSignal.receivers_forc C sR |t krt}nt|}t|}| || d| jkrN| jjrN| jj| ||d dS )a Disconnect *receiver* from this signal's events.
:param receiver: a previously :meth:`connected<connect>` callable
:param sender: a specific sender to disconnect from, or :obj:`ANY`
to disconnect from all senders. Defaults to ``ANY``.
r )r r N)r r" r rB r( r r r) )r r r r& r! r r r r* 3 s
zSignal.disconnectc C sd |t kr@| j|dr0| j D ]}|| q | j|d n | j| | | j| | d S )NF)r" r popr valuesdiscardr )r r! r& bucketr r r rB I s zSignal._disconnectc C s | |jt dS )z'Disconnect a receiver from all senders.N)rB r! r" )r r+ r r r r S s zSignal._cleanup_receiverc C sH |j }|tkst| j|d | j|dD ]}| j| | q.dS )z'Disconnect all receivers from a sender.Nr )r& r" AssertionErrorr rC r r rE )r r, r& r! r r r r% W s
zSignal._cleanup_senderc C s< | j | jfD ]*}t| D ]\}}|s ||d q q dS )an Prune unused sender/receiver bookeeping. Not threadsafe.
Connecting & disconnecting leave behind a small amount of bookeeping
for the receiver and sender values. Typical workloads using Blinker,
for example in most web apps, Flask, CLI scripts, etc., are not
adversely affected by this bookkeeping.
With a long-running Python process performing dynamic signal routing
with high volume- e.g. connecting to function closures, "senders" are
all unique object instances, and doing all of this over and over- you
may see memory usage will grow due to extraneous bookeeping. (An empty
set() for each stale sender/receiver pair.)
This method will prune that bookeeping away, with the caveat that such
pruning is not threadsafe. The risk is that cleanup of a fully
disconnected receiver/sender pair occurs while another thread is
connecting that same pair. If you are in the highly dynamic, unique
receiver/sender situation that has lead you to this method, that
failure mode is perhaps not a big deal for you.
N)r r listitemsrC )r mappingZ_idrF r r r _cleanup_bookkeeping_ s zSignal._cleanup_bookkeepingc C s, | j | j | j | j dS )z4Throw away all signal state. Useful for unit tests.N)r clearr r r r r r r _clear_statey s
zSignal._clear_state)N)F)__name__
__module__ __qualname__r r r r r r r- r2 r r4 r6 r) r> r= r* rB r r% rK rM r r r r r s*
D
$
r a
Sent by a :class:`Signal` after a receiver connects.
:argument: the Signal that was connected to
:keyword receiver_arg: the connected receiver
:keyword sender_arg: the sender to connect to
:keyword weak_arg: true if the connection to receiver_arg is a weak reference
.. deprecated:: 1.2
As of 1.2, individual signals have their own private
:attr:`~Signal.receiver_connected` and
:attr:`~Signal.receiver_disconnected` signals with a slightly simplified
call signature. This global signal is planned to be removed in 1.6.
c @ s" e Zd ZdZdddZdd ZdS ) NamedSignalz%A named generic notification emitter.Nc C s t | | || _d S r. )r r namer rR r r r r r s zNamedSignal.__init__c C s t | }d|d d | jf S )Nz%s; %r>)r __repr__rR )r baser r r rU s
zNamedSignal.__repr__)N)rN rO rP r r rU r r r r rQ s
rQ c @ s e Zd ZdZdddZdS ) Namespacez%A mapping of signal names to signals.Nc C s6 z
| | W S t k
r0 | |t|| Y S X dS zReturn the :class:`NamedSignal` *name*, creating it if required.
Repeated calls to this function will return the same signal object.
NKeyErrorr# rQ rS r r r signal s
zNamespace.signal)NrN rO rP r r[ r r r r rW s rW c @ s e Zd ZdZdddZdS )
WeakNamespacea- A weak mapping of signal names to signals.
Automatically cleans up unused Signals when the last reference goes out
of scope. This namespace implementation exists for a measure of legacy
compatibility with Blinker <= 1.2, and may be dropped in the future.
.. versionadded:: 1.3
Nc C s6 z
| | W S t k
r0 | |t|| Y S X dS rX rY rS r r r r[ s
zWeakNamespace.signal)Nr\ r r r r r] s
r] N)r warningsr weakrefr Zblinker._utilitiesr r r r r r r
r r" objectr r rQ dictrW r] r[ r r r r <module> s $ e