------------------------------------------------------------
revno: 6588
committer: Barry Warsaw <[EMAIL PROTECTED]>
branch nick: 3.0
timestamp: Thu 2008-01-24 05:18:02 -0500
message:
  Reorganize doctests, moving handler documentation into Mailman/handlers/docs.
  
  Rename all handlers to be more PEP 8 friendly, i.e. lowercased.
added:
  Mailman/handlers/docs/
renamed:
  Mailman/Handlers => Mailman/handlers
  Mailman/Handlers/Acknowledge.py => Mailman/handlers/acknowledge.py
  Mailman/Handlers/AfterDelivery.py => Mailman/handlers/after_delivery.py
  Mailman/Handlers/AvoidDuplicates.py => Mailman/handlers/avoid_duplicates.py
  Mailman/Handlers/CalcRecips.py => Mailman/handlers/calculate_recipients.py
  Mailman/Handlers/Cleanse.py => Mailman/handlers/cleanse.py
  Mailman/Handlers/CleanseDKIM.py => Mailman/handlers/cleanse_dkim.py
  Mailman/Handlers/CookHeaders.py => Mailman/handlers/cook_headers.py
  Mailman/Handlers/Decorate.py => Mailman/handlers/decorate.py
  Mailman/Handlers/FileRecips.py => Mailman/handlers/file_recipients.py
  Mailman/Handlers/MimeDel.py => Mailman/handlers/mime_delete.py
  Mailman/Handlers/Moderate.py => Mailman/handlers/moderate.py
  Mailman/Handlers/OwnerRecips.py => Mailman/handlers/owner_recipients.py
  Mailman/Handlers/Replybot.py => Mailman/handlers/replybot.py
  Mailman/Handlers/SMTPDirect.py => Mailman/handlers/smtp_direct.py
  Mailman/Handlers/Scrubber.py => Mailman/handlers/scrubber.py
  Mailman/Handlers/Tagger.py => Mailman/handlers/tagger.py
  Mailman/Handlers/ToArchive.py => Mailman/handlers/to_archive.py
  Mailman/Handlers/ToDigest.py => Mailman/handlers/to_digest.py
  Mailman/Handlers/ToOutgoing.py => Mailman/handlers/to_outgoing.py
  Mailman/Handlers/ToUsenet.py => Mailman/handlers/to_usenet.py
  Mailman/docs/ack-headers.txt => Mailman/handlers/docs/ack-headers.txt
  Mailman/docs/acknowledge.txt => Mailman/handlers/docs/acknowledge.txt
  Mailman/docs/after-delivery.txt => Mailman/handlers/docs/after-delivery.txt
  Mailman/docs/archives.txt => Mailman/handlers/docs/archives.txt
  Mailman/docs/avoid-duplicates.txt => 
Mailman/handlers/docs/avoid-duplicates.txt
  Mailman/docs/calc-recips.txt => Mailman/handlers/docs/calc-recips.txt
  Mailman/docs/cleanse.txt => Mailman/handlers/docs/cleanse.txt
  Mailman/docs/cook-headers.txt => Mailman/handlers/docs/cook-headers.txt
  Mailman/docs/decorate.txt => Mailman/handlers/docs/decorate.txt
  Mailman/docs/digests.txt => Mailman/handlers/docs/digests.txt
  Mailman/docs/file-recips.txt => Mailman/handlers/docs/file-recips.txt
  Mailman/docs/filtering.txt => Mailman/handlers/docs/filtering.txt
  Mailman/docs/nntp.txt => Mailman/handlers/docs/nntp.txt
  Mailman/docs/reply-to.txt => Mailman/handlers/docs/reply-to.txt
  Mailman/docs/replybot.txt => Mailman/handlers/docs/replybot.txt
  Mailman/docs/scrubber.txt => Mailman/handlers/docs/scrubber.txt
  Mailman/docs/subject-munging.txt => Mailman/handlers/docs/subject-munging.txt
  Mailman/docs/tagger.txt => Mailman/handlers/docs/tagger.txt
modified:
  Mailman/queue/docs/outgoing.txt
  Mailman/handlers/cleanse.py
  Mailman/handlers/to_digest.py
  Mailman/handlers/docs/ack-headers.txt
  Mailman/handlers/docs/acknowledge.txt
  Mailman/handlers/docs/after-delivery.txt
  Mailman/handlers/docs/archives.txt
  Mailman/handlers/docs/avoid-duplicates.txt
  Mailman/handlers/docs/calc-recips.txt
  Mailman/handlers/docs/cleanse.txt
  Mailman/handlers/docs/cook-headers.txt
  Mailman/handlers/docs/decorate.txt
  Mailman/handlers/docs/digests.txt
  Mailman/handlers/docs/file-recips.txt
  Mailman/handlers/docs/filtering.txt
  Mailman/handlers/docs/nntp.txt
  Mailman/handlers/docs/reply-to.txt
  Mailman/handlers/docs/replybot.txt
  Mailman/handlers/docs/scrubber.txt
  Mailman/handlers/docs/subject-munging.txt
  Mailman/handlers/docs/tagger.txt

=== renamed directory 'Mailman/Handlers' => 'Mailman/handlers'
=== renamed file 'Mailman/Handlers/Acknowledge.py' => 
'Mailman/handlers/acknowledge.py'
=== renamed file 'Mailman/Handlers/AfterDelivery.py' => 
'Mailman/handlers/after_delivery.py'
=== renamed file 'Mailman/Handlers/AvoidDuplicates.py' => 
'Mailman/handlers/avoid_duplicates.py'
=== renamed file 'Mailman/Handlers/CalcRecips.py' => 
'Mailman/handlers/calculate_recipients.py'
=== renamed file 'Mailman/Handlers/Cleanse.py' => 'Mailman/handlers/cleanse.py'
--- a/Mailman/Handlers/Cleanse.py       2008-01-13 21:40:59 +0000
+++ b/Mailman/handlers/cleanse.py       2008-01-24 10:18:02 +0000
@@ -21,7 +21,7 @@
 
 from email.Utils import formataddr
 
-from Mailman.Handlers.CookHeaders import uheader
+from Mailman.handlers.cook_headers import uheader
 
 log = logging.getLogger('mailman.post')
 

=== renamed file 'Mailman/Handlers/CleanseDKIM.py' => 
'Mailman/handlers/cleanse_dkim.py'
=== renamed file 'Mailman/Handlers/CookHeaders.py' => 
'Mailman/handlers/cook_headers.py'
=== renamed file 'Mailman/Handlers/Decorate.py' => 
'Mailman/handlers/decorate.py'
=== added directory 'Mailman/handlers/docs'
=== renamed file 'Mailman/docs/ack-headers.txt' => 
'Mailman/handlers/docs/ack-headers.txt'
--- a/Mailman/docs/ack-headers.txt      2007-11-04 23:10:21 +0000
+++ b/Mailman/handlers/docs/ack-headers.txt     2008-01-24 10:18:02 +0000
@@ -7,7 +7,7 @@
 changes depend on mailing list settings and others depend on how the message
 is getting sent through the system.  We'll take things one-by-one.
 
-    >>> from Mailman.Handlers.CookHeaders import process
+    >>> from Mailman.handlers.cook_headers import process
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> mlist.subject_prefix = u''
 

=== renamed file 'Mailman/docs/acknowledge.txt' => 
'Mailman/handlers/docs/acknowledge.txt'
--- a/Mailman/docs/acknowledge.txt      2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/acknowledge.txt     2008-01-24 10:18:02 +0000
@@ -5,7 +5,7 @@
 receive acknowledgments of their postings, Mailman will sent them such an
 acknowledgment.
 
-    >>> from Mailman.Handlers.Acknowledge import process
+    >>> from Mailman.handlers.acknowledge import process
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> mlist.real_name = u'XTest'
     >>> mlist.preferred_language = u'en'

=== renamed file 'Mailman/docs/after-delivery.txt' => 
'Mailman/handlers/docs/after-delivery.txt'
--- a/Mailman/docs/after-delivery.txt   2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/after-delivery.txt  2008-01-24 10:18:02 +0000
@@ -6,7 +6,7 @@
 bookkeeping pieces of information are updated.
 
     >>> import datetime
-    >>> from Mailman.Handlers.AfterDelivery import process
+    >>> from Mailman.handlers.after_delivery import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> post_time = datetime.datetime.now() - datetime.timedelta(minutes=10)

=== renamed file 'Mailman/docs/archives.txt' => 
'Mailman/handlers/docs/archives.txt'
--- a/Mailman/docs/archives.txt 2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/archives.txt        2008-01-24 10:18:02 +0000
@@ -7,7 +7,7 @@
 archivers to work in a separate process from the main Mailman delivery
 processes.
 
-    >>> from Mailman.Handlers.ToArchive import process
+    >>> from Mailman.handlers.to_archive import process
     >>> from Mailman.queue import Switchboard
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')

=== renamed file 'Mailman/docs/avoid-duplicates.txt' => 
'Mailman/handlers/docs/avoid-duplicates.txt'
--- a/Mailman/docs/avoid-duplicates.txt 2007-11-08 01:56:43 +0000
+++ b/Mailman/handlers/docs/avoid-duplicates.txt        2008-01-24 10:18:02 
+0000
@@ -6,7 +6,7 @@
 recipients from the list of recipients that earlier handler modules
 (e.g. CalcRecips) calculates.
 
-    >>> from Mailman.Handlers.AvoidDuplicates import process
+    >>> from Mailman.handlers.avoid_duplicates import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
 

=== renamed file 'Mailman/docs/calc-recips.txt' => 
'Mailman/handlers/docs/calc-recips.txt'
--- a/Mailman/docs/calc-recips.txt      2007-11-08 05:34:49 +0000
+++ b/Mailman/handlers/docs/calc-recips.txt     2008-01-24 10:18:02 +0000
@@ -5,7 +5,7 @@
 of recipient addresses.  These addresses are calculated by one of the handler
 modules and depends on a host of factors.
 
-    >>> from Mailman.Handlers.CalcRecips import process
+    >>> from Mailman.handlers.calculate_recipients import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
 

=== renamed file 'Mailman/docs/cleanse.txt' => 
'Mailman/handlers/docs/cleanse.txt'
--- a/Mailman/docs/cleanse.txt  2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/cleanse.txt 2008-01-24 10:18:02 +0000
@@ -5,7 +5,7 @@
 related to additional permissions that can be granted to the message and other
 headers can be used to fish for membership.
 
-    >>> from Mailman.Handlers.Cleanse import process
+    >>> from Mailman.handlers.cleanse import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
 

=== renamed file 'Mailman/docs/cook-headers.txt' => 
'Mailman/handlers/docs/cook-headers.txt'
--- a/Mailman/docs/cook-headers.txt     2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/cook-headers.txt    2008-01-24 10:18:02 +0000
@@ -7,7 +7,7 @@
 changes depend on mailing list settings and others depend on how the message
 is getting sent through the system.  We'll take things one-by-one.
 
-    >>> from Mailman.Handlers.CookHeaders import process
+    >>> from Mailman.handlers.cook_headers import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> mlist.subject_prefix = u''

=== renamed file 'Mailman/docs/decorate.txt' => 
'Mailman/handlers/docs/decorate.txt'
--- a/Mailman/docs/decorate.txt 2007-11-08 23:42:56 +0000
+++ b/Mailman/handlers/docs/decorate.txt        2008-01-24 10:18:02 +0000
@@ -5,7 +5,7 @@
 original message.  A handler module takes care of this based on the settings
 of the mailing list and the type of message being processed.
 
-    >>> from Mailman.Handlers.Decorate import process
+    >>> from Mailman.handlers.decorate import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> msg_text = """\

=== renamed file 'Mailman/docs/digests.txt' => 
'Mailman/handlers/docs/digests.txt'
--- a/Mailman/docs/digests.txt  2007-11-08 23:42:56 +0000
+++ b/Mailman/handlers/docs/digests.txt 2008-01-24 10:18:02 +0000
@@ -6,7 +6,7 @@
 digests, although only two are currently supported: MIME digests and RFC 1153
 (a.k.a. plain text) digests.
 
-    >>> from Mailman.Handlers.ToDigest import process
+    >>> from Mailman.handlers.to_digest import process
     >>> from Mailman.queue import Switchboard
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')

=== renamed file 'Mailman/docs/file-recips.txt' => 
'Mailman/handlers/docs/file-recips.txt'
--- a/Mailman/docs/file-recips.txt      2007-11-08 23:42:56 +0000
+++ b/Mailman/handlers/docs/file-recips.txt     2008-01-24 10:18:02 +0000
@@ -5,7 +5,7 @@
 include file.  This file must be called members.txt and it must live in the
 list's data directory.
 
-    >>> from Mailman.Handlers.FileRecips import process
+    >>> from Mailman.handlers.file_recipients import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
 

=== renamed file 'Mailman/docs/filtering.txt' => 
'Mailman/handlers/docs/filtering.txt'
--- a/Mailman/docs/filtering.txt        2007-11-08 23:42:56 +0000
+++ b/Mailman/handlers/docs/filtering.txt       2008-01-24 10:18:02 +0000
@@ -6,7 +6,7 @@
 message.  It does this with the MimeDel handler module, although other
 handlers can potentially do other kinds of finer level content filtering.
 
-    >>> from Mailman.Handlers.MimeDel import process
+    >>> from Mailman.handlers.mime_delete import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> mlist.preferred_language = u'en'

=== renamed file 'Mailman/docs/nntp.txt' => 'Mailman/handlers/docs/nntp.txt'
--- a/Mailman/docs/nntp.txt     2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/nntp.txt    2008-01-24 10:18:02 +0000
@@ -5,7 +5,7 @@
 be forwarded onto an NNTP newsgroup.  Typically this means Usenet, but since
 NNTP is to Usenet as IP is to the web, it's more general than that.
 
-    >>> from Mailman.Handlers.ToUsenet import process
+    >>> from Mailman.handlers.to_usenet import process
     >>> from Mailman.queue import Switchboard
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')

=== renamed file 'Mailman/docs/reply-to.txt' => 
'Mailman/handlers/docs/reply-to.txt'
--- a/Mailman/docs/reply-to.txt 2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/reply-to.txt        2008-01-24 10:18:02 +0000
@@ -7,7 +7,7 @@
 changes depend on mailing list settings and others depend on how the message
 is getting sent through the system.  We'll take things one-by-one.
 
-    >>> from Mailman.Handlers.CookHeaders import process
+    >>> from Mailman.handlers.cook_headers import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> mlist.subject_prefix = u''

=== renamed file 'Mailman/docs/replybot.txt' => 
'Mailman/handlers/docs/replybot.txt'
--- a/Mailman/docs/replybot.txt 2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/replybot.txt        2008-01-24 10:18:02 +0000
@@ -6,7 +6,7 @@
 responses are subject to various conditions, such as headers in the original
 message or the amount of time since the last auto-response.
 
-    >>> from Mailman.Handlers.Replybot import process
+    >>> from Mailman.handlers.replybot import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> mlist.real_name = u'XTest'

=== renamed file 'Mailman/docs/scrubber.txt' => 
'Mailman/handlers/docs/scrubber.txt'
--- a/Mailman/docs/scrubber.txt 2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/scrubber.txt        2008-01-24 10:18:02 +0000
@@ -6,7 +6,7 @@
 scrub attachments from messages so that binary goop doesn't end up in an
 archive message.
 
-    >>> from Mailman.Handlers.Scrubber import process, save_attachment
+    >>> from Mailman.handlers.scrubber import process, save_attachment
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> mlist.preferred_language = u'en'

=== renamed file 'Mailman/docs/subject-munging.txt' => 
'Mailman/handlers/docs/subject-munging.txt'
--- a/Mailman/docs/subject-munging.txt  2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/subject-munging.txt 2008-01-24 10:18:02 +0000
@@ -7,7 +7,7 @@
 changes depend on mailing list settings and others depend on how the message
 is getting sent through the system.  We'll take things one-by-one.
 
-    >>> from Mailman.Handlers.CookHeaders import process
+    >>> from Mailman.handlers.cook_headers import process
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')
     >>> mlist.subject_prefix = u''

=== renamed file 'Mailman/docs/tagger.txt' => 'Mailman/handlers/docs/tagger.txt'
--- a/Mailman/docs/tagger.txt   2008-01-24 07:40:41 +0000
+++ b/Mailman/handlers/docs/tagger.txt  2008-01-24 10:18:02 +0000
@@ -8,7 +8,7 @@
 its Subject: and Keywords: headers compared against these regular
 expressions.  The message then gets tagged with the topic names of each hit.
 
-    >>> from Mailman.Handlers.Tagger import process
+    >>> from Mailman.handlers.tagger import process
     >>> from Mailman.queue import Switchboard
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')

=== renamed file 'Mailman/Handlers/FileRecips.py' => 
'Mailman/handlers/file_recipients.py'
=== renamed file 'Mailman/Handlers/MimeDel.py' => 
'Mailman/handlers/mime_delete.py'
=== renamed file 'Mailman/Handlers/Moderate.py' => 
'Mailman/handlers/moderate.py'
=== renamed file 'Mailman/Handlers/OwnerRecips.py' => 
'Mailman/handlers/owner_recipients.py'
=== renamed file 'Mailman/Handlers/Replybot.py' => 
'Mailman/handlers/replybot.py'
=== renamed file 'Mailman/Handlers/Scrubber.py' => 
'Mailman/handlers/scrubber.py'
=== renamed file 'Mailman/Handlers/SMTPDirect.py' => 
'Mailman/handlers/smtp_direct.py'
=== renamed file 'Mailman/Handlers/Tagger.py' => 'Mailman/handlers/tagger.py'
=== renamed file 'Mailman/Handlers/ToArchive.py' => 
'Mailman/handlers/to_archive.py'
=== renamed file 'Mailman/Handlers/ToDigest.py' => 
'Mailman/handlers/to_digest.py'
--- a/Mailman/Handlers/ToDigest.py      2007-10-10 02:18:14 +0000
+++ b/Mailman/handlers/to_digest.py     2008-01-24 10:18:02 +0000
@@ -47,11 +47,11 @@
 from Mailman import Message
 from Mailman import Utils
 from Mailman import i18n
-from Mailman.Handlers.Decorate import decorate
-from Mailman.Handlers.Scrubber import process as scrubber
 from Mailman.Mailbox import Mailbox
 from Mailman.Mailbox import Mailbox
 from Mailman.configuration import config
+from Mailman.handlers.decorate import decorate
+from Mailman.handlers.scrubber import process as scrubber
 from Mailman.interfaces import DeliveryMode, DeliveryStatus
 from Mailman.queue import Switchboard
 

=== renamed file 'Mailman/Handlers/ToOutgoing.py' => 
'Mailman/handlers/to_outgoing.py'
=== renamed file 'Mailman/Handlers/ToUsenet.py' => 
'Mailman/handlers/to_usenet.py'
=== modified file 'Mailman/queue/docs/outgoing.txt'
--- a/Mailman/queue/docs/outgoing.txt   2008-02-02 16:18:22 +0000
+++ b/Mailman/queue/docs/outgoing.txt   2008-01-24 10:18:02 +0000
@@ -9,7 +9,7 @@
 basically describes how to encode the recipient's address in the originator
 headers for unambigous bounce processing.
 
-    >>> from Mailman.Handlers.ToOutgoing import process
+    >>> from Mailman.handlers.to_outgoing import process
     >>> from Mailman.queue import Switchboard
     >>> from Mailman.configuration import config
     >>> mlist = config.db.list_manager.create(u'[EMAIL PROTECTED]')



--
Primary development focus
https://code.launchpad.net/~mailman-coders/mailman/3.0

You are receiving this branch notification because you are subscribed to it.
_______________________________________________
Mailman-checkins mailing list
[email protected]
Unsubscribe: 
http://mail.python.org/mailman/options/mailman-checkins/archive%40jab.org

Reply via email to