summaryrefslogtreecommitdiff
path: root/mailman/app/plugins.py
diff options
context:
space:
mode:
authorBarry Warsaw2008-09-29 09:19:52 -0400
committerBarry Warsaw2008-09-29 09:19:52 -0400
commit20a97a4163774212ad9f16c5a2e3abcbf3ecf918 (patch)
treeeae145cfae3b3be448282e545a4f5ed810991f50 /mailman/app/plugins.py
parent73a3660cdf0bda56689f9fd0f7f7ac53c7aa0422 (diff)
downloadmailman-20a97a4163774212ad9f16c5a2e3abcbf3ecf918.tar.gz
mailman-20a97a4163774212ad9f16c5a2e3abcbf3ecf918.tar.zst
mailman-20a97a4163774212ad9f16c5a2e3abcbf3ecf918.zip
Diffstat (limited to 'mailman/app/plugins.py')
-rw-r--r--mailman/app/plugins.py65
1 files changed, 0 insertions, 65 deletions
diff --git a/mailman/app/plugins.py b/mailman/app/plugins.py
deleted file mode 100644
index cf22ad377..000000000
--- a/mailman/app/plugins.py
+++ /dev/null
@@ -1,65 +0,0 @@
-# Copyright (C) 2007-2008 by the Free Software Foundation, Inc.
-#
-# This file is part of GNU Mailman.
-#
-# GNU Mailman is free software: you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free
-# Software Foundation, either version 3 of the License, or (at your option)
-# any later version.
-#
-# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
-# more details.
-#
-# You should have received a copy of the GNU General Public License along with
-# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
-
-"""Get a requested plugin."""
-
-import pkg_resources
-
-
-
-def get_plugin(group):
- """Get the named plugin.
-
- In general, this returns exactly one plugin. If no plugins have been
- added to the named group, the 'stock' plugin will be used. If more than
- one plugin -- other than the stock one -- exists, an exception will be
- raised.
-
- :param group: The plugin group name.
- :return: The loaded plugin.
- :raises RuntimeError: If more than one plugin overrides the stock plugin
- for the named group.
- """
- entry_points = list(pkg_resources.iter_entry_points(group))
- if len(entry_points) == 0:
- raise RuntimeError('No entry points found for group: %s' % group)
- elif len(entry_points) == 1:
- # Okay, this is the one to use.
- return entry_points[0].load()
- elif len(entry_points) == 2:
- # Find the one /not/ named 'stock'.
- entry_points = [ep for ep in entry_points if ep.name <> 'stock']
- if len(entry_points) == 0:
- raise RuntimeError('No stock plugin found for group: %s' % group)
- elif len(entry_points) == 2:
- raise RuntimeError('Too many stock plugins defined')
- else:
- raise AssertionError('Insanity')
- return entry_points[0].load()
- else:
- raise RuntimeError('Too many plugins for group: %s' % group)
-
-
-
-def get_plugins(group):
- """Get and return all plugins in the named group.
-
- :param group: Plugin group name.
- :return: The loaded plugin.
- """
- for entry_point in pkg_resources.iter_entry_points(group):
- yield entry_point.load()