fonttools 4.55.8__tar.gz → 4.56.0__tar.gz

fonttools-4.56.0/Doc/source/ttLib/index.rst

@@ -0,0 +1,62 @@
+#################################################
+ttLib: Read and write OpenType and TrueType fonts
+#################################################
+
+.. contents:: On this page:
+    :local:
+
+.. rubric:: Overview:
+   :heading-level: 2
+
+Most users of the :mod:`fontTools` library will be using it to generate or manipulate
+OpenType and TrueType fonts. (FontTools initially only supported TrueType fonts,
+gaining OpenType support in version 2.0, and so uses the ``tt`` prefix to refer to
+both kinds of font. Because of this we will refer to both as "TrueType fonts"
+unless we need to make a distinction.)
+
+The main entry point for such operations is the :py:mod:`fontTools.ttLib.ttFont`
+module, but other modules also provide useful functionality for handling OpenType
+fonts:
+
+.. toctree::
+   :maxdepth: 1
+
+   ttFont
+
+:mod:`.ttLib` supports fonts with TrueType-flavored glyphs (i.e., with
+a ``glyf`` table), with PostScript-flavored glyphs (i.e., ``CFF`` or
+``CFF2`` tables), and with all of the glyph formats used for color fonts
+(``CBDT``, ``COLR``, ``sbix``, and ``SVG``). Static and variable fonts
+are both supported.
+
+
+Command-line utilities
+----------------------
+
+:mod:`.ttLib` includes two modules that provide command-line operations:
+     
+.. toctree::
+   :maxdepth: 1
+   
+   removeOverlaps
+   scaleUpem
+
+
+Supporting modules
+------------------
+
+It also contains helper modules that enable lower-level
+functionality. In most cases, users will not need to access these
+modules directly:
+
+.. toctree::
+   :maxdepth: 1
+   
+   ttCollection
+   ttGlyphSet
+   macUtils
+   reorderGlyphs
+   sfnt
+   standardGlyphOrder
+   tables
+   woff2

fonttools-4.56.0/Doc/source/ttLib/macUtils.rst

@@ -0,0 +1,7 @@
+##########################################
+macUtils: Access fonts in Mac file formats
+##########################################
+
+.. automodule:: fontTools.ttLib.macUtils
+   :members:
+   :undoc-members:

fonttools-4.56.0/Doc/source/ttLib/removeOverlaps.rst

@@ -0,0 +1,13 @@
+##############################################################
+removeOverlaps: Tools to remove overlapping contours in glyphs
+##############################################################
+
+.. rubric:: Overview
+   :heading-level: 2
+
+The :mod:`fontTools.ttLib.removeOverlaps` module is a helper for
+:mod:`fontTools.ttLib`.
+
+.. automodule:: fontTools.ttLib.removeOverlaps
+   :members:
+   :undoc-members:

fonttools-4.56.0/Doc/source/ttLib/reorderGlyphs.rst

@@ -0,0 +1,13 @@
+########################################################
+reorderGlyphs: Functions to reorder the glyphs in a font
+########################################################
+
+.. rubric:: Overview
+   :heading-level: 2
+
+The :mod:`fontTools.ttLib.reorderGlyphs` module is a helper for
+:mod:`fontTools.ttLib`.
+
+.. automodule:: fontTools.ttLib.reorderGlyphs
+   :members:
+   :undoc-members:

fonttools-4.56.0/Doc/source/ttLib/scaleUpem.rst

@@ -0,0 +1,13 @@
+###########################################################
+scaleUpem: Tools to change the units-per-Em value in a font
+###########################################################
+
+.. rubric:: Overview
+   :heading-level: 2
+
+The :mod:`fontTools.ttLib.scaleUpem` module is a helper for
+:mod:`fontTools.ttLib`.
+
+.. automodule:: fontTools.ttLib.scaleUpem
+   :members:
+   :undoc-members:

fonttools-4.56.0/Doc/source/ttLib/sfnt.rst

@@ -0,0 +1,7 @@
+#########################################
+sfnt: Read and write the SFNT file format
+#########################################
+
+.. automodule:: fontTools.ttLib.sfnt
+   :members:
+   :undoc-members:

{fonttools-4.55.8 → fonttools-4.56.0}/Doc/source/ttLib/standardGlyphOrder.rst

@@ -1,9 +1,8 @@
-##################
-standardGlyphOrder
-##################
+###########################################################
+standardGlyphOrder: Interface with the Standard Glyph Order
+###########################################################
 
 .. automodule:: fontTools.ttLib.standardGlyphOrder
-   :inherited-members:
    :members:
    :undoc-members:
 

{fonttools-4.55.8 → fonttools-4.56.0}/Doc/source/ttLib/tables/TupleVariation.rst

@@ -2,6 +2,8 @@
 OpenType variations helper module
 #################################
 
+.. currentmodule:: fontTools.ttLib.tables.TupleVariation
+
 .. rubric:: Overview:
    :heading-level: 2
 

fonttools-4.56.0/Doc/source/ttLib/ttCollection.rst

@@ -0,0 +1,15 @@
+################################################################
+ttCollection: Access fonts within a TrueType/OpenType Collection
+################################################################
+
+.. rubric:: Overview
+   :heading-level: 2
+
+The :mod:`fontTools.ttLib.ttCollection` module is a helper for
+:mod:`fontTools.ttLib`. It supports the reading of TrueType and
+OpenType `Collection <https://learn.microsoft.com/en-us/typography/opentype/spec/otff#font-collections>`_ files (\*.ttc, \*.otc) so that each member font in
+the collection is accessible as a :class:`.TTFont` instance.
+
+.. automodule:: fontTools.ttLib.ttCollection
+   :members:
+   :undoc-members:

fonttools-4.56.0/Doc/source/ttLib/ttFont.rst

@@ -0,0 +1,99 @@
+####################################
+ttFont: Read and write font contents
+####################################
+
+.. contents:: On this page:
+    :local:
+
+.. rubric:: Overview
+   :heading-level: 2
+
+:mod:`.ttLib.ttFont` is the primary fontTools interface for
+inspecting, constructing, or deconstructing TrueType and OpenType
+fonts.
+
+The :class:`fontTools.ttLib.ttFont.TTFont` class provides access to
+font-level data, including font metrics, substitution and positioning
+features, and metadata, through a set of :doc:`table converters
+</ttLib/tables>`. A :class:`.TTFont` may be instantiated from a single
+font file, or it may be a member of a
+:class:`.TTCollection`. :class:`.TTFont` objects can also be
+constructed from scratch. 
+
+
+glyphSets and ttGlyphs
+----------------------
+
+In addition to font-wide data, :mod:`.ttLib.ttFont` provides access to
+individual glyphs through a :class:`.TTFont` instance's
+``.glyphSet[]`` attribute. A ``.glyphSet`` is a dict-like object that is
+indexed by glyph names. Users can use the glyphSet to interact with
+each glyph's contours, components, points, and glyph metrics.
+
+Informally, some fontTools code or documentation will make reference to
+the individual glyphs in a ``.glyphSet`` as a "ttGlyph" or the
+like. This is convenient terminology, particularly for
+discussion. However, it is important to note that there is not a
+"ttGlyph" class. Instead, the ``.glyphSet`` attribute of a
+:class:`.TTFont` serves as an abstraction layer that provides a
+uniform interface to the glyphs, regardless of whether the
+:class:`.TTFont` instance in use comes from a font file with
+TrueType-flavored glyphs (and, therefore, has a `glyf` table
+containing glyph contours) or a font with PostScript-flavored outlines
+(and, therefore, with a ``CFF`` or ``CFF2`` table containing the glyph
+contours).
+
+Regardless of the flavor, each "ttGlyph" entry in the ``.glyphSet``
+includes the corresponding Bezier outlines and components from the
+``glyf`` or ``CFF``/``CFF2`` table and the glyph's metrics. Horizontal
+metrics are drawn from the font's ``hmtx`` table, and vertical metrics
+(if any) are drawn from the ``vmtx`` table. These attributes are:
+
+    width
+        The advance width of the glyph
+    
+    lsb
+        The left sidebearing of the glyph
+    
+    height
+        (For vertical-layout fonts) The advance height of the glyph
+    
+    tsb
+        (for vertical-layout fonts) The top sidebearing of the glyph
+
+Note that these attributes do not describe the bounding box of the
+glyph filled shape, because the filled area might include negative
+coordinate values or extend beyond the advance width due to overhang.
+
+The bounds of the glyph are accessible as ``xMin``, ``xMax``,
+``yMin``, and ``yMax`` attributes.
+
+For implementation details regarding the different flavors of
+"ttGlyph", see the :doc:`ttGlyphSet </ttLib/ttGlyphSet>`
+documentation.
+
+These glyph objects also implement the :doc:`Pen Protocol
+</pens/index>` by providing ``.draw()`` and ``.drawPoints()``
+methods. See the :doc:`pens </pens/index>` package documenation
+for more.
+
+
+Package contents
+----------------
+ 
+
+.. autoclass:: fontTools.ttLib.ttFont.TTFont
+   :members:
+   :undoc-members:
+
+
+      
+.. autoclass:: fontTools.ttLib.ttFont.GlyphOrder
+   :members:
+   :undoc-members:
+   :private-members:
+
+
+.. automodule:: fontTools.ttLib.ttFont
+   :members: getTableModule, registerCustomTableClass, unregisterCustomTableClass, getCustomTableClass, getClassTag, newTable, tagToIdentifier, identifierToTag, tagToXML, xmlToTag, sortedTagList, reorderFontTables
+   :exclude-members: TTFont, GlyphOrder

fonttools-4.56.0/Doc/source/ttLib/ttGlyphSet.rst

@@ -0,0 +1,18 @@
+#################################################
+ttGlyphSet: GlyphSets returned by a TTFont object
+#################################################
+
+.. rubric:: Overview
+   :heading-level: 2
+
+The :mod:`fontTools.ttLib.ttGlyphSet` module is a helper for
+:mod:`fontTools.ttLib`.
+
+Most users will not need to access this module directly. Instead, the
+glyphs in a font are accessible as a ``.glyphSet`` dictionary in a
+:class:`TTFont` instance.
+
+.. automodule:: fontTools.ttLib.ttGlyphSet
+   :members:
+   :undoc-members:
+   :private-members:

fonttools-4.56.0/Doc/source/ttLib/woff2.rst

@@ -0,0 +1,11 @@
+################################################
+woff2: Read and write the WOFF2 font file format
+################################################
+
+Note also that :mod:`woff2` supports some :doc:`optional </optional>`
+external libraries.
+
+
+.. automodule:: fontTools.ttLib.woff2
+   :members:
+   :undoc-members:

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fontTools/__init__.py

@@ -3,6 +3,6 @@ from fontTools.misc.loggingTools import configLogger
 
 log = logging.getLogger(__name__)
 
-version = __version__ = "4.55.8"
+version = __version__ = "4.56.0"
 
 __all__ = ["version", "log", "configLogger"]

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fontTools/feaLib/error.py

@@ -1,5 +1,5 @@
 class FeatureLibError(Exception):
-    def __init__(self, message, location):
+    def __init__(self, message, location=None):
         Exception.__init__(self, message)
         self.location = location
 

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fontTools/misc/testTools.py

@@ -58,6 +58,9 @@ class FakeFont:
         self.tables = {}
         self.cfg = Config()
 
+    def __contains__(self, tag):
+        return tag in self.tables
+
     def __getitem__(self, tag):
         return self.tables[tag]
 

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fontTools/ttLib/tables/otData.py

@@ -385,7 +385,7 @@ otData = [
             (
                 "DeltaValue",
                 "DeltaValue",
-                "",
+                None,
                 "DeltaFormat in (1,2,3)",
                 "Array of compressed data",
             ),

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fontTools/ttLib/tables/otTables.py

@@ -2226,24 +2226,28 @@ _equivalents = {
 def fixLookupOverFlows(ttf, overflowRecord):
     """Either the offset from the LookupList to a lookup overflowed, or
     an offset from a lookup to a subtable overflowed.
-    The table layout is:
-    GPSO/GUSB
-            Script List
-            Feature List
-            LookUpList
-                    Lookup[0] and contents
-                            SubTable offset list
-                                    SubTable[0] and contents
-                                    ...
-                                    SubTable[n] and contents
-                    ...
-                    Lookup[n] and contents
-                            SubTable offset list
-                                    SubTable[0] and contents
-                                    ...
-                                    SubTable[n] and contents
+
+    The table layout is::
+
+      GPSO/GUSB
+              Script List
+              Feature List
+              LookUpList
+                      Lookup[0] and contents
+                              SubTable offset list
+                                      SubTable[0] and contents
+                                      ...
+                                      SubTable[n] and contents
+                      ...
+                      Lookup[n] and contents
+                              SubTable offset list
+                                      SubTable[0] and contents
+                                      ...
+                                      SubTable[n] and contents
+
     If the offset to a lookup overflowed (SubTableIndex is None)
-            we must promote the *previous*	lookup to an Extension type.
+            we must promote the *previous* lookup to an Extension type.
+
     If the offset from a lookup to subtable overflowed, then we must promote it
             to an Extension Lookup type.
     """

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fontTools/ttLib/tables/otTraverse.py

@@ -79,7 +79,8 @@ def bfs_base_table(
     """Breadth-first search tree of BaseTables.
 
     Args:
-    the root of the tree.
+        root
+            the root of the tree.
         root_accessor (Optional[str]): attribute name for the root table, if any (mostly
             useful for debugging).
         skip_root (Optional[bool]): if True, the root itself is not visited, only its

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fontTools/ttLib/ttFont.py

@@ -27,6 +27,7 @@ class TTFont(object):
     they're actually accessed. This means that simple operations can be extremely fast.
 
     Example usage:
+
     .. code-block:: pycon
 
         >>>
@@ -39,8 +40,10 @@ class TTFont(object):
         >> tt['head'].unitsPerEm
         2048
 
-    For details of the objects returned when accessing each table, see :ref:`tables`.
+    For details of the objects returned when accessing each table, see the
+    :doc:`tables </ttLib/tables>` documentation.
     To add a table to the font, use the :py:func:`newTable` function:
+
     .. code-block:: pycon
 
         >>>
@@ -50,7 +53,8 @@ class TTFont(object):
         >> font["OS/2"] = os2
 
     TrueType fonts can also be serialized to and from XML format (see also the
-    :ref:`ttx` binary):
+    :doc:`ttx </ttx>` binary):
+
     .. code-block:: pycon
 
         >>

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fontTools/varLib/__init__.py

@@ -325,7 +325,6 @@ def _add_gvar(font, masterModel, master_ttfs, tolerance=0.5, optimize=True):
 
     for glyph in font.getGlyphOrder():
         log.debug("building gvar for glyph '%s'", glyph)
-        isComposite = glyf[glyph].isComposite()
 
         allData = [
             m.glyf._getCoordinatesAndControls(glyph, m.hMetrics, m.vMetrics)
@@ -363,7 +362,7 @@ def _add_gvar(font, masterModel, master_ttfs, tolerance=0.5, optimize=True):
         endPts = control.endPts
 
         for i, (delta, support) in enumerate(zip(deltas[1:], supports[1:])):
-            if all(v == 0 for v in delta.array) and not isComposite:
+            if all(v == 0 for v in delta.array):
                 continue
             var = TupleVariation(support, delta)
             if optimize:
@@ -372,16 +371,6 @@ def _add_gvar(font, masterModel, master_ttfs, tolerance=0.5, optimize=True):
                 )
 
                 if None in delta_opt:
-                    """In composite glyphs, there should be one 0 entry
-                    to make sure the gvar entry is written to the font.
-
-                    This is to work around an issue with macOS 10.14 and can be
-                    removed once the behaviour of macOS is changed.
-
-                    https://github.com/fonttools/fonttools/issues/1381
-                    """
-                    if all(d is None for d in delta_opt):
-                        delta_opt = [(0, 0)] + [None] * (len(delta_opt) - 1)
                     # Use "optimized" version only if smaller...
                     var_opt = TupleVariation(support, delta_opt)
 

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fontTools/varLib/varStore.py

@@ -412,25 +412,6 @@ class _Encoding(object):
     def extend(self, lst):
         self.items.update(lst)
 
-    def get_room(self):
-        """Maximum number of bytes that can be added to characteristic
-        while still being beneficial to merge it into another one."""
-        count = len(self.items)
-        return max(0, (self.overhead - 1) // count - self.width)
-
-    room = property(get_room)
-
-    def get_gain(self):
-        """Maximum possible byte gain from merging this into another
-        characteristic."""
-        count = len(self.items)
-        return max(0, self.overhead - count)
-
-    gain = property(get_gain)
-
-    def gain_sort_key(self):
-        return self.gain, self.chars
-
     def width_sort_key(self):
         return self.width, self.chars
 
@@ -534,13 +515,9 @@ def VarStore_optimize(self, use_NO_VARIATION_INDEX=True, quantization=1):
     # of the old encoding is completely eliminated. However, each row
     # now would require more bytes to encode, to the tune of one byte
     # per characteristic bit that is active in the new encoding but not
-    # in the old one. The number of bits that can be added to an encoding
-    # while still beneficial to merge it into another encoding is called
-    # the "room" for that encoding.
+    # in the old one.
     #
-    # The "gain" of an encodings is the maximum number of bytes we can
-    # save by merging it into another encoding. The "gain" of merging
-    # two encodings is how many bytes we save by doing so.
+    # The "gain" of merging two encodings is how many bytes we save by doing so.
     #
     # High-level algorithm:
     #
@@ -554,7 +531,11 @@ def VarStore_optimize(self, use_NO_VARIATION_INDEX=True, quantization=1):
     #
     # - Put all encodings into a "todo" list.
     #
-    # - Sort todo list by decreasing gain (for stability).
+    # - Sort todo list (for stability) by width_sort_key(), which is a tuple
+    #   of the following items:
+    #   * The "width" of the encoding.
+    #   * The characteristic bitmap of the encoding, with higher-numbered
+    #     columns compared first.
     #
     # - Make a priority-queue of the gain from combining each two
     #   encodings in the todo list. The priority queue is sorted by
@@ -575,16 +556,7 @@ def VarStore_optimize(self, use_NO_VARIATION_INDEX=True, quantization=1):
     #
     # The output is then sorted for stability, in the following way:
     # - The VarRegionList of the input is kept intact.
-    # - All encodings are sorted before the main algorithm, by
-    #   gain_key_sort(), which is a tuple of the following items:
-    #   * The gain of the encoding.
-    #   * The characteristic bitmap of the encoding, with higher-numbered
-    #     columns compared first.
-    # - The VarData is sorted by width_sort_key(), which is a tuple
-    #   of the following items:
-    #   * The "width" of the encoding.
-    #   * The characteristic bitmap of the encoding, with higher-numbered
-    #     columns compared first.
+    # - The VarData is sorted by the same width_sort_key() used at the beginning.
     # - Within each VarData, the items are sorted as vectors of numbers.
     #
     # Finally, each VarData is optimized to remove the empty columns and
@@ -626,7 +598,7 @@ def VarStore_optimize(self, use_NO_VARIATION_INDEX=True, quantization=1):
             front_mapping[(major << 16) + minor] = row
 
     # Prepare for the main algorithm.
-    todo = sorted(encodings.values(), key=_Encoding.gain_sort_key)
+    todo = sorted(encodings.values(), key=_Encoding.width_sort_key)
     del encodings
 
     # Repeatedly pick two best encodings to combine, and combine them.

{fonttools-4.55.8 → fonttools-4.56.0/Lib/fonttools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: fonttools
-Version: 4.55.8
+Version: 4.56.0
 Summary: Tools to manipulate font files
 Home-page: http://github.com/fonttools/fonttools
 Author: Just van Rossum
@@ -391,6 +391,15 @@ Have fun!
 Changelog
 ~~~~~~~~~
 
+4.56.0 (released 2025-02-07)
+----------------------------
+
+- [varStore] Sort the input todo list with the same sorting key used for the opimizer's output (#3767).
+- [otData] Fix DeviceTable's ``DeltaValue`` repeat value which caused a crash after importing from XML and then compiling a GPOS containing Device tables (#3758).
+- [feaLib] Make ``FeatureLibError`` pickleable, so client can e.g. use feaLib to can compile features in parallel with multiprocessing (#3762).
+- [varLib/gvar] Removed workaround for old, long-fixed macOS bug about composite glyphs with all zero deltas (#1381, #1788).
+- [Docs] Updated ttLib documentation, beefed up TTFont and TTGlyphSet explanations (#3720).
+
 4.55.8 (released 2025-01-29)
 ----------------------------
 

{fonttools-4.55.8 → fonttools-4.56.0}/Lib/fonttools.egg-info/SOURCES.txt

@@ -107,11 +107,15 @@ Doc/source/svgLib/path/index.rst
 Doc/source/svgLib/path/parser.rst
 Doc/source/ttLib/index.rst
 Doc/source/ttLib/macUtils.rst
+Doc/source/ttLib/removeOverlaps.rst
+Doc/source/ttLib/reorderGlyphs.rst
+Doc/source/ttLib/scaleUpem.rst
 Doc/source/ttLib/sfnt.rst
 Doc/source/ttLib/standardGlyphOrder.rst
 Doc/source/ttLib/tables.rst
 Doc/source/ttLib/ttCollection.rst
 Doc/source/ttLib/ttFont.rst
+Doc/source/ttLib/ttGlyphSet.rst
 Doc/source/ttLib/woff2.rst
 Doc/source/ttLib/tables/B_A_S_E_.rst
 Doc/source/ttLib/tables/Bitmap_related.rst

{fonttools-4.55.8 → fonttools-4.56.0}/NEWS.rst

@@ -1,3 +1,12 @@
+4.56.0 (released 2025-02-07)
+----------------------------
+
+- [varStore] Sort the input todo list with the same sorting key used for the opimizer's output (#3767).
+- [otData] Fix DeviceTable's ``DeltaValue`` repeat value which caused a crash after importing from XML and then compiling a GPOS containing Device tables (#3758).
+- [feaLib] Make ``FeatureLibError`` pickleable, so client can e.g. use feaLib to can compile features in parallel with multiprocessing (#3762).
+- [varLib/gvar] Removed workaround for old, long-fixed macOS bug about composite glyphs with all zero deltas (#1381, #1788).
+- [Docs] Updated ttLib documentation, beefed up TTFont and TTGlyphSet explanations (#3720).
+
 4.55.8 (released 2025-01-29)
 ----------------------------
 

{fonttools-4.55.8/Lib/fonttools.egg-info → fonttools-4.56.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: fonttools
-Version: 4.55.8
+Version: 4.56.0
 Summary: Tools to manipulate font files
 Home-page: http://github.com/fonttools/fonttools
 Author: Just van Rossum
@@ -391,6 +391,15 @@ Have fun!
 Changelog
 ~~~~~~~~~
 
+4.56.0 (released 2025-02-07)
+----------------------------
+
+- [varStore] Sort the input todo list with the same sorting key used for the opimizer's output (#3767).
+- [otData] Fix DeviceTable's ``DeltaValue`` repeat value which caused a crash after importing from XML and then compiling a GPOS containing Device tables (#3758).
+- [feaLib] Make ``FeatureLibError`` pickleable, so client can e.g. use feaLib to can compile features in parallel with multiprocessing (#3762).
+- [varLib/gvar] Removed workaround for old, long-fixed macOS bug about composite glyphs with all zero deltas (#1381, #1788).
+- [Docs] Updated ttLib documentation, beefed up TTFont and TTGlyphSet explanations (#3720).
+
 4.55.8 (released 2025-01-29)
 ----------------------------