このモジュールは TextFileクラスを提供します。これはテキストファイル へのインタフェースを提供し、コメントの削除、空行の無視、バックスラッシュ での行の連結を任意に行えます。
[filename=None , file=None , **options]) |
#
がコメント文字なら)コメントの削除、空行のスキップ、
(行末のバックスラッシュでの)改行のエスケープによる行の連結、
先頭/末尾の空白文字の削除。 これらは全て独立して任意に設定できます。
クラスはwarn()メソッドを提供しており、物理行つきの警告メッセー ジを生成することができます。この物理行は論理行が複数の物理行にまたがっ ていても大丈夫です。 またunreadline()メソッドが一行先読みを実装するために提供されています。
TextFileのインスタンスはfilename、file、またはその
両方をとって作成されます。
両方が None
の場合 RuntimeError が起きます。
filenameは文字列、fileはファイルオブジェク
ト(またはreadline()とclose()のメソッドを提供する何か)
である必要があります。
TextFileが生成する警告メッセージに含めることができるので、
filenameを与えることが推奨されます、
もしfileが提供されなければ、 TextFile は組み込みの open()
を利用して自分で作成します。
オプションは全て真偽値で、readline()で返される値に影響します。
オプション名 | 説明 | デフォルト値 |
---|---|---|
<オプション名>strip_commentsオプション名> | バックスラッシュでエスケープされていない限り、"#"から行末 までと、"#"の先にある空白文字の並びを削除します。 | true |
<オプション名>lstrip_wsオプション名> | 行を返す前に先頭の空白文字の並びを削除します。 | false |
<オプション名>rstrip_wsオプション名> | 行を返す前に行末の空白文字(改行文字を含みます!)の並びを削除します。 | true |
<オプション名>skip_blanksオプション名> | コメントと空白を除いた*あとで*内容がない行をスキップします。 (もし lstrip_ws と rstrip_ws がともに偽なら、空白文字だけの行があるか もしれません。これはskip_blanksが真でない限りスキップされません。) | true |
<オプション名>join_linesオプション名> | もしコメントと空白文字を削除したあとで、バックスラッシュが最後の改行文 字でない文字なら、次の行を接続して一つの論理行とします: N行の連続した行がバックスラッシュで終わる場合、N+1 行の物理行が1行の論 理行として扱われます。 | false |
<オプション名>collapse_joinオプション名> | 前の行と接続するとき、行頭の空白文字を削除します。"(join_lines and not lstrip_ws)" の時だけ意味をもちます。 | false |
rstrip_wsは行末の改行を削除するので、readline()のセマン
ティクスが組み込みファイルオブジェクトのreadline()メソッドと
は変わってしまいます!
特に、 rstrip_ws が真で skip_blanks が偽のとき、
readline() はファイルの終端でNone
を返し、空文字
列を返したときは空行(または全て空白文字の行)です。
filename) |
) |
msg[,line=None ]) |
) |
None
を返します。
) |
line) |
ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。