summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces
diff options
context:
space:
mode:
authorBarry Warsaw2014-11-02 14:55:10 -0500
committerBarry Warsaw2014-11-02 14:55:10 -0500
commitdfc451f81ccc8b0947fb3fa42e94c55026984cf8 (patch)
treec9834271a2dc7fd7d998e5dd211a0ef047f8085e /src/mailman/interfaces
parent0b1ee6fc8d224291c68c964a1af6b481921a13b3 (diff)
parent1d9f6970b9a26ee576838b53f485b96365e3a6c2 (diff)
downloadmailman-dfc451f81ccc8b0947fb3fa42e94c55026984cf8.tar.gz
mailman-dfc451f81ccc8b0947fb3fa42e94c55026984cf8.tar.zst
mailman-dfc451f81ccc8b0947fb3fa42e94c55026984cf8.zip
Trunk merge.
Diffstat (limited to 'src/mailman/interfaces')
-rw-r--r--src/mailman/interfaces/database.py12
-rw-r--r--src/mailman/interfaces/domain.py10
-rw-r--r--src/mailman/interfaces/listmanager.py9
-rw-r--r--src/mailman/interfaces/messages.py2
4 files changed, 15 insertions, 18 deletions
diff --git a/src/mailman/interfaces/database.py b/src/mailman/interfaces/database.py
index 21f2f71d0..9ca05b747 100644
--- a/src/mailman/interfaces/database.py
+++ b/src/mailman/interfaces/database.py
@@ -24,16 +24,13 @@ __all__ = [
'DatabaseError',
'IDatabase',
'IDatabaseFactory',
- 'ITemporaryDatabase',
]
-from zope.interface import Attribute, Interface
-
from mailman.interfaces.errors import MailmanError
+from zope.interface import Attribute, Interface
-
class DatabaseError(MailmanError):
"""A problem with the database occurred."""
@@ -61,12 +58,7 @@ class IDatabase(Interface):
"""Abort the current transaction."""
store = Attribute(
- """The underlying Storm store on which you can do queries.""")
-
-
-
-class ITemporaryDatabase(Interface):
- """Marker interface for test suite adaptation."""
+ """The underlying database object on which you can do queries.""")
diff --git a/src/mailman/interfaces/domain.py b/src/mailman/interfaces/domain.py
index e8610fd76..a4f929ddb 100644
--- a/src/mailman/interfaces/domain.py
+++ b/src/mailman/interfaces/domain.py
@@ -31,9 +31,8 @@ __all__ = [
]
-from zope.interface import Interface, Attribute
-
from mailman.core.errors import MailmanError
+from zope.interface import Interface, Attribute
@@ -97,7 +96,10 @@ class IDomain(Interface):
E.g. postmaster@example.com""")
mailing_lists = Attribute(
- 'All mailing lists for this domain.')
+ """All mailing lists for this domain.
+
+ The mailing lists are returned in order sorted by list-id.
+ """)
def confirm_url(token=''):
"""The url used for various forms of confirmation.
@@ -166,6 +168,8 @@ class IDomainManager(Interface):
def __iter__():
"""An iterator over all the domains.
+ Domains are returned sorted by `mail_host`.
+
:return: iterator over `IDomain`.
"""
diff --git a/src/mailman/interfaces/listmanager.py b/src/mailman/interfaces/listmanager.py
index 22d7b3418..7fe8ed35a 100644
--- a/src/mailman/interfaces/listmanager.py
+++ b/src/mailman/interfaces/listmanager.py
@@ -31,9 +31,8 @@ __all__ = [
]
-from zope.interface import Interface, Attribute
-
from mailman.interfaces.errors import MailmanError
+from zope.interface import Interface, Attribute
@@ -130,8 +129,10 @@ class IListManager(Interface):
"""
mailing_lists = Attribute(
- """An iterator over all the mailing list objects managed by this list
- manager.""")
+ """An iterator over all the mailing list objects.
+
+ The mailing lists are returned in order sorted by `list_id`.
+ """)
def __iter__():
"""An iterator over all the mailing lists.
diff --git a/src/mailman/interfaces/messages.py b/src/mailman/interfaces/messages.py
index 4980a4f9d..7b99578c4 100644
--- a/src/mailman/interfaces/messages.py
+++ b/src/mailman/interfaces/messages.py
@@ -83,7 +83,7 @@ class IMessageStore(Interface):
def get_message_by_hash(message_id_hash):
"""Return the message with the matching X-Message-ID-Hash.
-
+
:param message_id_hash: The X-Message-ID-Hash header contents to
search for.
:returns: The message, or None if no matching message was found.