home *** CD-ROM | disk | FTP | other *** search
/ Freelog 116 / FreelogNo116-JuilletSeptembre2013.iso / Bureautique / gImageReader / gimagereader_0.9-1_win32.exe / bin / plistlib.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2011-03-24  |  18KB  |  522 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.7)
  3.  
  4. '''plistlib.py -- a tool to generate and parse MacOSX .plist files.
  5.  
  6. The PropertyList (.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. import warnings
  70.  
  71. def readPlist(pathOrFile):
  72.     """Read a .plist file. 'pathOrFile' may either be a file name or a
  73.     (readable) file object. Return the unpacked root object (which
  74.     usually is a dictionary).
  75.     """
  76.     didOpen = 0
  77.     if isinstance(pathOrFile, (str, unicode)):
  78.         pathOrFile = open(pathOrFile)
  79.         didOpen = 1
  80.     p = PlistParser()
  81.     rootObject = p.parse(pathOrFile)
  82.     if didOpen:
  83.         pathOrFile.close()
  84.     return rootObject
  85.  
  86.  
  87. def writePlist(rootObject, pathOrFile):
  88.     """Write 'rootObject' to a .plist file. 'pathOrFile' may either be a
  89.     file name or a (writable) file object.
  90.     """
  91.     didOpen = 0
  92.     if isinstance(pathOrFile, (str, unicode)):
  93.         pathOrFile = open(pathOrFile, 'w')
  94.         didOpen = 1
  95.     writer = PlistWriter(pathOrFile)
  96.     writer.writeln('<plist version="1.0">')
  97.     writer.writeValue(rootObject)
  98.     writer.writeln('</plist>')
  99.     if didOpen:
  100.         pathOrFile.close()
  101.  
  102.  
  103. def readPlistFromString(data):
  104.     '''Read a plist data from a string. Return the root object.
  105.     '''
  106.     return readPlist(StringIO(data))
  107.  
  108.  
  109. def writePlistToString(rootObject):
  110.     """Return 'rootObject' as a plist-formatted string.
  111.     """
  112.     f = StringIO()
  113.     writePlist(rootObject, f)
  114.     return f.getvalue()
  115.  
  116.  
  117. def readPlistFromResource(path, restype = 'plst', resid = 0):
  118.     '''Read plst resource from the resource fork of path.
  119.     '''
  120.     warnings.warnpy3k('In 3.x, readPlistFromResource is removed.', stacklevel = 2)
  121.     FSRef = FSRef
  122.     FSGetResourceForkName = FSGetResourceForkName
  123.     import Carbon.File
  124.     fsRdPerm = fsRdPerm
  125.     import Carbon.Files
  126.     Res = Res
  127.     import Carbon
  128.     fsRef = FSRef(path)
  129.     resNum = Res.FSOpenResourceFile(fsRef, FSGetResourceForkName(), fsRdPerm)
  130.     Res.UseResFile(resNum)
  131.     plistData = Res.Get1Resource(restype, resid).data
  132.     Res.CloseResFile(resNum)
  133.     return readPlistFromString(plistData)
  134.  
  135.  
  136. def writePlistToResource(rootObject, path, restype = 'plst', resid = 0):
  137.     """Write 'rootObject' as a plst resource to the resource fork of path.
  138.     """
  139.     warnings.warnpy3k('In 3.x, writePlistToResource is removed.', stacklevel = 2)
  140.     FSRef = FSRef
  141.     FSGetResourceForkName = FSGetResourceForkName
  142.     import Carbon.File
  143.     fsRdWrPerm = fsRdWrPerm
  144.     import Carbon.Files
  145.     Res = Res
  146.     import Carbon
  147.     plistData = writePlistToString(rootObject)
  148.     fsRef = FSRef(path)
  149.     resNum = Res.FSOpenResourceFile(fsRef, FSGetResourceForkName(), fsRdWrPerm)
  150.     Res.UseResFile(resNum)
  151.     
  152.     try:
  153.         Res.Get1Resource(restype, resid).RemoveResource()
  154.     except Res.Error:
  155.         pass
  156.  
  157.     res = Res.Resource(plistData)
  158.     res.AddResource(restype, resid, '')
  159.     res.WriteResource()
  160.     Res.CloseResFile(resNum)
  161.  
  162.  
  163. class DumbXMLWriter:
  164.     
  165.     def __init__(self, file, indentLevel = 0, indent = '\t'):
  166.         self.file = file
  167.         self.stack = []
  168.         self.indentLevel = indentLevel
  169.         self.indent = indent
  170.  
  171.     
  172.     def beginElement(self, element):
  173.         self.stack.append(element)
  174.         self.writeln('<%s>' % element)
  175.         self.indentLevel += 1
  176.  
  177.     
  178.     def endElement(self, element):
  179.         if not self.indentLevel > 0:
  180.             raise AssertionError
  181.         if not None.stack.pop() == element:
  182.             raise AssertionError
  183.         None.indentLevel -= 1
  184.         self.writeln('</%s>' % element)
  185.  
  186.     
  187.     def simpleElement(self, element, value = None):
  188.         if value is not None:
  189.             value = _escapeAndEncode(value)
  190.             self.writeln('<%s>%s</%s>' % (element, value, element))
  191.         else:
  192.             self.writeln('<%s/>' % element)
  193.  
  194.     
  195.     def writeln(self, line):
  196.         if line:
  197.             self.file.write(self.indentLevel * self.indent + line + '\n')
  198.         else:
  199.             self.file.write('\n')
  200.  
  201.  
  202. _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')
  203.  
  204. def _dateFromString(s):
  205.     order = ('year', 'month', 'day', 'hour', 'minute', 'second')
  206.     gd = _dateParser.match(s).groupdict()
  207.     lst = []
  208.     for key in order:
  209.         val = gd[key]
  210.         if val is None:
  211.             break
  212.         lst.append(int(val))
  213.     
  214.     return datetime.datetime(*lst)
  215.  
  216.  
  217. def _dateToString(d):
  218.     return '%04d-%02d-%02dT%02d:%02d:%02dZ' % (d.year, d.month, d.day, d.hour, d.minute, d.second)
  219.  
  220. _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]')
  221.  
  222. def _escapeAndEncode(text):
  223.     m = _controlCharPat.search(text)
  224.     if m is not None:
  225.         raise ValueError("strings can't contains control characters; use plistlib.Data instead")
  226.     text = text.replace('\r\n', '\n')
  227.     text = text.replace('\r', '\n')
  228.     text = text.replace('&', '&')
  229.     text = text.replace('<', '<')
  230.     text = text.replace('>', '>')
  231.     return text.encode('utf-8')
  232.  
  233. PLISTHEADER = '<?xml version="1.0" encoding="UTF-8"?>\n<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n'
  234.  
  235. class PlistWriter(DumbXMLWriter):
  236.     
  237.     def __init__(self, file, indentLevel = 0, indent = '\t', writeHeader = 1):
  238.         if writeHeader:
  239.             file.write(PLISTHEADER)
  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, long)):
  252.             self.simpleElement('integer', '%d' % 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', '        ') * self.indentLevel)
  271.         for line in data.asBase64(maxlinelength).split('\n'):
  272.             if line:
  273.                 self.writeln(line)
  274.                 continue
  275.         self.indentLevel += 1
  276.         self.endElement('data')
  277.  
  278.     
  279.     def writeDict(self, d):
  280.         self.beginElement('dict')
  281.         items = d.items()
  282.         items.sort()
  283.         for key, value in items:
  284.             if not isinstance(key, (str, unicode)):
  285.                 raise TypeError('keys must be strings')
  286.             self.simpleElement('key', key)
  287.             self.writeValue(value)
  288.         
  289.         self.endElement('dict')
  290.  
  291.     
  292.     def writeArray(self, array):
  293.         self.beginElement('array')
  294.         for value in array:
  295.             self.writeValue(value)
  296.         
  297.         self.endElement('array')
  298.  
  299.  
  300.  
  301. class _InternalDict(dict):
  302.     
  303.     def __getattr__(self, attr):
  304.         
  305.         try:
  306.             value = self[attr]
  307.         except KeyError:
  308.             raise AttributeError, attr
  309.  
  310.         warn = warn
  311.         import warnings
  312.         warn('Attribute access from plist dicts is deprecated, use d[key] notation instead', PendingDeprecationWarning, 2)
  313.         return value
  314.  
  315.     
  316.     def __setattr__(self, attr, value):
  317.         warn = warn
  318.         import warnings
  319.         warn('Attribute access from plist dicts is deprecated, use d[key] notation instead', PendingDeprecationWarning, 2)
  320.         self[attr] = value
  321.  
  322.     
  323.     def __delattr__(self, attr):
  324.         
  325.         try:
  326.             del self[attr]
  327.         except KeyError:
  328.             raise AttributeError, attr
  329.  
  330.         warn = warn
  331.         import warnings
  332.         warn('Attribute access from plist dicts is deprecated, use d[key] notation instead', PendingDeprecationWarning, 2)
  333.  
  334.  
  335.  
  336. class Dict(_InternalDict):
  337.     
  338.     def __init__(self, **kwargs):
  339.         warn = warn
  340.         import warnings
  341.         warn('The plistlib.Dict class is deprecated, use builtin dict instead', PendingDeprecationWarning, 2)
  342.         super(Dict, self).__init__(**kwargs)
  343.  
  344.  
  345.  
  346. class Plist(_InternalDict):
  347.     '''This class has been deprecated. Use readPlist() and writePlist()
  348.     functions instead, together with regular dict objects.
  349.     '''
  350.     
  351.     def __init__(self, **kwargs):
  352.         warn = warn
  353.         import warnings
  354.         warn('The Plist class is deprecated, use the readPlist() and writePlist() functions instead', PendingDeprecationWarning, 2)
  355.         super(Plist, self).__init__(**kwargs)
  356.  
  357.     
  358.     def fromFile(cls, pathOrFile):
  359.         '''Deprecated. Use the readPlist() function instead.'''
  360.         rootObject = readPlist(pathOrFile)
  361.         plist = cls()
  362.         plist.update(rootObject)
  363.         return plist
  364.  
  365.     fromFile = classmethod(fromFile)
  366.     
  367.     def write(self, pathOrFile):
  368.         '''Deprecated. Use the writePlist() function instead.'''
  369.         writePlist(self, pathOrFile)
  370.  
  371.  
  372.  
  373. def _encodeBase64(s, maxlinelength = 76):
  374.     maxbinsize = (maxlinelength // 4) * 3
  375.     pieces = []
  376.     for i in range(0, len(s), maxbinsize):
  377.         chunk = s[i:i + maxbinsize]
  378.         pieces.append(binascii.b2a_base64(chunk))
  379.     
  380.     return ''.join(pieces)
  381.  
  382.  
  383. class Data:
  384.     '''Wrapper for binary data.'''
  385.     
  386.     def __init__(self, data):
  387.         self.data = data
  388.  
  389.     
  390.     def fromBase64(cls, data):
  391.         return cls(binascii.a2b_base64(data))
  392.  
  393.     fromBase64 = classmethod(fromBase64)
  394.     
  395.     def asBase64(self, maxlinelength = 76):
  396.         return _encodeBase64(self.data, maxlinelength)
  397.  
  398.     
  399.     def __cmp__(self, other):
  400.         if isinstance(other, self.__class__):
  401.             return cmp(self.data, other.data)
  402.         if None(other, str):
  403.             return cmp(self.data, other)
  404.         return None(id(self), id(other))
  405.  
  406.     
  407.     def __repr__(self):
  408.         return '%s(%s)' % (self.__class__.__name__, repr(self.data))
  409.  
  410.  
  411.  
  412. class PlistParser:
  413.     
  414.     def __init__(self):
  415.         self.stack = []
  416.         self.currentKey = None
  417.         self.root = None
  418.  
  419.     
  420.     def parse(self, fileobj):
  421.         ParserCreate = ParserCreate
  422.         import xml.parsers.expat
  423.         parser = ParserCreate()
  424.         parser.StartElementHandler = self.handleBeginElement
  425.         parser.EndElementHandler = self.handleEndElement
  426.         parser.CharacterDataHandler = self.handleData
  427.         parser.ParseFile(fileobj)
  428.         return self.root
  429.  
  430.     
  431.     def handleBeginElement(self, element, attrs):
  432.         self.data = []
  433.         handler = getattr(self, 'begin_' + element, None)
  434.         if handler is not None:
  435.             handler(attrs)
  436.  
  437.     
  438.     def handleEndElement(self, element):
  439.         handler = getattr(self, 'end_' + element, None)
  440.         if handler is not None:
  441.             handler()
  442.  
  443.     
  444.     def handleData(self, data):
  445.         self.data.append(data)
  446.  
  447.     
  448.     def addObject(self, value):
  449.         if self.currentKey is not None:
  450.             self.stack[-1][self.currentKey] = value
  451.             self.currentKey = None
  452.         elif not self.stack:
  453.             self.root = value
  454.         else:
  455.             self.stack[-1].append(value)
  456.  
  457.     
  458.     def getData(self):
  459.         data = ''.join(self.data)
  460.         
  461.         try:
  462.             data = data.encode('ascii')
  463.         except UnicodeError:
  464.             pass
  465.  
  466.         self.data = []
  467.         return data
  468.  
  469.     
  470.     def begin_dict(self, attrs):
  471.         d = _InternalDict()
  472.         self.addObject(d)
  473.         self.stack.append(d)
  474.  
  475.     
  476.     def end_dict(self):
  477.         self.stack.pop()
  478.  
  479.     
  480.     def end_key(self):
  481.         self.currentKey = self.getData()
  482.  
  483.     
  484.     def begin_array(self, attrs):
  485.         a = []
  486.         self.addObject(a)
  487.         self.stack.append(a)
  488.  
  489.     
  490.     def end_array(self):
  491.         self.stack.pop()
  492.  
  493.     
  494.     def end_true(self):
  495.         self.addObject(True)
  496.  
  497.     
  498.     def end_false(self):
  499.         self.addObject(False)
  500.  
  501.     
  502.     def end_integer(self):
  503.         self.addObject(int(self.getData()))
  504.  
  505.     
  506.     def end_real(self):
  507.         self.addObject(float(self.getData()))
  508.  
  509.     
  510.     def end_string(self):
  511.         self.addObject(self.getData())
  512.  
  513.     
  514.     def end_data(self):
  515.         self.addObject(Data.fromBase64(self.getData()))
  516.  
  517.     
  518.     def end_date(self):
  519.         self.addObject(_dateFromString(self.getData()))
  520.  
  521.  
  522.