Umwandeln Sie eine Zeichenfolge in einen gültigen Dateinamen?

Question

Ich habe einen String, den ich als Dateinamen verwenden möchte, daher möchte ich alle Zeichen entfernen, die in Dateinamen nicht erlaubt wären, mit Python.

Ich wäre lieber streng als nachlässig, also möchte ich nur Buchstaben, Zahlen und eine kleine Menge anderer Zeichen wie "_-.() " behalten. Was ist die eleganteste Lösung?

Der Dateiname muss auf mehreren Betriebssystemen gültig sein (Windows, Linux und Mac OS) - es handelt sich um eine MP3-Datei in meiner Bibliothek mit dem Songtitel als Dateiname und wird zwischen 3 Maschinen gemeinsam genutzt und gesichert.

Answer 1

Ein weiteres Problem, das in den anderen Kommentaren noch nicht angesprochen wurde, ist der leere String, der offensichtlich kein gültiger Dateiname ist. Sie können auch einen leeren String erhalten, wenn Sie zu viele Zeichen entfernen.

Was die Windows-reservierten Dateinamen und Probleme mit Punkten betrifft, ist die sicherste Antwort auf die Frage "Wie normalisiere ich einen gültigen Dateinamen aus beliebiger Benutzereingabe?" "Versuchen Sie es erst gar nicht": Wenn Sie einen anderen Weg finden können, um dies zu vermeiden (z. B. die Verwendung von Ganzzahl-Primärschlüsseln aus einer Datenbank als Dateinamen), tun Sie das.

Wenn Sie müssen und wirklich Leerzeichen und '.' für Dateierweiterungen als Teil des Namens zulassen müssen, versuchen Sie etwas Ähnliches wie:

import re
badchars= re.compile(r'[^A-Za-z0-9_. ]+|^\.|\.$|^ | $|^$')
badnames= re.compile(r'(aux|com[1-9]|con|lpt[1-9]|prn)(\.|$)')

def makeName(s):
    name= badchars.sub('_', s)
    if badnames.match(name):
        name= '_'+name
    return name

Selbst dies kann nicht garantiert richtig sein, insbesondere auf unerwarteten Betriebssystemen — zum Beispiel hasst RISC OS Leerzeichen und verwendet '.' als Verzeichnistrennzeichen.

Answer 2

Warum nicht einfach das "osopen" in einen try/except-Block einpacken und das zugrunde liegende Betriebssystem entscheiden lassen, ob die Datei gültig ist?

Dies scheint viel weniger Arbeit zu sein und ist unabhängig davon, welches Betriebssystem Sie verwenden.

Answer 3

>>> import string
>>> safechars = bytearray(('_-.()' + string.digits + string.ascii_letters).encode())
>>> allchars = bytearray(range(0x100))
>>> deletechars = bytearray(set(allchars) - set(safechars))
>>> filename = u'#ab\xa0c.$%.txt'
>>> safe_filename = filename.encode('ascii', 'ignore').translate(None, deletechars).decode()
>>> safe_filename
'abc..txt'

Es behandelt keine leeren Strings, spezielle Dateinamen ('nul', 'con', etc.).

Answer 4

Antwort modifiziert für Python 3.6

import string
import unicodedata

validFilenameChars = "-_.() %s%s" % (string.ascii_letters, string.digits)
def removeDisallowedFilenameChars(filename):
    cleanedFilename = unicodedata.normalize('NFKD', filename).encode('ASCII', 'ignore')
    return ''.join(chr(c) for c in cleanedFilename if chr(c) in validFilenameChars)

Answer 5

Yet another answer for Windows specific paths, using simple replacement and no funky modules:

import re

def check_for_illegal_char(input_str):
    # entferne ungültige Zeichen für Windows-Dateinamen/-Pfade
    # (ungültige Dateinamen sind eine Obermenge (41) der ungültigen Pfadnamen (36))
    # gemäß der Windows-Blacklist, die mit Powershell abgerufen wurde
    # von: https://stackoverflow.com/questions/1976007/what-characters-are-forbidden-in-windows-and-linux-directory-names/44750843#44750843
    #
    # PS> $enc = [system.Text.Encoding]::UTF8
    # PS> $FileNameInvalidChars = [System.IO.Path]::GetInvalidFileNameChars()
    # PS> $FileNameInvalidChars | foreach { $enc.GetBytes($_) } | Out-File -FilePath InvalidFileCharCodes.txt

    illegal = '\u0022\u003c\u003e\u007c\u0000\u0001\u0002\u0003\u0004\u0005\u0006\u0007\u0008' + \
              '\u0009\u000a\u000b\u000c\u000d\u000e\u000f\u0010\u0011\u0012\u0013\u0014\u0015' + \
              '\u0016\u0017\u0018\u0019\u001a\u001b\u001c\u001d\u001e\u001f\u003a\u002a\u003f\u005c\u002f' 

    output_str, _ = re.subn('['+illegal+']','_', input_str)
    output_str = output_str.replace('\\','_')   # backslash kann nicht von regex behandelt werden
    output_str = output_str.replace('..','_')   # doppelte Punkte sind auch ungültig, oder zumindest eine schlechte Idee
    output_str = output_str[:-1] if output_str[-1] == '.' else output_str # darf kein Ende der Zeile '.' haben

    if output_str != input_str:
        print(f"Der Name '{input_str}' enthielt ungültige Zeichen, "
              f"Name wurde zu '{output_str}' geändert")

    return output_str

Wenn getestet mit check_for_illegal_char('fas\u0003\u0004good\\..asd.'), erhalte ich:

Der Name 'fasgood\..asd.' enthielt ungültige Zeichen, Name wurde zu 'fas__good__asd' geändert