summaryrefslogtreecommitdiff
path: root/mailman/interfaces/styles.py
diff options
context:
space:
mode:
authorBarry Warsaw2009-01-25 13:01:41 -0500
committerBarry Warsaw2009-01-25 13:01:41 -0500
commiteefd06f1b88b8ecbb23a9013cd223b72ca85c20d (patch)
tree72c947fe16fce0e07e996ee74020b26585d7e846 /mailman/interfaces/styles.py
parent07871212f74498abd56bef3919bf3e029eb8b930 (diff)
downloadmailman-eefd06f1b88b8ecbb23a9013cd223b72ca85c20d.tar.gz
mailman-eefd06f1b88b8ecbb23a9013cd223b72ca85c20d.tar.zst
mailman-eefd06f1b88b8ecbb23a9013cd223b72ca85c20d.zip
Diffstat (limited to 'mailman/interfaces/styles.py')
-rw-r--r--mailman/interfaces/styles.py120
1 files changed, 0 insertions, 120 deletions
diff --git a/mailman/interfaces/styles.py b/mailman/interfaces/styles.py
deleted file mode 100644
index e70050f02..000000000
--- a/mailman/interfaces/styles.py
+++ /dev/null
@@ -1,120 +0,0 @@
-# Copyright (C) 2007-2009 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/>.
-
-"""Interfaces for list styles."""
-
-from __future__ import absolute_import, unicode_literals
-
-__metaclass__ = type
-__all__ = [
- 'DuplicateStyleError',
- 'IStyle',
- 'IStyleManager',
- ]
-
-
-from zope.interface import Interface, Attribute
-from mailman.interfaces.errors import MailmanError
-
-
-
-class DuplicateStyleError(MailmanError):
- """A style with the same name is already registered."""
-
-
-
-class IStyle(Interface):
- """Application of a style to an existing mailing list."""
-
- name = Attribute(
- """The name of this style. Must be unique.""")
-
- priority = Attribute(
- """The priority of this style, as an integer.""")
-
- def apply(mailing_list):
- """Apply the style to the mailing list.
-
- :type mailing_list: `IMailingList`.
- :param mailing_list: the mailing list to apply the style to.
- """
-
- def match(mailing_list, styles):
- """Give this list a chance to match the mailing list.
-
- If the style's internal matching rules match the `mailing_list`, then
- the style may append itself to the `styles` list. This list will be
- ordered when returned from `IStyleManager.lookup()`.
-
- :type mailing_list: `IMailingList`.
- :param mailing_list: the mailing list object.
- :param styles: ordered list of `IStyles` matched so far.
- """
-
-
-
-class IStyleManager(Interface):
- """A manager of styles and style chains."""
-
- def get(name):
- """Return the named style or None.
-
- :type name: Unicode
- :param name: A style name.
- :return: the named `IStyle` or None if the style doesn't exist.
- """
-
- def lookup(mailing_list):
- """Return a list of styles for the given mailing list.
-
- Use various registered rules to find an `IStyle` for the given mailing
- list. The returned styles are ordered by their priority.
-
- Style matches can be registered and reordered by plugins.
-
- :type mailing_list: `IMailingList`.
- :param mailing_list: The mailing list object to find a style for.
- :return: ordered list of `IStyles`. Zero is the lowest priority.
- """
-
- styles = Attribute(
- """An iterator over all the styles known by this manager.
-
- Styles are ordered by their priority, which may be changed.
- """)
-
- def register(style):
- """Register a style with this manager.
-
- :param style: an IStyle.
- :raises DuplicateStyleError: if a style with the same name was already
- registered.
- """
-
- def unregister(style):
- """Unregister the style.
-
- :param style: an IStyle.
- :raises KeyError: If the style's name is not currently registered.
- """
-
- def populate():
- """Populate the styles from the configuration files.
-
- This clears the current set of styles and resets them from those
- defined in the configuration files.
- """