"textwrap" — テキストの折り返しと詰め込み
*****************************************

バージョン 2.3 で追加.

**ソースコード:** Lib/textwrap.py

======================================================================

The "textwrap" module provides two convenience functions, "wrap()" and
"fill()", as well as "TextWrapper", the class that does all the work,
and a utility function  "dedent()".  If you’re just wrapping or
filling one or two  text strings, the convenience functions should be
good enough; otherwise,  you should use an instance of "TextWrapper"
for efficiency.

textwrap.wrap(text[, width[, ...]])

   *text* (文字列)内の段落を一つだけ折り返しを行います。したがって、す
   べての行が高々 *width* 文字の長さになります。最後に改行が付かない出
   力行のリストを返します。

   オプションのキーワード引数は、以下で説明する "TextWrapper" のインス
   タンス属性に対応しています。 *width* はデフォルトで "70" です。

   "wrap()" の動作についての詳細は "TextWrapper.wrap()" メソッドを参照
   してください。

textwrap.fill(text[, width[, ...]])

   *text* 内の段落を一つだけ折り返しを行い、折り返しが行われた段落を含
   む一つの文字列を返します。 "fill()" はこれの省略表現です

      "\n".join(wrap(text, ...))

   特に、 "fill()" は "wrap()" とまったく同じ名前のキーワード引数を受
   け取ります。

Both "wrap()" and "fill()" work by creating a "TextWrapper" instance
and calling a single method on it.  That instance is not reused, so
for applications that wrap/fill many text strings, it will be more
efficient for you to create your own "TextWrapper" object.

テキストはなるべく空白か、ハイフンを含む語のハイフンの直後で折り返され
ます。 "TextWrapper.break_long_words" が偽に設定されていなければ、必要
な場合に長い語が分解されます。

An additional utility function, "dedent()", is provided to remove
indentation from strings that have unwanted whitespace to the left of
the text.

textwrap.dedent(text)

   *text* の各行に対し、共通して現れる先頭の空白を削除します。

   この関数は通常、三重引用符で囲われた文字列をスクリーン/その他の左端
   にそろえ、なおかつソースコード中ではインデントされた形式を損なわな
   いようにするために使われます。

   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.  (This behaviour is new in
   Python 2.5; older versions of this module incorrectly expanded tabs
   before searching for common leading whitespace.)

   例えば:

      def test():
          # end first line with \ to avoid the empty line!
          s = '''\
          hello
            world
          '''
          print repr(s)          # prints '    hello\n      world\n    '
          print repr(dedent(s))  # prints 'hello\n  world\n'

class textwrap.TextWrapper(...)

   The "TextWrapper" constructor accepts a number of optional keyword
   arguments.  Each argument corresponds to one instance attribute, so
   for example

      wrapper = TextWrapper(initial_indent="* ")

   はこれと同じです

      wrapper = TextWrapper()
      wrapper.initial_indent = "* "

   あなたは同じ "TextWrapper" オブジェクトを何回も再利用できます。また
   、使用中にインスタンス属性へ代入することでそのオプションのどれでも
   変更できます。

   "TextWrapper" インスタンス属性(とコンストラクタのキーワード引数)は
   以下の通りです:

   width

      (デフォルト: "70") 折り返しが行われる行の最大の長さ。入力行に
      "width" より長い単一の語が無い限り、 "TextWrapper" は "width" 文
      字より長い出力行が無いことを保証します。

   expand_tabs

      (デフォルト: "True") もし真ならば、そのときは *text* 内のすべて
      のタブ文字は *text* の "expandtabs()" メソッドを用いて空白に展開
      されます。

   replace_whitespace

      (デフォルト: "True") 真の場合、 "wrap()" メソッドはタブの展開の
      後、 wrap 処理の前に各種空白文字をスペース1文字に置換します。置
      換される空白文字は: TAB, 改行, 垂直TAB, FF, CR ("'\t\n\v\f\r'")
      です。

      注釈: "expand_tabs" が偽で "replace_whitespace" が真ならば、各
        タブ文 字は1つの空白に置き換えられます。それはタブ展開と同じで
        は *あ りません* 。

      注釈: "replace_whitespace" が偽の場合、改行が行の途中で現れる
        ことで 出力がおかしくなることがあります。このため、テキストを
        ("str.splitlines()" などを使って)段落ごとに分けて別々に wrap
        する必要があります。

   drop_whitespace

      (デフォルト: "True") 真の場合、(wrap 処理のあとインデント処理の
      前に) 各行の最初と最後の空白文字を削除します。ただし、段落の最初
      の空白については、次の文字が空白文字でない場合は削除されません。
      削除される空白文字が行全体に及ぶ場合は、行自体を削除します。

      バージョン 2.6 で追加: Whitespace was always dropped in earlier
      versions.

   initial_indent

      (default: "''")  wrap の出力の最初の行の先頭に付与する文字列。最
      初の行の長さに加算されます。空文字列の場合インデントされません。

   subsequent_indent

      (デフォルト: "''") 一行目以外の折り返しが行われる出力のすべての
      行の先頭に付けられる文字列。一行目以外の各行の折り返しまでの長さ
      にカウントされます。

   fix_sentence_endings

      (デフォルト: "False") もし真ならば、 "TextWrapper" は文の終わり
      を見つけようとし、確実に文がちょうど二つの空白で常に区切られてい
      るようにします。これは一般的に固定スペースフォントのテキストに対
      して望ましいです。しかし、文の検出アルゴリズムは完全ではありませ
      ん: 文の終わりには、後ろに空白がある "'.'", "'!'" または "'?'"
      の中の一つ、ことによると "'"'" あるいは ""'"" が付随する小文字が
      あると仮定しています。これに伴う一つの問題はアルゴリズムで下記の
      」Dr.」と

         [...] Dr. Frankenstein's monster [...]

      下記の」Spot.」の間の差異を検出できないことです

         [...] See Spot. See Spot run [...]

      "fix_sentence_endings" はデフォルトで偽です。

      文検出アルゴリズムは」小文字」の定義のために "string.lowercase"
      に依存し、同一行の文を区切るためにピリオドの後に二つの空白を使う
      慣習に依存しているため、英文テキストに限定されたものです。

   break_long_words

      (デフォルト: "True") もし真ならば、そのとき "width" より長い行が
      確実にないようにするために、 "width" より長い語は切られます。偽
      ならば、長い語は切られないでしょう。そして、 "width" より長い行
      があるかもしれません。 ("width" を超える分を最小にするために、長
      い語は単独で一行に置かれるでしょう。)

   break_on_hyphens

      (デフォルト: "True") 真の場合、英語で一般的なように、ラップ処理
      は空白か合成語に含まれるハイフンの直後で行われます。偽の場合、空
      白だけが改行に適した位置として判断されます。ただし、本当に語の途
      中で改行が行われないようにするためには、 "break_long_words" 属性
      を真に設定する必要があります。過去のバージョンでのデフォルトの振
      る舞いは、常にハイフンの直後での改行を許していました。

      バージョン 2.6 で追加.

   "TextWrapper" also provides two public methods, analogous to the
   module-level convenience functions:

   wrap(text)

      1段落の文字列 *text* を、各行が "width" 文字以下になるように
      wrap します。 wrap のすべてのオプションは "TextWrapper" インスタ
      ンスの属性から取得します。結果の、行末に改行のない行のリストを返
      します。出力の内容が空になる場合は、返すリストも空になります。

   fill(text)

      *text* 内の段落を一つだけ折り返しを行い、折り返しが行われた段落
      を含む一つの文字列を返します。
