(ph( S r 1 Skr1 SkrSr " S S\5 rSS\4S jjr/ SS4S jr/ SS4S
jr \
S :X a S S
K r \ R " 5 g
g
)aZ
Convert user-provided internal UFO names to spec-compliant filenames.
This module implements the algorithm for converting between a "user name" -
something that a user can choose arbitrarily inside a font editor - and a file
name suitable for use in a wide range of operating systems and filesystems.
The `UFO 3 specification `_
provides an example of an algorithm for such conversion, which avoids illegal
characters, reserved file names, ambiguity between upper- and lower-case
characters, and clashes with existing files.
This code was originally copied from
`ufoLib `_
by Tal Leming and is copyright (c) 2005-2016, The RoboFab Developers:
- Erik van Blokland
- Tal Leming
- Just van Rossum
>/
"()*+/:<>?[\]|> auxconnulprncom1com2com3com4com5com6com7com8com9lpt1lpt2lpt3lpt4lpt5lpt6lpt7lpt8lpt9clock$ c \ rS rSrSrg)NameTranslationErrork N)__name__
__module__ __qualname____firstlineno____static_attributes__rL M/var/www/html/venv/lib/python3.13/site-packages/fontTools/ufoLib/filenames.pyrJ rJ k s rR rJ userNamec h [ U [ 5 ( d [ S5 e[ U5 n[ U5 nU( d U S S:X a SU SS - n / nU H9 nU[ ; a SnOXwR 5 :w a US-
nUR
U5 M; SR U5 n [ U-
U-
nU SU n / n U R S5 H1 n
U
R 5 [ ; a SU
- n
U R
U
5 M3 SR U 5 n X - U- n U R 5 U; a [ XX#5 n U $ )a Converts from a user name to a file name.
Takes care to avoid illegal characters, reserved file names, ambiguity between
upper- and lower-case characters, and clashes with existing files.
Args:
userName (str): The input file name.
existing: A case-insensitive list of all existing file names.
prefix: Prefix to be prepended to the file name.
suffix: Suffix to be appended to the file name.
Returns:
A suitable filename.
Raises:
NameTranslationError: If no suitable name could be generated.
Examples::
>>> userNameToFileName("a") == "a"
True
>>> userNameToFileName("A") == "A_"
True
>>> userNameToFileName("AE") == "A_E_"
True
>>> userNameToFileName("Ae") == "A_e"
True
>>> userNameToFileName("ae") == "ae"
True
>>> userNameToFileName("aE") == "aE_"
True
>>> userNameToFileName("a.alt") == "a.alt"
True
>>> userNameToFileName("A.alt") == "A_.alt"
True
>>> userNameToFileName("A.Alt") == "A_.A_lt"
True
>>> userNameToFileName("A.aLt") == "A_.aL_t"
True
>>> userNameToFileName(u"A.alT") == "A_.alT_"
True
>>> userNameToFileName("T_H") == "T__H_"
True
>>> userNameToFileName("T_h") == "T__h"
True
>>> userNameToFileName("t_h") == "t_h"
True
>>> userNameToFileName("F_F_I") == "F__F__I_"
True
>>> userNameToFileName("f_f_i") == "f_f_i"
True
>>> userNameToFileName("Aacute_V.swash") == "A_acute_V_.swash"
True
>>> userNameToFileName(".notdef") == "_notdef"
True
>>> userNameToFileName("con") == "_con"
True
>>> userNameToFileName("CON") == "C_O_N_"
True
>>> userNameToFileName("con.alt") == "_con.alt"
True
>>> userNameToFileName("alt.con") == "alt._con"
True
z(The value for userName must be a string. ._ NrT )
isinstancestr
ValueErrorlenillegalCharacterslowerappendjoinmaxFileNameLengthsplitreservedFileNames handleClash1) rU existingprefixsuffix prefixLength suffixLengthfilteredUserName character sliceLengthpartspartfullNames rS userNameToFileNamerr o s7 D h $ $CDDv;Lv;L hqkS(!" % ) )I
//+
+ I * ww'(H#l2\AK %H Es# ::<, ,:D
T $ xxH 6)H~~8# FC OrR c r [ U5 n[ U5 nU[ U 5 - U- S- [ : a" U[ U 5 - U- S- n[ U-
nU SU n SnSn UcL U [ U 5 R S5 - n
X*- U- n U R 5 U; a U nOU S-
n U S: a OUc ML Uc [ XU5 nU$ )a A helper function that resolves collisions with existing names when choosing a filename.
This function attempts to append an unused integer counter to the filename.
Args:
userName (str): The input file name.
existing: A case-insensitive list of all existing file names.
prefix: Prefix to be prepended to the file name.
suffix: Suffix to be appended to the file name.
Returns:
A suitable filename.
>>> prefix = ("0" * 5) + "."
>>> suffix = "." + ("0" * 10)
>>> existing = ["a" * 5]
>>> e = list(existing)
>>> handleClash1(userName="A" * 5, existing=e,
... prefix=prefix, suffix=suffix) == (
... '00000.AAAAA000000000000001.0000000000')
True
>>> e = list(existing)
>>> e.append(prefix + "aaaaa" + "1".zfill(15) + suffix)
>>> handleClash1(userName="A" * 5, existing=e,
... prefix=prefix, suffix=suffix) == (
... '00000.AAAAA000000000000002.0000000000')
True
>>> e = list(existing)
>>> e.append(prefix + "AAAAA" + "2".zfill(15) + suffix)
>>> handleClash1(userName="A" * 5, existing=e,
... prefix=prefix, suffix=suffix) == (
... '00000.AAAAA000000000000001.0000000000')
True
NrZ l I5 )r^ rc r\ zfillr` handleClash2) rU rg rh ri rj rk lrn finalNamecounternamerq s rS rf rf s P v;Lv;Lc(m#l2R7:KK 3x= (< 7" <'!+ L[)IG
#g,,,R00=6) >> 8 + I qLG o %
6: rR c [ [ U5 -
[ U5 -
n[ SU- 5 nSnSnUc8 U[ U5 - U- nUR 5 U ; a UnOUS-
nXd: a OUc M8 Uc [ S5 eU$ )a A helper function that resolves collisions with existing names when choosing a filename.
This function is a fallback to :func:`handleClash1`. It attempts to append an unused integer counter to the filename.
Args:
userName (str): The input file name.
existing: A case-insensitive list of all existing file names.
prefix: Prefix to be prepended to the file name.
suffix: Suffix to be appended to the file name.
Returns:
A suitable filename.
Raises:
NameTranslationError: If no suitable name could be generated.
Examples::
>>> prefix = ("0" * 5) + "."
>>> suffix = "." + ("0" * 10)
>>> existing = [prefix + str(i) + suffix for i in range(100)]
>>> e = list(existing)
>>> handleClash2(existing=e, prefix=prefix, suffix=suffix) == (
... '00000.100.0000000000')
True
>>> e = list(existing)
>>> e.remove(prefix + "1" + suffix)
>>> handleClash2(existing=e, prefix=prefix, suffix=suffix) == (
... '00000.1.0000000000')
True
>>> e = list(existing)
>>> e.remove(prefix + "2" + suffix)
>>> handleClash2(existing=e, prefix=prefix, suffix=suffix) == (
... '00000.2.0000000000')
True
9NrZ z No unique name could be found.)rc r^ intr\ r` rJ )rg rh ri maxLengthmaxValuerx ry rq s rS rv rv s R "CK/#f+=I3?#HIG
CL(61 >> 8 + I qLG
"#CDD rR __main__rW N)rL rT rT )
__doc__r_ re rc ExceptionrJ r\ rr rf rv rM doctesttestmodrL rR rS r sx :0 b 2 9 e eP %'r" ?D R ;| z OO rR