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
|
# 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 database interaction."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'DatabaseError',
'IDatabase',
'SchemaVersionMismatchError',
]
from zope.interface import Interface
from mailman.interfaces.errors import MailmanError
from mailman.version import DATABASE_SCHEMA_VERSION
class DatabaseError(MailmanError):
"""A problem with the database occurred."""
class SchemaVersionMismatchError(DatabaseError):
"""The database schema version number did not match what was expected."""
def __init__(self, got):
super(SchemaVersionMismatchError, self).__init__()
self._got = got
def __str__(self):
return ('Incompatible database schema version '
'(got: {0}, expected: {1})'.format(
self._got, DATABASE_SCHEMA_VERSION))
class IDatabase(Interface):
"""Database layer interface."""
def initialize(debug=None):
"""Initialize the database layer, using whatever means necessary.
:param debug: When None (the default), the configuration file
determines whether the database layer should have increased
debugging or not. When True or False, this overrides the
configuration file setting.
"""
def _reset():
"""Reset the database to its pristine state.
This is only used by the test framework.
"""
def begin():
"""Begin the current transaction."""
def commit():
"""Commit the current transaction."""
def abort():
"""Abort the current transaction."""
|
