Multivariate Pattern Analysis in Python

### Navigation

- index
- modules |
- modules |
- PyMVPA Home |
- Sitemap »

# mvpa2.base.state.TextWrapper

class `mvpa2.base.state.``TextWrapper`(width=70, initial_indent='', subsequent_indent='', expand_tabs=True, replace_whitespace=True, fix_sentence_endings=False, break_long_words=True, drop_whitespace=True, break_on_hyphens=True)

  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 1 .. 8 spaces, depending on its position in its line. If false, each tab is treated as a single character.
    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.

  Methods

  `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`((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.

  `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.

  `sentence_end_re` = <_sre.SRE_Pattern object at 0xa3e47b8>
  `unicode_whitespace_trans` = {32: 32, 9: 32, 10: 32, 11: 32, 12: 32, 13: 32}
  `uspace` = 32
  `whitespace_trans` = '\x00\x01\x02\x03\x04\x05\x06\x07\x08 \x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f !"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~\x7f\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f\xa0\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf\xb0\xb1\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff'
  `wordsep_re` = <_sre.SRE_Pattern object at 0xa494720>
  `wordsep_simple_re` = <_sre.SRE_Pattern object at 0xa3a6f20>
  `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.

  `x` = 32

### Navigation

- index
- modules |
- modules |
- PyMVPA Home |
- Sitemap »