What’s the easiest way to escape HTML in Python?

by

html.escape is the correct answer now, it used to be cgi.escape in python before 3.2. It escapes:

  • < to &lt;
  • > to &gt;
  • & to &amp;

That is enough for all HTML.

EDIT: If you have non-ascii chars you also want to escape, for inclusion in another encoded document that uses a different encoding, like Craig says, just use:

data.encode('ascii', 'xmlcharrefreplace')

Don’t forget to decode data to unicode first, using whatever encoding it was encoded.

However in my experience that kind of encoding is useless if you just work with unicode all the time from start. Just encode at the end to the encoding specified in the document header (utf-8 for maximum compatibility).

Example:

>>> cgi.escape(u'<a>bá</a>').encode('ascii', 'xmlcharrefreplace')
'&lt;a&gt;b&#225;&lt;/a&gt;

Also worth of note (thanks Greg) is the extra quote parameter cgi.escape takes. With it set to True, cgi.escape also escapes double quote chars (") so you can use the resulting value in a XML/HTML attribute.

EDIT: Note that cgi.escape has been deprecated in Python 3.2 in favor of html.escape, which does the same except that quote defaults to True.

More Related Contents:

  1. Strip HTML from strings in Python
  2. How to find elements by class
  3. How can I select a html element no matter what frame it is in in selenium?
  4. Post values from an HTML form and access them in a Flask view
  5. How to retrieve the values of dynamic html content using Python
  6. How to convert webpage into PDF by using Python
  7. Pandas to_html() truncates string contents
  8. Beautiful Soup findAll doesn’t find them all
  9. How to get text of an element in Selenium WebDriver, without including child element text?
  10. BeautifulSoup findAll() given multiple classes?
  11. How can I get href links from HTML using Python?
  12. BeautifulSoup webscraping find_all( ): finding exact match
  13. How can I make sure if some HTML elements are loaded for Selenium + Python?
  14. BeautifulSoup innerhtml?
  15. Does anybody know how to identify shadow dom web elements using selenium webdriver?
  16. Display a ‘loading’ message while a time consuming function is executed in Flask
  17. pandas read_html ValueError: No tables found
  18. Understand the Find() function in Beautiful Soup
  19. python beautifulsoup iframe document html extract
  20. BeautifulSoup: extract text from anchor tag
  21. How can I get all the plain text from a website with Scrapy?
  22. Checking if an element exists with Python Selenium
  23. pd.read_html() imports a list rather than a dataframe
  24. How to Download a File after POSTing data using FastAPI?
  25. BeautifulSoup return unexpected extra spaces
  26. Why is my static CSS not working in Django?
  27. How to find/replace text in html while preserving html tags/structure
  28. How can I run a Python script in HTML?
  29. How to format IPython html display of Pandas dataframe?
  30. Call a python function within a html file

Leave a Comment