lib/markupstring.py

   1 # Code taken from ActiveState Python recipes:
   2 # http://code.activestate.com/recipes/389023/
   3 #
   4 # Changed by Marek Stepniowski <marek@stepniowski.com> to handle unicode characters
   5 import xml.sax
   6
   7
   8 class simpleHandler (xml.sax.ContentHandler):
   9     """A simple handler that provides us with indices of marked up content."""
  10     def __init__ (self):
  11         self.elements = [] #this will contain a list of elements and their start/end indices
  12         self.open_elements = [] #this holds info on open elements while we wait for their close
  13         self.content = ""
  14
  15     def startElement (self,name,attrs):
  16         if name=='foobar': return # we require an outer wrapper, which we promptly ignore.
  17         self.open_elements.append({'name':name,
  18                                    'attrs':attrs.copy(),
  19                                    'start':len(self.content),
  20                                    })
  21
  22     def endElement (self, name):
  23         if name=='foobar': return # we require an outer wrapper, which we promptly ignore.
  24         for i in range(len(self.open_elements)):
  25             e = self.open_elements[i]
  26             if e['name']==name:
  27                 # append a  (start,end), name, attrs
  28                 self.elements.append(((e['start'], #start position
  29                                        len(self.content)),# current (end) position
  30                                       e['name'],e['attrs'])
  31                                      )
  32                 del self.open_elements[i]
  33                 return
  34
  35     def characters (self, chunk):
  36         self.content += chunk
  37
  38
  39 class MarkupString (unicode):
  40     """A simple class for dealing with marked up strings. When we are sliced, we return
  41     valid marked up strings, preserving markup."""
  42     def __init__ (self, string):
  43         unicode.__init__(self, string)
  44         self.handler = simpleHandler()
  45         xml.sax.parseString((u"<foobar>%s</foobar>" % string).encode('utf-8'), self.handler)
  46         self.raw = self.handler.content
  47
  48     def __getitem__ (self, n):
  49         return self.__getslice__(n,n+1)
  50
  51     def __getslice__ (self, s, e):
  52         # only include relevant elements
  53         if not e or e > len(self.raw): e = len(self.raw)
  54         elements = filter(lambda tp: (tp[0][1] >= s and # end after the start...
  55                                       tp[0][0] <= e # and start before the end
  56                                       ),
  57                           self.handler.elements)
  58         ends = {}
  59         starts = {}
  60         for el in elements:
  61             # cycle through elements that effect our slice and keep track of
  62             # where their start and end tags should go.
  63             pos = el[0]
  64             name = el[1]
  65             attrs = el[2]
  66             # write our start tag <stag att="val"...>
  67             stag = "<%s"%name
  68             for k,v in attrs.items(): stag += " %s=%s"%(k,xml.sax.saxutils.quoteattr(v))
  69             stag += ">"
  70             etag = "</%s>"%name # simple end tag
  71             spos = pos[0]
  72             epos = pos[1]
  73             if spos < s: spos=s
  74             if epos > e: epos=e
  75             if epos != spos: # we don't care about tags that don't markup any text
  76                 if not starts.has_key(spos): starts[spos]=[]
  77                 starts[spos].append(stag)
  78                 if not ends.has_key(epos): ends[epos]=[]
  79                 ends[epos].append(etag)
  80         outbuf = "" # our actual output string
  81         for pos in range(s,e): # we move through positions
  82             char = self.raw[pos]
  83             if ends.has_key(pos):  # if there are endtags to insert...
  84                 for et in ends[pos]: outbuf += et
  85             if starts.has_key(pos): # if there are start tags to insert
  86                 mystarts = starts[pos]
  87                 # reverse these so the order works out,e.g. <i><b><u></u></b></i>
  88                 mystarts.reverse()
  89                 for st in mystarts: outbuf += st
  90             outbuf += char
  91         if ends.has_key(e):
  92             for et in ends[e]: outbuf+= et
  93         return MarkupString(outbuf)
  94
  95     def __len__(self):
  96         return len(self.raw)
  97