Module text

Classes

• class StreamingBuffer
• class Truncator
  An object used to truncate text, either by characters or words.

Functions

• ▶ def camel_case_to_spaces(value)

  Split CamelCase and convert to lowercase. Strip surrounding whitespace.

  source link

  Reexports

  • Imported in django.db.models.options.
• ▶ def capfirst(x) @keep_lazy_text

  Capitalize the first letter of a string.

  @keep_lazy_text
  def capfirst(x)

  source link

  Reexports

  • Imported in django.contrib.admin.options.
  • Imported in django.contrib.admin.sites.
  • Imported in django.contrib.admin.templatetags.admin_list.
  • Imported in django.contrib.admin.utils.
  • Imported in django.contrib.auth.forms.
  • Imported in django.contrib.auth.management.commands.createsuperuser.
  • Imported in django.db.models.base.
  • Imported in django.db.models.fields.
  • Imported in django.forms.models.
  • Imported in django.test.selenium.
• ▶ def compress_sequence(sequence)

  source link

  Reexports

  • Imported in django.middleware.gzip.
• ▶ def compress_string(s)

  source link

  Reexports

  • Imported in django.middleware.gzip.
• ▶ def get_text_list(list_, last_word=gettext_lazy('or')) @keep_lazy_text

  >>> get_text_list(['a', 'b', 'c', 'd'])

  @keep_lazy_text
  def get_text_list(

  list_,

  last_word=gettext_lazy('or'),

  )

  source link

  'a, b, c or d'
  >>> get_text_list(['a', 'b', 'c'], 'and')
  'a, b and c'
  >>> get_text_list(['a', 'b'], 'and')
  'a and b'
  >>> get_text_list(['a'])
  'a'
  >>> get_text_list([])
  ''

  Reexports

  • Imported in django.contrib.admin.models.
  • Imported in django.contrib.admin.options.
  • Imported in django.core.management.commands.makemessages.
  • Imported in django.db.models.base.
  • Imported in django.forms.models.
  • Imported in django.template.base.
• ▶ def get_valid_filename(s) @keep_lazy_text

  Return the given string converted to a string that can be used for a clean

  @keep_lazy_text
  def get_valid_filename(s)

  source link

  filename. Remove leading and trailing spaces; convert other spaces to
  underscores; and remove anything that is not an alphanumeric, dash,
  underscore, or dot.
  >>> get_valid_filename("john's portrait in 2004.jpg")
  'johns_portrait_in_2004.jpg'

  Reexports

  • Imported in django.core.files.storage.
• ▶ def normalize_newlines(text) @keep_lazy_text

  Normalize CRLF and CR newlines to just LF.

  @keep_lazy_text
  def normalize_newlines(text)

  source link

  Reexports

  • Imported in django.template.defaultfilters.
  • Imported in django.utils.html.
• ▶ def phone2numeric(phone) @keep_lazy_text

  Convert a phone number with letters into its numeric equivalent.

  @keep_lazy_text
  def phone2numeric(phone)

  source link

  Reexports

  • Imported in django.template.defaultfilters.
• ▶ def slugify(value, allow_unicode=False) @keep_lazy_text

  Convert to ASCII if 'allow_unicode' is False. Convert spaces or repeated

  @keep_lazy_text
  def slugify(

  value,

  allow_unicode=False,

  )

  source link

  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.

  Reexports

  • Imported in django.template.defaultfilters as _slugify.
• ▶ def smart_split(text)

  Generator that splits a string by spaces, leaving quoted phrases together.

  source link

  Supports both single and double quotes, and supports escaping quotes with
  backslashes. In the output, strings will keep their initial and trailing
  quote marks and escaped quotes will remain escaped (the results can then
  be further processed with unescape_string_literal()).
  
  >>> list(smart_split(r'This is "a person\'s" test.'))
  ['This', 'is', '"a person\\\'s"', 'test.']
  >>> list(smart_split(r"Another 'person\'s' test."))
  ['Another', "'person\\'s'", 'test.']
  >>> list(smart_split(r'A "\"funky\" style" test.'))
  ['A', '"\\"funky\\" style"', 'test.']

  Reexports

  • Imported in django.contrib.admin.options.
  • Imported in django.template.base.
• ▷ def unescape_entities(text) @keep_lazy_text

  @keep_lazy_text
  def unescape_entities(text)

  source link
• ▶ def unescape_string_literal(s) @keep_lazy_text

  Convert quoted string literals to unquoted strings with escaped quotes and backslashes unquoted::

  @keep_lazy_text
  def unescape_string_literal(s)

  source link

  >>> unescape_string_literal('"abc"')
      'abc'
      >>> unescape_string_literal("'abc'")
      'abc'
      >>> unescape_string_literal('"a \"bc\""')
      'a "bc"'
      >>> unescape_string_literal("'\'ab\' c'")
      "'ab' c"

  Reexports

  • Imported in django.contrib.admin.options.
  • Imported in django.template.base.
• ▶ def wrap(text, width) @keep_lazy_text

  A word-wrap function that preserves existing line breaks. Expects that existing line breaks are posix newlines.

  @keep_lazy_text
  def wrap(

  text,

  width,

  )

  source link

  Preserve all white space except added line breaks consume the space on
  which they break the line.
  
  Don't wrap long words, thus the output text may have lines longer than
  ``width``.

  Reexports

  • Imported in django.template.defaultfilters.

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