summaryrefslogtreecommitdiff
path: root/Mailman/interfaces/user.py
diff options
context:
space:
mode:
authorbwarsaw2007-05-28 20:21:41 +0000
committerbwarsaw2007-05-28 20:21:41 +0000
commitb18f632faa6de17badabb3c6c7ba61752ac84c37 (patch)
tree8b444330b288c5dfc9b25be639d429abfaeb3d3d /Mailman/interfaces/user.py
parent5ff792b13599920527b48f92f8bad880668f8f26 (diff)
downloadmailman-b18f632faa6de17badabb3c6c7ba61752ac84c37.tar.gz
mailman-b18f632faa6de17badabb3c6c7ba61752ac84c37.tar.zst
mailman-b18f632faa6de17badabb3c6c7ba61752ac84c37.zip
Merge exp-elixir-branch to trunk. There is enough working to make me feel
confident the Elixir branch is ready to become mainline. Also, fewer branches makes for an easier migration to a dvcs. Don't expect much of the old test suite to work, or even for much of the old functionality to work. The changes here are disruptive enough to break higher level parts of Mailman. But that's okay because I am slowly building up a new and improved test suite, which will lead to a functional system again. For now, only the doctests in Mailman/docs (and their related test harnesses) will pass, but they all do pass. Note that Mailman/docs serve as system documentation first and unit tests second. You should be able to read the doctest files to understand the underlying data model. Other changes included in this merge: - Added the Mailman.ext extension package. - zope.interfaces uses to describe major components - SQLAlchemy/Elixir used as the database model - Top level doinstall target renamed to justinstall - 3rd-party packages are now installed in pythonlib/lib/python to be more compliant with distutils standards. This allows us to use just --home instead of all the --install-* options. - No longer need to include the email package or pysqlite, as Python 2.5 is required (and comes with both packages). - munepy package is included, for Python enums - IRosterSets are added as a way to manage a collection of IRosters. Roster sets are named so that we can maintain the indirection between mailing lists and rosters, where the two are maintained in different storages. - IMailingListRosters: remove_*_roster() -> delete_*_roster() - Remove IMember interface. - Utils.list_names() -> config.list_manager.names - fqdn_listname() takes an optional hostname argument. - Added a bunch of new exceptions used throughout the new interfaces. - Make LockFile a context manager for use with the 'with' statement.
Diffstat (limited to 'Mailman/interfaces/user.py')
-rw-r--r--Mailman/interfaces/user.py59
1 files changed, 59 insertions, 0 deletions
diff --git a/Mailman/interfaces/user.py b/Mailman/interfaces/user.py
new file mode 100644
index 000000000..6990eee4b
--- /dev/null
+++ b/Mailman/interfaces/user.py
@@ -0,0 +1,59 @@
+# 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 a user."""
+
+from zope.interface import Interface, Attribute
+
+
+
+class IUser(Interface):
+ """A basic user."""
+
+ real_name = Attribute(
+ """This user's Real Name.""")
+
+ password = Attribute(
+ """This user's password information.""")
+
+ profile = Attribute(
+ """The default IProfile for this user.""")
+
+ addresses = Attribute(
+ """An iterator over all the IAddresses controlled by this user.""")
+
+ def link(address):
+ """Link this user to the given IAddress.
+
+ Raises AddressAlreadyLinkedError if this IAddress is already linked to
+ another user.
+ """
+
+ def unlink(address):
+ """Unlink this IAddress from the user.
+
+ Raises AddressNotLinkedError if this address is not linked to this
+ user, either because it's not linked to any user or it's linked to
+ some other user.
+ """
+
+ def controls(address):
+ """Determine whether this user controls the given email address.
+
+ 'address' is a text email address. This method returns true if the
+ user controls the given email address, otherwise false.
+ """