Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Python3.x】PermissionError::characters_written定数の使い方

characters_written定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

characters_written定数は、Pythonの組み込み例外であるPermissionErrorオブジェクトに付随し、ファイルやデバイスへの書き込み操作中にアクセス権限エラーが発生した場合に、実際に書き込みが成功した文字数(またはバイト数)を表す定数です。

PermissionErrorは、通常、ファイルやディレクトリに対して必要なアクセス権限がない場合に発生するエラーで、例えば読み取り専用のファイルに書き込もうとしたり、システムが保護している領域にアクセスしようとしたりする際に発生します。このcharacters_written定数は、特に大量のデータを書き込もうとした際に途中で権限エラーが発生し、部分的な書き込みが行われた場合に役立ちます。

具体的には、エラーが発生するまでにどれだけのデータが書き込まれたかを知ることで、エラー発生時の状況把握や、書き込みが中断された後の処理のリカバリに活用できます。例えば、ログファイルへの書き込み中にこのエラーが発生した場合、エラー直前までに書き込まれたログの量を把握し、次回の処理でどの時点から書き込みを再開すべきかを判断するのに役立ちます。

ただし、この定数は全てのPermissionErrorで有効な情報を提供するわけではなく、書き込み操作の文脈で、かつ部分的な書き込みが発生した場合にのみ意味を持つ点に注意が必要です。それ以外の状況や、書き込み操作と無関係な権限エラーの場合には、この定数が設定されないか、あるいは値が0になることがあります。

構文(syntax)

1try:
2    pass
3except PermissionError as e:
4    e.characters_written

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

関連コンテンツ