Pythonで1行の記述が長くなりすぎたため、処理の途中で分割したい場面は、長い条件式の記述など、コーディング中に頻繁に発生します。スタイルガイドに準拠しつつ可読性を高める手段としてよく使われるのが「行継続」で、構文エラーを防ぎながら美しいフォーマットを簡単に実現できます。
この記事では、Pythonのソースコード内で改行を制御し、可読性を高める手法の基本的な使い方を解説していきます。丸括弧やバックスラッシュを用いた手法ごとの特徴や違いなど、サンプルコード付きで解説していきますので、ぜひ参考にしてください。
Pythonのコード内で改行する方法
Pythonでは改行が文の区切りとして認識される仕様のため、式や文が完了していない状態で改行すると構文エラーが発生する場合があります。
Python公式ドキュメントでも、改行文字の取り扱いについて次のように記載されています。
注釈 複数行に渡るコードの文字列を 'single' や 'eval' モードでコンパイルするとき、入力は一つ以上の改行文字で終端されなければなりません。
出典:Python公式ドキュメント open()関数
Pythonの字句解析では1つの論理行(Pythonが1つの文として解釈する行)が複数の物理行(ファイル上の実際の改行で区切られた行)にまたがることを「行継続」と呼びます。安全に複数行へ分けるためのこの行継続の記述方法を用いるのが一般的です。
コードを途中で折り返す主な手法は、以下の通りです。
- 丸括弧などの括弧類を使用して暗黙的に行継続する方法(非明示的行継続)
- 行末にバックスラッシュを配置して明示的に行継続する方法(明示的行継続)
とくにチーム開発においては、インデントの崩れを防ぐためにも適切な手法を選択することが求められます。
丸括弧を使って複数行に分ける
Pythonで長いコードを複数行に分ける際、最も推奨されるのが丸括弧()で全体を囲む手法です。括弧内では暗黙的な行継続が働く仕様を利用して、安全に記述を分割できます。
この仕組みは波括弧{}や角括弧[]でも同様に機能する仕様です。
長いif文の条件式を丸括弧を使って分割するコード例は、以下の通りです。
a = 10
b = 20
c = 30
if (a == 10 and
b == 20 and
c == 30):
print("条件を満たしました")
上記のコードでは、ifのあとの条件式全体を丸括弧で囲むことによって、各条件を改行して記述しています。バックスラッシュが不要になるため、コードの可読性が大幅に向上するというメリットがあります。
なお、PEP 8のMaximum Line Lengthにおいても、この括弧による暗黙的な行継続が推奨される標準的な記法です。
バックスラッシュで途中で区切る
もうひとつの手法として、行末にバックスラッシュ(日本語キーボードでは円記号キーに割り当てられている場合があります)を配置して、次の行へと明示的に行継続させる書き方が存在します。これは明示的な行継続と呼ばれる手法です。
バックスラッシュを用いて長い代入文を区切るコード例は、以下の通りです。
result = 1 + 2 + 3 + \
4 + 5 + 6 + \
7 + 8 + 9
print(result)
上記のコードでは、行末にバックスラッシュを置くことで、構文エラーを引き起こすことなく次の行へと行を継続しています。バックスラッシュの直後にはいかなる文字も置けない仕様です(スペース・タブ・不可視文字を含む)。
また、バックスラッシュ行継続では行末にコメントを付けられないという制約もあります。
手軽に記述できる反面、制約が多いため、基本的には前述の丸括弧による手法を優先的に利用することが推奨されます。バックスラッシュは、assert文など括弧によるグループ化が構文上サポートされていない限定的な状況でのみ活用するのが無難です。
Pythonの文字列に改行を入れる方法
Pythonのプログラムにおいて、文字列データそのものに改行を含める場面は多く存在します。
ここで扱う改行は「コードを複数行に折り返す行継続」ではなく、「文字列データの中に改行文字を埋め込む」操作です。用途に合わせて、適切な記述方法を選ぶことがポイントです。
改行文字を使って挿入する
エスケープシーケンスと呼ばれる特殊な文字を使って、文字列の途中で改行させるのが基本的なアプローチです。以下のコードは、改行を表す\nを文字列内に組み込んだ例です。
text = "1行目のテキストです。\n2行目のテキストです。"
print(text)
上記のコードでは、\nを挿入した位置で文字列が折り返されて出力されます。\nは文字列リテラル内のエスケープシーケンスとして改行文字になり、print()で表示される際に改行として反映される仕組みです。
複数の変数を連結する際にも、間にこの文字を挟むことによって同様の制御が可能です。
三重引用符で複数行として定義する
長い文章をそのままの形で変数に代入したい場合は、三重引用符を活用します。この記法を用いる場合は、対象の文字列を"""または'''で囲んで表現します。
text = """1行目のテキストです。
2行目のテキストです。
3行目のテキストです。"""
print(text)
上記のコードでは、ソースコード上で見えている改行がそのままデータとして保持されます。特殊な文字を手作業で入力する手間を省けるのが特徴です。
ただし、コード内のインデントも文字列の一部として認識される点には注意が必要です。関数内で定義する際などは、意図しない空白文字の混入を防ぐ対応が求められます。
対処法としては、textwrap.dedent()を使ってインデントを一括除去する方法や三重引用符の開始直後に\を置いて最初の改行を除去する方法が有効です。
Pythonで改行コードを処理する方法
ファイルからテキストを読み込んだり、文字列データを整形したりする際、改行コードの適切な処理が不可欠です。
ファイル読み込み時や文字列から改行コードを除去する
テキストファイルを読み込むと、各行の末尾に改行コードが含まれた状態で取得される仕様です。これをそのまま出力に利用すると、余分な空白行が生成される原因となります。
改行コードを取り除く際は、文字列のメソッドであるrstrip()を活用するのが一般的です。ただし、引数を省略したrstrip()は改行文字だけではなく、末尾のスペースやタブなどの空白文字も含めて削除する点に注意が必要です。
改行コードのみを確実に削除したい場合は、rstrip("\n")のように引数を明示する方法が確実です。
なお、rstrip("\r\n")の引数は「\r\nという文字列全体」ではなく、「\rと\nの文字集合」として扱われます。末尾に\r・\nが何文字続いていてもすべて除去されるため、Windowsの改行コード(CRLF)にも対応できます。
with open("sample.txt", "r") as f:
lines = [line.rstrip("\n") for line in f]
print(lines)
上記のコードでは、ファイルオブジェクトを直接反復して各行を処理し、リスト内包表記の中でrstrip("\n")を呼び出すことで末尾の改行コードのみを一括削除しています。外部データや入力値など変数として保持した文字列でも同じメソッドで処理が可能です。
先頭や末尾の両方から空白文字を含めて消したい場合は、strip()を使うという手法も有効です。
Pythonのコード内改行に関するよくある質問
丸括弧とバックスラッシュはどちらを使うべきですか?
原則として丸括弧による暗黙的な行継続を使うことが推奨されます。Python公式ドキュメントの字句解析でも、バックスラッシュには次のような制約が明記されています。
また、バックスラッシュを使ってコメントを継続することはできません。
出典:Python公式ドキュメント 字句解析
不可視文字の混入によるエラーリスクもあるため、PEP 8でも括弧内の暗黙的な行継続が標準的な記法として推奨されています。バックスラッシュは、assert文など括弧によるグループ化が構文上サポートされていない限定的な状況でのみ使用するのが適切です。
OSごとの改行コードの違いを意識する必要はあるか?
通常のテキストモードでのファイル操作では、意識しなくても問題ない仕様です。Pythonのテキストモードでファイルを開く際(open()のデフォルトnewline=None)は、読み込み時に\r・\r\n・\nをすべて\nに統一し、書き込み時は\nをOS固有の改行コードに変換する機能が備わっているためです。
なお、改行コードの形式はOSによって異なり、WindowsはCRLF(\r\n)、macOS(OS X以降)およびUnix/LinuxはLF(\n)を使用します。バイナリデータとして扱う場合や特定のフォーマットを厳密に維持したい場面では、open()関数のnewline引数を明示的に指定して動作を制御する対応が求められます。
※上記コンテンツの内容やソースコードはAIで確認・デバッグしておりますが、間違いやエラー、脆弱性などがある場合は、コメントよりご報告いただけますと幸いです。
ITやプログラミングに関するコラム
PythonをWebで実行する方法
共通テスト「情報Ⅰ」2年目で変わる、日本の教育と学び方
gitでブランチ(branch)を切り替える方法
git cloneでブランチを指定する方法
64GBのメモリが必要な人・不要な人の特徴
PCを再起動するコマンド一覧
CapsLock以外で大文字になる原因【Windows編】
パソコンで大文字になるのを解除する方法
面白いAIの活用事例を業界別に紹介
Gitでcommit(コミット)を取り消す方法
ITやプログラミングに関するニュース
株式会社HODL1がAI経営管理エージェントを提供開始、少人数での経営管理効率化を支援
株式会社サードスコープがKanataを発表、法人向けAI業務支援SaaSを展開
株式会社ナレッジセンスがChatSenseのPPTX出力機能を強化、資料修正負荷の軽減を支援
株式会社すららネットが「すらら」同時導入を公表、夜間中学で日本語学習と教科学習を支援
DUAL株式会社が空室通電DXと賃貸革命の連携を開始、空室時の通電管理効率化を推進
株式会社ITLINEがAWS生成AIシステム開発・運用を提供開始、企業管理型AI基盤の構築を支援
合同会社ウノマスがAI対応スコアを正式公開、LLMOとSEOの横断診断を支援
Markefan株式会社がmarke.aiを提供開始、BtoBマーケティングの属人化抑制を支援
株式会社FinatextがAIロールプレイング提供開始、金融機関の営業育成基盤構築を支援
株式会社アンドパッドがANDPAD ナレッジAIを提供開始、建設現場の情報検索と共有を支援
