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
|
# Copyright (C) 2007 by the Free Software Foundation, Inc.
#
# This program 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 2
# of the License, or (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
# USA.
"""Interface describing the basics of rules."""
from zope.interface import Interface, Attribute
class DuplicateRuleError(Exception):
"""A rule or rule name is added to a processor more than once."""
class IRule(Interface):
"""A basic rule."""
name = Attribute('Rule name; must be unique.')
description = Attribute('A brief description of the rule.')
def check(mlist, msg, msgdata):
"""Run the rule.
:param mlist: The mailing list object.
:param msg: The message object.
:param msgdata: The message metadata.
:return: A boolean specifying whether the rule was matched or not.
"""
class IRuleSet(Interface):
"""A rule processor."""
rules = Attribute('The set of all rules this processor knows about.')
def __getitem__(rule_name):
"""Return the named rule.
:param rule_name: The name of the rule.
:return: The IRule given by this name.
:raise: KeyError if no such rule is known by this processor.
"""
def get(rule_name, default=None):
"""Return the name rule.
:param rule_name: The name of the rule.
:return: The IRule given by this name, or `default` if no such rule
is known by this processor.
"""
|
