Back to module index

Go to module by name

textwrap

Text wrapping and filling.

Classes

TextWrapper

    Object for wrapping/filling text.  The public interface consists of
    the wrap() and fill() methods; the other methods are just there for
    subclasses to override in order to tweak the default behaviour.
    If you want to completely replace the main wrapping algorithm,
    you'll probably have to override _wrap_chunks().

    Several instance attributes control various aspects of wrapping:
      width (default: 70)
        the maximum width of wrapped lines (unless break_long_words
        is false)
      initial_indent (default: "")
        string that will be prepended to the first line of wrapped
        output.  Counts towards the line's width.
      subsequent_indent (default: "")
        string that will be prepended to all lines save the first
        of wrapped output; also counts towards each line's width.
      expand_tabs (default: true)
        Expand tabs in input text to spaces before further processing.
        Each tab will become 0 .. 'tabsize' spaces, depending on its position
        in its line.  If false, each tab is treated as a single character.
      tabsize (default: 8)
        Expand tabs in input text to 0 .. 'tabsize' spaces, unless
        'expand_tabs' is false.
      replace_whitespace (default: true)
        Replace all whitespace characters in the input text by spaces
        after tab expansion.  Note that if expand_tabs is false and
        replace_whitespace is true, every tab will be converted to a
        single space!
      fix_sentence_endings (default: false)
        Ensure that sentence-ending punctuation is always followed
        by two spaces.  Off by default because the algorithm is
        (unavoidably) imperfect.
      break_long_words (default: true)
        Break words longer than 'width'.  If false, those words will not
        be broken, and some lines might be longer than 'width'.
      break_on_hyphens (default: true)
        Allow breaking hyphenated words. If true, wrapping will occur
        preferably on whitespaces and right after hyphens part of
        compound words.
      drop_whitespace (default: true)
        Drop leading and trailing whitespace from lines.
      max_lines (default: None)
        Truncate wrapped lines.
      placeholder (default: ' [...]')
        Append to the last line of truncated text.
    

fill(self, text)

  fill(text : string) -> string

          Reformat the single paragraph in 'text' to fit in lines of no
          more than 'self.width' columns, and return a new string
          containing the entire wrapped paragraph.
        

wrap(self, text)

  wrap(text : string) -> [string]

          Reformat the single paragraph in 'text' so it fits in lines of
          no more than 'self.width' columns, and return a list of wrapped
          lines.  Tabs in 'text' are expanded with string.expandtabs(),
          and all other whitespace characters (including newline) are
          converted to space.
        

sentence_end_re = re.compile('[a-z][\\.\\!\\?][\\"\\\']?\\Z')

unicode_whitespace_trans = {9: 32, 10: 32, 11: 32, 12: 32, 13: 32, 32: 32}

uspace = 32

wordsep_re = re.compile('\n        ( # any whitespace\n          [\\\t\\\n\\\x0b\\\x0c\\\r\\ ]+\n        | # em-dash between words\n          (?<=[\\w!"\\\'&.,?]) -{2,} (?=\\w)\n        | # word, possibly hyphenated\n       , re.VERBOSE)

wordsep_simple_re = re.compile('([\\\t\\\n\\\x0b\\\x0c\\\r\\ ]+)')

x = ' '

Functions

dedent

dedent(text)

  Remove any common leading whitespace from every line in `text`.

      This can be used to make triple-quoted strings line up with the left
      edge of the display, while still presenting them in the source code
      in indented form.

      Note that tabs and spaces are both treated as whitespace, but they
      are not equal: the lines "  hello" and "\thello" are
      considered to have no common leading whitespace.

      Entirely blank lines are normalized to a newline character.
    

fill

fill(text, width=70, **kwargs)

  Fill a single paragraph of text, returning a new string.

      Reformat the single paragraph in 'text' to fit in lines of no more
      than 'width' columns, and return a new string containing the entire
      wrapped paragraph.  As with wrap(), tabs are expanded and other
      whitespace characters converted to space.  See TextWrapper class for
      available keyword args to customize wrapping behaviour.
    

indent

indent(text, prefix, predicate=None)

  Adds 'prefix' to the beginning of selected lines in 'text'.

      If 'predicate' is provided, 'prefix' will only be added to the lines
      where 'predicate(line)' is True. If 'predicate' is not provided,
      it will default to adding 'prefix' to all non-empty lines that do not
      consist solely of whitespace characters.
    

shorten

shorten(text, width, **kwargs)

  Collapse and truncate the given text to fit in the given width.

      The text first has its whitespace collapsed.  If it then fits in
      the *width*, it is returned as is.  Otherwise, as many words
      as possible are joined and then the placeholder is appended::

          >>> textwrap.shorten("Hello  world!", width=12)
          'Hello world!'
          >>> textwrap.shorten("Hello  world!", width=11)
          'Hello [...]'
    

wrap

wrap(text, width=70, **kwargs)

  Wrap a single paragraph of text, returning a list of wrapped lines.

      Reformat the single paragraph in 'text' so it fits in lines of no
      more than 'width' columns, and return a list of wrapped lines.  By
      default, tabs in 'text' are expanded with string.expandtabs(), and
      all other whitespace characters (including newline) are converted to
      space.  See TextWrapper class for available keyword args to customize
      wrapping behaviour.
    

Modules

re