715d6c6b68
https://github.com/fonttools/ufoLib2/blob/master/src/ufoLib2/plistlib.py replaces the old ufoLib.plistlib shim, privides a single interface similar to python3's stdlib `plistlib` module, but built on top of lxml. On python < 3, it requires the singledispatch backport. This will be added as conditional installation requirement.
350 lines
8.5 KiB
Python
350 lines
8.5 KiB
Python
from __future__ import absolute_import, unicode_literals
|
|
import re
|
|
from io import BytesIO
|
|
from datetime import datetime
|
|
from base64 import b64encode, b64decode
|
|
from numbers import Integral
|
|
|
|
try:
|
|
from functools import singledispatch
|
|
except ImportError:
|
|
from singledispatch import singledispatch
|
|
from lxml import etree
|
|
from fontTools.misc.py23 import unicode, basestring, tounicode
|
|
|
|
|
|
PLIST_DOCTYPE = (
|
|
'<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" '
|
|
'"http://www.apple.com/DTDs/PropertyList-1.0.dtd">'
|
|
)
|
|
|
|
# Date should conform to a subset of ISO 8601:
|
|
# YYYY '-' MM '-' DD 'T' HH ':' MM ':' SS 'Z'
|
|
_date_parser = re.compile(
|
|
r"(?P<year>\d\d\d\d)"
|
|
r"(?:-(?P<month>\d\d)"
|
|
r"(?:-(?P<day>\d\d)"
|
|
r"(?:T(?P<hour>\d\d)"
|
|
r"(?::(?P<minute>\d\d)"
|
|
r"(?::(?P<second>\d\d))"
|
|
r"?)?)?)?)?Z",
|
|
getattr(re, "ASCII", 0), # py3-only
|
|
)
|
|
|
|
|
|
def _date_from_string(s):
|
|
order = ("year", "month", "day", "hour", "minute", "second")
|
|
gd = _date_parser.match(s).groupdict()
|
|
lst = []
|
|
for key in order:
|
|
val = gd[key]
|
|
if val is None:
|
|
break
|
|
lst.append(int(val))
|
|
return datetime(*lst)
|
|
|
|
|
|
def _date_to_string(d):
|
|
return "%04d-%02d-%02dT%02d:%02d:%02dZ" % (
|
|
d.year,
|
|
d.month,
|
|
d.day,
|
|
d.hour,
|
|
d.minute,
|
|
d.second,
|
|
)
|
|
|
|
|
|
class PlistTarget(object):
|
|
""" Event handler using the ElementTree Target API that can be
|
|
passed to a XMLParser to produce property list objects from XML.
|
|
It is based on the CPython plistlib module's _PlistParser class,
|
|
but does not use the expat parser.
|
|
|
|
>>> from lxml import etree
|
|
>>> parser = etree.XMLParser(target=PlistTarget())
|
|
>>> result = etree.XML(
|
|
... "<dict>"
|
|
... " <key>something</key>"
|
|
... " <string>blah</string>"
|
|
... "</dict>",
|
|
... parser=parser)
|
|
>>> result == {"something": "blah"}
|
|
True
|
|
|
|
Links:
|
|
https://github.com/python/cpython/blob/master/Lib/plistlib.py
|
|
http://lxml.de/parsing.html#the-target-parser-interface
|
|
"""
|
|
|
|
def __init__(self, dict_type=dict):
|
|
self.stack = []
|
|
self.current_key = None
|
|
self.root = None
|
|
self._dict_type = dict_type
|
|
|
|
def start(self, tag, attrib):
|
|
self._data = []
|
|
handler = _TARGET_START_HANDLERS.get(tag)
|
|
if handler is not None:
|
|
handler(self)
|
|
|
|
def end(self, tag):
|
|
handler = _TARGET_END_HANDLERS.get(tag)
|
|
if handler is not None:
|
|
handler(self)
|
|
|
|
def data(self, data):
|
|
self._data.append(data)
|
|
|
|
def close(self):
|
|
return self.root
|
|
|
|
# helpers
|
|
|
|
def add_object(self, value):
|
|
if self.current_key is not None:
|
|
if not isinstance(self.stack[-1], type({})):
|
|
raise ValueError("unexpected element: %r" % self.stack[-1])
|
|
self.stack[-1][self.current_key] = value
|
|
self.current_key = None
|
|
elif not self.stack:
|
|
# this is the root object
|
|
self.root = value
|
|
else:
|
|
if not isinstance(self.stack[-1], type([])):
|
|
raise ValueError("unexpected element: %r" % self.stack[-1])
|
|
self.stack[-1].append(value)
|
|
|
|
def get_data(self):
|
|
data = "".join(self._data)
|
|
self._data = []
|
|
return data
|
|
|
|
|
|
# event handlers
|
|
|
|
|
|
def start_dict(self):
|
|
d = self._dict_type()
|
|
self.add_object(d)
|
|
self.stack.append(d)
|
|
|
|
|
|
def end_dict(self):
|
|
if self.current_key:
|
|
raise ValueError("missing value for key '%s'" % self.current_key)
|
|
self.stack.pop()
|
|
|
|
|
|
def end_key(self):
|
|
if self.current_key or not isinstance(self.stack[-1], type({})):
|
|
raise ValueError("unexpected key")
|
|
self.current_key = self.get_data()
|
|
|
|
|
|
def start_array(self):
|
|
a = []
|
|
self.add_object(a)
|
|
self.stack.append(a)
|
|
|
|
|
|
def end_array(self):
|
|
self.stack.pop()
|
|
|
|
|
|
def end_true(self):
|
|
self.add_object(True)
|
|
|
|
|
|
def end_false(self):
|
|
self.add_object(False)
|
|
|
|
|
|
def end_integer(self):
|
|
self.add_object(int(self.get_data()))
|
|
|
|
|
|
def end_real(self):
|
|
self.add_object(float(self.get_data()))
|
|
|
|
|
|
def end_string(self):
|
|
self.add_object(self.get_data())
|
|
|
|
|
|
def end_data(self):
|
|
self.add_object(b64decode(self.get_data()))
|
|
|
|
|
|
def end_date(self):
|
|
self.add_object(_date_from_string(self.get_data()))
|
|
|
|
|
|
_TARGET_START_HANDLERS = {"dict": start_dict, "array": start_array}
|
|
|
|
_TARGET_END_HANDLERS = {
|
|
"dict": end_dict,
|
|
"array": end_array,
|
|
"key": end_key,
|
|
"true": end_true,
|
|
"false": end_false,
|
|
"integer": end_integer,
|
|
"real": end_real,
|
|
"string": end_string,
|
|
"data": end_data,
|
|
"date": end_date,
|
|
}
|
|
|
|
# single-dispatch generic function and overloaded implementations based
|
|
# on the type of argument, to build an element tree from a plist data
|
|
|
|
|
|
@singledispatch
|
|
def _make_element(value, **options):
|
|
raise TypeError("unsupported type: %s" % type(value))
|
|
|
|
|
|
@_make_element.register(unicode)
|
|
def _unicode_element(value, **options):
|
|
el = etree.Element("string")
|
|
el.text = value
|
|
return el
|
|
|
|
|
|
@_make_element.register(bool)
|
|
def _bool_element(value, **options):
|
|
if value:
|
|
return etree.Element("true")
|
|
else:
|
|
return etree.Element("false")
|
|
|
|
|
|
@_make_element.register(Integral)
|
|
def _integer_element(value, **options):
|
|
if -1 << 63 <= value < 1 << 64:
|
|
el = etree.Element("integer")
|
|
el.text = "%d" % value
|
|
return el
|
|
else:
|
|
raise OverflowError(value)
|
|
|
|
|
|
@_make_element.register(float)
|
|
def _float_element(value, **options):
|
|
el = etree.Element("real")
|
|
el.text = repr(value)
|
|
return el
|
|
|
|
|
|
@_make_element.register(dict)
|
|
def _dict_element(d, **options):
|
|
el = etree.Element("dict")
|
|
items = d.items()
|
|
if options.get("sort_keys", True):
|
|
items = sorted(items)
|
|
for key, value in items:
|
|
if not isinstance(key, basestring):
|
|
if options.get("skipkeys", False):
|
|
continue
|
|
raise TypeError("keys must be strings")
|
|
k = etree.SubElement(el, "key")
|
|
k.text = tounicode(key, "utf-8")
|
|
el.append(totree(value, **options))
|
|
return el
|
|
|
|
|
|
@_make_element.register(list)
|
|
@_make_element.register(tuple)
|
|
def _array_element(array, **options):
|
|
el = etree.Element("array")
|
|
if len(array) == 0:
|
|
return el
|
|
for value in array:
|
|
el.append(totree(value, **options))
|
|
return el
|
|
|
|
|
|
@_make_element.register(datetime)
|
|
def _date_element(date, **options):
|
|
el = etree.Element("date")
|
|
el.text = _date_to_string(date)
|
|
return el
|
|
|
|
|
|
@_make_element.register(bytes)
|
|
@_make_element.register(bytearray)
|
|
def _data_element(data, **options):
|
|
el = etree.Element("data")
|
|
el.text = b64encode(data)
|
|
return el
|
|
|
|
|
|
# Public functions to create element tree from plist-compatible python
|
|
# data structures and viceversa, for use when (de)serializing GLIF xml.
|
|
|
|
|
|
def totree(value, sort_keys=True, skipkeys=False):
|
|
return _make_element(value, sort_keys=sort_keys, skipkeys=skipkeys)
|
|
|
|
|
|
def fromtree(tree, dict_type=dict):
|
|
target = PlistTarget(dict_type=dict_type)
|
|
for action, element in etree.iterwalk(tree, events=("start", "end")):
|
|
if action == "start":
|
|
target.start(element.tag, element.attrib)
|
|
elif action == "end":
|
|
# if there are no children, parse the leaf's data
|
|
if not len(element):
|
|
# always pass str, not None
|
|
target.data(element.text or "")
|
|
target.end(element.tag)
|
|
return target.close()
|
|
|
|
|
|
# python3 plistlib API
|
|
|
|
|
|
def load(fp, dict_type=dict):
|
|
if not hasattr(fp, "read"):
|
|
raise AttributeError(
|
|
"'%s' object has no attribute 'read'" % type(fp).__name__
|
|
)
|
|
target = PlistTarget(dict_type=dict_type)
|
|
parser = etree.XMLParser(target=target)
|
|
return etree.parse(fp, parser=parser)
|
|
|
|
|
|
def loads(value, dict_type=dict):
|
|
fp = BytesIO(value)
|
|
return load(fp, dict_type=dict_type)
|
|
|
|
|
|
def dump(value, fp, sort_keys=True, skipkeys=False, _pretty_print=True):
|
|
if not hasattr(fp, "write"):
|
|
raise AttributeError(
|
|
"'%s' object has no attribute 'write'" % type(fp).__name__
|
|
)
|
|
root = etree.Element("plist", version="1.0")
|
|
root.append(totree(value, sort_keys=sort_keys, skipkeys=skipkeys))
|
|
tree = etree.ElementTree(root)
|
|
tree.write(
|
|
fp,
|
|
encoding="utf-8",
|
|
pretty_print=_pretty_print,
|
|
xml_declaration=True,
|
|
doctype=PLIST_DOCTYPE,
|
|
)
|
|
|
|
|
|
def dumps(value, sort_keys=True, skipkeys=False, _pretty_print=True):
|
|
fp = BytesIO()
|
|
dump(
|
|
value,
|
|
fp,
|
|
sort_keys=sort_keys,
|
|
skipkeys=skipkeys,
|
|
_pretty_print=_pretty_print,
|
|
)
|
|
return fp.getvalue()
|