Merge pull request #61 from felipesanches/dehint_function

add a `dehinter.font.dehint` method for programs (such as FontBakery) that import dehinter as a dependency

Author: chrissimpkins

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v3.1.0
+- add a `dehinter.font.dehint` function to be used by programs that import dehinter as a module
+
 ## v3.0.0
 
 - add support for cvar table removal in variable fonts (backward incompatible change)

lib/dehinter/__main__.py

@@ -14,37 +14,14 @@
 
 import argparse
 import os
-import pprint
 import sys
 from typing import List
 
 from fontTools.ttLib import TTFont  # type: ignore
 
 from dehinter import __version__
-from dehinter.font import (
-    has_cvar_table,
-    has_cvt_table,
-    has_fpgm_table,
-    has_hdmx_table,
-    has_ltsh_table,
-    has_prep_table,
-    has_ttfa_table,
-    has_vdmx_table,
-    is_truetype_font,
-    is_variable_font,
-    remove_cvar_table,
-    remove_cvt_table,
-    remove_fpgm_table,
-    remove_glyf_instructions,
-    remove_hdmx_table,
-    remove_ltsh_table,
-    remove_prep_table,
-    remove_ttfa_table,
-    remove_vdmx_table,
-    update_gasp_table,
-    update_head_table_flags,
-    update_maxp_table,
-)
+from dehinter.font import (dehint,
+                           is_truetype_font)
 from dehinter.paths import filepath_exists, get_default_out_path
 from dehinter.system import get_filesize
 
@@ -54,9 +31,6 @@ def main() -> None:  # pragma: no cover
 
 
 def run(argv: List[str]) -> None:
-    # instantiate pretty printer
-    pp = pprint.PrettyPrinter(indent=4)
-
     # ===========================================================
     # argparse command line argument definitions
     # ===========================================================
@@ -132,111 +106,20 @@ def run(argv: List[str]) -> None:
         )
         sys.exit(1)
 
-    if is_variable_font(tt) and not args.keep_cvar:
-        if has_cvar_table(tt):
-            remove_cvar_table(tt)
-            if not has_cvar_table(tt):
-                print("[-] Removed cvar table")
-            else:  # pragma: no cover
-                sys.stderr.write(
-                    f"[!] Error: failed to remove cvar table from font{os.linesep}"
-                )
-
-    if not args.keep_cvt:
-        if has_cvt_table(tt):
-            remove_cvt_table(tt)
-            if not has_cvt_table(tt):
-                print("[-] Removed cvt table")
-            else:  # pragma: no cover
-                sys.stderr.write(
-                    f"[!] Error: failed to remove cvt table from font{os.linesep}"
-                )
-
-    if not args.keep_fpgm:
-        if has_fpgm_table(tt):
-            remove_fpgm_table(tt)
-            if not has_fpgm_table(tt):
-                print("[-] Removed fpgm table")
-            else:  # pragma: no cover
-                sys.stderr.write(
-                    f"[!] Error: failed to remove fpgm table from font{os.linesep}"
-                )
-
-    if not args.keep_hdmx:
-        if has_hdmx_table(tt):
-            remove_hdmx_table(tt)
-            if not has_hdmx_table(tt):
-                print("[-] Removed hdmx table")
-            else:  # pragma: no cover
-                sys.stderr.write(
-                    f"[!] Error: failed to remove hdmx table from font{os.linesep}"
-                )
-
-    if not args.keep_ltsh:
-        if has_ltsh_table(tt):
-            remove_ltsh_table(tt)
-            if not has_ltsh_table(tt):
-                print("[-] Removed LTSH table")
-            else:  # pragma: no cover
-                sys.stderr.write(
-                    f"[!] Error: failed to remove LTSH table from font{os.linesep}"
-                )
-
-    if not args.keep_prep:
-        if has_prep_table(tt):
-            remove_prep_table(tt)
-            if not has_prep_table(tt):
-                print("[-] Removed prep table")
-            else:  # pragma: no cover
-                sys.stderr.write(
-                    f"[!] Error: failed to remove prep table from font{os.linesep}"
-                )
-
-    if not args.keep_ttfa:
-        if has_ttfa_table(tt):
-            remove_ttfa_table(tt)
-            if not has_ttfa_table(tt):
-                print("[-] Removed TTFA table")
-            else:  # pragma: no cover
-                sys.stderr.write(
-                    f"[!] Error: failed to remove TTFA table from font{os.linesep}"
-                )
-
-    if not args.keep_vdmx:
-        if has_vdmx_table(tt):
-            remove_vdmx_table(tt)
-            if not has_vdmx_table(tt):
-                print("[-] Removed VDMX table")
-            else:  # pragma: no cover
-                sys.stderr.write(
-                    f"[!] Error: failed to remove VDMX table from font{os.linesep}"
-                )
-
-    #  (2) Remove glyf table instruction set bytecode
-    if not args.keep_glyf:
-        number_glyfs_edited = remove_glyf_instructions(tt)
-        if number_glyfs_edited > 0:
-            print(
-                f"[-] Removed glyf table instruction bytecode from "
-                f"{number_glyfs_edited} glyphs"
-            )
-
-    #  (3) Edit gasp table
-    if not args.keep_gasp:
-        if update_gasp_table(tt):
-            gasp_string = pp.pformat(tt["gasp"].__dict__)
-            print(f"[Δ] New gasp table values:{os.linesep}    {gasp_string}")
-
-    #  (4) Edit maxp table
-    if not args.keep_maxp:
-        if update_maxp_table(tt):
-            maxp_string = pp.pformat(tt["maxp"].__dict__)
-            print(f"[Δ] New maxp table values:{os.linesep}    {maxp_string}")
-
-    #  (5) Edit head table flags to clear bit 4
-    if not args.keep_head:
-        if update_head_table_flags(tt):
-            print("[Δ] Cleared bit 4 in head table flags")
+    dehint(tt,
+           keep_cvar=args.keep_cvar,
+           keep_cvt=args.keep_cvt,
+           keep_fpgm=args.keep_fpgm,
+           keep_gasp=args.keep_gasp,
+           keep_glyf=args.keep_glyf,
+           keep_hdmx=args.keep_hdmx,
+           keep_head=args.keep_head,
+           keep_ltsh=args.keep_ltsh,
+           keep_maxp=args.keep_maxp,
+           keep_prep=args.keep_prep,
+           keep_ttfa=args.keep_ttfa,
+           keep_vdmx=args.keep_vdmx,
+           verbose=True)
 
     # File write
     # ----------

lib/dehinter/font.py

@@ -14,12 +14,121 @@
 
 import array
 import os
+import pprint
+import sys
 from typing import Union
 
 from fontTools import ttLib  # type: ignore
 
 from dehinter.bitops import clear_bit_k, is_bit_k_set
 
+# instantiate pretty printer
+pp = pprint.PrettyPrinter(indent=4)
+
+
+# ========================================================
+# Core dehinting routine
+# ========================================================
+def dehint(tt,
+           keep_cvar=False,
+           keep_cvt=False,
+           keep_fpgm=False,
+           keep_gasp=False,
+           keep_glyf=False,
+           keep_hdmx=False,
+           keep_head=False,
+           keep_ltsh=False,
+           keep_maxp=False,
+           keep_prep=False,
+           keep_ttfa=False,
+           keep_vdmx=False,
+           verbose=True):
+    def report_actions(table, has_table):
+        if not has_table:
+            print(f"[-] Removed {table} table")
+        else:  # pragma: no cover
+            sys.stderr.write(
+                f"[!] Error: failed to remove {table} table from font{os.linesep}"
+            )
+
+    if is_variable_font(tt) and not keep_cvar:
+        if has_cvar_table(tt):
+            remove_cvar_table(tt)
+            if verbose:
+                report_actions("cvar", has_cvar_table(tt))
+
+    if not keep_cvt:
+        if has_cvt_table(tt):
+            remove_cvt_table(tt)
+            if verbose:
+                report_actions("cvt", has_cvt_table(tt))
+
+    if not keep_fpgm:
+        if has_fpgm_table(tt):
+            remove_fpgm_table(tt)
+            if verbose:
+                report_actions("fpgm", has_fpgm_table(tt))
+
+    if not keep_hdmx:
+        if has_hdmx_table(tt):
+            remove_hdmx_table(tt)
+            if verbose:
+                report_actions("hdmx", has_hdmx_table(tt))
+
+    if not keep_ltsh:
+        if has_ltsh_table(tt):
+            remove_ltsh_table(tt)
+            if verbose:
+                report_actions("LTSH", has_ltsh_table(tt))
+
+    if not keep_prep:
+        if has_prep_table(tt):
+            remove_prep_table(tt)
+            if verbose:
+                report_actions("prep", has_prep_table(tt))
+
+    if not keep_ttfa:
+        if has_ttfa_table(tt):
+            remove_ttfa_table(tt)
+            if verbose:
+                report_actions("ttfa", has_ttfa_table(tt))
+
+    if not keep_vdmx:
+        if has_vdmx_table(tt):
+            remove_vdmx_table(tt)
+            if verbose:
+                report_actions("VDMX", has_vdmx_table(tt))
+
+    #  (2) Remove glyf table instruction set bytecode
+    if not keep_glyf:
+        number_glyfs_edited = remove_glyf_instructions(tt)
+        if number_glyfs_edited > 0:
+            if verbose:
+                print(
+                    f"[-] Removed glyf table instruction bytecode from "
+                    f"{number_glyfs_edited} glyphs"
+                )
+
+    #  (3) Edit gasp table
+    if not keep_gasp:
+        if update_gasp_table(tt):
+            gasp_string = pp.pformat(tt["gasp"].__dict__)
+            if verbose:
+                print(f"[Δ] New gasp table values:{os.linesep}    {gasp_string}")
+
+    #  (4) Edit maxp table
+    if not keep_maxp:
+        if update_maxp_table(tt):
+            maxp_string = pp.pformat(tt["maxp"].__dict__)
+            if verbose:
+                print(f"[Δ] New maxp table values:{os.linesep}    {maxp_string}")
+
+    #  (5) Edit head table flags to clear bit 4
+    if not keep_head:
+        if update_head_table_flags(tt):
+            if verbose:
+                print("[Δ] Cleared bit 4 in head table flags")
+
 
 # ========================================================
 # Utilities

setup.py

@@ -13,7 +13,7 @@
 REQUIRES_PYTHON = ">=3.6.0"
 
 INSTALL_REQUIRES = [
-    "fontTools==4.22.1",
+    "fontTools",
 ]
 # Optional packages
 EXTRAS_REQUIRES = {