Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use a set for file names for clash checking #2422

Merged
merged 4 commits into from Oct 7, 2021
Merged

Use a set for file names for clash checking #2422

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7e4d86
Use a set for file names for clash checking
madig Oct 7, 2021
8270046
userNameToFileName should not have a mutable default parameter
madig Oct 7, 2021
cd32e1d
Use set comprehension
madig Oct 7, 2021
0466408
Minor: wording
madig Oct 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions Lib/fontTools/ufoLib/filenames.py
View file
Open in desktop
Expand Up @@ -15,9 +15,9 @@ class NameTranslationError(Exception):
pass


def userNameToFileName(userName: str, existing=[], prefix="", suffix=""):
def userNameToFileName(userName: str, existing=(), prefix="", suffix=""):
"""
existing should be a case-insensitive list
existing should be a case-insensitive set
madig marked this conversation as resolved.
Show resolved Hide resolved
of all existing file names.

>>> userNameToFileName("a") == "a"
Expand Down
23 changes: 14 additions & 9 deletions Lib/fontTools/ufoLib/glifLib.py
View file
Open in desktop
Expand Up @@ -10,6 +10,8 @@
glyph data. See the class doc string for details.
"""

from __future__ import annotations

import logging
import enum
from warnings import warn
Expand Down Expand Up @@ -205,7 +207,7 @@ def __init__(
self.glyphNameToFileName = glyphNameToFileNameFunc
self._validateRead = validateRead
self._validateWrite = validateWrite
self._existingFileNames = None
self._existingFileNames: set[str] | None = None
madig marked this conversation as resolved.
Show resolved Hide resolved
self._reverseContents = None

self.rebuildContents()
Expand Down Expand Up @@ -455,12 +457,12 @@ def writeGlyph(self, glyphName, glyphObject=None, drawPointsFunc=None, formatVer
fileName = self.contents.get(glyphName)
if fileName is None:
if self._existingFileNames is None:
self._existingFileNames = {}
for fileName in self.contents.values():
self._existingFileNames[fileName] = fileName.lower()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder why this self._existingFileNames was a dict to begin with, if we were only using the .values().
I hope nobody else ever accessed that (well, it is prefixed with underscore so technically it's private)

fileName = self.glyphNameToFileName(glyphName, self._existingFileNames.values())
self._existingFileNames = {
fileName.lower() for fileName in self.contents.values()
}
fileName = self.glyphNameToFileName(glyphName, self._existingFileNames)
self.contents[glyphName] = fileName
self._existingFileNames[fileName] = fileName.lower()
self._existingFileNames.add(fileName.lower())
if self._reverseContents is not None:
self._reverseContents[fileName.lower()] = glyphName
data = _writeGlyphToBytes(
Expand All @@ -485,9 +487,9 @@ def deleteGlyph(self, glyphName):
fileName = self.contents[glyphName]
self.fs.remove(fileName)
if self._existingFileNames is not None:
del self._existingFileNames[fileName]
self._existingFileNames.remove(fileName.lower())
if self._reverseContents is not None:
del self._reverseContents[self.contents[glyphName].lower()]
del self._reverseContents[fileName.lower()]
del self.contents[glyphName]

# dict-like support
Expand Down Expand Up @@ -573,9 +575,12 @@ def __exit__(self, exc_type, exc_value, exc_tb):
def glyphNameToFileName(glyphName, existingFileNames):
"""
Wrapper around the userNameToFileName function in filenames.py

Note that existingFileNames should be a set for large glyphsets
or performance will suffer.
"""
if existingFileNames is None:
existingFileNames = []
existingFileNames = set()
return userNameToFileName(glyphName, existing=existingFileNames, suffix=".glif")

# -----------------------
Expand Down
2 changes: 2 additions & 0 deletions Tests/ufoLib/glifLib_test.py
View file
Open in desktop
Expand Up @@ -159,6 +159,8 @@ def test_conflicting_case_insensitive_file_names(self, tmp_path):
dst.writeGlyph("a", glyph)
dst.writeGlyph("A", glyph)
dst.writeGlyph("a_", glyph)
dst.deleteGlyph("a_")
dst.writeGlyph("a_", glyph)
dst.writeGlyph("A_", glyph)
dst.writeGlyph("i_j", glyph)

Expand Down