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

Sie können sich das Django Framework ansehen (aber beachten Sie deren Lizenz!), wie sie aus beliebigem Text einen "Slug" erstellen. Ein Slug ist URL- und Dateinamen-freundlich.

Die Django-Text-Utilities definieren eine Funktion, slugify(), die wahrscheinlich der Goldstandard für diese Art von Dingen ist. Im Wesentlichen sieht ihr Code wie folgt aus.

import unicodedata
import re

def slugify(value, allow_unicode=False):
    """
    Übernommen von https://github.com/django/django/blob/master/django/utils/text.py
    Konvertiert in ASCII, wenn 'allow_unicode' False ist. Konvertiert Leerzeichen oder wiederholte Bindestriche in einzelne Bindestriche. Entfernt Zeichen, die keine alphanumerischen Zeichen, Unterstriche oder Bindestriche sind. Konvertiert in Kleinbuchstaben. Entfernt auch führende und abschließende Leerzeichen, Bindestriche und Unterstriche.
    """
    value = str(value)
    if allow_unicode:
        value = unicodedata.normalize('NFKC', value)
    else:
        value = unicodedata.normalize('NFKD', value).encode('ascii', 'ignore').decode('ascii')
    value = re.sub(r'[^\w\s-]', '', value.lower())
    return re.sub(r'[-\s]+', '-', value).strip('-_')

Und die ältere Version:

def slugify(value):
    """
    Normalisiert den String, konvertiert in Kleinbuchstaben, entfernt nicht-alfa-Zeichen und konvertiert Leerzeichen in Bindestriche.
    """
    import unicodedata
    value = unicodedata.normalize('NFKD', value).encode('ascii', 'ignore')
    value = unicode(re.sub('[^\w\s-]', '', value).strip().lower())
    value = unicode(re.sub('[-\s]+', '-', value))
    # ...
    return value

Es gibt noch mehr, aber ich habe es ausgelassen, da es nicht die Slug-Erstellung behandelt, sondern das Escapen.

Answer 2

Sie können list comprehension zusammen mit den String-Methoden verwenden.

>>> s
'foo-bar#baz?qux@127/\\9]'
>>> "".join(x for x in s if x.isalnum())
'foobarbazqux1279'

Answer 3

Was ist der Grund, Zeichenfolgen als Dateinamen zu verwenden? Wenn die menschliche Lesbarkeit keine Rolle spielt, würde ich das base64-Modul verwenden, das Dateisystem-sichere Zeichenfolgen erzeugen kann. Es wird zwar nicht lesbar sein, aber Sie werden keine Probleme mit Kollisionen haben und es ist umkehrbar.

import base64
dateiname_string = base64.urlsafe_b64encode(your_string)

Aktualisierung: Geändert basierend auf dem Kommentar von Matthew.

Answer 4

Dieser Whitelist-Ansatz (d.h. nur die in valid_chars vorhandenen Zeichen zuzulassen) funktioniert, wenn es keine Einschränkungen für die Formatierung der Dateien oder Kombinationen von gültigen Zeichen gibt, die verboten sind (wie z. B. ".."), zum Beispiel würde dein Ansatz es erlauben, eine Datei mit dem Namen ".txt" zu erstellen, was meiner Meinung nach auf Windows nicht gültig ist. Da dies der einfachste Ansatz ist, würde ich versuchen, Leerzeichen aus den gültigen Zeichen zu entfernen und im Fehlerfall einen bekannten gültigen String voranzustellen, jeder andere Ansatz müsste wissen, was wo erlaubt ist, um mit den Einschränkungen für Windows-Dateinamen umgehen zu können und dadurch wesentlich komplexer sein.

>>> import string
>>> valid_chars = "-_.() %s%s" % (string.ascii_letters, string.digits)
>>> valid_chars
'-_.() abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
>>> filename = "This Is a (valid) - filename%$&$ .txt"
>>> ''.join(c for c in filename if c in valid_chars)
'This Is a (valid) - filename .txt'

Answer 5

Es gibt ein schönes Projekt auf Github namens python-slugify:

Installieren:

pip install python-slugify

Dann verwenden:

>>> from slugify import slugify
>>> txt = "This\ is/ a%#$ test ---"
>>> slugify(txt)
'this-is-a-test'