weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity

preserve connection order in blinker

Browse source
This commit is contained in:
Deniz Turgut 2023-11-03 01:05:12 +03:00
commit 8a8b952ecb
No known key found for this signature in database
GPG key ID: 87B7168D7AB3ED2F
4 changed files with 34 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/plugins.rst
View file

@ -94,9 +94,12 @@ which you map the signals to your plugin logic. Let's take a simple example::
your ``register`` callable or they will be garbage-collected before the
signal is emitted.
If multiple plugins connect to the same signal, there is no way to guarantee or
control in which order the plugins will be executed. This is a limitation
inherited from Blinker_, the dependency Pelican uses to implement signals.
If multiple plugins connect to the same signal, plugins will be executed in the
order they are connected. With ``PLUGINS`` setting, order will be as defined in
the setting. If you rely on auto-discovered namespace plugins, no ``PLUGINS``
setting, they will be connected in the same order they are discovered (same
order as ``pelican-plugins`` output). If you want to specify the order
explicitly, disable auto-discovery by defining ``PLUGINS`` in the desired order.
Namespace plugin structure
--------------------------
@ -341,4 +344,3 @@ custom article, using the ``article_generator_pretaxonomy`` signal::
.. _Pip: https://pip.pypa.io/
.. _pelican-plugins bug #314: https://github.com/getpelican/pelican-plugins/issues/314
.. _Blinker: https://pythonhosted.org/blinker/