fonttools 4.60.2__cp311-cp311-win32.whl

fontTools/misc/testTools.py

@@ -0,0 +1,233 @@
+"""Helpers for writing unit tests."""
+
+from collections.abc import Iterable
+from io import BytesIO
+import os
+import re
+import shutil
+import sys
+import tempfile
+from unittest import TestCase as _TestCase
+from fontTools.config import Config
+from fontTools.misc.textTools import tobytes
+from fontTools.misc.xmlWriter import XMLWriter
+
+
+def parseXML(xmlSnippet):
+    """Parses a snippet of XML.
+
+    Input can be either a single string (unicode or UTF-8 bytes), or a
+    a sequence of strings.
+
+    The result is in the same format that would be returned by
+    XMLReader, but the parser imposes no constraints on the root
+    element so it can be called on small snippets of TTX files.
+    """
+    # To support snippets with multiple elements, we add a fake root.
+    reader = TestXMLReader_()
+    xml = b"<root>"
+    if isinstance(xmlSnippet, bytes):
+        xml += xmlSnippet
+    elif isinstance(xmlSnippet, str):
+        xml += tobytes(xmlSnippet, "utf-8")
+    elif isinstance(xmlSnippet, Iterable):
+        xml += b"".join(tobytes(s, "utf-8") for s in xmlSnippet)
+    else:
+        raise TypeError(
+            "expected string or sequence of strings; found %r"
+            % type(xmlSnippet).__name__
+        )
+    xml += b"</root>"
+    reader.parser.Parse(xml, 1)
+    return reader.root[2]
+
+
+def parseXmlInto(font, parseInto, xmlSnippet):
+    parsed_xml = [e for e in parseXML(xmlSnippet.strip()) if not isinstance(e, str)]
+    for name, attrs, content in parsed_xml:
+        parseInto.fromXML(name, attrs, content, font)
+    if hasattr(parseInto, "populateDefaults"):
+        parseInto.populateDefaults()
+    return parseInto
+
+
+class FakeFont:
+    def __init__(self, glyphs):
+        self.glyphOrder_ = glyphs
+        self.reverseGlyphOrderDict_ = {g: i for i, g in enumerate(glyphs)}
+        self.lazy = False
+        self.tables = {}
+        self.cfg = Config()
+
+    def __contains__(self, tag):
+        return tag in self.tables
+
+    def __getitem__(self, tag):
+        return self.tables[tag]
+
+    def __setitem__(self, tag, table):
+        self.tables[tag] = table
+
+    def get(self, tag, default=None):
+        return self.tables.get(tag, default)
+
+    def getGlyphID(self, name):
+        return self.reverseGlyphOrderDict_[name]
+
+    def getGlyphIDMany(self, lst):
+        return [self.getGlyphID(gid) for gid in lst]
+
+    def getGlyphName(self, glyphID):
+        if glyphID < len(self.glyphOrder_):
+            return self.glyphOrder_[glyphID]
+        else:
+            return "glyph%.5d" % glyphID
+
+    def getGlyphNameMany(self, lst):
+        return [self.getGlyphName(gid) for gid in lst]
+
+    def getGlyphOrder(self):
+        return self.glyphOrder_
+
+    def getReverseGlyphMap(self):
+        return self.reverseGlyphOrderDict_
+
+    def getGlyphNames(self):
+        return sorted(self.getGlyphOrder())
+
+
+class TestXMLReader_(object):
+    def __init__(self):
+        from xml.parsers.expat import ParserCreate
+
+        self.parser = ParserCreate()
+        self.parser.StartElementHandler = self.startElement_
+        self.parser.EndElementHandler = self.endElement_
+        self.parser.CharacterDataHandler = self.addCharacterData_
+        self.root = None
+        self.stack = []
+
+    def startElement_(self, name, attrs):
+        element = (name, attrs, [])
+        if self.stack:
+            self.stack[-1][2].append(element)
+        else:
+            self.root = element
+        self.stack.append(element)
+
+    def endElement_(self, name):
+        self.stack.pop()
+
+    def addCharacterData_(self, data):
+        self.stack[-1][2].append(data)
+
+
+def makeXMLWriter(newlinestr="\n"):
+    # don't write OS-specific new lines
+    writer = XMLWriter(BytesIO(), newlinestr=newlinestr)
+    # erase XML declaration
+    writer.file.seek(0)
+    writer.file.truncate()
+    return writer
+
+
+def getXML(func, ttFont=None):
+    """Call the passed toXML function and return the written content as a
+    list of lines (unicode strings).
+    Result is stripped of XML declaration and OS-specific newline characters.
+    """
+    writer = makeXMLWriter()
+    func(writer, ttFont)
+    xml = writer.file.getvalue().decode("utf-8")
+    # toXML methods must always end with a writer.newline()
+    assert xml.endswith("\n")
+    return xml.splitlines()
+
+
+def stripVariableItemsFromTTX(
+    string: str,
+    ttLibVersion: bool = True,
+    checkSumAdjustment: bool = True,
+    modified: bool = True,
+    created: bool = True,
+    sfntVersion: bool = False,  # opt-in only
+) -> str:
+    """Strip stuff like ttLibVersion, checksums, timestamps, etc. from TTX dumps."""
+    # ttlib changes with the fontTools version
+    if ttLibVersion:
+        string = re.sub(' ttLibVersion="[^"]+"', "", string)
+    # sometimes (e.g. some subsetter tests) we don't care whether it's OTF or TTF
+    if sfntVersion:
+        string = re.sub(' sfntVersion="[^"]+"', "", string)
+    # head table checksum and creation and mod date changes with each save.
+    if checkSumAdjustment:
+        string = re.sub('<checkSumAdjustment value="[^"]+"/>', "", string)
+    if modified:
+        string = re.sub('<modified value="[^"]+"/>', "", string)
+    if created:
+        string = re.sub('<created value="[^"]+"/>', "", string)
+    return string
+
+
+class MockFont(object):
+    """A font-like object that automatically adds any looked up glyphname
+    to its glyphOrder."""
+
+    def __init__(self):
+        self._glyphOrder = [".notdef"]
+
+        class AllocatingDict(dict):
+            def __missing__(reverseDict, key):
+                self._glyphOrder.append(key)
+                gid = len(reverseDict)
+                reverseDict[key] = gid
+                return gid
+
+        self._reverseGlyphOrder = AllocatingDict({".notdef": 0})
+        self.lazy = False
+
+    def getGlyphID(self, glyph):
+        gid = self._reverseGlyphOrder[glyph]
+        return gid
+
+    def getReverseGlyphMap(self):
+        return self._reverseGlyphOrder
+
+    def getGlyphName(self, gid):
+        return self._glyphOrder[gid]
+
+    def getGlyphOrder(self):
+        return self._glyphOrder
+
+
+class TestCase(_TestCase):
+    def __init__(self, methodName):
+        _TestCase.__init__(self, methodName)
+        # Python 3 renamed assertRaisesRegexp to assertRaisesRegex,
+        # and fires deprecation warnings if a program uses the old name.
+        if not hasattr(self, "assertRaisesRegex"):
+            self.assertRaisesRegex = self.assertRaisesRegexp
+
+
+class DataFilesHandler(TestCase):
+    def setUp(self):
+        self.tempdir = None
+        self.num_tempfiles = 0
+
+    def tearDown(self):
+        if self.tempdir:
+            shutil.rmtree(self.tempdir)
+
+    def getpath(self, testfile):
+        folder = os.path.dirname(sys.modules[self.__module__].__file__)
+        return os.path.join(folder, "data", testfile)
+
+    def temp_dir(self):
+        if not self.tempdir:
+            self.tempdir = tempfile.mkdtemp()
+
+    def temp_font(self, font_path, file_name):
+        self.temp_dir()
+        temppath = os.path.join(self.tempdir, file_name)
+        shutil.copy2(font_path, temppath)
+        return temppath

fontTools/misc/textTools.py

@@ -0,0 +1,156 @@
+"""fontTools.misc.textTools.py -- miscellaneous routines."""
+
+from __future__ import annotations
+
+import ast
+import string
+
+
+# alias kept for backward compatibility
+safeEval = ast.literal_eval
+
+
+class Tag(str):
+    @staticmethod
+    def transcode(blob):
+        if isinstance(blob, bytes):
+            blob = blob.decode("latin-1")
+        return blob
+
+    def __new__(self, content):
+        return str.__new__(self, self.transcode(content))
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __eq__(self, other):
+        return str.__eq__(self, self.transcode(other))
+
+    def __hash__(self):
+        return str.__hash__(self)
+
+    def tobytes(self):
+        return self.encode("latin-1")
+
+
+def readHex(content):
+    """Convert a list of hex strings to binary data."""
+    return deHexStr(strjoin(chunk for chunk in content if isinstance(chunk, str)))
+
+
+def deHexStr(hexdata):
+    """Convert a hex string to binary data."""
+    hexdata = strjoin(hexdata.split())
+    if len(hexdata) % 2:
+        hexdata = hexdata + "0"
+    data = []
+    for i in range(0, len(hexdata), 2):
+        data.append(bytechr(int(hexdata[i : i + 2], 16)))
+    return bytesjoin(data)
+
+
+def hexStr(data):
+    """Convert binary data to a hex string."""
+    h = string.hexdigits
+    r = ""
+    for c in data:
+        i = byteord(c)
+        r = r + h[(i >> 4) & 0xF] + h[i & 0xF]
+    return r
+
+
+def num2binary(l, bits=32):
+    items = []
+    binary = ""
+    for i in range(bits):
+        if l & 0x1:
+            binary = "1" + binary
+        else:
+            binary = "0" + binary
+        l = l >> 1
+        if not ((i + 1) % 8):
+            items.append(binary)
+            binary = ""
+    if binary:
+        items.append(binary)
+    items.reverse()
+    assert l in (0, -1), "number doesn't fit in number of bits"
+    return " ".join(items)
+
+
+def binary2num(bin):
+    bin = strjoin(bin.split())
+    l = 0
+    for digit in bin:
+        l = l << 1
+        if digit != "0":
+            l = l | 0x1
+    return l
+
+
+def caselessSort(alist):
+    """Return a sorted copy of a list. If there are only strings
+    in the list, it will not consider case.
+    """
+
+    try:
+        return sorted(alist, key=lambda a: (a.lower(), a))
+    except TypeError:
+        return sorted(alist)
+
+
+def pad(data, size):
+    r"""Pad byte string 'data' with null bytes until its length is a
+    multiple of 'size'.
+
+    >>> len(pad(b'abcd', 4))
+    4
+    >>> len(pad(b'abcde', 2))
+    6
+    >>> len(pad(b'abcde', 4))
+    8
+    >>> pad(b'abcdef', 4) == b'abcdef\x00\x00'
+    True
+    """
+    data = tobytes(data)
+    if size > 1:
+        remainder = len(data) % size
+        if remainder:
+            data += b"\0" * (size - remainder)
+    return data
+
+
+def tostr(s: str | bytes, encoding: str = "ascii", errors: str = "strict") -> str:
+    if not isinstance(s, str):
+        return s.decode(encoding, errors)
+    else:
+        return s
+
+
+def tobytes(s: str | bytes, encoding: str = "ascii", errors: str = "strict") -> bytes:
+    if isinstance(s, str):
+        return s.encode(encoding, errors)
+    else:
+        return bytes(s)
+
+
+def bytechr(n):
+    return bytes([n])
+
+
+def byteord(c):
+    return c if isinstance(c, int) else ord(c)
+
+
+def strjoin(iterable, joiner=""):
+    return tostr(joiner).join(iterable)
+
+
+def bytesjoin(iterable, joiner=b""):
+    return tobytes(joiner).join(tobytes(item) for item in iterable)
+
+
+if __name__ == "__main__":
+    import doctest, sys
+
+    sys.exit(doctest.testmod().failed)

fontTools/misc/timeTools.py

@@ -0,0 +1,88 @@
+"""fontTools.misc.timeTools.py -- tools for working with OpenType timestamps.
+"""
+
+import os
+import time
+from datetime import datetime, timezone
+import calendar
+
+
+epoch_diff = calendar.timegm((1904, 1, 1, 0, 0, 0, 0, 0, 0))
+
+DAYNAMES = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]
+MONTHNAMES = [
+    None,
+    "Jan",
+    "Feb",
+    "Mar",
+    "Apr",
+    "May",
+    "Jun",
+    "Jul",
+    "Aug",
+    "Sep",
+    "Oct",
+    "Nov",
+    "Dec",
+]
+
+
+def asctime(t=None):
+    """
+    Convert a tuple or struct_time representing a time as returned by gmtime()
+    or localtime() to a 24-character string of the following form:
+
+    >>> asctime(time.gmtime(0))
+    'Thu Jan  1 00:00:00 1970'
+
+    If t is not provided, the current time as returned by localtime() is used.
+    Locale information is not used by asctime().
+
+    This is meant to normalise the output of the built-in time.asctime() across
+    different platforms and Python versions.
+    In Python 3.x, the day of the month is right-justified, whereas on Windows
+    Python 2.7 it is padded with zeros.
+
+    See https://github.com/fonttools/fonttools/issues/455
+    """
+    if t is None:
+        t = time.localtime()
+    s = "%s %s %2s %s" % (
+        DAYNAMES[t.tm_wday],
+        MONTHNAMES[t.tm_mon],
+        t.tm_mday,
+        time.strftime("%H:%M:%S %Y", t),
+    )
+    return s
+
+
+def timestampToString(value):
+    return asctime(time.gmtime(max(0, value + epoch_diff)))
+
+
+def timestampFromString(value):
+    wkday, mnth = value[:7].split()
+    t = datetime.strptime(value[7:], " %d %H:%M:%S %Y")
+    t = t.replace(month=MONTHNAMES.index(mnth), tzinfo=timezone.utc)
+    wkday_idx = DAYNAMES.index(wkday)
+    assert t.weekday() == wkday_idx, '"' + value + '" has inconsistent weekday'
+    return int(t.timestamp()) - epoch_diff
+
+
+def timestampNow():
+    # https://reproducible-builds.org/specs/source-date-epoch/
+    source_date_epoch = os.environ.get("SOURCE_DATE_EPOCH")
+    if source_date_epoch is not None:
+        return int(source_date_epoch) - epoch_diff
+    return int(time.time() - epoch_diff)
+
+
+def timestampSinceEpoch(value):
+    return int(value - epoch_diff)
+
+
+if __name__ == "__main__":
+    import sys
+    import doctest
+
+    sys.exit(doctest.testmod().failed)