Turn a string into a valid filename?

by

You can look at the Django framework for how they create a “slug” from arbitrary text. A slug is URL- and filename- friendly.

The Django text utils define a function, slugify(), that’s probably the gold standard for this kind of thing. Essentially, their code is the following.

import unicodedata
import re

def slugify(value, allow_unicode=False):
    """
    Taken from https://github.com/django/django/blob/master/django/utils/text.py
    Convert to ASCII if 'allow_unicode' is False. Convert spaces or repeated
    dashes to single dashes. Remove characters that aren't alphanumerics,
    underscores, or hyphens. Convert to lowercase. Also strip leading and
    trailing whitespace, dashes, and underscores.
    """
    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('-_')

And the older version:

def slugify(value):
    """
    Normalizes string, converts to lowercase, removes non-alpha characters,
    and converts spaces to hyphens.
    """
    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

There’s more, but I left it out, since it doesn’t address slugification, but escaping.

More Related Contents:

  1. How to name a file using a value in a list in a dictionary?
  2. Extracting extension from filename in Python
  3. Why do I get a SyntaxError for a Unicode escape in my file path? [duplicate]
  4. What is a “slug” in Django?
  5. How do you import a file in python with spaces in the name?
  6. How to make Django slugify work properly with Unicode strings?
  7. String slugification in Python
  8. How do I create a slug in Django?
  9. How can I replace (or strip) an extension from a filename in Python?
  10. Build the full path filename in Python
  11. How can I create a full path to a file from parts (e.g. path to the folder, name and extension)?
  12. How do I create a python code that distinguishes between the capital of a state and the state that the capital has?
  13. Check to see if python script is running
  14. Callable modules
  15. What is the `self` parameter in class methods?
  16. scipy: savefig without frames, axes, only content
  17. Numpy ‘smart’ symmetric matrix
  18. Disable console messages in Flask server
  19. How to convert an H:MM:SS time string to seconds in Python?
  20. Permission Denied To Write To My Temporary File
  21. Python: How do I get key/value pairs from the BaseHTTPRequestHandler HTTP POST handler?
  22. Add advanced features to a tkinter Text widget
  23. Convert string “Jun 1 2005 1:33PM” into datetime
  24. How can I make a dictionary (dict) from separate lists of keys and values?
  25. What is the fastest way to generate image thumbnails in Python?
  26. Python decorator as a staticmethod
  27. How to remove decimal points in pandas
  28. flatten list of list through list comprehension
  29. Use pdb.set_trace() in a script that reads stdin via a pipe
  30. Search and replace for text within a pdf, in Python [duplicate]

Leave a Comment