InputStream クラス

入力 BLOB を表すファイルに似たオブジェクト。

継承
InputStream
InputStream

コンストラクター

InputStream()

メソッド

close

IO オブジェクトをフラッシュして閉じます。

ファイルが既に閉じている場合、このメソッドは無効です。

detach

このバッファーを基になる生ストリームから切断し、返します。

生ストリームがデタッチされると、バッファーは使用できない状態になります。

fileno

基になるファイル記述子が存在する場合は、そのファイル記述子を返します。

IO オブジェクトがファイル記述子を使用しない場合、OSError が発生します。

flush

必要に応じて、書き込みバッファーをフラッシュします。

これは、読み取り専用ストリームと非ブロッキング ストリームには実装されません。

isatty

これが "対話型" ストリームであるかどうかを返します。

判断できない場合は False を返します。

read

バイト のサイズ までを返して読み取ります。

read1

最大 n バイトまでの読み取りと返し。基になる生ストリームに対する read() 呼び出しは最大 1 回です。 短い結果は、EOF が差し迫っていることを意味するものではありません。

EOF の空のバイト オブジェクトを返します。

readable

オブジェクトが読み取り用に開かれたかどうかを返します。

False の場合、read() は OSError を発生させます。

readinto
readinto1
readline

ストリームから行を読み取って返します。

size を指定すると、最大サイズバイト数が読み取られます。

バイナリ ファイルの場合、行ターミネータは常に b'n' です。テキスト ファイルの場合、開く newlines 引数を使用して、認識される行終端記号を選択できます。

readlines

ストリームから行の一覧を返します。

hint は、読み取られた行数を制御するために指定できます。これまでのすべての行の合計サイズ (バイト/文字単位) がヒントを超えた場合、これ以上行は読み取らなくなります。

seek

ストリームの位置を変更します。

ストリーム位置を指定されたバイト オフセットに変更します。 オフセットは、whence によって示される位置を基準にして解釈されます。 whence の値は次のとおりです。

  • 0 – ストリームの開始 (既定値);offset は 0 または正である必要があります

  • 1 – 現在のストリーム位置;offset は負の値になる可能性があります

  • 2 – ストリームの終わり;offset は通常、負の値です

新しい絶対位置を返します。

seekable

オブジェクトがランダム アクセスをサポートしているかどうかを返します。

False、seek()、tell()、truncate() の場合、OSError が発生します。 このメソッドでは、テスト シーク () を行う必要がある場合があります。

tell

現在のストリーム位置を返します。

truncate

ファイルをバイトサイズに切り捨てます。

ファイル ポインターは変更されません。 サイズの既定値は、tell() によって報告される現在の IO 位置です。 新しいサイズを返します。

writable

オブジェクトが書き込み用に開かれたかどうかを返します。

False の場合、write() は OSError を発生させます。

write

指定されたバッファーを IO ストリームに書き込みます。

書き込まれたバイト数を返します。これは常に b の長さ (バイト単位) です。

バッファーがいっぱいで、基になる生ストリームが現在より多くのデータを受け入れることができない場合は、BlockingIOError を発生させます。

writelines

ストリームする行の一覧を書き込みます。

行区切り記号は追加されないため、指定された各行の末尾に線区切り記号が付けられるのが一般的です。

close

IO オブジェクトをフラッシュして閉じます。

ファイルが既に閉じている場合、このメソッドは無効です。

close()

detach

このバッファーを基になる生ストリームから切断し、返します。

生ストリームがデタッチされると、バッファーは使用できない状態になります。

detach()

fileno

基になるファイル記述子が存在する場合は、そのファイル記述子を返します。

IO オブジェクトがファイル記述子を使用しない場合、OSError が発生します。

fileno()

flush

必要に応じて、書き込みバッファーをフラッシュします。

これは、読み取り専用ストリームと非ブロッキング ストリームには実装されません。

flush()

isatty

これが "対話型" ストリームであるかどうかを返します。

判断できない場合は False を返します。

isatty()

read

バイト のサイズ までを返して読み取ります。

abstract read(size=-1) -> bytes

パラメーター

size
int
既定値: -1

読み取るバイト数。 引数を省略するか、 None負の値を指定すると、EOF に達するまでデータが読み取られ、返されます。

戻り値

入力ストリームから読み取られたバイト数。

read1

最大 n バイトまでの読み取りと返し。基になる生ストリームに対する read() 呼び出しは最大 1 回です。 短い結果は、EOF が差し迫っていることを意味するものではありません。

EOF の空のバイト オブジェクトを返します。

read1()

readable

オブジェクトが読み取り用に開かれたかどうかを返します。

False の場合、read() は OSError を発生させます。

readable()

readinto

readinto(buffer, /)

パラメーター

buffer
必須

readinto1

readinto1(buffer, /)

パラメーター

buffer
必須

readline

ストリームから行を読み取って返します。

size を指定すると、最大サイズバイト数が読み取られます。

バイナリ ファイルの場合、行ターミネータは常に b'n' です。テキスト ファイルの場合、開く newlines 引数を使用して、認識される行終端記号を選択できます。

readline(size=-1, /)

パラメーター

size
既定値: -1

readlines

ストリームから行の一覧を返します。

hint は、読み取られた行数を制御するために指定できます。これまでのすべての行の合計サイズ (バイト/文字単位) がヒントを超えた場合、これ以上行は読み取らなくなります。

readlines(hint=-1, /)

パラメーター

hint
既定値: -1

seek

ストリームの位置を変更します。

ストリーム位置を指定されたバイト オフセットに変更します。 オフセットは、whence によって示される位置を基準にして解釈されます。 whence の値は次のとおりです。

  • 0 – ストリームの開始 (既定値);offset は 0 または正である必要があります

  • 1 – 現在のストリーム位置;offset は負の値になる可能性があります

  • 2 – ストリームの終わり;offset は通常、負の値です

新しい絶対位置を返します。

seek()

seekable

オブジェクトがランダム アクセスをサポートしているかどうかを返します。

False、seek()、tell()、truncate() の場合、OSError が発生します。 このメソッドでは、テスト シーク () を行う必要がある場合があります。

seekable()

tell

現在のストリーム位置を返します。

tell()

truncate

ファイルをバイトサイズに切り捨てます。

ファイル ポインターは変更されません。 サイズの既定値は、tell() によって報告される現在の IO 位置です。 新しいサイズを返します。

truncate()

writable

オブジェクトが書き込み用に開かれたかどうかを返します。

False の場合、write() は OSError を発生させます。

writable()

write

指定されたバッファーを IO ストリームに書き込みます。

書き込まれたバイト数を返します。これは常に b の長さ (バイト単位) です。

バッファーがいっぱいで、基になる生ストリームが現在より多くのデータを受け入れることができない場合は、BlockingIOError を発生させます。

write()

writelines

ストリームする行の一覧を書き込みます。

行区切り記号は追加されないため、指定された各行の末尾に線区切り記号が付けられるのが一般的です。

writelines(lines, /)

パラメーター

lines
必須

属性

closed

length

name

uri