質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.48%
Python 3.x

Python 3はPythonプログラミング言語の最新バージョンであり、2008年12月3日にリリースされました。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

Q&A

解決済

1回答

286閲覧

Python3.6.6の公式ドキュメント「ドキュメンテーション文字列」について

pigton

総合スコア47

Python 3.x

Python 3はPythonプログラミング言語の最新バージョンであり、2008年12月3日にリリースされました。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

1グッド

0クリップ

投稿2018/08/29 03:11

前提・実現したいこと

Pythonを学習していますが、ドキュメンテーション文字列について、よくわからない記述があります。
回答・解説をいただけますと幸いです。

わからないところを抜粋

https://docs.python.jp/3/tutorial/controlflow.html
上記URLの4.7.6.ドキュメンテーション文字列のところ

Python のパーザは複数行にわたる Python 文字列リテラルからインデントを剥ぎ取らないので、ドキュメントを処理するツールでは必要に応じてインデントを剥ぎ取らなければなりません。この処理は以下の規約に従って行います。最初の行の 後にある 空行でない最初の行が、ドキュメント全体のインデントの量を決めます。(最初の行は通常、文字列を開始するクオートに隣り合っているので、インデントが文字列リテラル中に現れないためです。) このインデント量と "等価な" 空白が、文字列のすべての行頭から剥ぎ取られます。インデントの量が少ない行を書いてはならないのですが、もしそういう行があると、先頭の空白すべてが剥ぎ取られます。インデントの空白の大きさが等しいかどうかは、タブ文字を (通常は 8 文字のスペースとして) 展開した後に調べられます。

以下に複数行のドキュメンテーション文字列の例を示します:

Python

1>>> def my_function(): 2... """Do nothing, but document it. 3... 4... No, really, it doesn't do anything. 5... """ 6... pass 7... 8>>> print(my_function.__doc__) 9Do nothing, but document it. 10 11 No, really, it doesn't do anything.

何がわからないか

①ドキュメント全体のインデントの量を決める、最初の行の後にある空行でない最初の行とは、
上記ソースコードのpassの行で間違いないですか?

②「このインデント量と"等価な"空白が、文字列のすべての行頭から剥ぎ取られます。」というのは、つまり
passの行のインデントをスペース4つにしているので、他の行でもスペースが4つずつ削られるということでしょうか?

③「インデントの空白の大きさが等しいかどうかは、タブ文字を (通常は 8 文字のスペースとして) 展開した後に調べられます。」
この記述に関しては、全く理解できません。
どこから8という数字がでてきたのでしょうか?
また、インデントの空白の大きさが等しいかどうか調べるというのは、どんなときに行われる(行う?)作業なのでしょうか?

以上、細かなことですが、疑問がぬぐえないので質問させていただきました。
回答よろしくお願い致します。

tachikoma👍を押しています

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

ベストアンサー

①ドキュメント全体のインデントの量を決める、最初の行の後にある空行でない最初の行とは、

上記ソースコードのpassの行で間違いないですか?

間違っています。No, really, it doesn't do anything.の部分です。

②「このインデント量と"等価な"空白が、文字列のすべての行頭から剥ぎ取られます。」というのは、つまり

passの行のインデントをスペース4つにしているので、他の行でもスペースが4つずつ削られるということでしょうか?

はい。「ドキュメントを処理するツール」がそのルールに則って空白を「剥ぎ取ら」なけれなりません。

③「インデントの空白の大きさが等しいかどうかは、タブ文字を (通常は 8 文字のスペースとして) 展開した後に調べられます。」

この記述に関しては、全く理解できません。
どこから8という数字がでてきたのでしょうか?
また、インデントの空白の大きさが等しいかどうか調べるというのは、どんなときに行われる(行う?)作業なのでしょうか?

8というのはtab文字を半角スペース8つ分として扱います、というどこかの慣例を示しているだけです、

投稿2018/08/29 03:55

tachikoma

総合スコア3601

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

pigton

2018/08/29 04:18

疑問がすっきり解決しました! 回答ありがとうございました。
guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.48%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問