home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2010 May / maximum-cd-2010-05.iso / DiscContents / boxee-0.9.20.10711.exe / system / python / Lib / plat-mac / plistlib.pyo (.txt) < prev    next >
Encoding:
Python Compiled Bytecode  |  2009-07-20  |  17.4 KB  |  528 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyo (Python 2.4)
  3.  
  4. '''plistlib.py -- a tool to generate and parse MacOSX .plist files.
  5.  
  6. The PropertList (.plist) file format is a simple XML pickle supporting
  7. basic object types, like dictionaries, lists, numbers and strings.
  8. Usually the top level object is a dictionary.
  9.  
  10. To write out a plist file, use the writePlist(rootObject, pathOrFile)
  11. function. \'rootObject\' is the top level object, \'pathOrFile\' is a
  12. filename or a (writable) file object.
  13.  
  14. To parse a plist from a file, use the readPlist(pathOrFile) function,
  15. with a file name or a (readable) file object as the only argument. It
  16. returns the top level object (again, usually a dictionary).
  17.  
  18. To work with plist data in strings, you can use readPlistFromString()
  19. and writePlistToString().
  20.  
  21. Values can be strings, integers, floats, booleans, tuples, lists,
  22. dictionaries, Data or datetime.datetime objects. String values (including
  23. dictionary keys) may be unicode strings -- they will be written out as
  24. UTF-8.
  25.  
  26. The <data> plist type is supported through the Data class. This is a
  27. thin wrapper around a Python string.
  28.  
  29. Generate Plist example:
  30.  
  31.     pl = dict(
  32.         aString="Doodah",
  33.         aList=["A", "B", 12, 32.1, [1, 2, 3]],
  34.         aFloat = 0.1,
  35.         anInt = 728,
  36.         aDict=dict(
  37.             anotherString="<hello & hi there!>",
  38.             aUnicodeValue=u\'M\xe4ssig, Ma\xdf\',
  39.             aTrueValue=True,
  40.             aFalseValue=False,
  41.         ),
  42.         someData = Data("<binary gunk>"),
  43.         someMoreData = Data("<lots of binary gunk>" * 10),
  44.         aDate = datetime.datetime.fromtimestamp(time.mktime(time.gmtime())),
  45.     )
  46.     # unicode keys are possible, but a little awkward to use:
  47.     pl[u\'\xc5benraa\'] = "That was a unicode key."
  48.     writePlist(pl, fileName)
  49.  
  50. Parse Plist example:
  51.  
  52.     pl = readPlist(pathOrFile)
  53.     print pl["aKey"]
  54. '''
  55. __all__ = [
  56.     'readPlist',
  57.     'writePlist',
  58.     'readPlistFromString',
  59.     'writePlistToString',
  60.     'readPlistFromResource',
  61.     'writePlistToResource',
  62.     'Plist',
  63.     'Data',
  64.     'Dict']
  65. import binascii
  66. import datetime
  67. from cStringIO import StringIO
  68. import re
  69.  
  70. def readPlist(pathOrFile):
  71.     """Read a .plist file. 'pathOrFile' may either be a file name or a
  72.     (readable) file object. Return the unpacked root object (which
  73.     usually is a dictionary).
  74.     """
  75.     didOpen = 0
  76.     if isinstance(pathOrFile, (str, unicode)):
  77.         pathOrFile = open(pathOrFile)
  78.         didOpen = 1
  79.     
  80.     p = PlistParser()
  81.     rootObject = p.parse(pathOrFile)
  82.     if didOpen:
  83.         pathOrFile.close()
  84.     
  85.     return rootObject
  86.  
  87.  
  88. def writePlist(rootObject, pathOrFile):
  89.     """Write 'rootObject' to a .plist file. 'pathOrFile' may either be a
  90.     file name or a (writable) file object.
  91.     """
  92.     didOpen = 0
  93.     if isinstance(pathOrFile, (str, unicode)):
  94.         pathOrFile = open(pathOrFile, 'w')
  95.         didOpen = 1
  96.     
  97.     writer = PlistWriter(pathOrFile)
  98.     writer.writeln('<plist version="1.0">')
  99.     writer.writeValue(rootObject)
  100.     writer.writeln('</plist>')
  101.     if didOpen:
  102.         pathOrFile.close()
  103.     
  104.  
  105.  
  106. def readPlistFromString(data):
  107.     '''Read a plist data from a string. Return the root object.
  108.     '''
  109.     return readPlist(StringIO(data))
  110.  
  111.  
  112. def writePlistToString(rootObject):
  113.     """Return 'rootObject' as a plist-formatted string.
  114.     """
  115.     f = StringIO()
  116.     writePlist(rootObject, f)
  117.     return f.getvalue()
  118.  
  119.  
  120. def readPlistFromResource(path, restype = 'plst', resid = 0):
  121.     '''Read plst resource from the resource fork of path.
  122.     '''
  123.     FSRef = FSRef
  124.     FSGetResourceForkName = FSGetResourceForkName
  125.     import Carbon.File
  126.     fsRdPerm = fsRdPerm
  127.     import Carbon.Files
  128.     Res = Res
  129.     import Carbon
  130.     fsRef = FSRef(path)
  131.     resNum = Res.FSOpenResourceFile(fsRef, FSGetResourceForkName(), fsRdPerm)
  132.     Res.UseResFile(resNum)
  133.     plistData = Res.Get1Resource(restype, resid).data
  134.     Res.CloseResFile(resNum)
  135.     return readPlistFromString(plistData)
  136.  
  137.  
  138. def writePlistToResource(rootObject, path, restype = 'plst', resid = 0):
  139.     """Write 'rootObject' as a plst resource to the resource fork of path.
  140.     """
  141.     FSRef = FSRef
  142.     FSGetResourceForkName = FSGetResourceForkName
  143.     import Carbon.File
  144.     fsRdWrPerm = fsRdWrPerm
  145.     import Carbon.Files
  146.     Res = Res
  147.     import Carbon
  148.     plistData = writePlistToString(rootObject)
  149.     fsRef = FSRef(path)
  150.     resNum = Res.FSOpenResourceFile(fsRef, FSGetResourceForkName(), fsRdWrPerm)
  151.     Res.UseResFile(resNum)
  152.     
  153.     try:
  154.         Res.Get1Resource(restype, resid).RemoveResource()
  155.     except Res.Error:
  156.         pass
  157.  
  158.     res = Res.Resource(plistData)
  159.     res.AddResource(restype, resid, '')
  160.     res.WriteResource()
  161.     Res.CloseResFile(resNum)
  162.  
  163.  
  164. class DumbXMLWriter:
  165.     
  166.     def __init__(self, file, indentLevel = 0, indent = '\t'):
  167.         self.file = file
  168.         self.stack = []
  169.         self.indentLevel = indentLevel
  170.         self.indent = indent
  171.  
  172.     
  173.     def beginElement(self, element):
  174.         self.stack.append(element)
  175.         self.writeln('<%s>' % element)
  176.         self.indentLevel += 1
  177.  
  178.     
  179.     def endElement(self, element):
  180.         self.indentLevel -= 1
  181.         self.writeln('</%s>' % element)
  182.  
  183.     
  184.     def simpleElement(self, element, value = None):
  185.         if value is not None:
  186.             value = _escapeAndEncode(value)
  187.             self.writeln('<%s>%s</%s>' % (element, value, element))
  188.         else:
  189.             self.writeln('<%s/>' % element)
  190.  
  191.     
  192.     def writeln(self, line):
  193.         if line:
  194.             self.file.write(self.indentLevel * self.indent + line + '\n')
  195.         else:
  196.             self.file.write('\n')
  197.  
  198.  
  199. _dateParser = re.compile('(?P<year>\\d\\d\\d\\d)(?:-(?P<month>\\d\\d)(?:-(?P<day>\\d\\d)(?:T(?P<hour>\\d\\d)(?::(?P<minute>\\d\\d)(?::(?P<second>\\d\\d))?)?)?)?)?Z')
  200.  
  201. def _dateFromString(s):
  202.     order = ('year', 'month', 'day', 'hour', 'minute', 'second')
  203.     gd = _dateParser.match(s).groupdict()
  204.     lst = []
  205.     for key in order:
  206.         val = gd[key]
  207.         if val is None:
  208.             break
  209.         
  210.         lst.append(int(val))
  211.     
  212.     return datetime.datetime(*lst)
  213.  
  214.  
  215. def _dateToString(d):
  216.     return '%04d-%02d-%02dT%02d:%02d:%02dZ' % (d.year, d.month, d.day, d.hour, d.minute, d.second)
  217.  
  218. _controlCharPat = re.compile('[\\x00\\x01\\x02\\x03\\x04\\x05\\x06\\x07\\x08\\x0b\\x0c\\x0e\\x0f\\x10\\x11\\x12\\x13\\x14\\x15\\x16\\x17\\x18\\x19\\x1a\\x1b\\x1c\\x1d\\x1e\\x1f]')
  219.  
  220. def _escapeAndEncode(text):
  221.     m = _controlCharPat.search(text)
  222.     if m is not None:
  223.         raise ValueError("strings can't contains control characters; use plistlib.Data instead")
  224.     
  225.     text = text.replace('\r\n', '\n')
  226.     text = text.replace('\r', '\n')
  227.     text = text.replace('&', '&')
  228.     text = text.replace('<', '<')
  229.     text = text.replace('>', '>')
  230.     return text.encode('utf-8')
  231.  
  232. PLISTHEADER = '<?xml version="1.0" encoding="UTF-8"?>\n<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n'
  233.  
  234. class PlistWriter(DumbXMLWriter):
  235.     
  236.     def __init__(self, file, indentLevel = 0, indent = '\t', writeHeader = 1):
  237.         if writeHeader:
  238.             file.write(PLISTHEADER)
  239.         
  240.         DumbXMLWriter.__init__(self, file, indentLevel, indent)
  241.  
  242.     
  243.     def writeValue(self, value):
  244.         if isinstance(value, (str, unicode)):
  245.             self.simpleElement('string', value)
  246.         elif isinstance(value, bool):
  247.             if value:
  248.                 self.simpleElement('true')
  249.             else:
  250.                 self.simpleElement('false')
  251.         elif isinstance(value, int):
  252.             self.simpleElement('integer', str(value))
  253.         elif isinstance(value, float):
  254.             self.simpleElement('real', repr(value))
  255.         elif isinstance(value, dict):
  256.             self.writeDict(value)
  257.         elif isinstance(value, Data):
  258.             self.writeData(value)
  259.         elif isinstance(value, datetime.datetime):
  260.             self.simpleElement('date', _dateToString(value))
  261.         elif isinstance(value, (tuple, list)):
  262.             self.writeArray(value)
  263.         else:
  264.             raise TypeError('unsuported type: %s' % type(value))
  265.  
  266.     
  267.     def writeData(self, data):
  268.         self.beginElement('data')
  269.         self.indentLevel -= 1
  270.         maxlinelength = 76 - len(self.indent.replace('\t', ' ' * 8) * self.indentLevel)
  271.         for line in data.asBase64(maxlinelength).split('\n'):
  272.             if line:
  273.                 self.writeln(line)
  274.                 continue
  275.             self
  276.         
  277.         self.indentLevel += 1
  278.         self.endElement('data')
  279.  
  280.     
  281.     def writeDict(self, d):
  282.         self.beginElement('dict')
  283.         items = d.items()
  284.         items.sort()
  285.         for key, value in items:
  286.             if not isinstance(key, (str, unicode)):
  287.                 raise TypeError('keys must be strings')
  288.             
  289.             self.simpleElement('key', key)
  290.             self.writeValue(value)
  291.         
  292.         self.endElement('dict')
  293.  
  294.     
  295.     def writeArray(self, array):
  296.         self.beginElement('array')
  297.         for value in array:
  298.             self.writeValue(value)
  299.         
  300.         self.endElement('array')
  301.  
  302.  
  303.  
  304. class _InternalDict(dict):
  305.     
  306.     def __getattr__(self, attr):
  307.         
  308.         try:
  309.             value = self[attr]
  310.         except KeyError:
  311.             raise AttributeError, attr
  312.  
  313.         warn = warn
  314.         import warnings
  315.         warn('Attribute access from plist dicts is deprecated, use d[key] notation instead', PendingDeprecationWarning)
  316.         return value
  317.  
  318.     
  319.     def __setattr__(self, attr, value):
  320.         warn = warn
  321.         import warnings
  322.         warn('Attribute access from plist dicts is deprecated, use d[key] notation instead', PendingDeprecationWarning)
  323.         self[attr] = value
  324.  
  325.     
  326.     def __delattr__(self, attr):
  327.         
  328.         try:
  329.             del self[attr]
  330.         except KeyError:
  331.             raise AttributeError, attr
  332.  
  333.         warn = warn
  334.         import warnings
  335.         warn('Attribute access from plist dicts is deprecated, use d[key] notation instead', PendingDeprecationWarning)
  336.  
  337.  
  338.  
  339. class Dict(_InternalDict):
  340.     
  341.     def __init__(self, **kwargs):
  342.         warn = warn
  343.         import warnings
  344.         warn('The plistlib.Dict class is deprecated, use builtin dict instead', PendingDeprecationWarning)
  345.         super(Dict, self).__init__(**kwargs)
  346.  
  347.  
  348.  
  349. class Plist(_InternalDict):
  350.     '''This class has been deprecated. Use readPlist() and writePlist()
  351.     functions instead, together with regular dict objects.
  352.     '''
  353.     
  354.     def __init__(self, **kwargs):
  355.         warn = warn
  356.         import warnings
  357.         warn('The Plist class is deprecated, use the readPlist() and writePlist() functions instead', PendingDeprecationWarning)
  358.         super(Plist, self).__init__(**kwargs)
  359.  
  360.     
  361.     def fromFile(cls, pathOrFile):
  362.         '''Deprecated. Use the readPlist() function instead.'''
  363.         rootObject = readPlist(pathOrFile)
  364.         plist = cls()
  365.         plist.update(rootObject)
  366.         return plist
  367.  
  368.     fromFile = classmethod(fromFile)
  369.     
  370.     def write(self, pathOrFile):
  371.         '''Deprecated. Use the writePlist() function instead.'''
  372.         writePlist(self, pathOrFile)
  373.  
  374.  
  375.  
  376. def _encodeBase64(s, maxlinelength = 76):
  377.     maxbinsize = (maxlinelength // 4) * 3
  378.     pieces = []
  379.     for i in range(0, len(s), maxbinsize):
  380.         chunk = s[i:i + maxbinsize]
  381.         pieces.append(binascii.b2a_base64(chunk))
  382.     
  383.     return ''.join(pieces)
  384.  
  385.  
  386. class Data:
  387.     '''Wrapper for binary data.'''
  388.     
  389.     def __init__(self, data):
  390.         self.data = data
  391.  
  392.     
  393.     def fromBase64(cls, data):
  394.         return cls(binascii.a2b_base64(data))
  395.  
  396.     fromBase64 = classmethod(fromBase64)
  397.     
  398.     def asBase64(self, maxlinelength = 76):
  399.         return _encodeBase64(self.data, maxlinelength)
  400.  
  401.     
  402.     def __cmp__(self, other):
  403.         if isinstance(other, self.__class__):
  404.             return cmp(self.data, other.data)
  405.         elif isinstance(other, str):
  406.             return cmp(self.data, other)
  407.         else:
  408.             return cmp(id(self), id(other))
  409.  
  410.     
  411.     def __repr__(self):
  412.         return '%s(%s)' % (self.__class__.__name__, repr(self.data))
  413.  
  414.  
  415.  
  416. class PlistParser:
  417.     
  418.     def __init__(self):
  419.         self.stack = []
  420.         self.currentKey = None
  421.         self.root = None
  422.  
  423.     
  424.     def parse(self, fileobj):
  425.         ParserCreate = ParserCreate
  426.         import xml.parsers.expat
  427.         parser = ParserCreate()
  428.         parser.StartElementHandler = self.handleBeginElement
  429.         parser.EndElementHandler = self.handleEndElement
  430.         parser.CharacterDataHandler = self.handleData
  431.         parser.ParseFile(fileobj)
  432.         return self.root
  433.  
  434.     
  435.     def handleBeginElement(self, element, attrs):
  436.         self.data = []
  437.         handler = getattr(self, 'begin_' + element, None)
  438.         if handler is not None:
  439.             handler(attrs)
  440.         
  441.  
  442.     
  443.     def handleEndElement(self, element):
  444.         handler = getattr(self, 'end_' + element, None)
  445.         if handler is not None:
  446.             handler()
  447.         
  448.  
  449.     
  450.     def handleData(self, data):
  451.         self.data.append(data)
  452.  
  453.     
  454.     def addObject(self, value):
  455.         if self.currentKey is not None:
  456.             self.stack[-1][self.currentKey] = value
  457.             self.currentKey = None
  458.         elif not self.stack:
  459.             self.root = value
  460.         else:
  461.             self.stack[-1].append(value)
  462.  
  463.     
  464.     def getData(self):
  465.         data = ''.join(self.data)
  466.         
  467.         try:
  468.             data = data.encode('ascii')
  469.         except UnicodeError:
  470.             pass
  471.  
  472.         self.data = []
  473.         return data
  474.  
  475.     
  476.     def begin_dict(self, attrs):
  477.         d = _InternalDict()
  478.         self.addObject(d)
  479.         self.stack.append(d)
  480.  
  481.     
  482.     def end_dict(self):
  483.         self.stack.pop()
  484.  
  485.     
  486.     def end_key(self):
  487.         self.currentKey = self.getData()
  488.  
  489.     
  490.     def begin_array(self, attrs):
  491.         a = []
  492.         self.addObject(a)
  493.         self.stack.append(a)
  494.  
  495.     
  496.     def end_array(self):
  497.         self.stack.pop()
  498.  
  499.     
  500.     def end_true(self):
  501.         self.addObject(True)
  502.  
  503.     
  504.     def end_false(self):
  505.         self.addObject(False)
  506.  
  507.     
  508.     def end_integer(self):
  509.         self.addObject(int(self.getData()))
  510.  
  511.     
  512.     def end_real(self):
  513.         self.addObject(float(self.getData()))
  514.  
  515.     
  516.     def end_string(self):
  517.         self.addObject(self.getData())
  518.  
  519.     
  520.     def end_data(self):
  521.         self.addObject(Data.fromBase64(self.getData()))
  522.  
  523.     
  524.     def end_date(self):
  525.         self.addObject(_dateFromString(self.getData()))
  526.  
  527.  
  528.