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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
# Copyright (C) 2007-2011 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.
"""
|
