Skip to content

Commit 2d8ad7d

Browse files
committed
Fix FontChecker/Shaper error log crashing on missing glyph names, fixes issue mentioned in #87
1 parent 3809d44 commit 2d8ad7d

File tree

6 files changed

+235
-16
lines changed

6 files changed

+235
-16
lines changed

CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# A changelog for the lib/hyperglot language database and CLI tool (dd.mm.yyyy)
22

3+
## 0.6.4 (WIP)
4+
- FIX: Fixed an issue where trying to log missing shaping glyphs would crash in `FontChecker`
5+
36
## 0.6.3 (08.04.2024)
47
- FIX: Set correct default values for `Language.status` and `Orthography.preferred_as_group` and provide validation and tests for these.
58
- TWEAK: Deprecated plain list `SUPPORTLEVELS, VALIDITYLEVELS, STATUSES, ORTHOGRAPHY_STATUSES` and replaced them with `SupportLevel, LanguageValidity, LanguageStatus, OrthographyStatus` enums throughout the code base. The deprecated values will be removed in the next minor version.

lib/hyperglot/checker.py

+10-1
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,8 @@ def supports_language(
273273
f"{language} missing {len(base_missing)} base characters"
274274
)
275275

276+
# Proceed with shaping checks (for output) even when font is
277+
# already found not supporting a language!
276278
if shaping:
277279
joining_errors, mark_errors = self._check_shaping(
278280
ort, "base", marks, decomposed
@@ -295,7 +297,12 @@ def supports_language(
295297
# Validation
296298
if len(joining_errors) > 0 or len(mark_errors) > 0:
297299
supported = False
298-
logging.info(f"{language} missing base shaping for")
300+
msg = [f"{language} missing base shaping for: "]
301+
if len(mark_errors) > 0:
302+
msg.append("- mark attachment: " + " ".join(mark_errors))
303+
if len(joining_errors) > 0:
304+
msg.append("- joining shapes: " + " ".join(joining_errors))
305+
logging.info("\n".join(msg))
299306

300307
# If an orthography has no "auxiliary" we consider it supported on
301308
# "auxiliary" level, too.
@@ -320,6 +327,8 @@ def supports_language(
320327
supported = False
321328
logging.info(f"{language} missing {len(aux_missing)} 'aux'")
322329

330+
# Proceed with shaping checks (for output) even when font is
331+
# already found not supporting a language!
323332
if shaping:
324333
joining_errors, mark_errors = self._check_shaping(
325334
ort, "auxiliary", marks, decomposed

lib/hyperglot/shaper.py

+12-15
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,13 @@ def shape(self, text):
3434
"kern": True,
3535
"mark": True,
3636
"mkmk": True,
37-
3837
# Explicitly opt out of these so they do not interfere with basic
3938
# shaping/joining
4039
"liga": False,
4140
"rlig": False,
4241
"rclt": False,
4342
"calt": False,
4443
"salt": False,
45-
4644
# Others should get detected by script of the input, e.g. for
4745
# Arabic or Indic, so we do not explicitly opt in
4846
}
@@ -72,7 +70,7 @@ def names_for_codepoints(self, codepoints: Iterable[int]) -> List:
7270
"""
7371
Helper for better debug messages with font glyph names instead of gids.
7472
"""
75-
return [self.font.get_glyph_name(m) for m in codepoints]
73+
return [str(self.font.get_glyph_name(m)) for m in codepoints]
7674

7775
@lru_cache
7876
def check_joining(self, unicode: int) -> bool:
@@ -198,37 +196,36 @@ def check_mark_attachment(self, input: str) -> bool:
198196
if not uni.category(c).startswith("M")
199197
}
200198

201-
missing_from_font = []
199+
missing_from_font = 0
202200
missing_positioning = []
203201
for glyph_info, glyph_position in data:
204202
if glyph_info.codepoint in non_marks.keys():
205203
continue
206204

207205
# No such glyph in the font.
208-
# For regular check runs this should never trigger, since character
209-
# sets are checked first.
210-
# TODO maybe this should even be a raised Exception?
211-
if glyph_info.codepoint == 0:
212-
missing_from_font.append(glyph_info.codepoint)
206+
if glyph_info.codepoint == 0 or self.font.get_glyph_name(glyph_info.codepoint) is None:
207+
missing_from_font = missing_from_font + 1
213208
continue
214209

215210
# This appears to be a unpositioned mark!
216211
if glyph_position.x_offset == 0 and glyph_position.y_offset == 0:
217212
missing_positioning.append(glyph_info.codepoint)
218213
continue
219214

220-
if missing_from_font != []:
221-
names = ", ".join(self.names_for_codepoints(missing_from_font))
215+
if missing_from_font != 0:
222216
log.debug(
223-
f"Mark shaping for '{input}' is missing for font glyph names '{names}'"
217+
f"Mark shaping for '{input}' failed, "
218+
"missing %d %s"
219+
% (
220+
missing_from_font,
221+
"glyphs" if missing_from_font > 1 else "glyph",
222+
)
224223
)
225224
return False
226225

227226
if missing_positioning != []:
228227
names = ", ".join(self.names_for_codepoints(missing_positioning))
229-
log.debug(
230-
f"Mark positioning for '{input}' failed for font glyph names '{names}'"
231-
)
228+
log.debug(f"Mark positioning for '{input}' failed, glyph names: '{names}'")
232229
return False
233230

234231
return True

tests/Roboto/LICENSE.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

tests/Roboto/Roboto-Black.ttf

164 KB
Binary file not shown.

tests/test_checker.py

+8
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
from hyperglot.parse import character_list_from_string, parse_font_chars, parse_marks
1010
from hyperglot.checker import CharsetChecker, FontChecker
1111

12+
1213
# Just a most simple placeholder charset
1314
ascii = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
1415

@@ -20,6 +21,7 @@
2021
"tests/plex-4.0.2/IBM-Plex-Sans-Arabic/fonts/complete/otf/IBMPlexSansArabic-Regular-without-medi-fina.otf"
2122
) # noqa
2223
eczar = os.path.abspath("tests/Eczar-v1.004/otf/Eczar-Regular.otf")
24+
roboto = os.path.abspath("tests/Roboto/Roboto-Black.ttf")
2325
testfont = os.path.abspath("tests/HyperglotTestFont-Regular.ttf")
2426

2527

@@ -411,3 +413,9 @@ def test_checker_joining(caplog):
411413
# acm, because it is missing two dozen
412414
checker.supports_language("acm", report_joining=1)
413415
assert len(caplog.records) == 0
416+
417+
418+
def test_font_checker_logging_names():
419+
# Make sure not to choke on missing glyph names (refactored shaper code)
420+
checker = FontChecker(roboto)
421+
checker.get_supported_languages()

0 commit comments

Comments
 (0)