Module html

Classes

• class MLStripper

Functions

• ▶ def avoid_wrapping(value)

  Avoid text wrapping in the middle of a phrase by adding non-breaking spaces where there previously were normal spaces.

  source link

  Reexports

  • Imported in django.template.defaultfilters.
  • Imported in django.utils.timesince.
• ▶ def conditional_escape(text)

  Similar to escape(), except that it doesn't operate on pre-escaped strings.

  source link

  This function relies on the __html__ convention used both by Django's
  SafeData class and by third-party libraries like markupsafe.

  Reexports

  • Imported in django.contrib.admin.helpers.
  • Imported in django.forms.boundfield.
  • Imported in django.forms.forms.
  • Imported in django.template.backends.dummy.
  • Imported in django.template.base.
  • Imported in django.template.defaultfilters.
  • Imported in django.template.defaulttags.
  • Imported in django.template.library.
  • Imported in django.templatetags.static.
• ▶ def escape(text) @keep_lazy(str, SafeString)

  Return the given text with ampersands, quotes and angle brackets encoded for use in HTML.

  @keep_lazy(str, SafeString)
  def escape(text)

  source link

  Always escape input, even if it's already escaped and marked as such.
  This may result in double-escaping. If this is a concern, use
  conditional_escape() instead.

  Reexports

  • Imported in django.contrib.auth.admin.
  • Imported in django.contrib.syndication.views.
  • Imported in django.forms.utils.
  • Imported in django.template.base.
  • Imported in django.template.defaultfilters.
• ▶ def escapejs(value) @keep_lazy(str, SafeString)

  Hex encode characters for use in JavaScript strings.

  @keep_lazy(str, SafeString)
  def escapejs(value)

  source link

  Reexports

  • Imported in django.template.defaultfilters.
• ▶ def format_html(format_string, *args, **kwargs)

  Similar to str.format, but pass all arguments through conditional_escape(), and call mark_safe() on the result. This function should be used instead of str.format or % interpolation to build up small HTML fragments.

  source link

  Reexports

  • Imported in django.contrib.admin.helpers.
  • Imported in django.contrib.admin.options.
  • Imported in django.contrib.admin.templatetags.admin_list.
  • Imported in django.contrib.admin.utils.
  • Imported in django.contrib.auth.password_validation.
  • Imported in django.forms.boundfield.
  • Imported in django.forms.utils.
  • Imported in django.forms.widgets.
  • Imported in django.template.backends.utils.
  • Imported in django.template.defaulttags.
• ▶ def format_html_join(sep, format_string, args_generator)

  A wrapper of format_html, for the common case of a group of arguments that need to be formatted using the same format string, and then joined using 'sep'. 'sep' is also passed through conditional_escape.

  source link

  'args_generator' should be an iterator that returns the sequence of 'args'
      that will be passed to format_html.
  
      Example:
  
        format_html_join('
  ', "<li>{} {}</li>", ((u.first_name, u.last_name)
                                                    for u in users))

  Reexports

  • Imported in django.contrib.auth.password_validation.
  • Imported in django.forms.utils.
• ▶ def html_safe(klass)

  A decorator that defines the __html__ method. This helps non-Django templates to detect classes whose __str__ methods return SafeString.

  source link

  Reexports

  • Imported in django.forms.boundfield.
  • Imported in django.forms.forms.
  • Imported in django.forms.formsets.
  • Imported in django.forms.utils.
  • Imported in django.forms.widgets.
• ▶ def json_script(value, element_id)

  Escape all the HTML/XML special characters with their unicode escapes, so value is safe to be output anywhere except for inside a tag attribute. Wrap the escaped JSON in a script tag.

  source link

  Reexports

  • Imported in django.template.defaultfilters as _json_script.
• ▶ def linebreaks(value, autoescape=False) @keep_lazy_text

  Convert newlines into <p> and <br>s.

  @keep_lazy_text
  def linebreaks(

  value,

  autoescape=False,

  )

  source link

  Reexports

  • Imported in django.template.defaultfilters.
• ▶ def smart_urlquote(url)

  Quote a URL if it isn't already quoted.

  source link

  Reexports

  • Imported in django.contrib.admin.widgets.
• ▷ def strip_spaces_between_tags(value) @keep_lazy_text

  Return the given HTML with spaces between tags removed.

  @keep_lazy_text
  def strip_spaces_between_tags(value)

  source link
• ▶ def strip_tags(value) @keep_lazy_text

  Return the given HTML with all tags stripped.

  @keep_lazy_text
  def strip_tags(value)

  source link

  Reexports

  • Imported in django.template.defaultfilters.
• ▶ def urlize(text, trim_url_limit=None, nofollow=False, autoescape=False) @keep_lazy_text

  Convert any URLs in text into clickable links.

  @keep_lazy_text
  def urlize(

  text,

  trim_url_limit=None,

  nofollow=False,

  autoescape=False,

  )

  source link

  Works on http://, https://, www. links, and also on links ending in one of
  the original seven gTLDs (.com, .edu, .gov, .int, .mil, .net, and .org).
  Links can have trailing punctuation (periods, commas, close-parens) and
  leading punctuation (opening parens) and it'll still do the right thing.
  
  If trim_url_limit is not None, truncate the URLs in the link text longer
  than this limit to trim_url_limit - 1 characters and append an ellipsis.
  
  If nofollow is True, give the links a rel="nofollow" attribute.
  
  If autoescape is True, autoescape the link text and URLs.

  Reexports

  • Imported in django.template.defaultfilters as _urlize.

Generated by nedoc v0.9 at 2020-12-29 14:04