lib/dcparser/dcparser.py

   1 # -*- coding: utf-8 -*-
   2 from xml.parsers.expat import ExpatError
   3
   4 # Import ElementTree from anywhere
   5 try:
   6     import xml.etree.ElementTree as ET # Python >= 2.5
   7 except ImportError:
   8     try:
   9         import elementtree.ElementTree as ET # effbot's pure Python module
  10     except ImportError:
  11         import lxml.etree as ET # ElementTree API using libxml2
  12
  13 import converters
  14
  15
  16 __all__ = ('parse', 'ParseError')
  17
  18
  19 class ParseError(Exception):
  20     def __init__(self, message):
  21         super(self, Exception).__init__(message)
  22
  23
  24 class XMLNamespace(object):
  25     '''Represents XML namespace.'''
  26
  27     def __init__(self, uri):
  28         self.uri = uri
  29
  30     def __call__(self, tag):
  31         return '{%s}%s' % (self.uri, tag)
  32
  33     def __contains__(self, tag):
  34         return tag.startswith(str(self))
  35
  36     def __repr__(self):
  37         return 'XMLNamespace(%r)' % self.uri
  38
  39     def __str__(self):
  40         return '%s' % self.uri
  41
  42
  43 class BookInfo(object):
  44     RDF = XMLNamespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#')
  45     DC = XMLNamespace('http://purl.org/dc/elements/1.1/')
  46
  47     mapping = {
  48         DC('creator')        : ('author', converters.str_to_person),
  49         DC('title')          : ('title', converters.str_to_unicode),
  50         DC('subject.period') : ('epoch', converters.str_to_unicode),
  51         DC('subject.type')   : ('kind', converters.str_to_unicode),
  52         DC('subject.genre')  : ('genre', converters.str_to_unicode),
  53         DC('date')           : ('created_at', converters.str_to_date),
  54         DC('date.pd')        : ('released_to_public_domain_at', converters.str_to_date),
  55         DC('contributor.translator') : ('translator', converters.str_to_person),
  56         DC('contributor.technical_editor') : ('technical_editor', converters.str_to_person),
  57         DC('publisher')      : ('publisher', converters.str_to_unicode),
  58         DC('source')         : ('source_name', converters.str_to_unicode),
  59         DC('source.URL')     : ('source_url', converters.str_to_unicode),
  60     }
  61
  62     @classmethod
  63     def from_string(cls, xml):
  64         from StringIO import StringIO
  65         return cls.from_file(StringIO(xml))
  66
  67     @classmethod
  68     def from_file(cls, xml_file):
  69         book_info = cls()
  70
  71         try:
  72             tree = ET.parse(xml_file)
  73         except ExpatError, e:
  74             raise ParseError(e)
  75
  76         description = tree.find('//' + book_info.RDF('Description'))
  77         if description is None:
  78             raise ParseError('no Description tag found in document')
  79
  80         for element in description.findall('*'):
  81             book_info.parse_element(element)
  82
  83         return book_info
  84
  85     def parse_element(self, element):
  86         try:
  87             attribute, converter = self.mapping[element.tag]
  88             setattr(self, attribute, converter(element.text, getattr(self, attribute, None)))
  89         except KeyError:
  90             pass
  91
  92     def to_xml(self):
  93         """XML representation of this object."""
  94         ET._namespace_map[str(self.RDF)] = 'rdf'
  95         ET._namespace_map[str(self.DC)] = 'dc'
  96
  97         root = ET.Element(self.RDF('RDF'))
  98         description = ET.SubElement(root, self.RDF('Description'))
  99
 100         for tag, (attribute, converter) in self.mapping.iteritems():
 101             if hasattr(self, attribute):
 102                 e = ET.Element(tag)
 103                 e.text = unicode(getattr(self, attribute))
 104                 description.append(e)
 105
 106         return unicode(ET.tostring(root, 'utf-8'), 'utf-8')
 107
 108
 109 def parse(file_name):
 110     return BookInfo.from_file(file_name)
 111