# filenames

User name to file name conversion. This was taken from the UFO 3 spec.

exception fontTools.ufoLib.filenames.NameTranslationError
  add_note()

    Exception.add_note(note) – add a note to the exception

  args
  with_traceback()

    Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

fontTools.ufoLib.filenames.handleClash1(userName, existing=[], prefix='', suffix='')

  existing should be a case-insensitive list of all existing file names.

      >>> 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

fontTools.ufoLib.filenames.handleClash2(existing=[], prefix='', suffix='')

  existing should be a case-insensitive list of all existing file names.

      >>> 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

fontTools.ufoLib.filenames.userNameToFileName(userName: str, existing=(), prefix='', suffix='')

  existing should be a set-like object.

      >>> 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