git-svn-id: http://svn.robofab.com/branches/ufo3k@298 b5fa9d6c-a76f-4ffd-b3cb-f825fc41095c
This commit is contained in:
Tal Leming 2011-09-27 17:35:54 +00:00
parent b4782ab182
commit cfe561ea91

View File

@ -11,189 +11,189 @@ reservedFileNames += "LPT1 LPT2 LPT3 COM2 COM3 COM4".lower().split(" ")
maxFileNameLength = 255 maxFileNameLength = 255
def userNameToFileName(userName, existing=[], prefix="", suffix=""): def userNameToFileName(userName, existing=[], prefix="", suffix=""):
""" """
existing should be a case-insensitive list existing should be a case-insensitive list
of all existing file names. of all existing file names.
>>> userNameToFileName(u"a") >>> userNameToFileName(u"a")
u'a' u'a'
>>> userNameToFileName(u"A") >>> userNameToFileName(u"A")
u'A_' u'A_'
>>> userNameToFileName(u"AE") >>> userNameToFileName(u"AE")
u'A_E_' u'A_E_'
>>> userNameToFileName(u"Ae") >>> userNameToFileName(u"Ae")
u'A_e' u'A_e'
>>> userNameToFileName(u"ae") >>> userNameToFileName(u"ae")
u'ae' u'ae'
>>> userNameToFileName(u"aE") >>> userNameToFileName(u"aE")
u'aE_' u'aE_'
>>> userNameToFileName(u"a.alt") >>> userNameToFileName(u"a.alt")
u'a.alt' u'a.alt'
>>> userNameToFileName(u"A.alt") >>> userNameToFileName(u"A.alt")
u'A_.alt' u'A_.alt'
>>> userNameToFileName(u"A.Alt") >>> userNameToFileName(u"A.Alt")
u'A_.A_lt' u'A_.A_lt'
>>> userNameToFileName(u"A.aLt") >>> userNameToFileName(u"A.aLt")
u'A_.aL_t' u'A_.aL_t'
>>> userNameToFileName(u"A.alT") >>> userNameToFileName(u"A.alT")
u'A_.alT_' u'A_.alT_'
>>> userNameToFileName(u"T_H") >>> userNameToFileName(u"T_H")
u'T__H_' u'T__H_'
>>> userNameToFileName(u"T_h") >>> userNameToFileName(u"T_h")
u'T__h' u'T__h'
>>> userNameToFileName(u"t_h") >>> userNameToFileName(u"t_h")
u't_h' u't_h'
>>> userNameToFileName(u"F_F_I") >>> userNameToFileName(u"F_F_I")
u'F__F__I_' u'F__F__I_'
>>> userNameToFileName(u"f_f_i") >>> userNameToFileName(u"f_f_i")
u'f_f_i' u'f_f_i'
>>> userNameToFileName(u"Aacute_V.swash") >>> userNameToFileName(u"Aacute_V.swash")
u'A_acute_V_.swash' u'A_acute_V_.swash'
>>> userNameToFileName(u".notdef") >>> userNameToFileName(u".notdef")
u'_notdef' u'_notdef'
>>> userNameToFileName(u"con") >>> userNameToFileName(u"con")
u'_con' u'_con'
>>> userNameToFileName(u"CON") >>> userNameToFileName(u"CON")
u'C_O_N_' u'C_O_N_'
>>> userNameToFileName(u"con.alt") >>> userNameToFileName(u"con.alt")
u'_con.alt' u'_con.alt'
>>> userNameToFileName(u"alt.con") >>> userNameToFileName(u"alt.con")
u'alt._con' u'alt._con'
""" """
# the incoming name must be a unicode string # the incoming name must be a unicode string
assert isinstance(userName, unicode), "The value for userName must be a unicode string." assert isinstance(userName, unicode), "The value for userName must be a unicode string."
# establish the prefix and suffix lengths # establish the prefix and suffix lengths
prefixLength = len(prefix) prefixLength = len(prefix)
suffixLength = len(suffix) suffixLength = len(suffix)
# replace an initial period with an _ # replace an initial period with an _
# if no prefix is to be added # if no prefix is to be added
if not prefix and userName[0] == ".": if not prefix and userName[0] == ".":
userName = "_" + userName[1:] userName = "_" + userName[1:]
# filter the user name # filter the user name
filteredUserName = [] filteredUserName = []
for character in userName: for character in userName:
# replace illegal characters with _ # replace illegal characters with _
if character in illegalCharacters: if character in illegalCharacters:
character = "_" character = "_"
# add _ to all non-lower characters # add _ to all non-lower characters
elif character != character.lower(): elif character != character.lower():
character += "_" character += "_"
filteredUserName.append(character) filteredUserName.append(character)
userName = "".join(filteredUserName) userName = "".join(filteredUserName)
# clip to 255 # clip to 255
sliceLength = maxFileNameLength - prefixLength - suffixLength sliceLength = maxFileNameLength - prefixLength - suffixLength
userName = userName[:sliceLength] userName = userName[:sliceLength]
# test for illegal files names # test for illegal files names
parts = [] parts = []
for part in userName.split("."): for part in userName.split("."):
if part.lower() in reservedFileNames: if part.lower() in reservedFileNames:
part = "_" + part part = "_" + part
parts.append(part) parts.append(part)
userName = ".".join(parts) userName = ".".join(parts)
# test for clash # test for clash
fullName = prefix + userName + suffix fullName = prefix + userName + suffix
if fullName.lower() in existing: if fullName.lower() in existing:
fullName = handleClash1(userName, existing, prefix, suffix) fullName = handleClash1(userName, existing, prefix, suffix)
# finished # finished
return fullName return fullName
def handleClash1(userName, existing=[], prefix="", suffix=""): def handleClash1(userName, existing=[], prefix="", suffix=""):
""" """
existing should be a case-insensitive list existing should be a case-insensitive list
of all existing file names. of all existing file names.
>>> prefix = ("0" * 5) + "." >>> prefix = ("0" * 5) + "."
>>> suffix = "." + ("0" * 10) >>> suffix = "." + ("0" * 10)
>>> existing = ["a" * 5] >>> existing = ["a" * 5]
>>> e = list(existing) >>> e = list(existing)
>>> handleClash1(userName="A" * 5, existing=e, >>> handleClash1(userName="A" * 5, existing=e,
... prefix=prefix, suffix=suffix) ... prefix=prefix, suffix=suffix)
'00000.AAAAA000000000000001.0000000000' '00000.AAAAA000000000000001.0000000000'
>>> e = list(existing) >>> e = list(existing)
>>> e.append(prefix + "aaaaa" + "1".zfill(15) + suffix) >>> e.append(prefix + "aaaaa" + "1".zfill(15) + suffix)
>>> handleClash1(userName="A" * 5, existing=e, >>> handleClash1(userName="A" * 5, existing=e,
... prefix=prefix, suffix=suffix) ... prefix=prefix, suffix=suffix)
'00000.AAAAA000000000000002.0000000000' '00000.AAAAA000000000000002.0000000000'
>>> e = list(existing) >>> e = list(existing)
>>> e.append(prefix + "AAAAA" + "2".zfill(15) + suffix) >>> e.append(prefix + "AAAAA" + "2".zfill(15) + suffix)
>>> handleClash1(userName="A" * 5, existing=e, >>> handleClash1(userName="A" * 5, existing=e,
... prefix=prefix, suffix=suffix) ... prefix=prefix, suffix=suffix)
'00000.AAAAA000000000000001.0000000000' '00000.AAAAA000000000000001.0000000000'
""" """
# if the prefix length + user name length + suffix length + 15 is at # if the prefix length + user name length + suffix length + 15 is at
# or past the maximum length, silce 15 characters off of the user name # or past the maximum length, silce 15 characters off of the user name
prefixLength = len(prefix) prefixLength = len(prefix)
suffixLength = len(suffix) suffixLength = len(suffix)
if prefixLength + len(userName) + suffixLength + 15 > maxFileNameLength: if prefixLength + len(userName) + suffixLength + 15 > maxFileNameLength:
l = (prefixLength + len(userName) + suffixLength + 15) l = (prefixLength + len(userName) + suffixLength + 15)
sliceLength = maxFileNameLength - l sliceLength = maxFileNameLength - l
userName = userName[:sliceLength] userName = userName[:sliceLength]
finalName = None finalName = None
# try to add numbers to create a unique name # try to add numbers to create a unique name
counter = 1 counter = 1
while finalName is None: while finalName is None:
name = userName + str(counter).zfill(15) name = userName + str(counter).zfill(15)
fullName = prefix + name + suffix fullName = prefix + name + suffix
if fullName.lower() not in existing: if fullName.lower() not in existing:
finalName = fullName finalName = fullName
break break
else: else:
counter += 1 counter += 1
if counter >= 999999999999999: if counter >= 999999999999999:
break break
# if there is a clash, go to the next fallback # if there is a clash, go to the next fallback
if finalName is None: if finalName is None:
finalName = handleClash2(existing, prefix, suffix) finalName = handleClash2(existing, prefix, suffix)
# finished # finished
return finalName return finalName
def handleClash2(existing=[], prefix="", suffix=""): def handleClash2(existing=[], prefix="", suffix=""):
""" """
existing should be a case-insensitive list existing should be a case-insensitive list
of all existing file names. of all existing file names.
>>> prefix = ("0" * 5) + "." >>> prefix = ("0" * 5) + "."
>>> suffix = "." + ("0" * 10) >>> suffix = "." + ("0" * 10)
>>> existing = [prefix + str(i) + suffix for i in range(100)] >>> existing = [prefix + str(i) + suffix for i in range(100)]
>>> e = list(existing) >>> e = list(existing)
>>> handleClash2(existing=e, prefix=prefix, suffix=suffix) >>> handleClash2(existing=e, prefix=prefix, suffix=suffix)
'00000.100.0000000000' '00000.100.0000000000'
>>> e = list(existing) >>> e = list(existing)
>>> e.remove(prefix + "1" + suffix) >>> e.remove(prefix + "1" + suffix)
>>> handleClash2(existing=e, prefix=prefix, suffix=suffix) >>> handleClash2(existing=e, prefix=prefix, suffix=suffix)
'00000.1.0000000000' '00000.1.0000000000'
>>> e = list(existing) >>> e = list(existing)
>>> e.remove(prefix + "2" + suffix) >>> e.remove(prefix + "2" + suffix)
>>> handleClash2(existing=e, prefix=prefix, suffix=suffix) >>> handleClash2(existing=e, prefix=prefix, suffix=suffix)
'00000.2.0000000000' '00000.2.0000000000'
""" """
# calculate the longest possible string # calculate the longest possible string
maxLength = maxFileNameLength - len(prefix) - len(suffix) maxLength = maxFileNameLength - len(prefix) - len(suffix)
maxValue = int("9" * maxLength) maxValue = int("9" * maxLength)
# try to find a number # try to find a number
finalName = None finalName = None
counter = 1 counter = 1
while finalName is None: while finalName is None:
fullName = prefix + str(counter) + suffix fullName = prefix + str(counter) + suffix
if fullName.lower() not in existing: if fullName.lower() not in existing:
finalName = fullName finalName = fullName
break break
else: else:
counter += 1 counter += 1
if counter >= maxValue: if counter >= maxValue:
break break
# raise an error if nothing has been found # raise an error if nothing has been found
if finalName is None: if finalName is None:
raise NameTranslationError("No unique name could be found.") raise NameTranslationError("No unique name could be found.")
# finished # finished
return finalName return finalName
if __name__ == "__main__": if __name__ == "__main__":
import doctest import doctest
doctest.testmod() doctest.testmod()