| 1 | n/a | """A readline()-style interface to the parts of a multipart message. |
|---|
| 2 | n/a | |
|---|
| 3 | n/a | The MultiFile class makes each part of a multipart message "feel" like |
|---|
| 4 | n/a | an ordinary file, as long as you use fp.readline(). Allows recursive |
|---|
| 5 | n/a | use, for nested multipart messages. Probably best used together |
|---|
| 6 | n/a | with module mimetools. |
|---|
| 7 | n/a | |
|---|
| 8 | n/a | Suggested use: |
|---|
| 9 | n/a | |
|---|
| 10 | n/a | real_fp = open(...) |
|---|
| 11 | n/a | fp = MultiFile(real_fp) |
|---|
| 12 | n/a | |
|---|
| 13 | n/a | "read some lines from fp" |
|---|
| 14 | n/a | fp.push(separator) |
|---|
| 15 | n/a | while 1: |
|---|
| 16 | n/a | "read lines from fp until it returns an empty string" (A) |
|---|
| 17 | n/a | if not fp.next(): break |
|---|
| 18 | n/a | fp.pop() |
|---|
| 19 | n/a | "read remaining lines from fp until it returns an empty string" |
|---|
| 20 | n/a | |
|---|
| 21 | n/a | The latter sequence may be used recursively at (A). |
|---|
| 22 | n/a | It is also allowed to use multiple push()...pop() sequences. |
|---|
| 23 | n/a | |
|---|
| 24 | n/a | If seekable is given as 0, the class code will not do the bookkeeping |
|---|
| 25 | n/a | it normally attempts in order to make seeks relative to the beginning of the |
|---|
| 26 | n/a | current file part. This may be useful when using MultiFile with a non- |
|---|
| 27 | n/a | seekable stream object. |
|---|
| 28 | 1 | """ |
|---|
| 29 | 1 | from warnings import warn |
|---|
| 30 | 1 | warn("the multifile module has been deprecated since Python 2.5", |
|---|
| 31 | 1 | DeprecationWarning, stacklevel=2) |
|---|
| 32 | 1 | del warn |
|---|
| 33 | n/a | |
|---|
| 34 | 1 | __all__ = ["MultiFile","Error"] |
|---|
| 35 | n/a | |
|---|
| 36 | 2 | class Error(Exception): |
|---|
| 37 | 1 | pass |
|---|
| 38 | n/a | |
|---|
| 39 | 2 | class MultiFile: |
|---|
| 40 | n/a | |
|---|
| 41 | 1 | seekable = 0 |
|---|
| 42 | n/a | |
|---|
| 43 | 1 | def __init__(self, fp, seekable=1): |
|---|
| 44 | 1 | self.fp = fp |
|---|
| 45 | 1 | self.stack = [] |
|---|
| 46 | 1 | self.level = 0 |
|---|
| 47 | 1 | self.last = 0 |
|---|
| 48 | 1 | if seekable: |
|---|
| 49 | 1 | self.seekable = 1 |
|---|
| 50 | 1 | self.start = self.fp.tell() |
|---|
| 51 | 1 | self.posstack = [] |
|---|
| 52 | n/a | |
|---|
| 53 | 1 | def tell(self): |
|---|
| 54 | 36 | if self.level > 0: |
|---|
| 55 | 0 | return self.lastpos |
|---|
| 56 | 36 | return self.fp.tell() - self.start |
|---|
| 57 | n/a | |
|---|
| 58 | 1 | def seek(self, pos, whence=0): |
|---|
| 59 | 0 | here = self.tell() |
|---|
| 60 | 0 | if whence: |
|---|
| 61 | 0 | if whence == 1: |
|---|
| 62 | 0 | pos = pos + here |
|---|
| 63 | 0 | elif whence == 2: |
|---|
| 64 | 0 | if self.level > 0: |
|---|
| 65 | 0 | pos = pos + self.lastpos |
|---|
| 66 | n/a | else: |
|---|
| 67 | 0 | raise Error, "can't use whence=2 yet" |
|---|
| 68 | 0 | if not 0 <= pos <= here or \ |
|---|
| 69 | 0 | self.level > 0 and pos > self.lastpos: |
|---|
| 70 | 0 | raise Error, 'bad MultiFile.seek() call' |
|---|
| 71 | 0 | self.fp.seek(pos + self.start) |
|---|
| 72 | 0 | self.level = 0 |
|---|
| 73 | 0 | self.last = 0 |
|---|
| 74 | n/a | |
|---|
| 75 | 1 | def readline(self): |
|---|
| 76 | 34 | if self.level > 0: |
|---|
| 77 | 3 | return '' |
|---|
| 78 | 31 | line = self.fp.readline() |
|---|
| 79 | n/a | # Real EOF? |
|---|
| 80 | 31 | if not line: |
|---|
| 81 | 0 | self.level = len(self.stack) |
|---|
| 82 | 0 | self.last = (self.level > 0) |
|---|
| 83 | 0 | if self.last: |
|---|
| 84 | 0 | raise Error, 'sudden EOF in MultiFile.readline()' |
|---|
| 85 | 0 | return '' |
|---|
| 86 | 31 | assert self.level == 0 |
|---|
| 87 | n/a | # Fast check to see if this is just data |
|---|
| 88 | 31 | if self.is_data(line): |
|---|
| 89 | 25 | return line |
|---|
| 90 | n/a | else: |
|---|
| 91 | n/a | # Ignore trailing whitespace on marker lines |
|---|
| 92 | 6 | marker = line.rstrip() |
|---|
| 93 | n/a | # No? OK, try to match a boundary. |
|---|
| 94 | n/a | # Return the line (unstripped) if we don't. |
|---|
| 95 | 6 | for i, sep in enumerate(reversed(self.stack)): |
|---|
| 96 | 6 | if marker == self.section_divider(sep): |
|---|
| 97 | 4 | self.last = 0 |
|---|
| 98 | 4 | break |
|---|
| 99 | 2 | elif marker == self.end_marker(sep): |
|---|
| 100 | 2 | self.last = 1 |
|---|
| 101 | 2 | break |
|---|
| 102 | n/a | else: |
|---|
| 103 | 0 | return line |
|---|
| 104 | n/a | # We only get here if we see a section divider or EOM line |
|---|
| 105 | 6 | if self.seekable: |
|---|
| 106 | 6 | self.lastpos = self.tell() - len(line) |
|---|
| 107 | 6 | self.level = i+1 |
|---|
| 108 | 6 | if self.level > 1: |
|---|
| 109 | 0 | raise Error,'Missing endmarker in MultiFile.readline()' |
|---|
| 110 | 6 | return '' |
|---|
| 111 | n/a | |
|---|
| 112 | 1 | def readlines(self): |
|---|
| 113 | 3 | list = [] |
|---|
| 114 | 3 | while 1: |
|---|
| 115 | 12 | line = self.readline() |
|---|
| 116 | 12 | if not line: break |
|---|
| 117 | 9 | list.append(line) |
|---|
| 118 | 3 | return list |
|---|
| 119 | n/a | |
|---|
| 120 | 1 | def read(self): # Note: no size argument -- read until EOF only! |
|---|
| 121 | 0 | return ''.join(self.readlines()) |
|---|
| 122 | n/a | |
|---|
| 123 | 1 | def next(self): |
|---|
| 124 | 7 | while self.readline(): pass |
|---|
| 125 | 6 | if self.level > 1 or self.last: |
|---|
| 126 | 2 | return 0 |
|---|
| 127 | 4 | self.level = 0 |
|---|
| 128 | 4 | self.last = 0 |
|---|
| 129 | 4 | if self.seekable: |
|---|
| 130 | 4 | self.start = self.fp.tell() |
|---|
| 131 | 4 | return 1 |
|---|
| 132 | n/a | |
|---|
| 133 | 1 | def push(self, sep): |
|---|
| 134 | 2 | if self.level > 0: |
|---|
| 135 | 0 | raise Error, 'bad MultiFile.push() call' |
|---|
| 136 | 2 | self.stack.append(sep) |
|---|
| 137 | 2 | if self.seekable: |
|---|
| 138 | 2 | self.posstack.append(self.start) |
|---|
| 139 | 2 | self.start = self.fp.tell() |
|---|
| 140 | n/a | |
|---|
| 141 | 1 | def pop(self): |
|---|
| 142 | 2 | if self.stack == []: |
|---|
| 143 | 0 | raise Error, 'bad MultiFile.pop() call' |
|---|
| 144 | 2 | if self.level <= 1: |
|---|
| 145 | 2 | self.last = 0 |
|---|
| 146 | n/a | else: |
|---|
| 147 | 0 | abslastpos = self.lastpos + self.start |
|---|
| 148 | 2 | self.level = max(0, self.level - 1) |
|---|
| 149 | 2 | self.stack.pop() |
|---|
| 150 | 2 | if self.seekable: |
|---|
| 151 | 2 | self.start = self.posstack.pop() |
|---|
| 152 | 2 | if self.level > 0: |
|---|
| 153 | 0 | self.lastpos = abslastpos - self.start |
|---|
| 154 | n/a | |
|---|
| 155 | 1 | def is_data(self, line): |
|---|
| 156 | 31 | return line[:2] != '--' |
|---|
| 157 | n/a | |
|---|
| 158 | 1 | def section_divider(self, str): |
|---|
| 159 | 6 | return "--" + str |
|---|
| 160 | n/a | |
|---|
| 161 | 1 | def end_marker(self, str): |
|---|
| 162 | 2 | return "--" + str + "--" |
|---|
