fonttools 4.55.2__py3-none-any.whl → 4.55.3__py3-none-any.whl

fontTools/ttLib/tables/T_S_I__0.py

@@ -4,6 +4,8 @@ tool to store its hinting source data.
 TSI0 is the index table containing the lengths and offsets for the glyph
 programs and 'extra' programs ('fpgm', 'prep', and 'cvt') that are contained
 in the TSI1 table.
+
+See also https://learn.microsoft.com/en-us/typography/tools/vtt/tsi-tables
 """
 
 from . import DefaultTable

fontTools/ttLib/tables/T_S_I__1.py

@@ -3,6 +3,8 @@ tool to store its hinting source data.
 
 TSI1 contains the text of the glyph programs in the form of low-level assembly
 code, as well as the 'extra' programs 'fpgm', 'ppgm' (i.e. 'prep'), and 'cvt'.
+
+See also https://learn.microsoft.com/en-us/typography/tools/vtt/tsi-tables
 """
 
 from . import DefaultTable

fontTools/ttLib/tables/T_S_I__2.py

@@ -4,6 +4,8 @@ tool to store its hinting source data.
 TSI2 is the index table containing the lengths and offsets for the glyph
 programs that are contained in the TSI3 table. It uses the same format as
 the TSI0 table.
+
+See also https://learn.microsoft.com/en-us/typography/tools/vtt/tsi-tables
 """
 
 from fontTools import ttLib

fontTools/ttLib/tables/T_S_I__3.py

@@ -2,6 +2,8 @@
 tool to store its hinting source data.
 
 TSI3 contains the text of the glyph programs in the form of 'VTTTalk' code.
+
+See also https://learn.microsoft.com/en-us/typography/tools/vtt/tsi-tables
 """
 
 from fontTools import ttLib

fontTools/ttLib/tables/T_S_I__5.py

@@ -2,6 +2,8 @@
 tool to store its hinting source data.
 
 TSI5 contains the VTT character groups.
+
+See also https://learn.microsoft.com/en-us/typography/tools/vtt/tsi-tables
 """
 
 from fontTools.misc.textTools import safeEval

fontTools/ttLib/tables/T_T_F_A_.py

@@ -2,4 +2,13 @@ from . import asciiTable
 
 
 class table_T_T_F_A_(asciiTable.asciiTable):
+    """ttfautohint parameters table
+
+    The ``TTFA`` table is used by the free-software `ttfautohint` program
+    to record the parameters that `ttfautohint` was called with when it
+    was used to auto-hint the font.
+
+    See also http://freetype.org/ttfautohint/doc/ttfautohint.html#miscellaneous-1
+    """
+
     pass

fontTools/ttLib/tables/V_A_R_C_.py

@@ -2,4 +2,11 @@ from .otBase import BaseTTXConverter
 
 
 class table_V_A_R_C_(BaseTTXConverter):
+    """Variable Components table
+
+    The ``VARC`` table contains variation information for composite glyphs.
+
+    See also https://github.com/harfbuzz/boring-expansion-spec/blob/main/VARC.md
+    """
+
     pass

fontTools/ttLib/tables/V_D_M_X_.py

@@ -37,6 +37,14 @@ VDMX_vTableFmt = """
 
 
 class table_V_D_M_X_(DefaultTable.DefaultTable):
+    """Vertical Device Metrics table
+
+    The ``VDMX`` table records changes to the vertical glyph minima
+    and maxima that result from Truetype instructions.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/vdmx
+    """
+
     def decompile(self, data, ttFont):
         pos = 0  # track current position from to start of VDMX table
         dummy, data = sstruct.unpack2(VDMX_HeaderFmt, data, self)

fontTools/ttLib/tables/V_O_R_G_.py

@@ -4,11 +4,18 @@ import struct
 
 
 class table_V_O_R_G_(DefaultTable.DefaultTable):
-    """This table is structured so that you can treat it like a dictionary keyed by glyph name.
+    """Vertical Origin table
+
+    The ``VORG`` table contains the vertical origin of each glyph
+    in a `CFF` or `CFF2` font.
+
+    This table is structured so that you can treat it like a dictionary keyed by glyph name.
 
     ``ttFont['VORG'][<glyphName>]`` will return the vertical origin for any glyph.
 
     ``ttFont['VORG'][<glyphName>] = <value>`` will set the vertical origin for any glyph.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/vorg
     """
 
     def decompile(self, data, ttFont):

fontTools/ttLib/tables/V_V_A_R_.py

@@ -2,4 +2,12 @@ from .otBase import BaseTTXConverter
 
 
 class table_V_V_A_R_(BaseTTXConverter):
+    """Vertical Metrics Variations table
+
+    The ``VVAR`` table contains variation data for per-glyph vertical metrics
+    in a variable font.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/vvar
+    """
+
     pass

fontTools/ttLib/tables/_a_n_k_r.py

@@ -2,11 +2,12 @@ from .otBase import BaseTTXConverter
 
 
 class table__a_n_k_r(BaseTTXConverter):
-    """
+    """Anchor Point table
+
     The anchor point table provides a way to define anchor points.
     These are points within the coordinate space of a given glyph,
     independent of the control points used to render the glyph.
-    Anchor points are used in conjunction with the 'kerx' table.
+    Anchor points are used in conjunction with the ``kerx`` table.
 
     See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6ankr.html
     """

fontTools/ttLib/tables/_a_v_a_r.py

@@ -22,7 +22,7 @@ from .otBase import BaseTTXConverter
 
 
 class table__a_v_a_r(BaseTTXConverter):
-    """Axis Variations Table
+    """Axis Variations table
 
     This class represents the ``avar`` table of a variable font. The object has one
     substantive attribute, ``segments``, which maps axis tags to a segments dictionary::
@@ -43,6 +43,8 @@ class table__a_v_a_r(BaseTTXConverter):
     ``avar`` segment mapping must contain the entries ``-1.0: -1.0, 0.0: 0.0, 1.0: 1.0``.
     fontTools does not enforce this, so it is your responsibility to ensure that
     mappings are valid.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/avar
     """
 
     dependencies = ["fvar"]

fontTools/ttLib/tables/_b_s_l_n.py

@@ -3,4 +3,13 @@ from .otBase import BaseTTXConverter
 
 # https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6bsln.html
 class table__b_s_l_n(BaseTTXConverter):
+    """Baseline table
+
+    The AAT ``bsln`` table is similar in purpose to the OpenType ``BASE``
+    table; it stores per-script baselines to support automatic alignment
+    of lines of text.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6bsln.html
+    """
+
     pass

fontTools/ttLib/tables/_c_i_d_g.py

@@ -3,7 +3,9 @@ from .otBase import BaseTTXConverter
 
 
 class table__c_i_d_g(BaseTTXConverter):
-    """The AAT ``cidg`` table has almost the same structure as ``gidc``,
+    """CID to Glyph ID table
+
+    The AAT ``cidg`` table has almost the same structure as ``gidc``,
     just mapping CIDs to GlyphIDs instead of the reverse direction.
 
     It is useful for fonts that may be used by a PDF renderer in lieu of
@@ -14,6 +16,9 @@ class table__c_i_d_g(BaseTTXConverter):
     obsoleted by ``cidg``.
 
     For example, the first font in ``/System/Library/Fonts/PingFang.ttc``
-    (which Apple ships pre-installed on MacOS 10.12.6) has a ``cidg`` table."""
+    (which Apple ships pre-installed on MacOS 10.12.6) has a ``cidg`` table.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6gcid.html
+    """
 
     pass

fontTools/ttLib/tables/_c_m_a_p.py

@@ -54,6 +54,8 @@ class table__c_m_a_p(DefaultTable.DefaultTable):
             cmap = newTable("cmap")
             cmap.tableVersion = 0
             cmap.tables = [cmap4_0_3]
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/cmap
     """
 
     def getcmap(self, platformID, platEncID):

fontTools/ttLib/tables/_c_v_a_r.py

@@ -24,6 +24,14 @@ CVAR_HEADER_SIZE = sstruct.calcsize(CVAR_HEADER_FORMAT)
 
 
 class table__c_v_a_r(DefaultTable.DefaultTable):
+    """Control Value Table (CVT) variations table
+
+    The ``cvar`` table contains variations for the values in a ``cvt``
+    table.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/cvar
+    """
+
     dependencies = ["cvt ", "fvar"]
 
     def __init__(self, tag=None):

fontTools/ttLib/tables/_c_v_t.py

@@ -5,6 +5,14 @@ import array
 
 
 class table__c_v_t(DefaultTable.DefaultTable):
+    """Control Value Table
+
+    The Control Value Table holds a list of values that can be referenced
+    by TrueType font instructions.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/cvt
+    """
+
     def decompile(self, data, ttFont):
         values = array.array("h")
         values.frombytes(data)

fontTools/ttLib/tables/_f_e_a_t.py

@@ -2,11 +2,14 @@ from .otBase import BaseTTXConverter
 
 
 class table__f_e_a_t(BaseTTXConverter):
-    """The feature name table is an AAT (Apple Advanced Typography) table for
+    """Feature name table
+
+    The feature name table is an AAT (Apple Advanced Typography) table for
     storing font features, settings, and their human-readable names. It should
     not be confused with the ``Feat`` table or the OpenType Layout ``GSUB``/``GPOS``
-    tables. See `Feature Name Table <https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6feat.html>`_
-    in the TrueType Reference Manual for more information on the structure and
-    purpose of this table."""
+    tables.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6feat.html
+    """
 
     pass

fontTools/ttLib/tables/_f_p_g_m.py

@@ -3,6 +3,17 @@ from . import ttProgram
 
 
 class table__f_p_g_m(DefaultTable.DefaultTable):
+    """Font Program table
+
+    The ``fpgm`` table typically contains function defintions that are
+    used by font instructions. This Font Program is similar to the Control
+    Value Program that is stored in the ``prep`` table, but
+    the ``fpgm`` table is only executed one time, when the font is first
+    used.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/fpgm
+    """
+
     def decompile(self, data, ttFont):
         program = ttProgram.Program()
         program.fromBytecode(data)

fontTools/ttLib/tables/_f_v_a_r.py

@@ -43,6 +43,14 @@ FVAR_INSTANCE_FORMAT = """
 
 
 class table__f_v_a_r(DefaultTable.DefaultTable):
+    """FonT Variations table
+
+    The ``fvar`` table contains records of the variation axes and of the
+    named instances in a variable font.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6fvar.html
+    """
+
     dependencies = ["name"]
 
     def __init__(self, tag=None):

fontTools/ttLib/tables/_g_a_s_p.py

@@ -10,6 +10,14 @@ GASP_GRIDFIT = 0x0001
 
 
 class table__g_a_s_p(DefaultTable.DefaultTable):
+    """Grid-fitting and Scan-conversion Procedure table
+
+    The ``gasp`` table defines the preferred rasterization settings for
+    the font when rendered on monochrome and greyscale output devices.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/gasp
+    """
+
     def decompile(self, data, ttFont):
         self.version, numRanges = struct.unpack(">HH", data[:4])
         assert 0 <= self.version <= 1, "unknown 'gasp' format: %s" % self.version

fontTools/ttLib/tables/_g_c_i_d.py

@@ -3,4 +3,11 @@ from .otBase import BaseTTXConverter
 
 # https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6gcid.html
 class table__g_c_i_d(BaseTTXConverter):
+    """Glyph ID to CID table
+
+    The AAT ``gcid`` table stores glyphID-to-CID mappings.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6gcid.html
+    """
+
     pass

fontTools/ttLib/tables/_g_l_y_f.py

@@ -54,7 +54,7 @@ SCALE_COMPONENT_OFFSET_DEFAULT = 0  # 0 == MS, 1 == Apple
 
 
 class table__g_l_y_f(DefaultTable.DefaultTable):
-    """Glyph Data Table
+    """Glyph Data table
 
     This class represents the `glyf <https://docs.microsoft.com/en-us/typography/opentype/spec/glyf>`_
     table, which contains outlines for glyphs in TrueType format. In many cases,

fontTools/ttLib/tables/_g_v_a_r.py

@@ -3,6 +3,7 @@ from functools import partial
 from fontTools.misc import sstruct
 from fontTools.misc.textTools import safeEval
 from fontTools.misc.lazyTools import LazyDict
+from fontTools.ttLib.tables.TupleVariation import TupleVariation
 from . import DefaultTable
 import array
 import itertools
@@ -11,10 +12,7 @@ import struct
 import sys
 import fontTools.ttLib.tables.TupleVariation as tv
 
-
 log = logging.getLogger(__name__)
-TupleVariation = tv.TupleVariation
-
 
 # https://www.microsoft.com/typography/otspec/gvar.htm
 # https://www.microsoft.com/typography/otspec/otvarcommonformats.htm
@@ -41,6 +39,16 @@ GVAR_HEADER_SIZE = sstruct.calcsize(GVAR_HEADER_FORMAT)
 
 
 class table__g_v_a_r(DefaultTable.DefaultTable):
+    """Glyph Variations table
+
+    The ``gvar`` table provides the per-glyph variation data that
+    describe how glyph outlines in the ``glyf`` table change across
+    the variation space that is defined for the font in the ``fvar``
+    table.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/gvar
+    """
+
     dependencies = ["fvar", "glyf"]
 
     def __init__(self, tag=None):

fontTools/ttLib/tables/_h_d_m_x.py

@@ -31,6 +31,14 @@ class _GlyphnamedList(Mapping):
 
 
 class table__h_d_m_x(DefaultTable.DefaultTable):
+    """Horizontal Device Metrics table
+
+    The ``hdmx`` table is an optional table that stores advance widths for
+    glyph outlines at specified pixel sizes.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/hdmx
+    """
+
     def decompile(self, data, ttFont):
         numGlyphs = ttFont["maxp"].numGlyphs
         glyphOrder = ttFont.getGlyphOrder()

fontTools/ttLib/tables/_h_e_a_d.py

@@ -37,6 +37,13 @@ headFormat = """
 
 
 class table__h_e_a_d(DefaultTable.DefaultTable):
+    """Font Header table
+
+    The ``head`` table contains a variety of font-wide information.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/head
+    """
+
     dependencies = ["maxp", "loca", "CFF ", "CFF2"]
 
     def decompile(self, data, ttFont):

fontTools/ttLib/tables/_h_h_e_a.py

@@ -31,6 +31,18 @@ hheaFormat = """
 
 
 class table__h_h_e_a(DefaultTable.DefaultTable):
+    """Horizontal Header table
+
+    The ``hhea`` table contains information needed during horizontal
+    text layout.
+
+    .. note::
+       This converter class is kept in sync with the :class:`._v_h_e_a.table__v_h_e_a`
+       table constructor.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/hhea
+    """
+
     # Note: Keep in sync with table__v_h_e_a
 
     dependencies = ["hmtx", "glyf", "CFF ", "CFF2"]

fontTools/ttLib/tables/_h_m_t_x.py

@@ -12,6 +12,15 @@ log = logging.getLogger(__name__)
 
 
 class table__h_m_t_x(DefaultTable.DefaultTable):
+    """Horizontal Metrics table
+
+    The ``hmtx`` table contains per-glyph metrics for the glyphs in a
+    ``glyf``, ``CFF ``, or ``CFF2`` table, as needed for horizontal text
+    layout.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/hmtx
+    """
+
     headerTag = "hhea"
     advanceName = "width"
     sideBearingName = "lsb"

fontTools/ttLib/tables/_k_e_r_n.py

@@ -12,6 +12,17 @@ log = logging.getLogger(__name__)
 
 
 class table__k_e_r_n(DefaultTable.DefaultTable):
+    """Kerning table
+
+    The ``kern`` table contains values that contextually adjust the inter-glyph
+    spacing for the glyphs in a ``glyf`` table.
+
+    Note that similar contextual spacing adjustments can also be stored
+    in the "kern" feature of a ``GPOS`` table.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/kern
+    """
+
     def getkern(self, format):
         for subtable in self.kernTables:
             if subtable.format == format:

fontTools/ttLib/tables/_l_c_a_r.py

@@ -2,4 +2,12 @@ from .otBase import BaseTTXConverter
 
 
 class table__l_c_a_r(BaseTTXConverter):
+    """Ligature Caret table
+
+    The AAT ``lcar`` table stores division points within ligatures, which applications
+    can use to position carets properly between the logical parts of the ligature.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6lcar.html
+    """
+
     pass

fontTools/ttLib/tables/_l_o_c_a.py

@@ -8,6 +8,14 @@ log = logging.getLogger(__name__)
 
 
 class table__l_o_c_a(DefaultTable.DefaultTable):
+    """Index to Location table
+
+    The ``loca`` table stores the offsets in the ``glyf`` table that correspond
+    to the descriptions of each glyph. The glyphs are references by Glyph ID.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/loca
+    """
+
     dependencies = ["glyf"]
 
     def decompile(self, data, ttFont):

fontTools/ttLib/tables/_l_t_a_g.py

@@ -6,6 +6,14 @@ import struct
 
 
 class table__l_t_a_g(DefaultTable.DefaultTable):
+    """Language Tag table
+
+    The AAT ``ltag`` table contains mappings between the numeric codes used
+    in the language field of the ``name`` table and IETF language tags.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6ltag.html
+    """
+
     def __init__(self, tag=None):
         DefaultTable.DefaultTable.__init__(self, tag)
         self.version, self.flags = 1, 0

fontTools/ttLib/tables/_m_a_x_p.py

@@ -27,6 +27,14 @@ maxpFormat_1_0_add = """
 
 
 class table__m_a_x_p(DefaultTable.DefaultTable):
+    """Maximum Profile table
+
+    The ``maxp`` table contains the memory requirements for the data in
+    the font.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/maxp
+    """
+
     dependencies = ["glyf"]
 
     def decompile(self, data, ttFont):

fontTools/ttLib/tables/_m_e_t_a.py

@@ -24,6 +24,14 @@ DATA_MAP_FORMAT = """
 
 
 class table__m_e_t_a(DefaultTable.DefaultTable):
+    """Metadata table
+
+    The ``meta`` table contains various metadata values for the font. Each
+    category of metadata in the table is identified by a four-character tag.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/meta
+    """
+
     def __init__(self, tag=None):
         DefaultTable.DefaultTable.__init__(self, tag)
         self.data = {}

fontTools/ttLib/tables/_m_o_r_t.py

@@ -3,4 +3,12 @@ from .otBase import BaseTTXConverter
 
 # https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6mort.html
 class table__m_o_r_t(BaseTTXConverter):
+    """The AAT ``mort`` table contains glyph transformations used for script shaping and
+    for various other optional smart features.
+
+    Note: ``mort`` has been deprecated in favor of the newer ``morx`` table.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6mort.html
+    """
+
     pass

fontTools/ttLib/tables/_m_o_r_x.py

@@ -3,4 +3,13 @@ from .otBase import BaseTTXConverter
 
 # https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6morx.html
 class table__m_o_r_x(BaseTTXConverter):
+    """The AAT ``morx`` table contains glyph transformations used for script shaping and
+    for various other optional smart features, akin to ``GSUB`` and ``GPOS`` features
+    in OpenType Layout.
+
+    Note: ``morx`` is a replacement for the now deprecated ``mort`` table.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6morx.html
+    """
+
     pass

fontTools/ttLib/tables/_n_a_m_e.py

@@ -36,6 +36,16 @@ nameRecordSize = sstruct.calcsize(nameRecordFormat)
 
 
 class table__n_a_m_e(DefaultTable.DefaultTable):
+    """Naming table
+
+    The ``name`` table is used to store a variety of strings that can be
+    associated with user-facing font information. Records in the ``name``
+    table can be tagged with language tags to support multilingual naming
+    and can support platform-specific character-encoding variants.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/name
+    """
+
     dependencies = ["ltag"]
 
     def decompile(self, data, ttFont):

fontTools/ttLib/tables/_o_p_b_d.py

@@ -3,4 +3,12 @@ from .otBase import BaseTTXConverter
 
 # https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6opbd.html
 class table__o_p_b_d(BaseTTXConverter):
+    """Optical Bounds table
+
+    The AAT ``opbd`` table contains optical boundary points for glyphs, which
+    applications can use for the visual alignment of lines of text.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6opbd.html
+    """
+
     pass

fontTools/ttLib/tables/_p_o_s_t.py

@@ -27,6 +27,15 @@ postFormatSize = sstruct.calcsize(postFormat)
 
 
 class table__p_o_s_t(DefaultTable.DefaultTable):
+    """PostScript table
+
+    The ``post`` table contains information needed to use the font on
+    PostScript printers, including the PostScript names of glyphs and
+    data that was stored in the ``FontInfo`` dictionary for Type 1 fonts.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/post
+    """
+
     def decompile(self, data, ttFont):
         sstruct.unpack(postFormat, data[:postFormatSize], self)
         data = data[postFormatSize:]

fontTools/ttLib/tables/_p_r_e_p.py

@@ -4,4 +4,13 @@ superclass = ttLib.getTableClass("fpgm")
 
 
 class table__p_r_e_p(superclass):
+    """Control Value Program table
+
+    The ``prep`` table contains TrueType instructions that can makee font-wide
+    alterations to the Control Value Table. It may potentially be executed
+    before any glyph is processed.
+
+    See also https://learn.microsoft.com/en-us/typography/opentype/spec/prep
+    """
+
     pass

fontTools/ttLib/tables/_p_r_o_p.py

@@ -3,4 +3,10 @@ from .otBase import BaseTTXConverter
 
 # https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6prop.html
 class table__p_r_o_p(BaseTTXConverter):
+    """The AAT ``prop`` table can store a variety of per-glyph properties, such as
+       Unicode directionality or whether glyphs are non-spacing marks.
+
+    See also https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6prop.html
+    """
+
     pass