Vega strike Python Modules doc: Folder Class Reference

def copymessage	(	self,
		n,
		tofolder,
		ton
	)

Copy one message over a specific destination message,
which may or may not already exist.

Definition at line 577 of file mhlib.py.

References shutil.copy2(), Folder.getmessagefilename(), and aifc.open().

 
     def copymessage(self, n, tofolder, ton):
         """Copy one message over a specific destination message,
         which may or may not already exist."""
         path = self.getmessagefilename(n)
         # Open it to check that it exists
         f = open(path)
         f.close()
         del f
         topath = tofolder.getmessagefilename(ton)
         backuptopath = tofolder.getmessagefilename(',%d' % ton)
         try:
             os.rename(topath, backuptopath)
         except os.error:
             pass
         ok = 0
         try:
             tofolder.setlast(None)
             shutil.copy2(path, topath)
             ok = 1
         finally:
             if not ok:
                 try:
                     os.unlink(topath)
                 except os.error:
                     pass

def createmessage	(	self,
		n,
		txt
	)

Create a message, with text from the open file txt.

Definition at line 603 of file mhlib.py.

References Folder.getmessagefilename(), and aifc.open().

 
     def createmessage(self, n, txt):
         """Create a message, with text from the open file txt."""
         path = self.getmessagefilename(n)
         backuppath = self.getmessagefilename(',%d' % n)
         try:
             os.rename(path, backuppath)
         except os.error:
             pass
         ok = 0
         BUFSIZE = 16*1024
         try:
             f = open(path, "w")
             while 1:
                 buf = txt.read(BUFSIZE)
                 if not buf:
                     break
                 f.write(buf)
             f.close()
             ok = 1
         finally:
             if not ok:
                 try:
                     os.unlink(path)
                 except os.error:
                     pass

def error	(	self,
		args
	)

Error message handler.

Definition at line 255 of file mhlib.py.

 
     def error(self, *args):
         """Error message handler."""
         apply(self.mh.error, args)

def getcurrent ( self)

Return the current message.  Raise Error when there is none.

Definition at line 333 of file mhlib.py.

References Folder.getsequences(), and sre_parse.max.

 
     def getcurrent(self):
         """Return the current message.  Raise Error when there is none."""
         seqs = self.getsequences()
         try:
             return max(seqs['cur'])
         except (ValueError, KeyError):
             raise Error, "no cur message"

def getfullname ( self)

Return the full pathname of the folder.

Definition at line 259 of file mhlib.py.

References Folder.name, MiniFieldStorage.name, and FieldStorage.name.

 
     def getfullname(self):
         """Return the full pathname of the folder."""
         return os.path.join(self.mh.path, self.name)

def getlast ( self)

Return the last message number.

Definition at line 648 of file mhlib.py.

References Folder.last, BlockFinder.last, and Folder.listmessages().

 
     def getlast(self):
         """Return the last message number."""
         if not hasattr(self, 'last'):
             self.listmessages() # Set self.last
         return self.last

def getmessagefilename	(	self,
		n
	)

Return the full pathname of a message in the folder.

Definition at line 267 of file mhlib.py.

References Folder.getfullname(), and locale.str().

 
     def getmessagefilename(self, n):
         """Return the full pathname of a message in the folder."""
         return os.path.join(self.getfullname(), str(n))

def getsequences ( self)

Return the set of sequences for the folder.

Definition at line 296 of file mhlib.py.

References MH.error(), Folder.error(), Folder.getsequencesfilename(), aifc.open(), and string.strip().

 
     def getsequences(self):
         """Return the set of sequences for the folder."""
         sequences = {}
         fullname = self.getsequencesfilename()
         try:
             f = open(fullname, 'r')
         except IOError:
             return sequences
         while 1:
             line = f.readline()
             if not line: break
             fields = line.split(':')
             if len(fields) != 2:
                 self.error('bad sequence in %s: %s' %
                           (fullname, line.strip()))
             key = fields[0].strip()
             value = IntSet(fields[1].strip(), ' ').tolist()
             sequences[key] = value
         return sequences

def getsequencesfilename ( self)

Return the full pathname of the folder's sequences file.

Definition at line 263 of file mhlib.py.

References Folder.getfullname().

 
     def getsequencesfilename(self):
         """Return the full pathname of the folder's sequences file."""
         return os.path.join(self.getfullname(), MH_SEQUENCES)

def listallsubfolders ( self)

Return list of all subfolders.

Definition at line 275 of file mhlib.py.

References Folder.name, MiniFieldStorage.name, and FieldStorage.name.

 
     def listallsubfolders(self):
         """Return list of all subfolders."""
         return self.mh.listallsubfolders(self.name)

def listmessages ( self)

Return the list of messages currently present in the folder.
As a side effect, set self.last to the last message (or 0).

Definition at line 279 of file mhlib.py.

References reconvert.append, Folder.getfullname(), and pre.match().

 
     def listmessages(self):
         """Return the list of messages currently present in the folder.
         As a side effect, set self.last to the last message (or 0)."""
         messages = []
         match = numericprog.match
         append = messages.append
         for name in os.listdir(self.getfullname()):
             if match(name):
                 append(name)
         messages = map(int, messages)
         messages.sort()
         if messages:
             self.last = messages[-1]
         else:
             self.last = 0
         return messages

def listsubfolders ( self)

Return list of direct subfolders.

Definition at line 271 of file mhlib.py.

References Folder.name, MiniFieldStorage.name, and FieldStorage.name.

 
     def listsubfolders(self):
         """Return list of direct subfolders."""
         return self.mh.listsubfolders(self.name)

def movemessage	(	self,
		n,
		tofolder,
		ton
	)

Move one message over a specific destination message,
which may or may not already exist.

Definition at line 545 of file mhlib.py.

References shutil.copy2(), Folder.getmessagefilename(), aifc.open(), and Folder.removefromallsequences().

 
     def movemessage(self, n, tofolder, ton):
         """Move one message over a specific destination message,
         which may or may not already exist."""
         path = self.getmessagefilename(n)
         # Open it to check that it exists
         f = open(path)
         f.close()
         del f
         topath = tofolder.getmessagefilename(ton)
         backuptopath = tofolder.getmessagefilename(',%d' % ton)
         try:
             os.rename(topath, backuptopath)
         except os.error:
             pass
         try:
             os.rename(path, topath)
         except os.error:
             # Try copying
             ok = 0
             try:
                 tofolder.setlast(None)
                 shutil.copy2(path, topath)
                 ok = 1
             finally:
                 if not ok:
                     try:
                         os.unlink(topath)
                     except os.error:
                         pass
             os.unlink(path)
         self.removefromallsequences([n])

def openmessage	(	self,
		n
	)

Open a message -- returns a Message object.

Definition at line 460 of file mhlib.py.

 
     def openmessage(self, n):
         """Open a message -- returns a Message object."""
         return Message(self, n)

def parsesequence	(	self,
		seq
	)

Parse an MH sequence specification into a message list.
Attempt to mimic mh-sequence(5) as close as possible.
Also attempt to mimic observed behavior regarding which
conditions cause which error messages.

Definition at line 345 of file mhlib.py.

References Folder._parseindex(), Folder.getcurrent(), Folder.getsequences(), mhlib.isnumeric(), Folder.listmessages(), sre_parse.max, Folder.name, MiniFieldStorage.name, and FieldStorage.name.

 
     def parsesequence(self, seq):
         """Parse an MH sequence specification into a message list.
         Attempt to mimic mh-sequence(5) as close as possible.
         Also attempt to mimic observed behavior regarding which
         conditions cause which error messages."""
         # XXX Still not complete (see mh-format(5)).
         # Missing are:
         # - 'prev', 'next' as count
         # - Sequence-Negation option
         all = self.listmessages()
         # Observed behavior: test for empty folder is done first
         if not all:
             raise Error, "no messages in %s" % self.name
         # Common case first: all is frequently the default
         if seq == 'all':
             return all
         # Test for X:Y before X-Y because 'seq:-n' matches both
         i = seq.find(':')
         if i >= 0:
             head, dir, tail = seq[:i], '', seq[i+1:]
             if tail[:1] in '-+':
                 dir, tail = tail[:1], tail[1:]
             if not isnumeric(tail):
                 raise Error, "bad message list %s" % seq
             try:
                 count = int(tail)
             except (ValueError, OverflowError):
                 # Can't use sys.maxint because of i+count below
                 count = len(all)
             try:
                 anchor = self._parseindex(head, all)
             except Error, msg:
                 seqs = self.getsequences()
                 if not seqs.has_key(head):
                     if not msg:
                         msg = "bad message list %s" % seq
                     raise Error, msg, sys.exc_info()[2]
                 msgs = seqs[head]
                 if not msgs:
                     raise Error, "sequence %s empty" % head
                 if dir == '-':
                     return msgs[-count:]
                 else:
                     return msgs[:count]
             else:
                 if not dir:
                     if head in ('prev', 'last'):
                         dir = '-'
                 if dir == '-':
                     i = bisect(all, anchor)
                     return all[max(0, i-count):i]
                 else:
                     i = bisect(all, anchor-1)
                     return all[i:i+count]
         # Test for X-Y next
         i = seq.find('-')
         if i >= 0:
             begin = self._parseindex(seq[:i], all)
             end = self._parseindex(seq[i+1:], all)
             i = bisect(all, begin-1)
             j = bisect(all, end)
             r = all[i:j]
             if not r:
                 raise Error, "bad message list %s" % seq
             return r
         # Neither X:Y nor X-Y; must be a number or a (pseudo-)sequence
         try:
             n = self._parseindex(seq, all)
         except Error, msg:
             seqs = self.getsequences()
             if not seqs.has_key(seq):
                 if not msg:
                     msg = "bad message list %s" % seq
                 raise Error, msg
             return seqs[seq]
         else:
             if n not in all:
                 if isnumeric(seq):
                     raise Error, "message %d doesn't exist" % n
                 else:
                     raise Error, "no %s message" % seq
             else:
                 return [n]

def putsequences	(	self,
		sequences
	)

Write the set of sequences back to the folder.

Definition at line 316 of file mhlib.py.

References Folder.getsequencesfilename(), and aifc.open().

 
     def putsequences(self, sequences):
         """Write the set of sequences back to the folder."""
         fullname = self.getsequencesfilename()
         f = None
         for key in sequences.keys():
             s = IntSet('', ' ')
             s.fromlist(sequences[key])
             if not f: f = open(fullname, 'w')
             f.write('%s: %s\n' % (key, s.tostring()))
         if not f:
             try:
                 os.unlink(fullname)
             except os.error:
                 pass
         else:
             f.close()

def refilemessages	(	self,
		list,
		tofolder,
		keepsequences = `0`
	)

Refile one or more messages -- may raise os.error.
'tofolder' is an open folder object.

Definition at line 489 of file mhlib.py.

References shutil.copy2(), Folder.getmessagefilename(), Folder.getsequences(), Folder.putsequences(), and Folder.removefromallsequences().

 
     def refilemessages(self, list, tofolder, keepsequences=0):
         """Refile one or more messages -- may raise os.error.
         'tofolder' is an open folder object."""
         errors = []
         refiled = {}
         for n in list:
             ton = tofolder.getlast() + 1
             path = self.getmessagefilename(n)
             topath = tofolder.getmessagefilename(ton)
             try:
                 os.rename(path, topath)
             except os.error:
                 # Try copying
                 try:
                     shutil.copy2(path, topath)
                     os.unlink(path)
                 except (IOError, os.error), msg:
                     errors.append(msg)
                     try:
                         os.unlink(topath)
                     except os.error:
                         pass
                     continue
             tofolder.setlast(ton)
             refiled[n] = ton
         if refiled:
             if keepsequences:
                 tofolder._copysequences(self, refiled.items())
             self.removefromallsequences(refiled.keys())
         if errors:
             if len(errors) == 1:
                 raise os.error, errors[0]
             else:
                 raise os.error, ('multiple errors:', errors)

def removefromallsequences	(	self,
		list
	)

Remove one or more messages from all sequences (including last)
-- but not from 'cur'!!!

Definition at line 629 of file mhlib.py.

References Folder.getsequences(), Folder.last, BlockFinder.last, and Folder.putsequences().

 
     def removefromallsequences(self, list):
         """Remove one or more messages from all sequences (including last)
         -- but not from 'cur'!!!"""
         if hasattr(self, 'last') and self.last in list:
             del self.last
         sequences = self.getsequences()
         changed = 0
         for name, seq in sequences.items():
             if name == 'cur':
                 continue
             for n in list:
                 if n in seq:
                     seq.remove(n)
                     changed = 1
                     if not seq:
                         del sequences[name]
         if changed:
             self.putsequences(sequences)

def removemessages	(	self,
		list
	)

Remove one or more messages -- may raise os.error.

Definition at line 464 of file mhlib.py.

References Folder.getmessagefilename(), Folder.removefromallsequences(), and locale.str().

 
     def removemessages(self, list):
         """Remove one or more messages -- may raise os.error."""
         errors = []
         deleted = []
         for n in list:
             path = self.getmessagefilename(n)
             commapath = self.getmessagefilename(',' + str(n))
             try:
                 os.unlink(commapath)
             except os.error:
                 pass
             try:
                 os.rename(path, commapath)
             except os.error, msg:
                 errors.append(msg)
             else:
                 deleted.append(n)
         if deleted:
             self.removefromallsequences(deleted)
         if errors:
             if len(errors) == 1:
                 raise os.error, errors[0]
             else:
                 raise os.error, ('multiple errors:', errors)

def setcurrent	(	self,
		n
	)

Set the current message.

Definition at line 341 of file mhlib.py.

References Folder.getsequencesfilename(), locale.str(), and mhlib.updateline().

 
     def setcurrent(self, n):
         """Set the current message."""
         updateline(self.getsequencesfilename(), 'cur', str(n), 0)

def setlast	(	self,
		last
	)

Set the last message number.

Definition at line 654 of file mhlib.py.

References Folder.last, and BlockFinder.last.

 
     def setlast(self, last):
         """Set the last message number."""
         if last is None:
             if hasattr(self, 'last'):
                 del self.last
         else:
             self.last = last

last

Definition at line 291 of file mhlib.py.

mh

Definition at line 246 of file mhlib.py.

name

Definition at line 247 of file mhlib.py.

def __init__	(	self,
		mh,
		name
	)

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

Public Member Functions
def	__init__

def	__repr__

def	error

def	getfullname

def	getsequencesfilename

def	getmessagefilename

def	listsubfolders

def	listallsubfolders

def	listmessages

def	getsequences

def	putsequences

def	getcurrent

def	setcurrent

def	parsesequence

def	openmessage

def	removemessages

def	refilemessages

def	movemessage

def	copymessage

def	createmessage

def	removefromallsequences

def	getlast

def	setlast